From 32858d9d665171701b12ccfb08585724014eba49 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Thu, 14 Nov 2019 18:44:38 -0300 Subject: [PATCH 01/13] Technical guidelines > Abstract classes MUST NOT be marked as public @api --- .../Model/System/Message/Media/AbstractSynchronization.php | 1 + app/code/Magento/Backend/App/AbstractAction.php | 1 + .../Block/Widget/Grid/Column/Renderer/AbstractRenderer.php | 2 ++ .../Magento/Backend/Console/Command/AbstractCacheCommand.php | 1 + .../Backend/Console/Command/AbstractCacheManageCommand.php | 1 + .../Magento/Backend/Console/Command/AbstractCacheSetCommand.php | 1 + .../Backend/Console/Command/AbstractCacheTypeManageCommand.php | 1 + app/code/Magento/Backend/Model/Menu/AbstractDirector.php | 1 + app/code/Magento/Backend/Model/Menu/Builder/AbstractCommand.php | 2 ++ app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php | 1 + app/code/Magento/Catalog/Block/Product/View/AbstractView.php | 1 + app/code/Magento/Catalog/Model/AbstractModel.php | 2 ++ app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php | 1 + .../Catalog/Model/Indexer/Category/Product/AbstractAction.php | 1 + app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php | 1 + app/code/Magento/Catalog/Model/Product/Type/AbstractType.php | 1 + .../Model/ResourceModel/Product/Indexer/AbstractIndexer.php | 1 + .../Ui/Component/Listing/Attribute/AbstractRepository.php | 1 + .../Ui/DataProvider/Product/Related/AbstractDataProvider.php | 1 + .../Model/Export/Product/Type/AbstractType.php | 1 + app/code/Magento/Checkout/CustomerData/AbstractItem.php | 1 + .../System/Config/Form/Field/FieldArray/AbstractFieldArray.php | 2 ++ .../Controller/Adminhtml/System/Config/AbstractScopeConfig.php | 1 + .../Config/Model/Config/Backend/Currency/AbstractCurrency.php | 1 + .../Magento/Config/Model/Config/Structure/AbstractMapper.php | 1 + .../CustomerImportExport/Model/Import/AbstractCustomer.php | 1 + .../Magento/Directory/Model/Currency/Import/AbstractImport.php | 1 + .../Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php | 1 + .../Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php | 1 + app/code/Magento/Eav/Model/Attribute/Data/AbstractData.php | 1 + .../Eav/Model/Entity/Attribute/Backend/AbstractBackend.php | 1 + .../Eav/Model/Entity/Attribute/Frontend/AbstractFrontend.php | 1 + .../Magento/Eav/Model/Entity/Increment/AbstractIncrement.php | 1 + .../GoogleAdwords/Model/Config/Backend/AbstractConversion.php | 1 + app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php | 1 + app/code/Magento/ImportExport/Model/Export/AbstractEntity.php | 1 + .../ImportExport/Model/Export/Adapter/AbstractAdapter.php | 1 + .../Magento/ImportExport/Model/Export/Entity/AbstractEav.php | 1 + .../Magento/ImportExport/Model/Export/Entity/AbstractEntity.php | 1 + app/code/Magento/ImportExport/Model/Import/AbstractEntity.php | 1 + app/code/Magento/ImportExport/Model/Import/AbstractSource.php | 1 + .../Magento/ImportExport/Model/Import/Entity/AbstractEav.php | 1 + .../Magento/ImportExport/Model/Import/Entity/AbstractEntity.php | 1 + .../ImportExport/Model/Source/Import/AbstractBehavior.php | 1 + .../Magento/Indexer/Model/ResourceModel/AbstractResource.php | 1 + app/code/Magento/Payment/Block/Info/AbstractContainer.php | 1 + .../Magento/Payment/Gateway/Validator/AbstractValidator.php | 1 + .../Model/Method/Specification/AbstractSpecification.php | 1 + .../Magento/Payment/Observer/AbstractDataAssignObserver.php | 1 + .../Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php | 1 + app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php | 1 + .../Reports/Controller/Adminhtml/Report/AbstractReport.php | 1 + .../Reports/Model/ResourceModel/Product/Index/AbstractIndex.php | 2 ++ .../Reports/Model/ResourceModel/Report/AbstractReport.php | 1 + app/code/Magento/Rule/Model/Action/AbstractAction.php | 1 + .../Magento/Rule/Model/Condition/Product/AbstractProduct.php | 1 + app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php | 1 + app/code/Magento/Sales/Model/AbstractModel.php | 1 + .../Sales/Model/Order/Creditmemo/Total/AbstractTotal.php | 2 ++ .../Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php | 2 ++ app/code/Magento/Sales/Model/Order/Pdf/Items/AbstractItems.php | 1 + app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php | 2 ++ app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php | 2 ++ .../Sales/Model/ResourceModel/Collection/AbstractCollection.php | 1 + .../Order/Comment/Collection/AbstractCollection.php | 1 + app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php | 1 + .../Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php | 1 + app/code/Magento/Ui/Component/AbstractComponent.php | 1 + app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php | 2 ++ app/code/Magento/Ui/Component/Form/Element/AbstractElement.php | 1 + .../Ui/Component/Form/Element/DataType/AbstractDataType.php | 1 + app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php | 2 ++ app/code/Magento/Ui/DataProvider/AbstractDataProvider.php | 1 + app/code/Magento/Vault/Block/AbstractCardRenderer.php | 2 ++ app/code/Magento/Vault/Block/AbstractTokenRenderer.php | 2 ++ lib/internal/Magento/Framework/Api/AbstractExtensibleObject.php | 2 ++ lib/internal/Magento/Framework/Backup/AbstractBackup.php | 1 + .../Framework/Backup/Filesystem/Rollback/AbstractRollback.php | 1 + lib/internal/Magento/Framework/Config/AbstractXml.php | 1 + .../Magento/Framework/Exception/AbstractAggregateException.php | 1 + lib/internal/Magento/Framework/Message/AbstractMessage.php | 1 + .../Magento/Framework/Model/ResourceModel/AbstractResource.php | 1 + lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php | 1 + lib/internal/Magento/Framework/Validator/AbstractValidator.php | 1 + 84 files changed, 98 insertions(+) diff --git a/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php b/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php index daf29db540d4d..cc07b40bec28c 100644 --- a/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php +++ b/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php @@ -6,6 +6,7 @@ namespace Magento\AdminNotification\Model\System\Message\Media; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/App/AbstractAction.php b/app/code/Magento/Backend/App/AbstractAction.php index fb2daa283f111..55fad14a67c08 100644 --- a/app/code/Magento/Backend/App/AbstractAction.php +++ b/app/code/Magento/Backend/App/AbstractAction.php @@ -8,6 +8,7 @@ /** * Generic backend controller * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php index 623a75015eb2f..a6f0105470141 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php @@ -10,6 +10,8 @@ /** * Backend grid item abstract renderer + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @api diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php index 11da740c46606..c528968a7fb3c 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheCommand.php @@ -13,6 +13,7 @@ /** * Abstract cache command * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php index 35da8eace1fe7..4c40cc483c39e 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php @@ -10,6 +10,7 @@ use Symfony\Component\Console\Input\InputInterface; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php index 02390d03783df..8eaa7e044a7f5 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php @@ -10,6 +10,7 @@ use Symfony\Component\Console\Output\OutputInterface; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php index 2facdf165c5df..2601804f4d290 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php @@ -12,6 +12,7 @@ use Magento\Framework\App\Cache\Manager; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Model/Menu/AbstractDirector.php b/app/code/Magento/Backend/Model/Menu/AbstractDirector.php index 4bd96575f3080..669642e09109c 100644 --- a/app/code/Magento/Backend/Model/Menu/AbstractDirector.php +++ b/app/code/Magento/Backend/Model/Menu/AbstractDirector.php @@ -6,6 +6,7 @@ namespace Magento\Backend\Model\Menu; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Model/Menu/Builder/AbstractCommand.php b/app/code/Magento/Backend/Model/Menu/Builder/AbstractCommand.php index 720fe9b757004..843f711230933 100644 --- a/app/code/Magento/Backend/Model/Menu/Builder/AbstractCommand.php +++ b/app/code/Magento/Backend/Model/Menu/Builder/AbstractCommand.php @@ -7,6 +7,8 @@ /** * Menu builder command + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php index bb68853dcc08d..a13c107a9dc45 100644 --- a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php +++ b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php @@ -7,6 +7,7 @@ namespace Magento\Backend\Model\Widget\Grid; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Catalog/Block/Product/View/AbstractView.php b/app/code/Magento/Catalog/Block/Product/View/AbstractView.php index ec16bc1d2334f..848ec7153f8ef 100644 --- a/app/code/Magento/Catalog/Block/Product/View/AbstractView.php +++ b/app/code/Magento/Catalog/Block/Product/View/AbstractView.php @@ -8,6 +8,7 @@ /** * Product view abstract block * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @deprecated 101.1.0 * @since 100.0.2 diff --git a/app/code/Magento/Catalog/Model/AbstractModel.php b/app/code/Magento/Catalog/Model/AbstractModel.php index 78a49cd1e8b14..6d77a319e51cb 100644 --- a/app/code/Magento/Catalog/Model/AbstractModel.php +++ b/app/code/Magento/Catalog/Model/AbstractModel.php @@ -9,6 +9,8 @@ /** * Abstract model for catalog entities + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @author Magento Core Team diff --git a/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php b/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php index b39048d4dfa40..1221f248bcba9 100644 --- a/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php +++ b/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php @@ -8,6 +8,7 @@ use Magento\Store\Model\ScopeInterface; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php b/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php index 178f4172ce6fa..8c5f0486e45a1 100644 --- a/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php +++ b/app/code/Magento/Catalog/Model/Indexer/Category/Product/AbstractAction.php @@ -18,6 +18,7 @@ /** * Class AbstractAction * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php b/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php index f2e2e67f944e9..ee609b3fa785e 100644 --- a/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php +++ b/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php @@ -8,6 +8,7 @@ /** * Layer category filter abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php index e6804d9246faa..d676e675425a3 100644 --- a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php +++ b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php @@ -11,6 +11,7 @@ use Magento\Framework\Exception\LocalizedException; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * Abstract model for product type implementation * @SuppressWarnings(PHPMD.ExcessivePublicCount) diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php index 4259504b8f0f0..c68d3a4f3d0cb 100644 --- a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php +++ b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php @@ -10,6 +10,7 @@ /** * Catalog Product Indexer Abstract Resource Model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @author Magento Core Team diff --git a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php index c7b339d5fac96..02895e029593e 100644 --- a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php +++ b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php @@ -6,6 +6,7 @@ namespace Magento\Catalog\Ui\Component\Listing\Attribute; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php index 8154cab3d9068..b243e855b36a0 100644 --- a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php +++ b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php @@ -19,6 +19,7 @@ /** * Class AbstractDataProvider * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 101.0.0 */ diff --git a/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php b/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php index 7ca95c0ec5e9f..0e4553fb8b144 100644 --- a/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php +++ b/app/code/Magento/CatalogImportExport/Model/Export/Product/Type/AbstractType.php @@ -10,6 +10,7 @@ /** * Export entity product type abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Checkout/CustomerData/AbstractItem.php b/app/code/Magento/Checkout/CustomerData/AbstractItem.php index 9c2e3a32ef901..41715c7982ee3 100644 --- a/app/code/Magento/Checkout/CustomerData/AbstractItem.php +++ b/app/code/Magento/Checkout/CustomerData/AbstractItem.php @@ -11,6 +11,7 @@ /** * Abstract item * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractItem implements ItemInterface diff --git a/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php b/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php index 3bb4632ee4517..20abd3aa8dc36 100644 --- a/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php +++ b/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php @@ -10,6 +10,8 @@ * Backend system config array field renderer * * @author Magento Core Team + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php b/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php index 27f7217b50ba1..eba0494089064 100644 --- a/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php +++ b/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php @@ -9,6 +9,7 @@ use Magento\Config\Controller\Adminhtml\System\ConfigSectionChecker; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Config/Model/Config/Backend/Currency/AbstractCurrency.php b/app/code/Magento/Config/Model/Config/Backend/Currency/AbstractCurrency.php index 25303093ace5d..3b0d8d2e92bc7 100644 --- a/app/code/Magento/Config/Model/Config/Backend/Currency/AbstractCurrency.php +++ b/app/code/Magento/Config/Model/Config/Backend/Currency/AbstractCurrency.php @@ -16,6 +16,7 @@ /** * Base currency class * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php b/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php index 711a165dc5541..2bb013f8104f6 100644 --- a/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php +++ b/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php @@ -10,6 +10,7 @@ namespace Magento\Config\Model\Config\Structure; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php b/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php index cc6eebed57b1d..c2e0e80bcfd89 100644 --- a/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php +++ b/app/code/Magento/CustomerImportExport/Model/Import/AbstractCustomer.php @@ -13,6 +13,7 @@ /** * Import entity abstract customer model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php b/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php index da9f2a43b56b3..17aeaacf56bcb 100644 --- a/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php +++ b/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php @@ -10,6 +10,7 @@ namespace Magento\Directory\Model\Currency\Import; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php index 9b44b2c7395ac..412228d2eb452 100644 --- a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php +++ b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php @@ -8,6 +8,7 @@ /** * Attribute add/edit form options tab * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @deprecated 100.2.0 * @since 100.0.2 diff --git a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php index 55c0583191492..da92a5bd5126d 100644 --- a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php +++ b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php @@ -8,6 +8,7 @@ /** * Product attributes grid * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.DepthOfInheritance) * @deprecated 100.2.0 diff --git a/app/code/Magento/Eav/Model/Attribute/Data/AbstractData.php b/app/code/Magento/Eav/Model/Attribute/Data/AbstractData.php index 3bc87ed977517..da344d18cede5 100644 --- a/app/code/Magento/Eav/Model/Attribute/Data/AbstractData.php +++ b/app/code/Magento/Eav/Model/Attribute/Data/AbstractData.php @@ -13,6 +13,7 @@ /** * EAV Attribute Abstract Data Model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @author Magento Core Team * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Backend/AbstractBackend.php b/app/code/Magento/Eav/Model/Entity/Attribute/Backend/AbstractBackend.php index 86ab6f6ea6e9f..5161afbea66fb 100644 --- a/app/code/Magento/Eav/Model/Entity/Attribute/Backend/AbstractBackend.php +++ b/app/code/Magento/Eav/Model/Entity/Attribute/Backend/AbstractBackend.php @@ -12,6 +12,7 @@ /** * Entity/Attribute/Model - attribute backend abstract * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @since 100.0.2 diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Frontend/AbstractFrontend.php b/app/code/Magento/Eav/Model/Entity/Attribute/Frontend/AbstractFrontend.php index 2c7ea1ab9268e..7f957f5702726 100644 --- a/app/code/Magento/Eav/Model/Entity/Attribute/Frontend/AbstractFrontend.php +++ b/app/code/Magento/Eav/Model/Entity/Attribute/Frontend/AbstractFrontend.php @@ -22,6 +22,7 @@ /** * EAV entity attribute form renderer. * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Eav/Model/Entity/Increment/AbstractIncrement.php b/app/code/Magento/Eav/Model/Entity/Increment/AbstractIncrement.php index 406e23921db4d..71b5d35a887a9 100644 --- a/app/code/Magento/Eav/Model/Entity/Increment/AbstractIncrement.php +++ b/app/code/Magento/Eav/Model/Entity/Increment/AbstractIncrement.php @@ -12,6 +12,7 @@ * - pad_char * - last_id * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php b/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php index 71b65fce93e0c..e81a264fa9f90 100644 --- a/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php +++ b/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php @@ -9,6 +9,7 @@ /** * @SuppressWarnings(PHPMD.LongVariable) + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php b/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php index 135c8c92c6aa9..91a2576a7d781 100644 --- a/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php +++ b/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php @@ -11,6 +11,7 @@ use Magento\Framework\Event\ObserverInterface; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php index 8baf9e8fe9cb9..7683dd6208665 100644 --- a/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Export/AbstractEntity.php @@ -12,6 +12,7 @@ /** * Export entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.TooManyFields) diff --git a/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php b/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php index 8fbc91de5b211..0a7ef760541e3 100644 --- a/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php +++ b/app/code/Magento/ImportExport/Model/Export/Adapter/AbstractAdapter.php @@ -11,6 +11,7 @@ /** * Abstract adapter model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php index df556e961d2ce..eb9fc33a31bf2 100644 --- a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php +++ b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEav.php @@ -14,6 +14,7 @@ /** * Export EAV entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php index d9e3879b4be13..4575624dd6d6f 100644 --- a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php @@ -11,6 +11,7 @@ /** * Export entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.TooManyFields) diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php index 5bd956c1bc322..4784cb782607b 100644 --- a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php @@ -15,6 +15,7 @@ /** * Import entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.TooManyFields) diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractSource.php b/app/code/Magento/ImportExport/Model/Import/AbstractSource.php index 41665a71341c1..d4bf177cfc20d 100644 --- a/app/code/Magento/ImportExport/Model/Import/AbstractSource.php +++ b/app/code/Magento/ImportExport/Model/Import/AbstractSource.php @@ -10,6 +10,7 @@ /** * Data source with columns for Magento_ImportExport * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php index 82c4478874844..67abb9769e00a 100644 --- a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php +++ b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php @@ -10,6 +10,7 @@ /** * Import EAV entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) diff --git a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php index 10b29a50a4064..88fe71b60c1cc 100644 --- a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEntity.php @@ -17,6 +17,7 @@ /** * Import entity abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @SuppressWarnings(PHPMD.TooManyFields) diff --git a/app/code/Magento/ImportExport/Model/Source/Import/AbstractBehavior.php b/app/code/Magento/ImportExport/Model/Source/Import/AbstractBehavior.php index 9f83f10ad4d53..8c139ae70223b 100644 --- a/app/code/Magento/ImportExport/Model/Source/Import/AbstractBehavior.php +++ b/app/code/Magento/ImportExport/Model/Source/Import/AbstractBehavior.php @@ -8,6 +8,7 @@ /** * Source import behavior model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php index 7032c9258cae6..380bffe69d9b1 100644 --- a/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php @@ -11,6 +11,7 @@ /** * Abstract resource model. Can be used as base for indexer resources * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Payment/Block/Info/AbstractContainer.php b/app/code/Magento/Payment/Block/Info/AbstractContainer.php index fa250ef2f360c..c0c2a7c6da805 100644 --- a/app/code/Magento/Payment/Block/Info/AbstractContainer.php +++ b/app/code/Magento/Payment/Block/Info/AbstractContainer.php @@ -8,6 +8,7 @@ /** * Payment information container block * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Payment/Gateway/Validator/AbstractValidator.php b/app/code/Magento/Payment/Gateway/Validator/AbstractValidator.php index 110fe10ee5c3b..97ae5bafc913b 100644 --- a/app/code/Magento/Payment/Gateway/Validator/AbstractValidator.php +++ b/app/code/Magento/Payment/Gateway/Validator/AbstractValidator.php @@ -11,6 +11,7 @@ /** * Represents a basic validator shell that can create a result * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Payment/Model/Method/Specification/AbstractSpecification.php b/app/code/Magento/Payment/Model/Method/Specification/AbstractSpecification.php index b753a68e5ff0d..57640f6fd5f58 100644 --- a/app/code/Magento/Payment/Model/Method/Specification/AbstractSpecification.php +++ b/app/code/Magento/Payment/Model/Method/Specification/AbstractSpecification.php @@ -11,6 +11,7 @@ /** * Abstract specification * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php b/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php index 0ad18a448ed98..82eff4a524e58 100644 --- a/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php +++ b/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php @@ -14,6 +14,7 @@ /** * Class AbstractDataAssignObserver * @package Magento\Payment\Observer + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php index 00dd9ab913c89..3311f16fc1cae 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php +++ b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php @@ -8,6 +8,7 @@ /** * Sales Quote Address Total abstract model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @SuppressWarnings(PHPMD.UnusedFormalParameter) diff --git a/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php b/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php index a6fa6828a04e7..193ccc0d7b3f0 100644 --- a/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php +++ b/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php @@ -18,6 +18,7 @@ * - custom_price - new price that can be declared by user and recalculated during calculation process * - original_custom_price - original defined value of custom price without any conversion * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @method float getDiscountAmount() * @method \Magento\Quote\Model\Quote\Item\AbstractItem setDiscountAmount(float $amount) diff --git a/app/code/Magento/Reports/Controller/Adminhtml/Report/AbstractReport.php b/app/code/Magento/Reports/Controller/Adminhtml/Report/AbstractReport.php index 2fbff13a5b644..057ac9c5a6ae7 100644 --- a/app/code/Magento/Reports/Controller/Adminhtml/Report/AbstractReport.php +++ b/app/code/Magento/Reports/Controller/Adminhtml/Report/AbstractReport.php @@ -18,6 +18,7 @@ /** * Reports api controller * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 * @SuppressWarnings(PHPMD.AllPurposeAction) diff --git a/app/code/Magento/Reports/Model/ResourceModel/Product/Index/AbstractIndex.php b/app/code/Magento/Reports/Model/ResourceModel/Product/Index/AbstractIndex.php index 9158ce5cd850e..1c38c32dd611d 100644 --- a/app/code/Magento/Reports/Model/ResourceModel/Product/Index/AbstractIndex.php +++ b/app/code/Magento/Reports/Model/ResourceModel/Product/Index/AbstractIndex.php @@ -8,6 +8,8 @@ /** * Reports Product Index Abstract Resource Model + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php b/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php index e949589e59eb4..9bda446d50a0f 100644 --- a/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php +++ b/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php @@ -9,6 +9,7 @@ /** * Abstract report aggregate resource model * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Rule/Model/Action/AbstractAction.php b/app/code/Magento/Rule/Model/Action/AbstractAction.php index 4d56f6cc56edc..10ffc051fdd9f 100644 --- a/app/code/Magento/Rule/Model/Action/AbstractAction.php +++ b/app/code/Magento/Rule/Model/Action/AbstractAction.php @@ -11,6 +11,7 @@ /** * Abstract rule action * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php b/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php index e216e2ae658ba..eecc82a303628 100644 --- a/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php +++ b/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php @@ -14,6 +14,7 @@ * * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php index 6e685a9a9b978..9ab156eb6c7f6 100644 --- a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php @@ -9,6 +9,7 @@ /** * Abstract Rule entity resource model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Sales/Model/AbstractModel.php b/app/code/Magento/Sales/Model/AbstractModel.php index 6d8796aaa351f..cd26f6fbe4783 100644 --- a/app/code/Magento/Sales/Model/AbstractModel.php +++ b/app/code/Magento/Sales/Model/AbstractModel.php @@ -12,6 +12,7 @@ * Sales abstract model * Provide date processing functionality * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @since 100.0.2 diff --git a/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php index ddae9f5910c16..1d6d085cb97c4 100644 --- a/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php +++ b/app/code/Magento/Sales/Model/Order/Creditmemo/Total/AbstractTotal.php @@ -7,6 +7,8 @@ /** * Base class for credit memo total + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @author Magento Core Team diff --git a/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php index d7e373afce51d..dfb814f3ff244 100644 --- a/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php +++ b/app/code/Magento/Sales/Model/Order/Invoice/Total/AbstractTotal.php @@ -7,6 +7,8 @@ /** * Base class for invoice total + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @author Magento Core Team * @since 100.0.2 diff --git a/app/code/Magento/Sales/Model/Order/Pdf/Items/AbstractItems.php b/app/code/Magento/Sales/Model/Order/Pdf/Items/AbstractItems.php index 422ff1746c9a6..d2afa67fbbff0 100644 --- a/app/code/Magento/Sales/Model/Order/Pdf/Items/AbstractItems.php +++ b/app/code/Magento/Sales/Model/Order/Pdf/Items/AbstractItems.php @@ -10,6 +10,7 @@ /** * Sales Order Pdf Items renderer Abstract * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @since 100.0.2 diff --git a/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php index 6c5cfb6e3a3a4..98d692aaf41dc 100644 --- a/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php +++ b/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php @@ -7,6 +7,8 @@ /** * Base class for configure totals order + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * * @author Magento Core Team diff --git a/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php b/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php index 25c15449a9fb4..2906d77f0c02c 100644 --- a/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php +++ b/app/code/Magento/Sales/Model/ResourceModel/AbstractGrid.php @@ -10,6 +10,8 @@ /** * Class AbstractGrid + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php index a7cb9866d1f3d..c9502b51316a5 100644 --- a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php +++ b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php @@ -8,6 +8,7 @@ /** * Flat sales abstract collection * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @since 100.0.2 diff --git a/app/code/Magento/Sales/Model/ResourceModel/Order/Comment/Collection/AbstractCollection.php b/app/code/Magento/Sales/Model/ResourceModel/Order/Comment/Collection/AbstractCollection.php index dcd7dbd9e6376..4616b8f9f1582 100644 --- a/app/code/Magento/Sales/Model/ResourceModel/Order/Comment/Collection/AbstractCollection.php +++ b/app/code/Magento/Sales/Model/ResourceModel/Order/Comment/Collection/AbstractCollection.php @@ -8,6 +8,7 @@ /** * Flat sales order abstract comments collection, used as parent for: invoice, shipment, creditmemo * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @author Magento Core Team * @since 100.0.2 diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php index 76555ce8a6d8c..def85761d53a6 100644 --- a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php +++ b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php @@ -12,6 +12,7 @@ /** * Class AbstractCarrier * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php index 27047ae46bf1f..51863ee46137f 100644 --- a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php +++ b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php @@ -15,6 +15,7 @@ /** * Abstract online shipping carrier model * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @since 100.0.2 diff --git a/app/code/Magento/Ui/Component/AbstractComponent.php b/app/code/Magento/Ui/Component/AbstractComponent.php index 772bdceeb4957..88bb8e793995f 100644 --- a/app/code/Magento/Ui/Component/AbstractComponent.php +++ b/app/code/Magento/Ui/Component/AbstractComponent.php @@ -17,6 +17,7 @@ /** * Abstract class AbstractComponent * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @SuppressWarnings(PHPMD.NumberOfChildren) * @since 100.0.2 diff --git a/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php b/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php index f5d3af44f71f4..81868a2c1273f 100644 --- a/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php +++ b/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php @@ -13,6 +13,8 @@ /** * Abstract class AbstractFilter + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php b/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php index fb8db59c90bd7..4b72d1ea97cdf 100644 --- a/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php +++ b/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php @@ -10,6 +10,7 @@ /** * Class AbstractElement * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Ui/Component/Form/Element/DataType/AbstractDataType.php b/app/code/Magento/Ui/Component/Form/Element/DataType/AbstractDataType.php index 3940622e1dabe..c7eb966c19b07 100644 --- a/app/code/Magento/Ui/Component/Form/Element/DataType/AbstractDataType.php +++ b/app/code/Magento/Ui/Component/Form/Element/DataType/AbstractDataType.php @@ -10,6 +10,7 @@ /** * Class AbstractDataType * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php b/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php index e7ca944908e07..7d05d58798f2f 100644 --- a/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php +++ b/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php @@ -12,6 +12,8 @@ /** * Class Render + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php index 578ebe4d441d9..616e27315c657 100644 --- a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php +++ b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php @@ -9,6 +9,7 @@ use Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Vault/Block/AbstractCardRenderer.php b/app/code/Magento/Vault/Block/AbstractCardRenderer.php index fdb3280417540..524a9b3a00b01 100644 --- a/app/code/Magento/Vault/Block/AbstractCardRenderer.php +++ b/app/code/Magento/Vault/Block/AbstractCardRenderer.php @@ -10,6 +10,8 @@ /** * Class AbstractCardRenderer + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.1.0 */ diff --git a/app/code/Magento/Vault/Block/AbstractTokenRenderer.php b/app/code/Magento/Vault/Block/AbstractTokenRenderer.php index 337ea28f480fe..024ee1ec279de 100644 --- a/app/code/Magento/Vault/Block/AbstractTokenRenderer.php +++ b/app/code/Magento/Vault/Block/AbstractTokenRenderer.php @@ -11,6 +11,8 @@ /** * Class AbstractTokenRenderer + * + * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.2.0 */ diff --git a/lib/internal/Magento/Framework/Api/AbstractExtensibleObject.php b/lib/internal/Magento/Framework/Api/AbstractExtensibleObject.php index 97c24167d47e1..07e1236aef19d 100644 --- a/lib/internal/Magento/Framework/Api/AbstractExtensibleObject.php +++ b/lib/internal/Magento/Framework/Api/AbstractExtensibleObject.php @@ -11,6 +11,8 @@ * Base Class for extensible data Objects * * @SuppressWarnings(PHPMD.NumberOfChildren) + * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractExtensibleObject extends AbstractSimpleObject implements CustomAttributesDataInterface diff --git a/lib/internal/Magento/Framework/Backup/AbstractBackup.php b/lib/internal/Magento/Framework/Backup/AbstractBackup.php index 66bcdbf16a54b..174228cc2b70b 100644 --- a/lib/internal/Magento/Framework/Backup/AbstractBackup.php +++ b/lib/internal/Magento/Framework/Backup/AbstractBackup.php @@ -11,6 +11,7 @@ /** * Class to work with archives * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractBackup implements BackupInterface, SourceFileInterface diff --git a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/AbstractRollback.php b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/AbstractRollback.php index 8c8c21a8405b6..e27e5b3647df3 100644 --- a/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/AbstractRollback.php +++ b/lib/internal/Magento/Framework/Backup/Filesystem/Rollback/AbstractRollback.php @@ -10,6 +10,7 @@ /** * Filesystem rollback workers abstract class * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractRollback diff --git a/lib/internal/Magento/Framework/Config/AbstractXml.php b/lib/internal/Magento/Framework/Config/AbstractXml.php index caead98147bf5..a3e8535da52cd 100644 --- a/lib/internal/Magento/Framework/Config/AbstractXml.php +++ b/lib/internal/Magento/Framework/Config/AbstractXml.php @@ -10,6 +10,7 @@ namespace Magento\Framework\Config; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractXml diff --git a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php index ff142c5319006..45ae82df59a87 100644 --- a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php +++ b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php @@ -9,6 +9,7 @@ use Magento\Framework\Phrase; /** + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractAggregateException extends LocalizedException implements AggregateExceptionInterface diff --git a/lib/internal/Magento/Framework/Message/AbstractMessage.php b/lib/internal/Magento/Framework/Message/AbstractMessage.php index 85789bca9047c..2abcc425e04b0 100644 --- a/lib/internal/Magento/Framework/Message/AbstractMessage.php +++ b/lib/internal/Magento/Framework/Message/AbstractMessage.php @@ -8,6 +8,7 @@ /** * Abstract message model * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractMessage implements MessageInterface diff --git a/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php b/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php index 255e6d94d741f..e60ea37082c46 100644 --- a/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php +++ b/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php @@ -13,6 +13,7 @@ /** * Abstract resource model * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractResource diff --git a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php index 8c49385f7e60f..097b3f8c5d89f 100644 --- a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php +++ b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php @@ -15,6 +15,7 @@ * Class AbstractPrice * Should be the base for creating any Price type class * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractPrice implements PriceInterface diff --git a/lib/internal/Magento/Framework/Validator/AbstractValidator.php b/lib/internal/Magento/Framework/Validator/AbstractValidator.php index db636516aacab..f51731dea0b6d 100644 --- a/lib/internal/Magento/Framework/Validator/AbstractValidator.php +++ b/lib/internal/Magento/Framework/Validator/AbstractValidator.php @@ -8,6 +8,7 @@ /** * Abstract validator class. * + * phpcs:disable Magento2.Classes.AbstractApi * @api */ abstract class AbstractValidator implements \Magento\Framework\Validator\ValidatorInterface From 743bfa04252f1f31aaf40f11201a3895bd0142af Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Fri, 22 Nov 2019 21:38:15 -0300 Subject: [PATCH 02/13] Fix > PHP Code Sniffer violation : Missing short description --- .../Message/Media/AbstractSynchronization.php | 2 + .../Magento/Backend/App/AbstractAction.php | 14 +++++ .../Command/AbstractCacheManageCommand.php | 2 + .../Command/AbstractCacheSetCommand.php | 2 + .../AbstractCacheTypeManageCommand.php | 2 + .../Backend/Model/Menu/AbstractDirector.php | 2 + .../Model/Widget/Grid/AbstractTotals.php | 2 + .../Model/Indexer/AbstractFlatState.php | 2 + .../Model/Product/Type/AbstractType.php | 4 ++ .../Product/Indexer/AbstractIndexer.php | 2 + .../Listing/Attribute/AbstractRepository.php | 4 ++ .../Field/FieldArray/AbstractFieldArray.php | 2 + .../System/Config/AbstractScopeConfig.php | 2 + .../Model/Config/Structure/AbstractMapper.php | 2 + .../Model/Currency/Import/AbstractImport.php | 8 +++ .../Adminhtml/Attribute/Grid/AbstractGrid.php | 2 + .../Config/Backend/AbstractConversion.php | 2 + .../GoogleOptimizer/Observer/AbstractSave.php | 6 +++ .../Model/Import/AbstractEntity.php | 6 ++- .../Quote/Address/Total/AbstractTotal.php | 4 ++ .../Rule/Model/Action/AbstractAction.php | 52 +++++++++++++++++++ .../Model/ResourceModel/AbstractResource.php | 2 + .../Ui/Component/AbstractComponent.php | 2 + .../Form/Element/AbstractElement.php | 10 ++++ .../Controller/Adminhtml/AbstractAction.php | 2 + .../Ui/DataProvider/AbstractDataProvider.php | 10 ++++ .../Vault/Block/AbstractCardRenderer.php | 2 + .../Vault/Block/AbstractTokenRenderer.php | 4 ++ .../Magento/Framework/Config/AbstractXml.php | 2 + .../Exception/AbstractAggregateException.php | 4 ++ .../Framework/Pricing/Price/AbstractPrice.php | 6 +++ 31 files changed, 167 insertions(+), 1 deletion(-) diff --git a/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php b/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php index cc07b40bec28c..eb8ec73433ce1 100644 --- a/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php +++ b/app/code/Magento/AdminNotification/Model/System/Message/Media/AbstractSynchronization.php @@ -6,6 +6,8 @@ namespace Magento\AdminNotification\Model\System\Message\Media; /** + * Abstract Synchronization + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Backend/App/AbstractAction.php b/app/code/Magento/Backend/App/AbstractAction.php index 55fad14a67c08..5109cd65882bf 100644 --- a/app/code/Magento/Backend/App/AbstractAction.php +++ b/app/code/Magento/Backend/App/AbstractAction.php @@ -102,6 +102,8 @@ public function __construct(Action\Context $context) } /** + * Check current user permission on resource and privilege + * * @return bool */ protected function _isAllowed() @@ -120,6 +122,8 @@ protected function _getSession() } /** + * Get message manager + * * @return \Magento\Framework\Message\ManagerInterface */ protected function getMessageManager() @@ -147,6 +151,8 @@ protected function _setActiveMenu($itemId) } /** + * Add breadcrumb + * * @param string $label * @param string $title * @param string|null $link @@ -159,6 +165,8 @@ protected function _addBreadcrumb($label, $title, $link = null) } /** + * Add block to content container + * * @param \Magento\Framework\View\Element\AbstractBlock $block * @return $this */ @@ -168,6 +176,8 @@ protected function _addContent(\Magento\Framework\View\Element\AbstractBlock $bl } /** + * Add block to left container + * * @param \Magento\Framework\View\Element\AbstractBlock $block * @return $this */ @@ -177,6 +187,8 @@ protected function _addLeft(\Magento\Framework\View\Element\AbstractBlock $block } /** + * Add block to js container + * * @param \Magento\Framework\View\Element\AbstractBlock $block * @return $this */ @@ -201,6 +213,8 @@ private function _moveBlockToContainer(\Magento\Framework\View\Element\AbstractB } /** + * Dispatch request + * * @param \Magento\Framework\App\RequestInterface $request * @return \Magento\Framework\App\ResponseInterface */ diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php index 4c40cc483c39e..499179a5b8a22 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php @@ -10,6 +10,8 @@ use Symfony\Component\Console\Input\InputInterface; /** + * Abstract Cache Manage Command + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php index 8eaa7e044a7f5..30e49e11e5905 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php @@ -10,6 +10,8 @@ use Symfony\Component\Console\Output\OutputInterface; /** + * Abstract Cache Set Command + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php index 2601804f4d290..d3e3c33af29a1 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheTypeManageCommand.php @@ -12,6 +12,8 @@ use Magento\Framework\App\Cache\Manager; /** + * Abstract Cache Type Manage Command + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Backend/Model/Menu/AbstractDirector.php b/app/code/Magento/Backend/Model/Menu/AbstractDirector.php index 669642e09109c..1616ba1fd9bb2 100644 --- a/app/code/Magento/Backend/Model/Menu/AbstractDirector.php +++ b/app/code/Magento/Backend/Model/Menu/AbstractDirector.php @@ -6,6 +6,8 @@ namespace Magento\Backend\Model\Menu; /** + * Abstract Director + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php index a13c107a9dc45..c5e2931d64f83 100644 --- a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php +++ b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php @@ -7,6 +7,8 @@ namespace Magento\Backend\Model\Widget\Grid; /** + * Abstract Totals + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php b/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php index 1221f248bcba9..79ce5a314c9af 100644 --- a/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php +++ b/app/code/Magento/Catalog/Model/Indexer/AbstractFlatState.php @@ -8,6 +8,8 @@ use Magento\Store\Model\ScopeInterface; /** + * Abstract Flat State + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php index d676e675425a3..dc009a923f2c4 100644 --- a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php +++ b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php @@ -11,6 +11,8 @@ use Magento\Framework\Exception\LocalizedException; /** + * Abstract Type + * * phpcs:disable Magento2.Classes.AbstractApi * @api * Abstract model for product type implementation @@ -1093,6 +1095,8 @@ public function getIdentities(\Magento\Catalog\Model\Product $product) } /** + * Get associated products + * * @param \Magento\Catalog\Model\Product\Type\AbstractType $product * @return array * @SuppressWarnings(PHPMD.UnusedFormalParameter) diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php index c68d3a4f3d0cb..bf2e823f90158 100644 --- a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php +++ b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php @@ -235,6 +235,8 @@ public function getRelationsByParent($parentIds) } /** + * Get metadata pool + * * @return \Magento\Framework\EntityManager\MetadataPool * @since 101.0.0 */ diff --git a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php index 02895e029593e..6dedfa5254052 100644 --- a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php +++ b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php @@ -6,6 +6,8 @@ namespace Magento\Catalog\Ui\Component\Listing\Attribute; /** + * Abstract Repository + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 @@ -40,6 +42,8 @@ public function __construct( abstract protected function buildSearchCriteria(); /** + * Get attributes list + * * @return \Magento\Catalog\Api\Data\ProductAttributeInterface[] */ public function getList() diff --git a/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php b/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php index 20abd3aa8dc36..a702ee855b0ce 100644 --- a/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php +++ b/app/code/Magento/Config/Block/System/Config/Form/Field/FieldArray/AbstractFieldArray.php @@ -283,6 +283,8 @@ public function getColumns() } /** + * Get label of add button + * * @return string * @since 100.2.0 */ diff --git a/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php b/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php index eba0494089064..ff9f9b25753e5 100644 --- a/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php +++ b/app/code/Magento/Config/Controller/Adminhtml/System/Config/AbstractScopeConfig.php @@ -9,6 +9,8 @@ use Magento\Config\Controller\Adminhtml\System\ConfigSectionChecker; /** + * Abstract Scope Config + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php b/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php index 2bb013f8104f6..76ee414ac6024 100644 --- a/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php +++ b/app/code/Magento/Config/Model/Config/Structure/AbstractMapper.php @@ -10,6 +10,8 @@ namespace Magento\Config\Model\Config\Structure; /** + * Abstract Mapper + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 diff --git a/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php b/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php index 17aeaacf56bcb..5a76529ee19fb 100644 --- a/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php +++ b/app/code/Magento/Directory/Model/Currency/Import/AbstractImport.php @@ -10,6 +10,8 @@ namespace Magento\Directory\Model\Currency\Import; /** + * Abstract Import + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 @@ -92,6 +94,8 @@ public function importRates() } /** + * Fetch rates + * * @return array */ public function fetchRates() @@ -122,6 +126,8 @@ public function fetchRates() } /** + * Number format + * * @param float|int $number * @return float|int */ @@ -131,6 +137,8 @@ protected function _numberFormat($number) } /** + * Get messages + * * @return array */ public function getMessages() diff --git a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php index da92a5bd5126d..87166d4af15ab 100644 --- a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php +++ b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Grid/AbstractGrid.php @@ -24,6 +24,8 @@ abstract class AbstractGrid extends \Magento\Backend\Block\Widget\Grid\Extended protected $_module = 'adminhtml'; /** + * Internal constructor, that is called from real constructor + * * @return void */ protected function _construct() diff --git a/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php b/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php index e81a264fa9f90..64067cfa3ca0f 100644 --- a/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php +++ b/app/code/Magento/GoogleAdwords/Model/Config/Backend/AbstractConversion.php @@ -8,6 +8,8 @@ namespace Magento\GoogleAdwords\Model\Config\Backend; /** + * Abstract Conversion + * * @SuppressWarnings(PHPMD.LongVariable) * phpcs:disable Magento2.Classes.AbstractApi * @api diff --git a/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php b/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php index 91a2576a7d781..fa03fbcb588e3 100644 --- a/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php +++ b/app/code/Magento/GoogleOptimizer/Observer/AbstractSave.php @@ -11,6 +11,8 @@ use Magento\Framework\Event\ObserverInterface; /** + * Abstract Save + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 @@ -186,6 +188,8 @@ protected function _deleteCode() } /** + * Is request data available + * * @return bool */ private function isDataAvailable() @@ -195,6 +199,8 @@ private function isDataAvailable() } /** + * Request parameter google_experiment + * * @return mixed */ private function getRequestData() diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php index 4784cb782607b..e2e0ec12bcfde 100644 --- a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php @@ -336,6 +336,8 @@ public function __construct( } /** + * Get error aggregator + * * @return ProcessingErrorAggregatorInterface */ public function getErrorAggregator() @@ -653,7 +655,9 @@ public function isAttributeParticular($attributeCode) } /** - * @return string the master attribute code to use in an import + * Get the master attribute code to use in an import + * + * @return string */ public function getMasterAttributeCode() { diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php index 3311f16fc1cae..a8b1df1acd593 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php +++ b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php @@ -149,6 +149,8 @@ protected function _getAddress() protected $total; /** + * Set total + * * @param \Magento\Quote\Model\Quote\Address\Total $total * @return $this */ @@ -159,6 +161,8 @@ public function _setTotal(\Magento\Quote\Model\Quote\Address\Total $total) } /** + * Get total + * * @return \Magento\Quote\Model\Quote\Address\Total */ protected function _getTotal() diff --git a/app/code/Magento/Rule/Model/Action/AbstractAction.php b/app/code/Magento/Rule/Model/Action/AbstractAction.php index 10ffc051fdd9f..b0273f3a5d46d 100644 --- a/app/code/Magento/Rule/Model/Action/AbstractAction.php +++ b/app/code/Magento/Rule/Model/Action/AbstractAction.php @@ -64,6 +64,8 @@ public function __construct( } /** + * Get form + * * @return Form */ public function getForm() @@ -72,6 +74,8 @@ public function getForm() } /** + * Array + * * @param array $arrAttributes * @return array * @SuppressWarnings(PHPMD.UnusedFormalParameter) @@ -88,6 +92,8 @@ public function asArray(array $arrAttributes = []) } /** + * Xml + * * @return string */ public function asXml() @@ -108,6 +114,8 @@ public function asXml() } /** + * Load array + * * @param array $arr * @return $this */ @@ -128,6 +136,8 @@ public function loadArray(array $arr) } /** + * Load attribute options + * * @return $this */ public function loadAttributeOptions() @@ -137,6 +147,8 @@ public function loadAttributeOptions() } /** + * Get attribute select options + * * @return array */ public function getAttributeSelectOptions() @@ -149,6 +161,8 @@ public function getAttributeSelectOptions() } /** + * Get Attribute name + * * @return string */ public function getAttributeName() @@ -157,6 +171,8 @@ public function getAttributeName() } /** + * Load operator options + * * @return $this */ public function loadOperatorOptions() @@ -166,6 +182,8 @@ public function loadOperatorOptions() } /** + * Get operator select options + * * @return array */ public function getOperatorSelectOptions() @@ -178,6 +196,8 @@ public function getOperatorSelectOptions() } /** + * Get operator name + * * @return string */ public function getOperatorName() @@ -186,6 +206,8 @@ public function getOperatorName() } /** + * Load value options + * * @return $this */ public function loadValueOptions() @@ -195,6 +217,8 @@ public function loadValueOptions() } /** + * Get value select options + * * @return array */ public function getValueSelectOptions() @@ -207,6 +231,8 @@ public function getValueSelectOptions() } /** + * Get value name + * * @return string */ public function getValueName() @@ -216,6 +242,8 @@ public function getValueName() } /** + * Get new child select options + * * @return array */ public function getNewChildSelectOptions() @@ -224,6 +252,8 @@ public function getNewChildSelectOptions() } /** + * Get new child name + * * @return string */ public function getNewChildName() @@ -232,6 +262,8 @@ public function getNewChildName() } /** + * Html + * * @return string */ public function asHtml() @@ -240,6 +272,8 @@ public function asHtml() } /** + * Html recursive + * * @return string */ public function asHtmlRecursive() @@ -249,6 +283,8 @@ public function asHtmlRecursive() } /** + * Get type element + * * @return AbstractElement */ public function getTypeElement() @@ -265,6 +301,8 @@ public function getTypeElement() } /** + * Get attribute element + * * @return $this */ public function getAttributeElement() @@ -284,6 +322,8 @@ public function getAttributeElement() } /** + * Get operator element + * * @return $this */ public function getOperatorElement() @@ -303,6 +343,8 @@ public function getOperatorElement() } /** + * Get value element + * * @return $this */ public function getValueElement() @@ -321,6 +363,8 @@ public function getValueElement() } /** + * Get add link html + * * @return string */ public function getAddLinkHtml() @@ -331,6 +375,8 @@ public function getAddLinkHtml() } /** + * Get remove link html + * * @return string */ public function getRemoveLinkHtml() @@ -343,6 +389,8 @@ public function getRemoveLinkHtml() } /** + * String + * * @param string $format * @return string * @SuppressWarnings(PHPMD.UnusedFormalParameter) @@ -353,6 +401,8 @@ public function asString($format = '') } /** + * String recursive + * * @param int $level * @return string */ @@ -363,6 +413,8 @@ public function asStringRecursive($level = 0) } /** + * Process + * * @return $this */ public function process() diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php index 9ab156eb6c7f6..7583dc40a7773 100644 --- a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php @@ -52,6 +52,8 @@ public function _beforeSave(\Magento\Framework\Model\AbstractModel $object) } /** + * Resolve date + * * @param \Magento\Framework\Model\AbstractModel $object * @param string $dateIdentifier * @return void diff --git a/app/code/Magento/Ui/Component/AbstractComponent.php b/app/code/Magento/Ui/Component/AbstractComponent.php index 88bb8e793995f..1a687a3b7839e 100644 --- a/app/code/Magento/Ui/Component/AbstractComponent.php +++ b/app/code/Magento/Ui/Component/AbstractComponent.php @@ -174,6 +174,8 @@ public function addComponent($name, UiComponentInterface $component) } /** + * Get component + * * @param string $name * @return UiComponentInterface */ diff --git a/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php b/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php index 4b72d1ea97cdf..104cd4c80eac3 100644 --- a/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php +++ b/app/code/Magento/Ui/Component/Form/Element/AbstractElement.php @@ -17,6 +17,8 @@ abstract class AbstractElement extends AbstractComponent implements ElementInterface { /** + * Get html id + * * @return string */ public function getHtmlId() @@ -25,6 +27,8 @@ public function getHtmlId() } /** + * Get value + * * @return string|int */ public function getValue() @@ -33,6 +37,8 @@ public function getValue() } /** + * Get form input name + * * @return string */ public function getFormInputName() @@ -41,6 +47,8 @@ public function getFormInputName() } /** + * Is read only + * * @return bool */ public function isReadonly() @@ -49,6 +57,8 @@ public function isReadonly() } /** + * Get css classes + * * @return string */ public function getCssClasses() diff --git a/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php b/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php index 7d05d58798f2f..39d2a6eec6484 100644 --- a/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php +++ b/app/code/Magento/Ui/Controller/Adminhtml/AbstractAction.php @@ -65,6 +65,8 @@ public function executeAjaxRequest() } /** + * Check current user permission on resource and privilege + * * @return bool */ protected function _isAllowed() diff --git a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php index 616e27315c657..d449752ee9cc0 100644 --- a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php +++ b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php @@ -9,6 +9,8 @@ use Magento\Framework\View\Element\UiComponent\DataProvider\DataProviderInterface; /** + * Abstract Data Provider + * * phpcs:disable Magento2.Classes.AbstractApi * @api * @since 100.0.2 @@ -75,6 +77,8 @@ public function __construct( } /** + * Get collection + * * @return AbstractCollection */ public function getCollection() @@ -113,6 +117,8 @@ public function getRequestFieldName() } /** + * Get meta + * * @return array */ public function getMeta() @@ -132,6 +138,8 @@ public function getFieldSetMetaInfo($fieldSetName) } /** + * Get fields meta info + * * @param string $fieldSetName * @return array */ @@ -141,6 +149,8 @@ public function getFieldsMetaInfo($fieldSetName) } /** + * Get field meta info + * * @param string $fieldSetName * @param string $fieldName * @return array diff --git a/app/code/Magento/Vault/Block/AbstractCardRenderer.php b/app/code/Magento/Vault/Block/AbstractCardRenderer.php index 524a9b3a00b01..cccf67b7774c6 100644 --- a/app/code/Magento/Vault/Block/AbstractCardRenderer.php +++ b/app/code/Magento/Vault/Block/AbstractCardRenderer.php @@ -39,6 +39,8 @@ public function __construct( } /** + * Get icon for type + * * @param string $type * @return array * @since 100.1.0 diff --git a/app/code/Magento/Vault/Block/AbstractTokenRenderer.php b/app/code/Magento/Vault/Block/AbstractTokenRenderer.php index 024ee1ec279de..a8d86256a744b 100644 --- a/app/code/Magento/Vault/Block/AbstractTokenRenderer.php +++ b/app/code/Magento/Vault/Block/AbstractTokenRenderer.php @@ -43,6 +43,8 @@ public function render(PaymentTokenInterface $token) } /** + * Get token + * * @return PaymentTokenInterface|null * @since 100.2.0 */ @@ -52,6 +54,8 @@ public function getToken() } /** + * Get token details + * * @return array|null * @since 100.2.0 */ diff --git a/lib/internal/Magento/Framework/Config/AbstractXml.php b/lib/internal/Magento/Framework/Config/AbstractXml.php index a3e8535da52cd..a36bafd2bf71e 100644 --- a/lib/internal/Magento/Framework/Config/AbstractXml.php +++ b/lib/internal/Magento/Framework/Config/AbstractXml.php @@ -10,6 +10,8 @@ namespace Magento\Framework\Config; /** + * Abstract Xml + * * phpcs:disable Magento2.Classes.AbstractApi * @api */ diff --git a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php index 45ae82df59a87..16ae6bc7647a5 100644 --- a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php +++ b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php @@ -9,6 +9,8 @@ use Magento\Framework\Phrase; /** + * Abstract Aggregate Exception + * * phpcs:disable Magento2.Classes.AbstractApi * @api */ @@ -80,6 +82,8 @@ public function addError(Phrase $phrase) } /** + * Add exception + * * @param LocalizedException $exception * @return $this */ diff --git a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php index 097b3f8c5d89f..c9555bdde2938 100644 --- a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php +++ b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php @@ -105,6 +105,8 @@ public function getAmount() } /** + * Get custom amount + * * @param float $amount * @param null|bool|string|array $exclude * @param null|array $context @@ -131,6 +133,8 @@ public function getPriceCode() } /** + * Get product + * * @return SaleableInterface */ public function getProduct() @@ -139,6 +143,8 @@ public function getProduct() } /** + * Get quantity + * * @return float */ public function getQuantity() From 524f108a2ca47d6d4132645bb78212a6952312c5 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Fri, 22 Nov 2019 22:58:17 -0300 Subject: [PATCH 03/13] =?UTF-8?q?Fix=20>=20PHP=20Code=20Sniffer=20violatio?= =?UTF-8?q?n=20:=20If=20the=20@inheritdoc=20not=20inline=20it=20shouldn?= =?UTF-8?q?=E2=80=99t=20have=20braces?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Backend/Console/Command/AbstractCacheManageCommand.php | 2 +- .../Backend/Console/Command/AbstractCacheSetCommand.php | 2 +- .../Ui/Component/Listing/Attribute/AbstractRepository.php | 2 +- .../Ui/DataProvider/Product/Related/AbstractDataProvider.php | 2 +- app/code/Magento/Checkout/CustomerData/AbstractItem.php | 2 +- .../Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php | 3 ++- app/code/Magento/Ui/Component/AbstractComponent.php | 2 +- app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php | 2 +- 8 files changed, 9 insertions(+), 8 deletions(-) diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php index 499179a5b8a22..2e69b04c4001e 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheManageCommand.php @@ -24,7 +24,7 @@ abstract class AbstractCacheManageCommand extends AbstractCacheCommand const INPUT_KEY_TYPES = 'types'; /** - * {@inheritdoc} + * @inheritdoc */ protected function configure() { diff --git a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php index 30e49e11e5905..91175fef34399 100644 --- a/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php +++ b/app/code/Magento/Backend/Console/Command/AbstractCacheSetCommand.php @@ -26,7 +26,7 @@ abstract class AbstractCacheSetCommand extends AbstractCacheManageCommand abstract protected function isEnable(); /** - * {@inheritdoc} + * @inheritdoc */ protected function execute(InputInterface $input, OutputInterface $output) { diff --git a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php index 6dedfa5254052..ebd2288de117c 100644 --- a/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php +++ b/app/code/Magento/Catalog/Ui/Component/Listing/Attribute/AbstractRepository.php @@ -37,7 +37,7 @@ public function __construct( } /** - * {@inheritdoc} + * @inheritdoc */ abstract protected function buildSearchCriteria(); diff --git a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php index b243e855b36a0..cba74d5478809 100644 --- a/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php +++ b/app/code/Magento/Catalog/Ui/DataProvider/Product/Related/AbstractDataProvider.php @@ -114,7 +114,7 @@ public function __construct( abstract protected function getLinkType(); /** - * {@inheritdoc} + * @inheritdoc * @since 101.0.0 */ public function getCollection() diff --git a/app/code/Magento/Checkout/CustomerData/AbstractItem.php b/app/code/Magento/Checkout/CustomerData/AbstractItem.php index 41715c7982ee3..f43da887e70b0 100644 --- a/app/code/Magento/Checkout/CustomerData/AbstractItem.php +++ b/app/code/Magento/Checkout/CustomerData/AbstractItem.php @@ -22,7 +22,7 @@ abstract class AbstractItem implements ItemInterface protected $item; /** - * {@inheritdoc} + * @inheritdoc */ public function getItemData(Item $item) { diff --git a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php index 412228d2eb452..e902117798764 100644 --- a/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php +++ b/app/code/Magento/Eav/Block/Adminhtml/Attribute/Edit/Options/AbstractOptions.php @@ -28,7 +28,8 @@ protected function _prepareLayout() } /** - * {@inheritdoc} + * @inheritdoc + * * @return string */ protected function _toHtml() diff --git a/app/code/Magento/Ui/Component/AbstractComponent.php b/app/code/Magento/Ui/Component/AbstractComponent.php index 1a687a3b7839e..fc8345b153f3d 100644 --- a/app/code/Magento/Ui/Component/AbstractComponent.php +++ b/app/code/Magento/Ui/Component/AbstractComponent.php @@ -281,7 +281,7 @@ public function prepareDataSource(array $dataSource) } /** - * {@inheritdoc} + * @inheritdoc */ public function getDataSourceData() { diff --git a/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php b/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php index 81868a2c1273f..f776e1de6a826 100644 --- a/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php +++ b/app/code/Magento/Ui/Component/Filters/Type/AbstractFilter.php @@ -86,7 +86,7 @@ public function getComponentName() } /** - * {@inheritdoc} + * @inheritdoc */ public function prepare() { From 0f20067b8b6afee8a367f5b2ac062593c19dc7cc Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Fri, 22 Nov 2019 23:03:11 -0300 Subject: [PATCH 04/13] Fix > PHP Code Sniffer violation : Short description should not be in multi lines --- app/code/Magento/Backend/App/AbstractAction.php | 3 +-- app/code/Magento/Catalog/Model/Product/Type/AbstractType.php | 3 +-- .../Magento/Indexer/Model/ResourceModel/AbstractResource.php | 3 +-- app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php | 3 +-- lib/internal/Magento/Framework/Backup/AbstractBackup.php | 1 + 5 files changed, 5 insertions(+), 8 deletions(-) diff --git a/app/code/Magento/Backend/App/AbstractAction.php b/app/code/Magento/Backend/App/AbstractAction.php index 5109cd65882bf..835320e337135 100644 --- a/app/code/Magento/Backend/App/AbstractAction.php +++ b/app/code/Magento/Backend/App/AbstractAction.php @@ -301,8 +301,7 @@ public function _processUrlKeys() } /** - * Set session locale, - * process force locale set through url params + * Set session locale, process force locale set through url params * * @return $this */ diff --git a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php index dc009a923f2c4..852123bc1a6bf 100644 --- a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php +++ b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php @@ -646,8 +646,7 @@ public function checkProductBuyState($product) } /** - * Prepare additional options/information for order item which will be - * created from this product + * Prepare additional options/information for order item which will be created from this product * * @param \Magento\Catalog\Model\Product $product * @return array diff --git a/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php index 380bffe69d9b1..67e95c6838601 100644 --- a/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Indexer/Model/ResourceModel/AbstractResource.php @@ -121,8 +121,7 @@ public function insertFromTable($sourceTable, $destTable, $readToIndex = true) } /** - * Insert data from select statement of read adapter to - * destination table related with index adapter + * Insert data from select statement of read adapter to destination table related with index adapter * * @param Select $select * @param string $destTable diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php index 7583dc40a7773..842e1042b267e 100644 --- a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php @@ -231,8 +231,7 @@ public function getCustomerGroupIds($ruleId) } /** - * Retrieve correspondent entity information (associations table name, columns names) - * of rule's associated entity by specified entity type + * Retrieve correspondent entity information of rule's associated entity by specified entity type * * @param string $entityType * @return array diff --git a/lib/internal/Magento/Framework/Backup/AbstractBackup.php b/lib/internal/Magento/Framework/Backup/AbstractBackup.php index 174228cc2b70b..faaaffa6271ad 100644 --- a/lib/internal/Magento/Framework/Backup/AbstractBackup.php +++ b/lib/internal/Magento/Framework/Backup/AbstractBackup.php @@ -166,6 +166,7 @@ public function setRootDir($rootDir) /** * Get Magento's root directory + * * @return string */ public function getRootDir() From ebd15ffaca2d511f3d9c09bf5be7961e59871c94 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sat, 23 Nov 2019 19:24:38 -0300 Subject: [PATCH 05/13] Fix > PHP Code Sniffer violation : Tags visual alignment must be consistent --- app/code/Magento/Backend/App/AbstractAction.php | 4 ++-- .../Widget/Grid/Column/Renderer/AbstractRenderer.php | 2 +- app/code/Magento/Catalog/Model/AbstractModel.php | 8 ++++---- .../Catalog/Model/Layer/Filter/AbstractFilter.php | 4 ++-- .../Product/Indexer/AbstractIndexer.php | 12 ++++++------ .../Model/Quote/Address/Total/AbstractTotal.php | 10 +++++----- .../Magento/Quote/Model/Quote/Item/AbstractItem.php | 2 +- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/app/code/Magento/Backend/App/AbstractAction.php b/app/code/Magento/Backend/App/AbstractAction.php index 835320e337135..169d16a00e2b1 100644 --- a/app/code/Magento/Backend/App/AbstractAction.php +++ b/app/code/Magento/Backend/App/AbstractAction.php @@ -323,8 +323,8 @@ protected function _processLocaleSettings() * Set redirect into response * * @TODO MAGETWO-28356: Refactor controller actions to new ResultInterface - * @param string $path - * @param array $arguments + * @param string $path + * @param array $arguments * @return \Magento\Framework\App\ResponseInterface */ protected function _redirect($path, $arguments = []) diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php index a6f0105470141..ae52e11740e66 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Renderer/AbstractRenderer.php @@ -55,7 +55,7 @@ public function getColumn() * Renders grid column * * @param DataObject $row - * @return string + * @return string */ public function render(DataObject $row) { diff --git a/app/code/Magento/Catalog/Model/AbstractModel.php b/app/code/Magento/Catalog/Model/AbstractModel.php index 6d77a319e51cb..a894fb04d28e4 100644 --- a/app/code/Magento/Catalog/Model/AbstractModel.php +++ b/app/code/Magento/Catalog/Model/AbstractModel.php @@ -315,8 +315,8 @@ private function getAttributeScopeOverriddenValue() /** * Retrieve default value for attribute code * - * @param string $attributeCode - * @return array|boolean + * @param string $attributeCode + * @return array|boolean * * @deprecated 101.0.0 */ @@ -350,8 +350,8 @@ public function setExistsStoreValueFlag($attributeCode) /** * Check if object attribute has value in current store * - * @param string $attributeCode - * @return bool + * @param string $attributeCode + * @return bool * @SuppressWarnings(PHPMD.BooleanGetMethodName) * * @deprecated 101.0.0 diff --git a/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php b/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php index ee609b3fa785e..c0626a36f037a 100644 --- a/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php +++ b/app/code/Magento/Catalog/Model/Layer/Filter/AbstractFilter.php @@ -363,9 +363,9 @@ public function getClearLinkText() /** * Get option text from frontend model by option id * - * @param int $optionId + * @param int $optionId * @throws \Magento\Framework\Exception\LocalizedException - * @return string|bool + * @return string|bool */ protected function getOptionText($optionId) { diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php index bf2e823f90158..27fe3b65f686b 100644 --- a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php +++ b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php @@ -66,12 +66,12 @@ protected function _getAttribute($attributeCode) * If $condition is not empty apply limitation for select * * @param \Magento\Framework\DB\Select $select - * @param string $attrCode the attribute code - * @param string|\Zend_Db_Expr $entity the entity field or expression for condition - * @param string|\Zend_Db_Expr $store the store field or expression for condition - * @param \Zend_Db_Expr $condition the limitation condition - * @param bool $required if required or has condition used INNER join, else - LEFT - * @return \Zend_Db_Expr the attribute value expression + * @param string $attrCode the attribute code + * @param string|\Zend_Db_Expr $entity the entity field or expression for condition + * @param string|\Zend_Db_Expr $store the store field or expression for condition + * @param \Zend_Db_Expr $condition the limitation condition + * @param bool $required if required or has condition used INNER join, else - LEFT + * @return \Zend_Db_Expr the attribute value expression */ protected function _addAttributeToSelect($select, $attrCode, $entity, $store, $condition = null, $required = false) { diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php index a8b1df1acd593..ff67855d0f614 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php +++ b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php @@ -120,7 +120,7 @@ public function fetch(\Magento\Quote\Model\Quote $quote, \Magento\Quote\Model\Qu /** * Set address which can be used inside totals calculation * - * @param \Magento\Quote\Model\Quote\Address $address + * @param \Magento\Quote\Model\Quote\Address $address * @return $this */ protected function _setAddress(\Magento\Quote\Model\Quote\Address $address) @@ -132,8 +132,8 @@ protected function _setAddress(\Magento\Quote\Model\Quote\Address $address) /** * Get quote address object * - * @return \Magento\Quote\Model\Quote\Address - * @throws \Magento\Framework\Exception\LocalizedException if address not declared + * @return \Magento\Quote\Model\Quote\Address + * @throws \Magento\Framework\Exception\LocalizedException if address not declared */ protected function _getAddress() { @@ -173,7 +173,7 @@ protected function _getTotal() /** * Set total model amount value to address * - * @param float $amount + * @param float $amount * @return $this */ protected function _setAmount($amount) @@ -202,7 +202,7 @@ protected function _setBaseAmount($baseAmount) /** * Add total model amount value to address * - * @param float $amount + * @param float $amount * @return $this */ protected function _addAmount($amount) diff --git a/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php b/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php index 193ccc0d7b3f0..5358175afe07f 100644 --- a/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php +++ b/app/code/Magento/Quote/Model/Quote/Item/AbstractItem.php @@ -256,7 +256,7 @@ public function setMessage($messages) /** * Add message of quote item to array of messages * - * @param string $message + * @param string $message * @return $this */ public function addMessage($message) From c244b80e32d51ec70589061f7bd97d6b19982b98 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:31:37 -0300 Subject: [PATCH 06/13] Fix > PHP Code Sniffer violation : There must be exactly one blank line between lines --- .../Magento/Catalog/Model/Product/Type/AbstractType.php | 6 ++++++ .../Model/ResourceModel/Product/Indexer/AbstractIndexer.php | 1 + .../Magento/Payment/Observer/AbstractDataAssignObserver.php | 1 + .../Quote/Model/Quote/Address/Total/AbstractTotal.php | 1 + app/code/Magento/Sales/Model/AbstractModel.php | 1 + app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php | 1 + .../Model/ResourceModel/Collection/AbstractCollection.php | 6 ++++++ .../Magento/Framework/Pricing/Price/AbstractPrice.php | 1 + 8 files changed, 18 insertions(+) diff --git a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php index 852123bc1a6bf..d563eed589b8a 100644 --- a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php +++ b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php @@ -358,6 +358,7 @@ public function isSalable($product) /** * Prepare product and its configuration to be added to some products list. + * * Perform standard preparation process and then prepare options belonging to specific product type. * * @param \Magento\Framework\DataObject $buyRequest @@ -443,6 +444,7 @@ public function processConfiguration( /** * Initialize product(s) for add to cart process. + * * Advanced version of func to prepare product for cart - processMode can be specified there. * * @param \Magento\Framework\DataObject $buyRequest @@ -535,6 +537,7 @@ public function processFileQueue() /** * Add file to File Queue + * * @param array $queueOptions Array of File Queue * (eg. ['operation'=>'move', * 'src_name'=>'filename', @@ -942,6 +945,7 @@ public function prepareQuoteItemQty($qty, $product) /** * Implementation of product specify logic of which product needs to be assigned to option. + * * For example if product which was added to option already removed from catalog. * * @param \Magento\Catalog\Model\Product $optionProduct @@ -981,6 +985,7 @@ public function setConfig($config) /** * Retrieve additional searchable data from type instance + * * Using based on product id and store_id data * * @param \Magento\Catalog\Model\Product $product @@ -1001,6 +1006,7 @@ public function getSearchableData($product) /** * Retrieve products divided into groups required to purchase + * * At least one product in each group has to be purchased * * @param \Magento\Catalog\Model\Product $product diff --git a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php index 27fe3b65f686b..95f3f2b0f8d94 100644 --- a/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php +++ b/app/code/Magento/Catalog/Model/ResourceModel/Product/Indexer/AbstractIndexer.php @@ -159,6 +159,7 @@ protected function _addWebsiteJoinToSelect($select, $store = true, $joinConditio /** * Add join for catalog/product_website table + * * Joined table has alias pw * * @param \Magento\Framework\DB\Select $select the select object diff --git a/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php b/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php index 82eff4a524e58..2d84df929da1c 100644 --- a/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php +++ b/app/code/Magento/Payment/Observer/AbstractDataAssignObserver.php @@ -13,6 +13,7 @@ /** * Class AbstractDataAssignObserver + * * @package Magento\Payment\Observer * phpcs:disable Magento2.Classes.AbstractApi * @api diff --git a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php index ff67855d0f614..d345f6edf87d0 100644 --- a/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php +++ b/app/code/Magento/Quote/Model/Quote/Address/Total/AbstractTotal.php @@ -283,6 +283,7 @@ public function getIsItemRowTotalCompoundable(\Magento\Quote\Model\Quote\Item\Ab /** * Process model configuration array. + * * This method can be used for changing models apply sort order * * @param array $config diff --git a/app/code/Magento/Sales/Model/AbstractModel.php b/app/code/Magento/Sales/Model/AbstractModel.php index cd26f6fbe4783..9e22832537999 100644 --- a/app/code/Magento/Sales/Model/AbstractModel.php +++ b/app/code/Magento/Sales/Model/AbstractModel.php @@ -10,6 +10,7 @@ /** * Sales abstract model + * * Provide date processing functionality * * phpcs:disable Magento2.Classes.AbstractApi diff --git a/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php b/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php index 98d692aaf41dc..27f9c0d9456cb 100644 --- a/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php +++ b/app/code/Magento/Sales/Model/Order/Total/AbstractTotal.php @@ -18,6 +18,7 @@ abstract class AbstractTotal extends \Magento\Framework\DataObject { /** * Process model configuration array. + * * This method can be used for changing models apply sort order * * @param array $config diff --git a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php index c9502b51316a5..63b8382eda450 100644 --- a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php +++ b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php @@ -73,6 +73,7 @@ protected function _attributeToField($attribute) /** * Add attribute to select result set. + * * Backward compatibility with EAV collection * * @param string $attribute @@ -86,6 +87,7 @@ public function addAttributeToSelect($attribute) /** * Specify collection select filter by attribute value + * * Backward compatibility with EAV collection * * @param string|\Magento\Eav\Model\Entity\Attribute $attribute @@ -100,6 +102,7 @@ public function addAttributeToFilter($attribute, $condition = null) /** * Specify collection select order by attribute value + * * Backward compatibility with EAV collection * * @param string $attribute @@ -114,6 +117,7 @@ public function addAttributeToSort($attribute, $dir = 'asc') /** * Set collection page start and records to show + * * Backward compatibility with EAV collection * * @param int $pageNum @@ -128,6 +132,7 @@ public function setPage($pageNum, $pageSize) /** * Create all ids retrieving select with limitation + * * Backward compatibility with EAV collection * * @param int $limit @@ -148,6 +153,7 @@ protected function _getAllIdsSelect($limit = null, $offset = null) /** * Retrieve all ids for collection + * * Backward compatibility with EAV collection * * @param int $limit diff --git a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php index c9555bdde2938..6a4e562228200 100644 --- a/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php +++ b/lib/internal/Magento/Framework/Pricing/Price/AbstractPrice.php @@ -13,6 +13,7 @@ /** * Class AbstractPrice + * * Should be the base for creating any Price type class * * phpcs:disable Magento2.Classes.AbstractApi From afc75605d22046c9666dc51e56e8e61e75206b3b Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sat, 23 Nov 2019 20:36:11 -0300 Subject: [PATCH 07/13] Fix > PHP Code Sniffer violation : Short description must start with a capital letter --- .../Sales/Model/ResourceModel/Collection/AbstractCollection.php | 2 +- app/code/Magento/Ui/DataProvider/AbstractDataProvider.php | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php index 63b8382eda450..7cb650e25ce6b 100644 --- a/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php +++ b/app/code/Magento/Sales/Model/ResourceModel/Collection/AbstractCollection.php @@ -38,7 +38,7 @@ public function setSelectCountSql(\Magento\Framework\DB\Select $countSelect) } /** - * get select count sql + * Get select count sql * * @return \Magento\Framework\DB\Select */ diff --git a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php index d449752ee9cc0..dbf4a7bf05776 100644 --- a/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php +++ b/app/code/Magento/Ui/DataProvider/AbstractDataProvider.php @@ -208,7 +208,7 @@ public function addField($field, $alias = null) } /** - * self::setOrder() alias + * Self::setOrder() alias * * @param string $field * @param string $direction From ebc100bb4c556b4af128310db9dfc4da02886903 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sat, 23 Nov 2019 20:39:43 -0300 Subject: [PATCH 08/13] Fix > PHP Code Sniffer violation : There must be exactly one blank line before tags --- .../Magento/ImportExport/Model/Export/Entity/AbstractEntity.php | 1 + 1 file changed, 1 insertion(+) diff --git a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php index 4575624dd6d6f..0af86c637a7af 100644 --- a/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Export/Entity/AbstractEntity.php @@ -562,6 +562,7 @@ public function setWriter(AbstractAdapter $writer) /** * Clean cached values + * * @since 100.1.2 */ public function __destruct() From 746aa2cf719572db18777b43356988ba35651cb7 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:26:10 -0300 Subject: [PATCH 09/13] Fix > Semantic Version Checker --- app/code/Magento/ImportExport/Model/Import/AbstractEntity.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php index e2e0ec12bcfde..80d25e9e8a59f 100644 --- a/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php +++ b/app/code/Magento/ImportExport/Model/Import/AbstractEntity.php @@ -657,7 +657,7 @@ public function isAttributeParticular($attributeCode) /** * Get the master attribute code to use in an import * - * @return string + * @return string the master attribute code to use in an import */ public function getMasterAttributeCode() { From dbc895116a4263b9cbbb068102e1f0011b0de87b Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:36:41 -0300 Subject: [PATCH 10/13] Fix > PHP Code Sniffer violation : null is not a valid PHP type --- .../Reports/Model/ResourceModel/Report/AbstractReport.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php b/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php index 9bda446d50a0f..14b8fbb0004a3 100644 --- a/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php +++ b/app/code/Magento/Reports/Model/ResourceModel/Report/AbstractReport.php @@ -57,7 +57,7 @@ abstract class AbstractReport extends \Magento\Framework\Model\ResourceModel\Db\ * @param \Magento\Reports\Model\FlagFactory $reportsFlagFactory * @param \Magento\Framework\Stdlib\DateTime\Timezone\Validator $timezoneValidator * @param \Magento\Framework\Stdlib\DateTime\DateTime $dateTime - * @param null $connectionName + * @param string|null $connectionName */ public function __construct( \Magento\Framework\Model\ResourceModel\Db\Context $context, From ed2ea4315ae549193809f2c9fb93e41cd9ce08a0 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:41:16 -0300 Subject: [PATCH 11/13] Fix > PHP Code Sniffer violation : Constants must have short description if they add information beyond what the constant name supplies --- .../Magento/ImportExport/Model/Import/Entity/AbstractEav.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php index 67abb9769e00a..b7af4be807a6b 100644 --- a/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php +++ b/app/code/Magento/ImportExport/Model/Import/Entity/AbstractEav.php @@ -19,7 +19,7 @@ abstract class AbstractEav extends \Magento\ImportExport\Model\Import\AbstractEntity { /** - * Attribute collection name + * Attribute collection name (data collection) */ const ATTRIBUTE_COLLECTION_NAME = \Magento\Framework\Data\Collection::class; From 678fab55a9ab86ebba4fb2233fb7b9eb12f5a8a2 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:44:44 -0300 Subject: [PATCH 12/13] Fix > PHP Code Sniffer violation : $store parameter is missing in method annotation --- app/code/Magento/Catalog/Model/Product/Type/AbstractType.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php index d563eed589b8a..95c543f58b7fb 100644 --- a/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php +++ b/app/code/Magento/Catalog/Model/Product/Type/AbstractType.php @@ -905,7 +905,7 @@ public function getStoreFilter($product) /** * Set store filter for associated products * - * @param $store int|\Magento\Store\Model\Store + * @param int|\Magento\Store\Model\Store $store * @param \Magento\Catalog\Model\Product $product * @return $this */ From 05a397b8ea89ec6df50bd4e730fa6d3f532803b4 Mon Sep 17 00:00:00 2001 From: "Leandro F. L" Date: Sun, 8 Dec 2019 21:48:59 -0300 Subject: [PATCH 13/13] Fix > PHP Code Sniffer violation : Method arguments visual alignment must be consistent --- .../Magento/Backend/Model/Widget/Grid/AbstractTotals.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php index c5e2931d64f83..042ee75a8954d 100644 --- a/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php +++ b/app/code/Magento/Backend/Model/Widget/Grid/AbstractTotals.php @@ -136,9 +136,9 @@ protected function _countExpr($expr, $collection) /** * Check if operands in not null and set operands values if they are empty * - * @param float|int &$firstOperand - * @param float|int &$secondOperand - * @param float|int &$tmpResult + * @param float|int $firstOperand + * @param float|int $secondOperand + * @param float|int $tmpResult * @param float|int $result * @return void */