From fe21ce40c9ad84a0c0669a11f86c0d2ef374fdf5 Mon Sep 17 00:00:00 2001 From: Dan Wallis Date: Tue, 7 Mar 2023 14:17:24 +0000 Subject: [PATCH 1/5] Remove forbidden @author tag --- lib/internal/Magento/Framework/Archive.php | 2 -- lib/internal/Magento/Framework/Archive/AbstractArchive.php | 2 -- lib/internal/Magento/Framework/Archive/ArchiveInterface.php | 2 -- lib/internal/Magento/Framework/Archive/Bz.php | 2 -- lib/internal/Magento/Framework/Archive/Gz.php | 2 -- lib/internal/Magento/Framework/Archive/Tar.php | 2 -- lib/internal/Magento/Framework/Backup/Archive/Tar.php | 2 -- lib/internal/Magento/Framework/Backup/BackupInterface.php | 2 -- lib/internal/Magento/Framework/Backup/Db.php | 1 - lib/internal/Magento/Framework/Backup/Filesystem.php | 2 -- lib/internal/Magento/Framework/Backup/Filesystem/Helper.php | 2 -- .../Magento/Framework/Backup/Filesystem/Iterator/File.php | 2 -- .../Magento/Framework/Backup/Filesystem/Iterator/Filter.php | 2 -- .../Magento/Framework/Backup/Filesystem/Rollback/Fs.php | 2 -- lib/internal/Magento/Framework/Backup/Media.php | 2 -- lib/internal/Magento/Framework/Backup/Nomedia.php | 2 -- lib/internal/Magento/Framework/Backup/Snapshot.php | 2 -- lib/internal/Magento/Framework/DB/Statement/Parameter.php | 2 -- lib/internal/Magento/Framework/DB/Statement/Pdo/Mysql.php | 2 -- lib/internal/Magento/Framework/Data/Form/AbstractForm.php | 2 -- 20 files changed, 39 deletions(-) diff --git a/lib/internal/Magento/Framework/Archive.php b/lib/internal/Magento/Framework/Archive.php index fac86778ee26e..b6065e839244f 100644 --- a/lib/internal/Magento/Framework/Archive.php +++ b/lib/internal/Magento/Framework/Archive.php @@ -11,8 +11,6 @@ /** * Class to work with archives - * - * @author Magento Core Team */ class Archive { diff --git a/lib/internal/Magento/Framework/Archive/AbstractArchive.php b/lib/internal/Magento/Framework/Archive/AbstractArchive.php index 8cdb15f037884..30ddd3ea8553e 100644 --- a/lib/internal/Magento/Framework/Archive/AbstractArchive.php +++ b/lib/internal/Magento/Framework/Archive/AbstractArchive.php @@ -6,8 +6,6 @@ /** * Class to work with archives - * - * @author Magento Core Team */ namespace Magento\Framework\Archive; diff --git a/lib/internal/Magento/Framework/Archive/ArchiveInterface.php b/lib/internal/Magento/Framework/Archive/ArchiveInterface.php index c6e85b558b24e..d94db06fd2702 100644 --- a/lib/internal/Magento/Framework/Archive/ArchiveInterface.php +++ b/lib/internal/Magento/Framework/Archive/ArchiveInterface.php @@ -6,8 +6,6 @@ /** * Interface for work with archives - * - * @author Magento Core Team */ namespace Magento\Framework\Archive; diff --git a/lib/internal/Magento/Framework/Archive/Bz.php b/lib/internal/Magento/Framework/Archive/Bz.php index 9e4a319240ba4..26b447ba9ea57 100644 --- a/lib/internal/Magento/Framework/Archive/Bz.php +++ b/lib/internal/Magento/Framework/Archive/Bz.php @@ -6,8 +6,6 @@ /** * Class to work with bzip2 archives - * - * @author Magento Core Team */ namespace Magento\Framework\Archive; diff --git a/lib/internal/Magento/Framework/Archive/Gz.php b/lib/internal/Magento/Framework/Archive/Gz.php index c80821c537165..5e1f070614c1c 100644 --- a/lib/internal/Magento/Framework/Archive/Gz.php +++ b/lib/internal/Magento/Framework/Archive/Gz.php @@ -6,8 +6,6 @@ /** * Class to work with gz archives - * - * @author Magento Core Team */ namespace Magento\Framework\Archive; diff --git a/lib/internal/Magento/Framework/Archive/Tar.php b/lib/internal/Magento/Framework/Archive/Tar.php index ba875593af1d4..edb0ea18a16d7 100644 --- a/lib/internal/Magento/Framework/Archive/Tar.php +++ b/lib/internal/Magento/Framework/Archive/Tar.php @@ -10,8 +10,6 @@ /** * Class to work with tar archives - * - * @author Magento Core Team */ class Tar extends \Magento\Framework\Archive\AbstractArchive implements \Magento\Framework\Archive\ArchiveInterface { diff --git a/lib/internal/Magento/Framework/Backup/Archive/Tar.php b/lib/internal/Magento/Framework/Backup/Archive/Tar.php index 4ac40c584ee20..61e768c4bd1f1 100644 --- a/lib/internal/Magento/Framework/Backup/Archive/Tar.php +++ b/lib/internal/Magento/Framework/Backup/Archive/Tar.php @@ -6,8 +6,6 @@ /** * Extended version of \Magento\Framework\Archive\Tar that supports filtering - * - * @author Magento Core Team */ namespace Magento\Framework\Backup\Archive; diff --git a/lib/internal/Magento/Framework/Backup/BackupInterface.php b/lib/internal/Magento/Framework/Backup/BackupInterface.php index e16eef51d25a9..506810e9fd615 100644 --- a/lib/internal/Magento/Framework/Backup/BackupInterface.php +++ b/lib/internal/Magento/Framework/Backup/BackupInterface.php @@ -6,8 +6,6 @@ /** * Interface for work with archives - * - * @author Magento Core Team */ namespace Magento\Framework\Backup; diff --git a/lib/internal/Magento/Framework/Backup/Db.php b/lib/internal/Magento/Framework/Backup/Db.php index b7e0edf7c4f47..7559373e8998e 100644 --- a/lib/internal/Magento/Framework/Backup/Db.php +++ b/lib/internal/Magento/Framework/Backup/Db.php @@ -12,7 +12,6 @@ /** * Class to work with database backups * - * @author Magento Core Team * @api * @since 100.0.2 */ diff --git a/lib/internal/Magento/Framework/Backup/Filesystem.php b/lib/internal/Magento/Framework/Backup/Filesystem.php index 8759e3c5a466b..d1b40e413801c 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem.php @@ -19,8 +19,6 @@ /** * Class to work with filesystem backups - * - * @author Magento Core Team */ class Filesystem extends AbstractBackup { diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php b/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php index fb33b4639aad8..788b54f983db7 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php @@ -11,8 +11,6 @@ /** * Filesystem helper - * - * @author Magento Core Team */ class Helper { diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/File.php b/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/File.php index b58ad53dd139b..e32460a6f9d0e 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/File.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/File.php @@ -7,8 +7,6 @@ /** * File lines iterator - * - * @author Magento Core Team */ class File extends \SplFileObject { diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/Filter.php b/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/Filter.php index 845a1a6a56bbe..01420d9275753 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/Filter.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Iterator/Filter.php @@ -6,8 +6,6 @@ /** * Filter \Iterator - * - * @author Magento Core Team */ namespace Magento\Framework\Backup\Filesystem\Iterator; diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php index b8eca279fdf22..9d4fe29e62a0b 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php @@ -20,8 +20,6 @@ /** * Rollback worker for rolling back via local filesystem - * - * @author Magento Core Team */ class Fs extends AbstractRollback { diff --git a/lib/internal/Magento/Framework/Backup/Media.php b/lib/internal/Magento/Framework/Backup/Media.php index 50bbc72869088..e0cdfd2628e59 100644 --- a/lib/internal/Magento/Framework/Backup/Media.php +++ b/lib/internal/Magento/Framework/Backup/Media.php @@ -7,8 +7,6 @@ /** * Class to work media folder and database backups - * - * @author Magento Core Team */ class Media extends Snapshot { diff --git a/lib/internal/Magento/Framework/Backup/Nomedia.php b/lib/internal/Magento/Framework/Backup/Nomedia.php index a1361331771de..70b3dfa9e9675 100644 --- a/lib/internal/Magento/Framework/Backup/Nomedia.php +++ b/lib/internal/Magento/Framework/Backup/Nomedia.php @@ -7,8 +7,6 @@ /** * Class to work system backup that excludes media folder - * - * @author Magento Core Team */ class Nomedia extends \Magento\Framework\Backup\Media { diff --git a/lib/internal/Magento/Framework/Backup/Snapshot.php b/lib/internal/Magento/Framework/Backup/Snapshot.php index 1d2059eaacd3d..ddc0d0ddba38e 100644 --- a/lib/internal/Magento/Framework/Backup/Snapshot.php +++ b/lib/internal/Magento/Framework/Backup/Snapshot.php @@ -6,8 +6,6 @@ /** * Class to work with full filesystem and database backups - * - * @author Magento Core Team */ namespace Magento\Framework\Backup; diff --git a/lib/internal/Magento/Framework/DB/Statement/Parameter.php b/lib/internal/Magento/Framework/DB/Statement/Parameter.php index fb7dd5e47c57e..a5b3d2063de69 100644 --- a/lib/internal/Magento/Framework/DB/Statement/Parameter.php +++ b/lib/internal/Magento/Framework/DB/Statement/Parameter.php @@ -12,8 +12,6 @@ * way to the query. * Most used properties and methods are defined in interface. Specific things for concrete DB adapter can be * transmitted using 'addtional' property (\Magento\Framework\DataObject) as a container. - * - * @author Magento Core Team */ class Parameter { diff --git a/lib/internal/Magento/Framework/DB/Statement/Pdo/Mysql.php b/lib/internal/Magento/Framework/DB/Statement/Pdo/Mysql.php index 7a5b51574ac41..77d39f414e1ae 100644 --- a/lib/internal/Magento/Framework/DB/Statement/Pdo/Mysql.php +++ b/lib/internal/Magento/Framework/DB/Statement/Pdo/Mysql.php @@ -9,8 +9,6 @@ /** * Mysql DB Statement - * - * @author Magento Core Team */ class Mysql extends \Zend_Db_Statement_Pdo { diff --git a/lib/internal/Magento/Framework/Data/Form/AbstractForm.php b/lib/internal/Magento/Framework/Data/Form/AbstractForm.php index 4a082d71ddd4a..8385827b7f32a 100644 --- a/lib/internal/Magento/Framework/Data/Form/AbstractForm.php +++ b/lib/internal/Magento/Framework/Data/Form/AbstractForm.php @@ -14,8 +14,6 @@ /** * Abstract class for form, column and fieldset - * - * @author Magento Core Team */ class AbstractForm extends \Magento\Framework\DataObject { From 97ae81fa0088a06430d129eb0498588e62acc5f8 Mon Sep 17 00:00:00 2001 From: Dan Wallis Date: Mon, 20 Mar 2023 22:24:57 +0000 Subject: [PATCH 2/5] Comply with coding standard --- .../Magento/Framework/Backup/Filesystem.php | 14 ++++++++------ .../Magento/Framework/Backup/Filesystem/Helper.php | 10 ++++++---- .../Magento/Framework/DB/Statement/Parameter.php | 9 +++++++++ 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/lib/internal/Magento/Framework/Backup/Filesystem.php b/lib/internal/Magento/Framework/Backup/Filesystem.php index d1b40e413801c..4abd1f152d900 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem.php @@ -1,4 +1,5 @@ validateAvailableDiscSpace($this->getBackupsDir(), $filesInfo['size']); $tarTmpPath = $this->_getTarTmpPath(); @@ -158,8 +156,9 @@ public function create() * * @param string $backupDir * @param int $size + * * @return void - * @throws LocalizedException + * @throws NotEnoughFreeSpace */ public function validateAvailableDiscSpace($backupDir, $size) { @@ -182,6 +181,7 @@ public function validateAvailableDiscSpace($backupDir, $size) * @param string $username * @param string $password * @param string $path + * * @return $this */ public function setUseFtp($host, $username, $password, $path) @@ -210,6 +210,7 @@ public function getType() * Add path that should be ignoring when creating or rolling back backup * * @param string|array $paths + * * @return $this */ public function addIgnorePaths($paths) @@ -241,6 +242,7 @@ public function getIgnorePaths() * Set directory where backups saved and add it to ignore paths * * @param string $backupsDir + * * @return $this * * @see AbstractBackup::setBackupsDir() @@ -277,7 +279,7 @@ public function getFtpConnectString() * Check backups directory existence and whether it's writeable * * @return void - * @throws LocalizedException + * @throws NotEnoughPermissions */ protected function _checkBackupsDir() { diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php b/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php index 788b54f983db7..9a70503b7d7bb 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Helper.php @@ -20,7 +20,7 @@ class Helper * * @const int */ - const INFO_WRITABLE = 1; + public const INFO_WRITABLE = 1; /** * Constant can be used in getInfo() function as second parameter. @@ -28,7 +28,7 @@ class Helper * * @const int */ - const INFO_READABLE = 2; + public const INFO_READABLE = 2; /** * Constant can be used in getInfo() function as second parameter. @@ -36,7 +36,7 @@ class Helper * * @const int */ - const INFO_SIZE = 4; + public const INFO_SIZE = 4; /** * Constant can be used in getInfo() function as second parameter. @@ -44,7 +44,7 @@ class Helper * * @const int */ - const INFO_ALL = 7; + public const INFO_ALL = 7; /** * Recursively delete $path @@ -52,6 +52,7 @@ class Helper * @param string $path * @param array $skipPaths * @param bool $removeRoot + * * @return void * @throws \Magento\Framework\Exception\LocalizedException * @SuppressWarnings(PHPMD.ShortMethodName) @@ -80,6 +81,7 @@ public function rm($path, $skipPaths = [], $removeRoot = false) * @param string $path * @param int $infoOptions * @param array $skipFiles + * * @return array * @SuppressWarnings(PHPMD.CyclomaticComplexity) * @SuppressWarnings(PHPMD.NPathComplexity) diff --git a/lib/internal/Magento/Framework/DB/Statement/Parameter.php b/lib/internal/Magento/Framework/DB/Statement/Parameter.php index a5b3d2063de69..48f5d9bfb569a 100644 --- a/lib/internal/Magento/Framework/DB/Statement/Parameter.php +++ b/lib/internal/Magento/Framework/DB/Statement/Parameter.php @@ -1,8 +1,10 @@ Date: Mon, 18 Dec 2023 13:08:23 +0530 Subject: [PATCH 3/5] Fixed static test failures. --- lib/internal/Magento/Framework/Backup/BackupInterface.php | 1 + lib/internal/Magento/Framework/Backup/Filesystem.php | 2 ++ .../Magento/Framework/Backup/Filesystem/Rollback/Fs.php | 1 + 3 files changed, 4 insertions(+) diff --git a/lib/internal/Magento/Framework/Backup/BackupInterface.php b/lib/internal/Magento/Framework/Backup/BackupInterface.php index 506810e9fd615..4ddfff96e4964 100644 --- a/lib/internal/Magento/Framework/Backup/BackupInterface.php +++ b/lib/internal/Magento/Framework/Backup/BackupInterface.php @@ -13,6 +13,7 @@ * @api * * @deprecated 101.0.7 Backups should be done using other means. + * @see Nothing * @since 100.0.2 */ interface BackupInterface diff --git a/lib/internal/Magento/Framework/Backup/Filesystem.php b/lib/internal/Magento/Framework/Backup/Filesystem.php index 4abd1f152d900..ca875949e23d7 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem.php @@ -321,6 +321,7 @@ protected function _getTarTmpPath() * * @return Ftp * @deprecated 101.0.0 + * @see Nothing */ protected function getRollBackFtp() { @@ -339,6 +340,7 @@ protected function getRollBackFtp() * * @return Fs * @deprecated 101.0.0 + * @see Nothing */ protected function getRollBackFs() { diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php index 9d4fe29e62a0b..c6447a57c4179 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/Fs.php @@ -96,6 +96,7 @@ public function run() * * @return Helper * @deprecated 101.0.0 + * @see Nothing */ private function getFsHelper() { From fd659bbdbdf6305384071c6f84abc892b2bc5f13 Mon Sep 17 00:00:00 2001 From: Indrani Sonawane Date: Tue, 1 Oct 2024 14:34:17 +0530 Subject: [PATCH 4/5] Fixing SVC error --- lib/internal/Magento/Framework/Backup/Filesystem.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/internal/Magento/Framework/Backup/Filesystem.php b/lib/internal/Magento/Framework/Backup/Filesystem.php index ca875949e23d7..a52d8d5568f5a 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem.php @@ -156,7 +156,7 @@ public function create() * * @param string $backupDir * @param int $size - * + * @phpcs:ignore * @return void * @throws NotEnoughFreeSpace */ From 0a8fcca05f1c1605bf5b735db61758892c6d696d Mon Sep 17 00:00:00 2001 From: Dan Wallis Date: Tue, 1 Oct 2024 19:53:39 +0100 Subject: [PATCH 5/5] Revert "Fixing SVC error" This reverts commit fd659bbdbdf6305384071c6f84abc892b2bc5f13. --- lib/internal/Magento/Framework/Backup/Filesystem.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/internal/Magento/Framework/Backup/Filesystem.php b/lib/internal/Magento/Framework/Backup/Filesystem.php index a52d8d5568f5a..ca875949e23d7 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem.php @@ -156,7 +156,7 @@ public function create() * * @param string $backupDir * @param int $size - * @phpcs:ignore + * * @return void * @throws NotEnoughFreeSpace */