diff --git a/.phpmd.dist.xml b/.phpmd.dist.xml new file mode 100644 index 00000000000..41c0e8c67d5 --- /dev/null +++ b/.phpmd.dist.xml @@ -0,0 +1,125 @@ + + + + OpenMage ruleset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/code/core/Mage/Adminhtml/Block/Customer/Online/Grid/Renderer/Ip.php b/app/code/core/Mage/Adminhtml/Block/Customer/Online/Grid/Renderer/Ip.php index 996d3e325d1..de121ef7477 100644 --- a/app/code/core/Mage/Adminhtml/Block/Customer/Online/Grid/Renderer/Ip.php +++ b/app/code/core/Mage/Adminhtml/Block/Customer/Online/Grid/Renderer/Ip.php @@ -27,6 +27,9 @@ */ class Mage_Adminhtml_Block_Customer_Online_Grid_Renderer_Ip extends Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Abstract { + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function render(Varien_Object $row) { /** diff --git a/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Renderer/Ip.php b/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Renderer/Ip.php index fd4575f11ef..e855420de39 100644 --- a/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Renderer/Ip.php +++ b/app/code/core/Mage/Adminhtml/Block/Widget/Grid/Column/Renderer/Ip.php @@ -32,6 +32,8 @@ class Mage_Adminhtml_Block_Widget_Grid_Column_Renderer_Ip extends Mage_Adminhtml * * @param Varien_Object $row * @return string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function render(Varien_Object $row) { diff --git a/app/code/core/Mage/Backup/Helper/Data.php b/app/code/core/Mage/Backup/Helper/Data.php index 40dc1cdff69..efb2d23a301 100644 --- a/app/code/core/Mage/Backup/Helper/Data.php +++ b/app/code/core/Mage/Backup/Helper/Data.php @@ -207,6 +207,8 @@ public function turnOnMaintenanceMode() /** * Turn off store maintenance mode + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function turnOffMaintenanceMode() { diff --git a/app/code/core/Mage/Backup/Model/Backup.php b/app/code/core/Mage/Backup/Model/Backup.php index e169ed8cf72..31f67d6a9b5 100644 --- a/app/code/core/Mage/Backup/Model/Backup.php +++ b/app/code/core/Mage/Backup/Model/Backup.php @@ -168,6 +168,8 @@ public function setFile(&$content) * @todo rewrite to Varien_IO, but there no possibility read part of files. * @return string * @throws Mage_Backup_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function &getFile() { @@ -227,6 +229,8 @@ public function deleteFile() * * @param bool $write * @return $this + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function open($write = false) { @@ -312,6 +316,8 @@ public function write($string) * Close open backup file * * @return $this + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function close() { diff --git a/app/code/core/Mage/Catalog/Model/Api2/Product/Image/Rest/Admin/V1.php b/app/code/core/Mage/Catalog/Model/Api2/Product/Image/Rest/Admin/V1.php index 22eb73e8fa0..83fc1109880 100644 --- a/app/code/core/Mage/Catalog/Model/Api2/Product/Image/Rest/Admin/V1.php +++ b/app/code/core/Mage/Catalog/Model/Api2/Product/Image/Rest/Admin/V1.php @@ -34,6 +34,8 @@ class Mage_Catalog_Model_Api2_Product_Image_Rest_Admin_V1 extends Mage_Catalog_M * @throws Mage_Api2_Exception * @param array $data * @return string|void + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _create(array $data) { diff --git a/app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php b/app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php index e931e2c2ba4..47d32f1f782 100644 --- a/app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php +++ b/app/code/core/Mage/Catalog/Model/Product/Attribute/Media/Api.php @@ -111,6 +111,8 @@ public function info($productId, $file, $store = null, $identifierType = null) * @param string|null $identifierType * @return string * @throws Mage_Api_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function create($productId, $data, $store = null, $identifierType = null) { @@ -202,6 +204,8 @@ public function create($productId, $data, $store = null, $identifierType = null) * @param string|null $identifierType * @return bool * @throws Mage_Api_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function update($productId, $file, $data, $store = null, $identifierType = null) { diff --git a/app/code/core/Mage/Catalog/Model/Product/Option/Type/File.php b/app/code/core/Mage/Catalog/Model/Product/Option/Type/File.php index 05dd2f627d4..35c11efba6c 100644 --- a/app/code/core/Mage/Catalog/Model/Product/Option/Type/File.php +++ b/app/code/core/Mage/Catalog/Model/Product/Option/Type/File.php @@ -617,6 +617,8 @@ public function prepareOptionValueForRequest($optionValue) * Quote item to order item copy process * * @return $this + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function copyQuoteToOrder() { @@ -798,6 +800,8 @@ protected function _getUploadMaxFilesize() * * @param string $ini_key php.ini Var name * @return int Setting value + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _getBytesIniValue($ini_key) { diff --git a/app/code/core/Mage/Cms/Model/Wysiwyg/Images/Storage.php b/app/code/core/Mage/Cms/Model/Wysiwyg/Images/Storage.php index 0194b755ea4..c4b0b70b90c 100644 --- a/app/code/core/Mage/Cms/Model/Wysiwyg/Images/Storage.php +++ b/app/code/core/Mage/Cms/Model/Wysiwyg/Images/Storage.php @@ -100,6 +100,8 @@ public function getDirsCollection($path) * @param string $path Parent directory path * @param string $type Type of storage, e.g. image, media etc. * @return Varien_Data_Collection_Filesystem + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function getFilesCollection($path, $type = null) { diff --git a/app/code/core/Mage/Core/Controller/Varien/Front.php b/app/code/core/Mage/Core/Controller/Varien/Front.php index 0b593631e5b..8f27b67934b 100644 --- a/app/code/core/Mage/Core/Controller/Varien/Front.php +++ b/app/code/core/Mage/Core/Controller/Varien/Front.php @@ -327,6 +327,8 @@ protected function _processRewriteUrl($url) * By default this feature is enabled in configuration. * * @param Mage_Core_Controller_Request_Http $request + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _checkBaseUrl($request) { diff --git a/app/code/core/Mage/Core/Helper/Data.php b/app/code/core/Mage/Core/Helper/Data.php index d546293881d..88268a44dd2 100644 --- a/app/code/core/Mage/Core/Helper/Data.php +++ b/app/code/core/Mage/Core/Helper/Data.php @@ -335,6 +335,8 @@ public function getStoreId($store = null) * @param string $string * @param bool $german * @return false|string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function removeAccents($string, $german = false) { @@ -763,6 +765,8 @@ public function uniqHash($prefix = '') * @param callable $beforeMergeCallback * @param array|string $extensionsFilter * @return bool|string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mergeFiles( array $srcFiles, diff --git a/app/code/core/Mage/Core/Model/Config/Options.php b/app/code/core/Mage/Core/Model/Config/Options.php index ba2f4afc3ba..7a84d5353d4 100644 --- a/app/code/core/Mage/Core/Model/Config/Options.php +++ b/app/code/core/Mage/Core/Model/Config/Options.php @@ -263,6 +263,8 @@ public function getExportDir() /** * @param string $dir * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function createDirIfNotExists($dir) { diff --git a/app/code/core/Mage/Core/Model/Date.php b/app/code/core/Mage/Core/Model/Date.php index f204e1659e1..b98f4e2bef7 100644 --- a/app/code/core/Mage/Core/Model/Date.php +++ b/app/code/core/Mage/Core/Model/Date.php @@ -67,6 +67,8 @@ protected function _getConfigTimezone() * * @param string $timezone * @return int offset between timezone and gmt + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function calculateOffset($timezone = null) { diff --git a/app/code/core/Mage/Core/Model/Design/Package.php b/app/code/core/Mage/Core/Model/Design/Package.php index 3c3b4dc68d4..184b9238f50 100644 --- a/app/code/core/Mage/Core/Model/Design/Package.php +++ b/app/code/core/Mage/Core/Model/Design/Package.php @@ -659,6 +659,8 @@ protected function _checkUserAgentAgainstRegexps($regexpsConfigPath) * @param array $rules - design exception rules * @param string $regexpsConfigPath * @return bool|string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public static function getPackageByUserAgent(array $rules, $regexpsConfigPath = 'path_mock') { diff --git a/app/code/core/Mage/Core/Model/File/Storage/Abstract.php b/app/code/core/Mage/Core/Model/File/Storage/Abstract.php index f1a7a564ed2..a96c473cd46 100644 --- a/app/code/core/Mage/Core/Model/File/Storage/Abstract.php +++ b/app/code/core/Mage/Core/Model/File/Storage/Abstract.php @@ -63,6 +63,8 @@ public function getMediaBaseDirectory() * * @param string $path * @return array + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function collectFileInfo($path) { diff --git a/app/code/core/Mage/Core/Model/Locale.php b/app/code/core/Mage/Core/Model/Locale.php index bf28e957e59..3eb1b107bb7 100644 --- a/app/code/core/Mage/Core/Model/Locale.php +++ b/app/code/core/Mage/Core/Model/Locale.php @@ -586,6 +586,8 @@ public function utcDate($store, $date, $includeTime = false, $format = null) * * @param mixed $store * @return int + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function storeTimeStamp($store = null) { diff --git a/app/code/core/Mage/Core/Model/Resource/File/Storage/File.php b/app/code/core/Mage/Core/Model/Resource/File/Storage/File.php index b9d566e98b7..bc58299ac2f 100644 --- a/app/code/core/Mage/Core/Model/Resource/File/Storage/File.php +++ b/app/code/core/Mage/Core/Model/Resource/File/Storage/File.php @@ -113,6 +113,8 @@ public function getStorageData($dir = '') * * @param string $dir * @return $this + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function clear($dir = '') { @@ -161,6 +163,8 @@ protected function _getIgnoredFiles() * * @param array $dir * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function saveDir($dir) { @@ -192,6 +196,8 @@ public function saveDir($dir) * @param bool $overwrite * @return bool true if file written, otherwise false * @throws Mage_Core_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function saveFile($filePath, $content, $overwrite = false) { @@ -236,6 +242,8 @@ public function saveFile($filePath, $content, $overwrite = false) * * @param string $filePath * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function lockCreateFile($filePath) { @@ -279,6 +287,8 @@ public function lockCreateFile($filePath) * Unlock, close and remove a locked file (in case the file could not be read from remote storage) * * @param string $filePath + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function removeLockedFile($filePath) { diff --git a/app/code/core/Mage/Core/functions.php b/app/code/core/Mage/Core/functions.php index 0dce97d3794..cc4b27d9a7c 100644 --- a/app/code/core/Mage/Core/functions.php +++ b/app/code/core/Mage/Core/functions.php @@ -203,6 +203,8 @@ function mageCoreErrorHandler($errno, $errstr, $errfile, $errline) * @param bool $html * @param bool $showFirst * @return string|void + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ function mageDebugBacktrace($return = false, $html = true, $showFirst = false) { @@ -240,6 +242,8 @@ function mageSendErrorFooter() /** * @param string $path + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ function mageDelTree($path) { @@ -296,6 +300,8 @@ function mageParseCsv($string, $delimiter = ",", $enclosure = '"', $escape = '\\ /** * @param string $dir * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ function is_dir_writeable($dir) { diff --git a/app/code/core/Mage/Eav/Model/Attribute/Data/Image.php b/app/code/core/Mage/Eav/Model/Attribute/Data/Image.php index 89e3685349f..8e7423bd575 100644 --- a/app/code/core/Mage/Eav/Model/Attribute/Data/Image.php +++ b/app/code/core/Mage/Eav/Model/Attribute/Data/Image.php @@ -34,6 +34,8 @@ class Mage_Eav_Model_Attribute_Data_Image extends Mage_Eav_Model_Attribute_Data_ * * @param array $value * @return array + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _validateByRules($value) { diff --git a/app/code/core/Mage/Install/Model/Installer/Console.php b/app/code/core/Mage/Install/Model/Installer/Console.php index 997a9cf07a7..a8e29cc409b 100644 --- a/app/code/core/Mage/Install/Model/Installer/Console.php +++ b/app/code/core/Mage/Install/Model/Installer/Console.php @@ -316,6 +316,8 @@ protected function _prepareData() * Install Magento * * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function install() { diff --git a/app/code/core/Mage/Media/Model/File/Image.php b/app/code/core/Mage/Media/Model/File/Image.php index 4033d1fccaf..52dd3371d85 100644 --- a/app/code/core/Mage/Media/Model/File/Image.php +++ b/app/code/core/Mage/Media/Model/File/Image.php @@ -203,6 +203,8 @@ public function saveAs(Mage_Media_Model_Image $object, $extension = null) * * @param Mage_Media_Model_Image $object * @return Varien_Object + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function getDimensions(Mage_Media_Model_Image $object) { diff --git a/app/code/core/Mage/Paypal/Model/Report/Settlement.php b/app/code/core/Mage/Paypal/Model/Report/Settlement.php index 62e8a22f22b..2952da552be 100644 --- a/app/code/core/Mage/Paypal/Model/Report/Settlement.php +++ b/app/code/core/Mage/Paypal/Model/Report/Settlement.php @@ -187,6 +187,8 @@ protected function _beforeSave() * * @param array $config SFTP credentials * @return int Number of report rows that were fetched and saved successfully + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function fetchAndSave($config) { diff --git a/app/code/core/Mage/Sales/Model/Order/Pdf/Abstract.php b/app/code/core/Mage/Sales/Model/Order/Pdf/Abstract.php index ffc5586b733..cb7b966240c 100644 --- a/app/code/core/Mage/Sales/Model/Order/Pdf/Abstract.php +++ b/app/code/core/Mage/Sales/Model/Order/Pdf/Abstract.php @@ -86,6 +86,8 @@ abstract public function getPdf(); * @param Zend_Pdf_Resource_Font $font * @param float $fontSize Font size in points * @return float + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function widthForStringUsingFontSize($string, $font, $fontSize) { diff --git a/app/code/core/Mage/Sales/controllers/DownloadController.php b/app/code/core/Mage/Sales/controllers/DownloadController.php index 0ad8ffd372f..0069e1b76d4 100644 --- a/app/code/core/Mage/Sales/controllers/DownloadController.php +++ b/app/code/core/Mage/Sales/controllers/DownloadController.php @@ -78,6 +78,8 @@ protected function _validateFilePath($info) * * @param string $filePath * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _processDatabaseFile($filePath) { diff --git a/lib/Mage/Archive/Abstract.php b/lib/Mage/Archive/Abstract.php index 234c60ee527..f1e73c1cd9c 100644 --- a/lib/Mage/Archive/Abstract.php +++ b/lib/Mage/Archive/Abstract.php @@ -50,6 +50,8 @@ protected function _writeFile($destination, $data) * @param string $source * @return string * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _readFile($source) { diff --git a/lib/Mage/Archive/Helper/File.php b/lib/Mage/Archive/Helper/File.php index 46e8efd143c..876691d0272 100644 --- a/lib/Mage/Archive/Helper/File.php +++ b/lib/Mage/Archive/Helper/File.php @@ -161,6 +161,8 @@ public function eof() /** * Close file + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function close() { @@ -175,6 +177,8 @@ public function close() * * @param string $mode * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _open($mode) { @@ -190,6 +194,8 @@ protected function _open($mode) * * @param string $data * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _write($data) { diff --git a/lib/Mage/Archive/Helper/File/Bz.php b/lib/Mage/Archive/Helper/File/Bz.php index c9ee4030a18..12ad051953e 100644 --- a/lib/Mage/Archive/Helper/File/Bz.php +++ b/lib/Mage/Archive/Helper/File/Bz.php @@ -33,6 +33,8 @@ class Mage_Archive_Helper_File_Bz extends Mage_Archive_Helper_File * * @throws Mage_Exception * @param string $mode + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _open($mode) { @@ -48,6 +50,8 @@ protected function _open($mode) * * @throws Mage_Exception * @param $data + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _write($data) { diff --git a/lib/Mage/Archive/Helper/File/Gz.php b/lib/Mage/Archive/Helper/File/Gz.php index 87811c5c083..27572584783 100644 --- a/lib/Mage/Archive/Helper/File/Gz.php +++ b/lib/Mage/Archive/Helper/File/Gz.php @@ -43,6 +43,8 @@ public function __construct($filePath) /** * @see Mage_Archive_Helper_File::_open() + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _open($mode) { @@ -55,6 +57,8 @@ protected function _open($mode) /** * @see Mage_Archive_Helper_File::_write() + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _write($data) { diff --git a/lib/Mage/Archive/Tar.php b/lib/Mage/Archive/Tar.php index 1e56cd21533..00174da7c8e 100644 --- a/lib/Mage/Archive/Tar.php +++ b/lib/Mage/Archive/Tar.php @@ -412,6 +412,8 @@ protected function _composeHeader($long = false) * @param string $destination path to file is unpacked * @return array list of files * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _unpackCurrentTar($destination) { diff --git a/lib/Mage/Autoload/Simple.php b/lib/Mage/Autoload/Simple.php index c7448bc9f6a..f221957f767 100644 --- a/lib/Mage/Autoload/Simple.php +++ b/lib/Mage/Autoload/Simple.php @@ -36,6 +36,9 @@ public static function register() spl_autoload_register([self::instance(), 'autoload']); } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function autoload($class) { $classFile = str_replace(' ', DIRECTORY_SEPARATOR, ucwords(str_replace('_', ' ', $class))); diff --git a/lib/Mage/Backup/Db.php b/lib/Mage/Backup/Db.php index 81bc10604ae..57f1b8c3a98 100644 --- a/lib/Mage/Backup/Db.php +++ b/lib/Mage/Backup/Db.php @@ -31,6 +31,8 @@ class Mage_Backup_Db extends Mage_Backup_Abstract * Implements Rollback functionality for Db * * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rollback() { diff --git a/lib/Mage/Backup/Filesystem.php b/lib/Mage/Backup/Filesystem.php index c7dcffd5225..fb70018cfdd 100644 --- a/lib/Mage/Backup/Filesystem.php +++ b/lib/Mage/Backup/Filesystem.php @@ -93,6 +93,8 @@ public function rollback() * * @throws Mage_Exception * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function create() { diff --git a/lib/Mage/Backup/Filesystem/Helper.php b/lib/Mage/Backup/Filesystem/Helper.php index dbf03ac7b8c..0d4991cb067 100644 --- a/lib/Mage/Backup/Filesystem/Helper.php +++ b/lib/Mage/Backup/Filesystem/Helper.php @@ -66,6 +66,8 @@ class Mage_Backup_Filesystem_Helper * @param array $skipPaths * @param bool $removeRoot * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rm($path, $skipPaths = [], $removeRoot = false) { diff --git a/lib/Mage/Backup/Filesystem/Rollback/Ftp.php b/lib/Mage/Backup/Filesystem/Rollback/Ftp.php index 153076c3a9c..bc8af609907 100644 --- a/lib/Mage/Backup/Filesystem/Rollback/Ftp.php +++ b/lib/Mage/Backup/Filesystem/Rollback/Ftp.php @@ -81,6 +81,8 @@ protected function _initFtpClient() * Perform ftp validation. Check whether ftp account provided points to current magento installation * * @throws Mage_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _validateFtp() { @@ -121,6 +123,8 @@ protected function _unpackSnapshot($tmpDir) /** * @throws Mage_Exception * @return string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _createTmpDir() { diff --git a/lib/Mage/Backup/Snapshot.php b/lib/Mage/Backup/Snapshot.php index d525188c7c0..e3f993b2c48 100644 --- a/lib/Mage/Backup/Snapshot.php +++ b/lib/Mage/Backup/Snapshot.php @@ -126,6 +126,8 @@ protected function _getDbBackupManager() * Remove Db backup after added it to the snapshot * * @return $this + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _removeDbBackup() { diff --git a/lib/Mage/Cache/Backend/File.php b/lib/Mage/Cache/Backend/File.php index 7fe99fc8105..5edcc371203 100644 --- a/lib/Mage/Cache/Backend/File.php +++ b/lib/Mage/Cache/Backend/File.php @@ -264,6 +264,8 @@ public function clean($mode = Zend_Cache::CLEANING_MODE_ALL, $tags = []) * Return an array of stored tags * * @return array Array of stored tags (string) + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function getTags() { @@ -375,8 +377,9 @@ public function touch($id, $extraLifetime) * * @param string $file Cache file * @param bool $withData - * * @return array|bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _getCache($file, $withData) { @@ -481,6 +484,8 @@ protected function _path($id, $parts = false) * * @throws Zend_Cache_Exception * @return boolean In case of success returns true + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _clean($dir, $mode = Zend_Cache::CLEANING_MODE_ALL, $tags = []) { @@ -648,6 +653,8 @@ protected function _tagFile($id) * Return the complete directory path where tags are stored * * @return string Complete directory path + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _tagPath() { @@ -671,6 +678,8 @@ protected function _tagPath() * @param string|resource $tag * * @return array + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _getTagIds($tag) { @@ -744,6 +753,8 @@ protected function _updateIdsTags($ids, $tags, $mode) * @param string $string String to put in file * * @return boolean In case of success returns true + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _filePutContents($file, $string) { @@ -760,6 +771,8 @@ protected function _filePutContents($file, $string) * * @param string $id cache id * @return boolean true + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _recursiveMkdirAndChmod($id) { diff --git a/lib/Mage/DB/Mysqli.php b/lib/Mage/DB/Mysqli.php index 9ac94f32d6b..1b24c37efc3 100644 --- a/lib/Mage/DB/Mysqli.php +++ b/lib/Mage/DB/Mysqli.php @@ -73,6 +73,8 @@ public function __construct() * @param string $db * @param int $port * @return mixed + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function connect($host, $user, $paswd, $db, $port = self::DEFAULT_PORT) { diff --git a/lib/Mage/HTTP/Client/Socket.php b/lib/Mage/HTTP/Client/Socket.php index 96fe7ac17d3..c7e7d0144a3 100644 --- a/lib/Mage/HTTP/Client/Socket.php +++ b/lib/Mage/HTTP/Client/Socket.php @@ -130,6 +130,8 @@ public function connect($host, $port = 80) /** * Disconnect + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function disconnect() { @@ -385,6 +387,8 @@ protected function processResponseHeaders() /** * Process response body + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function processResponseBody() { @@ -437,6 +441,8 @@ public function getStatus() * @param string $method * @param string $uri * @param array $params + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function makeRequest($method, $uri, $params = []) { diff --git a/lib/Mage/System/Dirs.php b/lib/Mage/System/Dirs.php index 021670f0d7b..c0dc554073f 100644 --- a/lib/Mage/System/Dirs.php +++ b/lib/Mage/System/Dirs.php @@ -20,6 +20,9 @@ */ class Mage_System_Dirs { + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public static function rm($dirname) { if (is_array($dirname)) { @@ -70,6 +73,9 @@ public static function rm($dirname) return true; } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public static function mkdirStrict($path, $recursive = true, $mode = 0777) { $exists = file_exists($path); diff --git a/lib/Mage/System/Ftp.php b/lib/Mage/System/Ftp.php index 2e0e9c0384a..6be7032e572 100644 --- a/lib/Mage/System/Ftp.php +++ b/lib/Mage/System/Ftp.php @@ -53,6 +53,8 @@ protected function checkConnected() * * @param string $name * @return string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mdkir($name) { @@ -66,6 +68,8 @@ public function mdkir($name) * @param string $path * @param int $mode * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mkdirRecursive($path, $mode = 0777) { @@ -95,6 +99,8 @@ public function mkdirRecursive($path, $mode = 0777) * @param string $password * @throws Exception on invalid login credentials * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function login($login = "anonymous", $password = "test@gmail.com") { @@ -112,6 +118,8 @@ public function login($login = "anonymous", $password = "test@gmail.com") * @param string $string * @throws Exception * @return array + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function validateConnectionString($string) { @@ -163,6 +171,8 @@ public function connect($string, $timeout = 900) * @param int $mode FTP_BINARY | FTP_ASCII * @param int $startPos * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function fput($remoteFile, $handle, $mode = FTP_BINARY, $startPos = 0) { @@ -212,6 +222,8 @@ public function getcwd() * * @param string $cmd * @return mixed + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function raw($cmd) { @@ -284,6 +296,8 @@ public function download($remote, $local, $ftpMode = FTP_BINARY) * * @param bool $pasv * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function pasv($pasv) { @@ -295,6 +309,8 @@ public function pasv($pasv) * Close FTP connection * * @return void + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function close() { @@ -309,6 +325,8 @@ public function close() * @param $mode * @param $remoteFile * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function chmod($mode, $remoteFile) { @@ -321,6 +339,8 @@ public function chmod($mode, $remoteFile) * * @param string $dir * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function chdir($dir) { @@ -332,6 +352,8 @@ public function chdir($dir) * ftp_cdup wrapper * * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function cdup() { @@ -347,6 +369,8 @@ public function cdup() * @param int $fileMode FTP_BINARY | FTP_ASCII * @param int $resumeOffset * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function get($localFile, $remoteFile, $fileMode = FTP_BINARY, $resumeOffset = 0) { @@ -360,6 +384,8 @@ public function get($localFile, $remoteFile, $fileMode = FTP_BINARY, $resumeOffs * * @param string $dir * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function nlist($dir = "/") { @@ -374,6 +400,8 @@ public function nlist($dir = "/") * @param string $dir * @param bool $recursive * @return mixed + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rawlist($dir = "/", $recursive = false) { @@ -493,6 +521,8 @@ public function correctFilePath($str) * * @param string $file * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function delete($file) { diff --git a/lib/Magento/Autoload/Simple.php b/lib/Magento/Autoload/Simple.php index ba161f801a5..990045e9088 100644 --- a/lib/Magento/Autoload/Simple.php +++ b/lib/Magento/Autoload/Simple.php @@ -38,6 +38,9 @@ public static function register() spl_autoload_register([self::instance(), 'autoload']); } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function autoload($class) { $classFile = str_replace(' ', DIRECTORY_SEPARATOR, ucwords(str_replace('_', ' ', $class))); diff --git a/lib/Varien/Autoload.php b/lib/Varien/Autoload.php index 27f33fff559..be33494ccd2 100644 --- a/lib/Varien/Autoload.php +++ b/lib/Varien/Autoload.php @@ -54,6 +54,8 @@ public static function register() * Load class source code * * @param string $class + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function autoload($class) { diff --git a/lib/Varien/Db/Adapter/Mysqli.php b/lib/Varien/Db/Adapter/Mysqli.php index 622c61ee65f..a638de02fd5 100644 --- a/lib/Varien/Db/Adapter/Mysqli.php +++ b/lib/Varien/Db/Adapter/Mysqli.php @@ -29,6 +29,8 @@ class Varien_Db_Adapter_Mysqli extends Zend_Db_Adapter_Mysqli * * @return void * @throws Zend_Db_Adapter_Mysqli_Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _connect() { diff --git a/lib/Varien/File/Uploader.php b/lib/Varien/File/Uploader.php index 28bb2431629..7ff010f217e 100644 --- a/lib/Varien/File/Uploader.php +++ b/lib/Varien/File/Uploader.php @@ -529,6 +529,9 @@ private function _setUploadFileId($fileId) } } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ private function _createDestinationFolder($destinationFolder) { if (!$destinationFolder) { diff --git a/lib/Varien/Image/Adapter/Abstract.php b/lib/Varien/Image/Adapter/Abstract.php index 2be36b71d6a..5eeb09e56aa 100644 --- a/lib/Varien/Image/Adapter/Abstract.php +++ b/lib/Varien/Image/Adapter/Abstract.php @@ -147,6 +147,9 @@ abstract public function watermark($watermarkImage, $positionX = 0, $positionY = abstract public function checkDependencies(); + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function getMimeType() { if ($this->_fileMimeType) { diff --git a/lib/Varien/Image/Adapter/Gd2.php b/lib/Varien/Image/Adapter/Gd2.php index 8c49ed63596..1da6514c378 100644 --- a/lib/Varien/Image/Adapter/Gd2.php +++ b/lib/Varien/Image/Adapter/Gd2.php @@ -45,6 +45,8 @@ public function __construct() /** * Destroy object image on shutdown + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function destruct() { diff --git a/lib/Varien/Io/File.php b/lib/Varien/Io/File.php index 72fe656e516..cf3c2a9b5fa 100644 --- a/lib/Varien/Io/File.php +++ b/lib/Varien/Io/File.php @@ -118,6 +118,8 @@ public function destruct() * @param string $fileName * @param string $mode * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamOpen($fileName, $mode = 'w+', $chmod = 0666) { @@ -180,6 +182,8 @@ public function streamUnlock() * * @param int $length * @return bool|string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamRead($length = 1024) { @@ -196,6 +200,8 @@ public function streamRead($length = 1024) * Gets line from file pointer and parse for CSV fields * * @return array|false|null + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamReadCsv($delimiter = ',', $enclosure = '"') { @@ -210,6 +216,8 @@ public function streamReadCsv($delimiter = ',', $enclosure = '"') * * @param string $str * @return bool|int + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamWrite($str) { @@ -226,6 +234,8 @@ public function streamWrite($str) * @param string $delimiter * @param string $enclosure * @return bool|int + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamWriteCsv(array $row, $delimiter = ',', $enclosure = '"') { @@ -241,6 +251,8 @@ public function streamWriteCsv(array $row, $delimiter = ',', $enclosure = '"') * Set chmod on a file * * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamClose() { @@ -265,6 +277,8 @@ public function streamClose() * @param string $part the part of statistic * @param mixed $default default value for part * @return array|bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function streamStat($part = null, $default = null) { @@ -338,6 +352,8 @@ public function close() * @param int $mode * @param boolean $recursive * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mkdir($dir, $mode = 0777, $recursive = true) { @@ -360,6 +376,8 @@ public function mkdir($dir, $mode = 0777, $recursive = true) * * @param string $dir * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rmdir($dir, $recursive = false) { @@ -378,6 +396,8 @@ public function rmdir($dir, $recursive = false) * @param string $dir * @param bool $recursive * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public static function rmdirRecursive($dir, $recursive = true) { @@ -415,6 +435,8 @@ public function pwd() * @param string $dir * @return boolean * @throws Exception + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function cd($dir) { @@ -436,6 +458,8 @@ public function cd($dir) * @param string $filename * @param string|resource $dest * @return boolean|string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function read($filename, $dest = null) { @@ -488,6 +512,8 @@ public function write($filename, $src, $mode = null) * * @param string|resource $src * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _isValidSource($src) { @@ -510,6 +536,8 @@ protected function _isValidSource($src) * @param string $filename * @throws Varien_Io_Exception * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _isFilenameWriteable($filename) { @@ -542,6 +570,8 @@ protected function _isFilenameWriteable($filename) * * @param string $src * @return bool + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ protected function _checkSrcIsFile($src) { @@ -560,6 +590,8 @@ protected function _checkSrcIsFile($src) * @param string|resource $src * * @return int + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function filePutContent($filename, $src) { @@ -574,6 +606,9 @@ public function filePutContent($filename, $src) return $result; } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function fileExists($file, $onlyFile = true) { if ($this->_cwd) { @@ -589,6 +624,9 @@ public function fileExists($file, $onlyFile = true) return $result; } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function isWriteable($path) { if ($this->_cwd) { @@ -651,6 +689,8 @@ public function checkAndCreateFolder($folder, $mode = 0777) * * @param string $filename * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rm($filename) { @@ -670,6 +710,8 @@ public function rm($filename) * @param string $src * @param string $dest * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mv($src, $dest) { @@ -689,6 +731,8 @@ public function mv($src, $dest) * @param string $src * @param string $dest * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function cp($src, $dest) { @@ -708,6 +752,8 @@ public function cp($src, $dest) * @param string $filename * @param int $mode * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function chmod($filename, $mode) { diff --git a/lib/Varien/Io/Ftp.php b/lib/Varien/Io/Ftp.php index 38ff287185f..4ba7fd35a48 100644 --- a/lib/Varien/Io/Ftp.php +++ b/lib/Varien/Io/Ftp.php @@ -75,6 +75,8 @@ class Varien_Io_Ftp extends Varien_Io_Abstract * * @param array $args * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function open(array $args = []) { @@ -145,6 +147,8 @@ public function open(array $args = []) * Close a connection * * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function close() { @@ -159,6 +163,8 @@ public function close() * @param int $mode * @param boolean $recursive * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mkdir($dir, $mode = 0777, $recursive = true) { @@ -170,6 +176,8 @@ public function mkdir($dir, $mode = 0777, $recursive = true) * * @param string $dir * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rmdir($dir, $recursive = false) { @@ -180,6 +188,8 @@ public function rmdir($dir, $recursive = false) * Get current working directory * * @return string + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function pwd() { @@ -191,6 +201,8 @@ public function pwd() * * @param string $dir * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function cd($dir) { @@ -236,6 +248,8 @@ public function read($filename, $dest = null) * @param string $filename * @param string|resource $src filename, string data or source stream * @return int|boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function write($filename, $src, $mode = null) { @@ -266,6 +280,8 @@ public function write($filename, $src, $mode = null) * * @param string $filename * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function rm($filename) { @@ -278,6 +294,8 @@ public function rm($filename) * @param string $src * @param string $dest * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function mv($src, $dest) { @@ -290,12 +308,17 @@ public function mv($src, $dest) * @param string $filename * @param int $mode * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function chmod($filename, $mode) { return @ftp_chmod($this->_conn, $mode, $filename); } + /** + * @SuppressWarnings(PHPMD.ErrorControlOperator) + */ public function ls($grep = null) { $ls = @ftp_nlist($this->_conn, '.'); diff --git a/lib/Varien/Simplexml/Config.php b/lib/Varien/Simplexml/Config.php index b8ffdc61ca0..03f2a542723 100644 --- a/lib/Varien/Simplexml/Config.php +++ b/lib/Varien/Simplexml/Config.php @@ -140,6 +140,8 @@ public function getNode($path = null) * * @param string $xpath * @return Varien_Simplexml_Element[]|false + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function getXpath($xpath) { diff --git a/lib/Varien/Simplexml/Config/Cache/File.php b/lib/Varien/Simplexml/Config/Cache/File.php index 823aa6c2e8f..b4f521a250a 100644 --- a/lib/Varien/Simplexml/Config/Cache/File.php +++ b/lib/Varien/Simplexml/Config/Cache/File.php @@ -49,6 +49,8 @@ public function setKey($key) * Try to load configuration cache from file * * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function load() { @@ -85,6 +87,8 @@ public function load() * Try to save configuration cache to file * * @return boolean + * + * @SuppressWarnings(PHPMD.ErrorControlOperator) */ public function save() {