diff --git a/app/code/Magento/Authorization/Model/CompositeUserContext.php b/app/code/Magento/Authorization/Model/CompositeUserContext.php index 567422bb138f4..1f98631188307 100644 --- a/app/code/Magento/Authorization/Model/CompositeUserContext.php +++ b/app/code/Magento/Authorization/Model/CompositeUserContext.php @@ -9,7 +9,12 @@ use Magento\Framework\ObjectManager\Helper\Composite as CompositeHelper; /** - * Composite user context (implements composite pattern). + * User context. + * + * This class is not implementing standard composite pattern and will not invoke all of its children. + * Instead, it will try to find the first suitable child and return its result. + * + * @api */ class CompositeUserContext implements \Magento\Authorization\Model\UserContextInterface { diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php index f04ae37d05efd..997687868da62 100644 --- a/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php +++ b/app/code/Magento/Authorization/Model/ResourceModel/Permissions/Collection.php @@ -8,20 +8,9 @@ /** * Admin permissions collection * - * @author Magento Core Team + * @deprecated + * @see \Magento\Authorization\Model\ResourceModel\Rules\Collection */ -class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection +class Collection extends \Magento\Authorization\Model\ResourceModel\Rules\Collection { - /** - * Initialize resource - * - * @return void - */ - protected function _construct() - { - $this->_init( - \Magento\Authorization\Model\Rules::class, - \Magento\Authorization\Model\ResourceModel\Rules::class - ); - } } diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php index 350511cc3b839..18f932d2732d0 100644 --- a/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php +++ b/app/code/Magento/Authorization/Model/ResourceModel/Role/Collection.php @@ -9,6 +9,8 @@ /** * Admin role collection + * + * @api */ class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection { diff --git a/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php b/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php index 841a3fa32207d..d90cdfd1df6d7 100644 --- a/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php +++ b/app/code/Magento/Authorization/Model/ResourceModel/Rules/Collection.php @@ -8,7 +8,7 @@ /** * Rules collection * - * @author Magento Core Team + * @api */ class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection { diff --git a/app/code/Magento/Authorization/Model/Role.php b/app/code/Magento/Authorization/Model/Role.php index 41bf08e656a7f..c40514de1a35f 100644 --- a/app/code/Magento/Authorization/Model/Role.php +++ b/app/code/Magento/Authorization/Model/Role.php @@ -24,6 +24,7 @@ * @method \Magento\Authorization\Model\Role setUserType(string $value) * @method string getRoleName() * @method \Magento\Authorization\Model\Role setRoleName(string $value) + * @api */ class Role extends \Magento\Framework\Model\AbstractModel { diff --git a/app/code/Magento/Authorization/Model/Rules.php b/app/code/Magento/Authorization/Model/Rules.php index 065bf552572f7..77ca82e059ca8 100644 --- a/app/code/Magento/Authorization/Model/Rules.php +++ b/app/code/Magento/Authorization/Model/Rules.php @@ -21,6 +21,7 @@ * @method \Magento\Authorization\Model\Rules setAssertId(int $value) * @method string getPermission() * @method \Magento\Authorization\Model\Rules setPermission(string $value) + * @api */ class Rules extends \Magento\Framework\Model\AbstractModel { @@ -30,14 +31,14 @@ class Rules extends \Magento\Framework\Model\AbstractModel * @param \Magento\Framework\Model\Context $context * @param \Magento\Framework\Registry $registry * @param \Magento\Authorization\Model\ResourceModel\Rules $resource - * @param \Magento\Authorization\Model\ResourceModel\Permissions\Collection $resourceCollection + * @param \Magento\Authorization\Model\ResourceModel\Rules\Collection $resourceCollection * @param array $data */ public function __construct( \Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Authorization\Model\ResourceModel\Rules $resource, - \Magento\Authorization\Model\ResourceModel\Permissions\Collection $resourceCollection, + \Magento\Authorization\Model\ResourceModel\Rules\Collection $resourceCollection, array $data = [] ) { parent::__construct($context, $registry, $resource, $resourceCollection, $data); diff --git a/app/code/Magento/Authorization/Model/UserContextInterface.php b/app/code/Magento/Authorization/Model/UserContextInterface.php index 0049adb07a44d..2db9cec811651 100644 --- a/app/code/Magento/Authorization/Model/UserContextInterface.php +++ b/app/code/Magento/Authorization/Model/UserContextInterface.php @@ -8,6 +8,8 @@ /** * Interface for current user identification. + * + * @api */ interface UserContextInterface { diff --git a/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php b/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php index f08479b4f4c78..8d6fe96022313 100644 --- a/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php +++ b/app/code/Magento/Captcha/Block/Adminhtml/Captcha/DefaultCaptcha.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ +namespace Magento\Captcha\Block\Adminhtml\Captcha; + /** * Captcha block for adminhtml area - * - * @author Magento Core Team */ -namespace Magento\Captcha\Block\Adminhtml\Captcha; - class DefaultCaptcha extends \Magento\Captcha\Block\Captcha\DefaultCaptcha { /** diff --git a/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php b/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php index 0d4b56bf0ac89..c0a091ca2d0d9 100644 --- a/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php +++ b/app/code/Magento/Captcha/Block/Captcha/DefaultCaptcha.php @@ -7,8 +7,6 @@ /** * Captcha block - * - * @author Magento Core Team */ class DefaultCaptcha extends \Magento\Framework\View\Element\Template { diff --git a/app/code/Magento/Captcha/Helper/Data.php b/app/code/Magento/Captcha/Helper/Data.php index 55dd2fccc5368..9372510911f7f 100644 --- a/app/code/Magento/Captcha/Helper/Data.php +++ b/app/code/Magento/Captcha/Helper/Data.php @@ -11,6 +11,8 @@ /** * Captcha image model + * + * @api */ class Data extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/Captcha/Model/DefaultModel.php b/app/code/Magento/Captcha/Model/DefaultModel.php index a45e682200112..37db991f60721 100644 --- a/app/code/Magento/Captcha/Model/DefaultModel.php +++ b/app/code/Magento/Captcha/Model/DefaultModel.php @@ -8,7 +8,7 @@ /** * Implementation of \Zend\Captcha\Image * - * @author Magento Core Team + * @api */ class DefaultModel extends \Zend\Captcha\Image implements \Magento\Captcha\Model\CaptchaInterface { diff --git a/app/code/Magento/Captcha/view/frontend/web/captcha.js b/app/code/Magento/Captcha/view/frontend/web/captcha.js index 612dd50b0ae10..0d4d4812f64c3 100644 --- a/app/code/Magento/Captcha/view/frontend/web/captcha.js +++ b/app/code/Magento/Captcha/view/frontend/web/captcha.js @@ -9,6 +9,9 @@ define([ ], function ($) { 'use strict'; + /** + * @api + */ $.widget('mage.captcha', { options: { refreshClass: 'refreshing', @@ -26,7 +29,7 @@ define([ }, /** - * Method triggeres an AJAX request to refresh the CAPTCHA image + * Method triggers an AJAX request to refresh the CAPTCHA image */ refresh: function () { var imageLoader = this.options.imageLoader; diff --git a/app/code/Magento/Catalog/Model/Product/Exception.php b/app/code/Magento/Catalog/Model/Product/Exception.php index e0f37af360bd3..bcd9ddb057ab8 100644 --- a/app/code/Magento/Catalog/Model/Product/Exception.php +++ b/app/code/Magento/Catalog/Model/Product/Exception.php @@ -7,6 +7,9 @@ use Magento\Framework\Exception\LocalizedException; +/** + * @api + */ class Exception extends LocalizedException { } diff --git a/app/code/Magento/CatalogRule/Model/Flag.php b/app/code/Magento/CatalogRule/Model/Flag.php index 99cfc2134c505..df52fa0b69e9d 100644 --- a/app/code/Magento/CatalogRule/Model/Flag.php +++ b/app/code/Magento/CatalogRule/Model/Flag.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * Flag stores status about availability not applied catalog price rules - * - * @author Magento Core Team - */ namespace Magento\CatalogRule\Model; +/** + * Flag indicates that some rules have changed but changes have not been applied yet. + */ class Flag extends \Magento\Framework\Flag { /** diff --git a/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php b/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php index 082df47564514..53c7544f70e79 100644 --- a/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php +++ b/app/code/Magento/CatalogRule/Model/Indexer/IndexBuilder.php @@ -16,6 +16,7 @@ /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class IndexBuilder { diff --git a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php index 4fbdc6c03f626..62ddd76b422c4 100644 --- a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php +++ b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/IndexTableNotExistException.php @@ -11,6 +11,8 @@ /** * Exception which represents situation where temporary index table should be used somewhere, * but it does not exist in a database + * + * @api */ class IndexTableNotExistException extends LocalizedException { diff --git a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php index c4f54e13b6f1a..728342ce29986 100644 --- a/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php +++ b/app/code/Magento/CatalogSearch/Model/Indexer/Scope/UnknownStateException.php @@ -10,6 +10,8 @@ /** * Exception for situation where used state which is not defined in configuration + * + * @api */ class UnknownStateException extends LocalizedException { diff --git a/app/code/Magento/Checkout/Exception.php b/app/code/Magento/Checkout/Exception.php index bb86d53d194fa..4957e6be9b5da 100644 --- a/app/code/Magento/Checkout/Exception.php +++ b/app/code/Magento/Checkout/Exception.php @@ -5,6 +5,9 @@ */ namespace Magento\Checkout; +/** + * @api + */ class Exception extends \Magento\Framework\Exception\LocalizedException { } diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php b/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php index 6957d34658a61..6aa8810583e3a 100644 --- a/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php +++ b/app/code/Magento/Eav/Model/Entity/Attribute/AttributeGroupAlreadyExistsException.php @@ -8,7 +8,7 @@ use Magento\Framework\Exception\AlreadyExistsException; /** - * Class AttributeGroupAlreadyExistsException + * @api */ class AttributeGroupAlreadyExistsException extends AlreadyExistsException { diff --git a/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php b/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php index d677f66940d85..559cce22bb2c7 100644 --- a/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php +++ b/app/code/Magento/Eav/Model/Entity/Attribute/Exception.php @@ -8,7 +8,7 @@ /** * EAV entity attribute exception * - * @author Magento Core Team + * @api */ class Exception extends \Magento\Framework\Exception\LocalizedException { diff --git a/app/code/Magento/Integration/Model/AdminTokenService.php b/app/code/Magento/Integration/Model/AdminTokenService.php index 18efcaef3f93c..140c3ddc97791 100644 --- a/app/code/Magento/Integration/Model/AdminTokenService.php +++ b/app/code/Magento/Integration/Model/AdminTokenService.php @@ -17,13 +17,12 @@ /** * Class to handle token generation for Admins - * */ class AdminTokenService implements \Magento\Integration\Api\AdminTokenServiceInterface { /** * Token Model - *a + * * @var TokenModelFactory */ private $tokenModelFactory; diff --git a/app/code/Magento/Integration/Model/Integration.php b/app/code/Magento/Integration/Model/Integration.php index 700e53afbff71..a63da3195422c 100644 --- a/app/code/Magento/Integration/Model/Integration.php +++ b/app/code/Magento/Integration/Model/Integration.php @@ -26,6 +26,7 @@ * @method \string getUpdatedAt() * @method Integration setUpdatedAt(\string $createdAt) * @method \Magento\Integration\Model\ResourceModel\Integration getResource() + * @api */ class Integration extends \Magento\Framework\Model\AbstractModel { diff --git a/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php b/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php index 3ec6bfde7e75b..d3ef8dc5e262e 100644 --- a/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php +++ b/app/code/Magento/Integration/Model/Message/RecreatedIntegration.php @@ -14,7 +14,6 @@ /** * Class RecreatedIntegration to display message when a config-based integration needs to be reactivated - * */ class RecreatedIntegration implements \Magento\Framework\Notification\MessageInterface { diff --git a/app/code/Magento/Integration/Model/Oauth/Token.php b/app/code/Magento/Integration/Model/Oauth/Token.php index 7d3ec73845b04..62c0cf36be64a 100644 --- a/app/code/Magento/Integration/Model/Oauth/Token.php +++ b/app/code/Magento/Integration/Model/Oauth/Token.php @@ -41,6 +41,7 @@ * @method int getAuthorized() * @method Token setAuthorized() setAuthorized(int $authorized) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class Token extends \Magento\Framework\Model\AbstractModel { diff --git a/app/code/Magento/Integration/view/adminhtml/web/js/integration.js b/app/code/Magento/Integration/view/adminhtml/web/js/integration.js index b40159b71f0e8..0bd7df8c0fa10 100644 --- a/app/code/Magento/Integration/view/adminhtml/web/js/integration.js +++ b/app/code/Magento/Integration/view/adminhtml/web/js/integration.js @@ -3,6 +3,11 @@ * See COPYING.txt for license details. */ +/** + * jQuery plugin is added. + * + * @api + */ define([ 'jquery', 'Magento_Ui/js/modal/alert', diff --git a/app/code/Magento/MediaStorage/Helper/File/Storage.php b/app/code/Magento/MediaStorage/Helper/File/Storage.php index 58fcdae694083..5406410cd9f3c 100644 --- a/app/code/Magento/MediaStorage/Helper/File/Storage.php +++ b/app/code/Magento/MediaStorage/Helper/File/Storage.php @@ -4,13 +4,13 @@ * See COPYING.txt for license details. */ +namespace Magento\MediaStorage\Helper\File; + /** * File storage helper * - * @author Magento Core Team + * @api */ -namespace Magento\MediaStorage\Helper\File; - class Storage extends \Magento\Framework\App\Helper\AbstractHelper { /** diff --git a/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php b/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php index 8861da142b7d3..790329f30a70d 100644 --- a/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php +++ b/app/code/Magento/MediaStorage/Helper/File/Storage/Database.php @@ -4,16 +4,16 @@ * See COPYING.txt for license details. */ -/** - * Database saving file helper - * - * @author Magento Core Team - */ namespace Magento\MediaStorage\Helper\File\Storage; use Magento\Framework\App\Filesystem\DirectoryList; use Magento\Framework\Filesystem; +/** + * Database saving file helper + * + * @api + */ class Database extends \Magento\Framework\App\Helper\AbstractHelper { /** diff --git a/app/code/Magento/MediaStorage/Model/File/Storage.php b/app/code/Magento/MediaStorage/Model/File/Storage.php index 648fa11b32eeb..84633b3ed9ac8 100644 --- a/app/code/Magento/MediaStorage/Model/File/Storage.php +++ b/app/code/Magento/MediaStorage/Model/File/Storage.php @@ -14,7 +14,9 @@ /** * Class Storage + * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class Storage extends AbstractModel { diff --git a/app/code/Magento/MediaStorage/Model/File/Storage/Database.php b/app/code/Magento/MediaStorage/Model/File/Storage/Database.php index 6dcf19b04ed36..17daa4d87339f 100644 --- a/app/code/Magento/MediaStorage/Model/File/Storage/Database.php +++ b/app/code/Magento/MediaStorage/Model/File/Storage/Database.php @@ -7,6 +7,8 @@ /** * Class Database + * + * @api */ class Database extends \Magento\MediaStorage\Model\File\Storage\Database\AbstractDatabase { diff --git a/app/code/Magento/MediaStorage/Model/File/Storage/File.php b/app/code/Magento/MediaStorage/Model/File/Storage/File.php index d1665a1caf201..11128d816544c 100644 --- a/app/code/Magento/MediaStorage/Model/File/Storage/File.php +++ b/app/code/Magento/MediaStorage/Model/File/Storage/File.php @@ -7,6 +7,8 @@ /** * Class File + * + * @api */ class File { diff --git a/app/code/Magento/MediaStorage/Model/File/Uploader.php b/app/code/Magento/MediaStorage/Model/File/Uploader.php index 5353f0ecb7eb6..a90ac8fb05df7 100644 --- a/app/code/Magento/MediaStorage/Model/File/Uploader.php +++ b/app/code/Magento/MediaStorage/Model/File/Uploader.php @@ -4,13 +4,13 @@ * See COPYING.txt for license details. */ +namespace Magento\MediaStorage\Model\File; + /** * Core file uploader model * - * @author Magento Core Team + * @api */ -namespace Magento\MediaStorage\Model\File; - class Uploader extends \Magento\Framework\File\Uploader { /** diff --git a/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php b/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php index 0b8ccaf2610bd..95c822262df5c 100644 --- a/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php +++ b/app/code/Magento/Msrp/Pricing/Price/MsrpPriceInterface.php @@ -10,6 +10,8 @@ /** * MSRP price interface + * + * @api */ interface MsrpPriceInterface { diff --git a/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js b/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js index 2b2770d0a9137..99d09c2e0da01 100644 --- a/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js +++ b/app/code/Magento/Msrp/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js @@ -2,6 +2,11 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ + +/** + * @api + */ + define([ 'Magento_Tax/js/view/checkout/minicart/subtotal/totals', 'underscore' diff --git a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/ColumnNotFoundException.php b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/ColumnNotFoundException.php index 243a2a9658f0c..0cc2a7c24cfcc 100644 --- a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/ColumnNotFoundException.php +++ b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/ColumnNotFoundException.php @@ -8,6 +8,9 @@ use Magento\Framework\Exception\LocalizedException; +/** + * @api + */ class ColumnNotFoundException extends LocalizedException { diff --git a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/RowException.php b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/RowException.php index 4765b12dd79d0..bed2c9284dbc3 100644 --- a/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/RowException.php +++ b/app/code/Magento/OfflineShipping/Model/ResourceModel/Carrier/Tablerate/CSV/RowException.php @@ -8,6 +8,9 @@ use Magento\Framework\Exception\LocalizedException; +/** + * @api + */ class RowException extends LocalizedException { } diff --git a/app/code/Magento/Paypal/Model/Api/ProcessableException.php b/app/code/Magento/Paypal/Model/Api/ProcessableException.php index 1695b5c2653c1..e455cf3128428 100644 --- a/app/code/Magento/Paypal/Model/Api/ProcessableException.php +++ b/app/code/Magento/Paypal/Model/Api/ProcessableException.php @@ -11,6 +11,9 @@ use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; +/** + * @api + */ class ProcessableException extends LocalizedException { /**#@+ diff --git a/app/code/Magento/Rule/Model/AbstractModel.php b/app/code/Magento/Rule/Model/AbstractModel.php index 717754c8a42ac..311f8b209a12a 100644 --- a/app/code/Magento/Rule/Model/AbstractModel.php +++ b/app/code/Magento/Rule/Model/AbstractModel.php @@ -10,7 +10,9 @@ /** * Abstract Rule entity data model + * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ abstract class AbstractModel extends \Magento\Framework\Model\AbstractExtensibleModel { diff --git a/app/code/Magento/Rule/Model/Action/AbstractAction.php b/app/code/Magento/Rule/Model/Action/AbstractAction.php index 84bf10850dedf..e8111c0dc9cd1 100644 --- a/app/code/Magento/Rule/Model/Action/AbstractAction.php +++ b/app/code/Magento/Rule/Model/Action/AbstractAction.php @@ -9,7 +9,9 @@ use Magento\Framework\Data\Form\Element\AbstractElement; /** - * Quote rule action abstract + * Abstract rule action + * + * @api */ abstract class AbstractAction extends \Magento\Framework\DataObject implements ActionInterface { diff --git a/app/code/Magento/Rule/Model/Action/ActionInterface.php b/app/code/Magento/Rule/Model/Action/ActionInterface.php index 7e6886c0f2f85..ce2d74e020168 100644 --- a/app/code/Magento/Rule/Model/Action/ActionInterface.php +++ b/app/code/Magento/Rule/Model/Action/ActionInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\Rule\Model\Action; +/** + * @api + */ interface ActionInterface { } diff --git a/app/code/Magento/Rule/Model/Action/Collection.php b/app/code/Magento/Rule/Model/Action/Collection.php index b404e2b1b1d1e..2f9963deffd12 100644 --- a/app/code/Magento/Rule/Model/Action/Collection.php +++ b/app/code/Magento/Rule/Model/Action/Collection.php @@ -5,6 +5,9 @@ */ namespace Magento\Rule\Model\Action; +/** + * @api + */ class Collection extends AbstractAction { /** diff --git a/app/code/Magento/Rule/Model/ActionFactory.php b/app/code/Magento/Rule/Model/ActionFactory.php index 994b0e3e191bd..4d20dd08365c3 100644 --- a/app/code/Magento/Rule/Model/ActionFactory.php +++ b/app/code/Magento/Rule/Model/ActionFactory.php @@ -3,8 +3,12 @@ * Copyright © Magento, Inc. All rights reserved. * See COPYING.txt for license details. */ + namespace Magento\Rule\Model; +/** + * @api + */ class ActionFactory { /** diff --git a/app/code/Magento/Rule/Model/Condition/AbstractCondition.php b/app/code/Magento/Rule/Model/Condition/AbstractCondition.php index 660dac2341929..75888b0deec81 100644 --- a/app/code/Magento/Rule/Model/Condition/AbstractCondition.php +++ b/app/code/Magento/Rule/Model/Condition/AbstractCondition.php @@ -4,21 +4,20 @@ * See COPYING.txt for license details. */ -/** - * Abstract Rule condition data model - * - * @method string getOperator() - * @method string getFormName() - * @method setFormName() - */ namespace Magento\Rule\Model\Condition; use Magento\Framework\Data\Form; use Magento\Framework\Data\Form\Element\AbstractElement; /** + * Abstract Rule condition data model + * + * @method string getOperator() + * @method string getFormName() + * @method setFormName() * @SuppressWarnings(PHPMD.ExcessivePublicCount) * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) + * @api */ abstract class AbstractCondition extends \Magento\Framework\DataObject implements ConditionInterface { diff --git a/app/code/Magento/Rule/Model/Condition/Combine.php b/app/code/Magento/Rule/Model/Condition/Combine.php index 7534c63c78845..c8b1e744a62e4 100644 --- a/app/code/Magento/Rule/Model/Condition/Combine.php +++ b/app/code/Magento/Rule/Model/Condition/Combine.php @@ -5,6 +5,9 @@ */ namespace Magento\Rule\Model\Condition; +/** + * @api + */ class Combine extends AbstractCondition { /** diff --git a/app/code/Magento/Rule/Model/Condition/ConditionInterface.php b/app/code/Magento/Rule/Model/Condition/ConditionInterface.php index 2f95429020987..b7e03424a4860 100644 --- a/app/code/Magento/Rule/Model/Condition/ConditionInterface.php +++ b/app/code/Magento/Rule/Model/Condition/ConditionInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\Rule\Model\Condition; +/** + * @api + */ interface ConditionInterface { /** diff --git a/app/code/Magento/Rule/Model/Condition/Context.php b/app/code/Magento/Rule/Model/Condition/Context.php index 353de3cc129e6..584d274e32547 100644 --- a/app/code/Magento/Rule/Model/Condition/Context.php +++ b/app/code/Magento/Rule/Model/Condition/Context.php @@ -4,12 +4,13 @@ * See COPYING.txt for license details. */ +namespace Magento\Rule\Model\Condition; + /** - * Abstract block context object. Will be used as rule condition constructor modification point after release. + * Abstract block context object. Is used as rule condition constructor modification point. + * * Important: Should not be modified by extension developers. */ -namespace Magento\Rule\Model\Condition; - class Context implements \Magento\Framework\ObjectManager\ContextInterface { /** diff --git a/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php b/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php index 081258bcd5092..299b352e0bce5 100644 --- a/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php +++ b/app/code/Magento/Rule/Model/Condition/Product/AbstractProduct.php @@ -4,16 +4,14 @@ * See COPYING.txt for license details. */ -/** - * Abstract Rule product condition data model - * - * @author Magento Core Team - */ namespace Magento\Rule\Model\Condition\Product; /** + * Abstract Rule product condition data model + * * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ abstract class AbstractProduct extends \Magento\Rule\Model\Condition\AbstractCondition { diff --git a/app/code/Magento/Rule/Model/Condition/Sql/Builder.php b/app/code/Magento/Rule/Model/Condition/Sql/Builder.php index 01b3ee6529624..c3ffda059c951 100644 --- a/app/code/Magento/Rule/Model/Condition/Sql/Builder.php +++ b/app/code/Magento/Rule/Model/Condition/Sql/Builder.php @@ -12,8 +12,6 @@ /** * Class SQL Builder - * - * @package Magento\Rule\Model\Condition\Sql */ class Builder { diff --git a/app/code/Magento/Rule/Model/Condition/Sql/Expression.php b/app/code/Magento/Rule/Model/Condition/Sql/Expression.php index 6826f6f84f591..0896a65652681 100644 --- a/app/code/Magento/Rule/Model/Condition/Sql/Expression.php +++ b/app/code/Magento/Rule/Model/Condition/Sql/Expression.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ +namespace Magento\Rule\Model\Condition\Sql; + /** * Abstract Rule sql condition - * - * @author Magento Core Team */ -namespace Magento\Rule\Model\Condition\Sql; - class Expression extends \Zend_Db_Expr { /** diff --git a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php index e698c9a2b73bd..d5953f6613f8b 100644 --- a/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php +++ b/app/code/Magento/Rule/Model/ResourceModel/AbstractResource.php @@ -4,13 +4,13 @@ * See COPYING.txt for license details. */ +namespace Magento\Rule\Model\ResourceModel; + /** * Abstract Rule entity resource model * - * @author Magento Core Team + * @api */ -namespace Magento\Rule\Model\ResourceModel; - abstract class AbstractResource extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb { /** diff --git a/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php b/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php index bc5971fd65367..dc4049b597ef8 100644 --- a/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php +++ b/app/code/Magento/Rule/Model/ResourceModel/Rule/Collection/AbstractCollection.php @@ -4,13 +4,13 @@ * See COPYING.txt for license details. */ +namespace Magento\Rule\Model\ResourceModel\Rule\Collection; + /** * Abstract Rule entity resource collection model * - * @author Magento Core Team + * @api */ -namespace Magento\Rule\Model\ResourceModel\Rule\Collection; - abstract class AbstractCollection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection { /** diff --git a/app/code/Magento/Rule/view/adminhtml/web/rules.js b/app/code/Magento/Rule/view/adminhtml/web/rules.js index d9fe11ec2d7f7..1423c05fefcaf 100644 --- a/app/code/Magento/Rule/view/adminhtml/web/rules.js +++ b/app/code/Magento/Rule/view/adminhtml/web/rules.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ "jquery", 'Magento_Ui/js/modal/alert', diff --git a/app/code/Magento/Sales/Exception/CouldNotInvoiceException.php b/app/code/Magento/Sales/Exception/CouldNotInvoiceException.php index dff7089f08491..fc40a70a2396e 100644 --- a/app/code/Magento/Sales/Exception/CouldNotInvoiceException.php +++ b/app/code/Magento/Sales/Exception/CouldNotInvoiceException.php @@ -10,6 +10,8 @@ /** * Class CouldNotInvoiceException + * + * @api */ class CouldNotInvoiceException extends LocalizedException implements CouldNotInvoiceExceptionInterface { diff --git a/app/code/Magento/Sales/Exception/CouldNotRefundException.php b/app/code/Magento/Sales/Exception/CouldNotRefundException.php index 4b27ee52a85bd..c021fbab9505f 100644 --- a/app/code/Magento/Sales/Exception/CouldNotRefundException.php +++ b/app/code/Magento/Sales/Exception/CouldNotRefundException.php @@ -9,7 +9,7 @@ use Magento\Sales\Api\Exception\CouldNotRefundExceptionInterface; /** - * Class CouldNotRefundException + * @api */ class CouldNotRefundException extends LocalizedException implements CouldNotRefundExceptionInterface { diff --git a/app/code/Magento/Sales/Exception/CouldNotShipException.php b/app/code/Magento/Sales/Exception/CouldNotShipException.php index 8fd7963c20aa9..e9831a3f65e83 100644 --- a/app/code/Magento/Sales/Exception/CouldNotShipException.php +++ b/app/code/Magento/Sales/Exception/CouldNotShipException.php @@ -9,7 +9,7 @@ use Magento\Sales\Api\Exception\CouldNotShipExceptionInterface; /** - * Class CouldNotShipException + * @api */ class CouldNotShipException extends LocalizedException implements CouldNotShipExceptionInterface { diff --git a/app/code/Magento/Sales/Exception/DocumentValidationException.php b/app/code/Magento/Sales/Exception/DocumentValidationException.php index 628f97d7e8630..f9ea154c649fe 100644 --- a/app/code/Magento/Sales/Exception/DocumentValidationException.php +++ b/app/code/Magento/Sales/Exception/DocumentValidationException.php @@ -9,7 +9,7 @@ use Magento\Sales\Api\Exception\DocumentValidationExceptionInterface; /** - * Class DocumentValidationException + * @api */ class DocumentValidationException extends LocalizedException implements DocumentValidationExceptionInterface { diff --git a/app/code/Magento/SalesRule/Helper/Coupon.php b/app/code/Magento/SalesRule/Helper/Coupon.php index bfc3c3c5838c8..c5c64b0384cf4 100644 --- a/app/code/Magento/SalesRule/Helper/Coupon.php +++ b/app/code/Magento/SalesRule/Helper/Coupon.php @@ -11,7 +11,7 @@ /** * Helper for coupon codes creating and managing * - * @author Magento Core Team + * @api */ class Coupon extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/SalesRule/Model/Coupon/CodegeneratorInterface.php b/app/code/Magento/SalesRule/Model/Coupon/CodegeneratorInterface.php index fb706b87a2b75..6453a02cfcc1c 100644 --- a/app/code/Magento/SalesRule/Model/Coupon/CodegeneratorInterface.php +++ b/app/code/Magento/SalesRule/Model/Coupon/CodegeneratorInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\SalesRule\Model\Coupon; +/** + * @api + */ interface CodegeneratorInterface { /** diff --git a/app/code/Magento/SalesRule/Model/Rule/Action/Discount/DiscountInterface.php b/app/code/Magento/SalesRule/Model/Rule/Action/Discount/DiscountInterface.php index 89ddb221a01df..05d78c6495e2b 100644 --- a/app/code/Magento/SalesRule/Model/Rule/Action/Discount/DiscountInterface.php +++ b/app/code/Magento/SalesRule/Model/Rule/Action/Discount/DiscountInterface.php @@ -5,6 +5,9 @@ */ namespace Magento\SalesRule\Model\Rule\Action\Discount; +/** + * @api + */ interface DiscountInterface { /** diff --git a/app/code/Magento/SalesRule/Model/Spi/CouponResourceInterface.php b/app/code/Magento/SalesRule/Model/Spi/CouponResourceInterface.php index 395b164846b2d..90ab16a950ed9 100644 --- a/app/code/Magento/SalesRule/Model/Spi/CouponResourceInterface.php +++ b/app/code/Magento/SalesRule/Model/Spi/CouponResourceInterface.php @@ -7,6 +7,8 @@ /** * Interface ResourceInterface + * + * @api */ interface CouponResourceInterface { diff --git a/app/code/Magento/Search/Model/Synonym/MergeConflictException.php b/app/code/Magento/Search/Model/Synonym/MergeConflictException.php index 4a58e6b3b6f50..2c0ab409b47c5 100644 --- a/app/code/Magento/Search/Model/Synonym/MergeConflictException.php +++ b/app/code/Magento/Search/Model/Synonym/MergeConflictException.php @@ -10,6 +10,8 @@ /** * Exception class for merge conflict during inserting and updating synonym groups + * + * @api */ class MergeConflictException extends LocalizedException { diff --git a/app/code/Magento/Swagger/view/frontend/web/swagger-ui/js/magento-swagger.js b/app/code/Magento/Swagger/view/frontend/web/swagger-ui/js/magento-swagger.js index c69ef848c37cc..085e313068fba 100644 --- a/app/code/Magento/Swagger/view/frontend/web/swagger-ui/js/magento-swagger.js +++ b/app/code/Magento/Swagger/view/frontend/web/swagger-ui/js/magento-swagger.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ $(function () { var url = $('#input_baseUrl').val(); diff --git a/app/code/Magento/Tax/Helper/Data.php b/app/code/Magento/Tax/Helper/Data.php index f21aa25362915..5c06831333745 100644 --- a/app/code/Magento/Tax/Helper/Data.php +++ b/app/code/Magento/Tax/Helper/Data.php @@ -24,6 +24,7 @@ * @SuppressWarnings(PHPMD.TooManyFields) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @codingStandardsIgnoreFile + * @api */ class Data extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/grand-total.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/grand-total.js index 160e59493bf47..713d81c708784 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/grand-total.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/grand-total.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Tax/js/view/checkout/summary/grand-total' ], function (Component) { diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/shipping.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/shipping.js index 5baeabcf6e0e1..9f051ba23f68c 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/shipping.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/shipping.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Tax/js/view/checkout/summary/shipping', 'Magento_Checkout/js/model/quote' diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/tax.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/tax.js index 455821e4f10d8..b0e9927c1d8b9 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/tax.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/cart/totals/tax.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Tax/js/view/checkout/summary/tax', 'Magento_Checkout/js/model/totals' diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js index 073ea86f1ac99..483ff84c7d31d 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/minicart/subtotal/totals.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'ko', 'uiComponent', diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/shipping_method/price.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/shipping_method/price.js index 153c5f33c70d8..cee1f7792b883 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/shipping_method/price.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/shipping_method/price.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'uiComponent', 'Magento_Checkout/js/model/quote', diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/grand-total.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/grand-total.js index 0ebb9f65fad4b..72f152915ce14 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/grand-total.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/grand-total.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Checkout/js/view/summary/abstract-total', 'Magento_Checkout/js/model/quote', diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/item/details/subtotal.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/item/details/subtotal.js index a9742e44c886e..9fb38263814dc 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/item/details/subtotal.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/item/details/subtotal.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Checkout/js/view/summary/item/details/subtotal' ], function (subtotal) { diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/shipping.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/shipping.js index 9cfa6c7b82cdc..6b5104193c77d 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/shipping.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/shipping.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'jquery', 'Magento_Checkout/js/view/summary/shipping', diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/subtotal.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/subtotal.js index afa43f630022b..b74afa69d1b01 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/subtotal.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/subtotal.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Checkout/js/view/summary/abstract-total', 'Magento_Checkout/js/model/quote' diff --git a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/tax.js b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/tax.js index 8fb9677a280fe..c86c3b4d1ab06 100644 --- a/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/tax.js +++ b/app/code/Magento/Tax/view/frontend/web/js/view/checkout/summary/tax.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'ko', 'Magento_Checkout/js/view/summary/abstract-total', diff --git a/app/code/Magento/User/Helper/Data.php b/app/code/Magento/User/Helper/Data.php index cc552171b964e..c17e8b6d7beef 100644 --- a/app/code/Magento/User/Helper/Data.php +++ b/app/code/Magento/User/Helper/Data.php @@ -8,7 +8,7 @@ /** * User data helper * - * @author Magento Core Team + * @api */ class Data extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/User/Model/ResourceModel/User.php b/app/code/Magento/User/Model/ResourceModel/User.php index 79aa8ef727c55..c5ace3f6941d1 100644 --- a/app/code/Magento/User/Model/ResourceModel/User.php +++ b/app/code/Magento/User/Model/ResourceModel/User.php @@ -13,7 +13,9 @@ /** * ACL user resource + * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class User extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb { diff --git a/app/code/Magento/User/Model/ResourceModel/User/Collection.php b/app/code/Magento/User/Model/ResourceModel/User/Collection.php index 8671c1d30461f..9444f6d7492a9 100644 --- a/app/code/Magento/User/Model/ResourceModel/User/Collection.php +++ b/app/code/Magento/User/Model/ResourceModel/User/Collection.php @@ -8,7 +8,7 @@ /** * Admin user collection * - * @author Magento Core Team + * @api */ class Collection extends \Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection { diff --git a/app/code/Magento/User/Model/User.php b/app/code/Magento/User/Model/User.php index f7b80cb641d06..560e097605a12 100644 --- a/app/code/Magento/User/Model/User.php +++ b/app/code/Magento/User/Model/User.php @@ -31,6 +31,7 @@ * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) * @SuppressWarnings(PHPMD.LongVariable) * @SuppressWarnings(PHPMD.ExcessivePublicCount) + * @api */ class User extends AbstractModel implements StorageInterface, UserInterface { diff --git a/app/code/Magento/User/Model/UserValidationRules.php b/app/code/Magento/User/Model/UserValidationRules.php index 7dfd2a17d1ae8..bfd796065d37b 100644 --- a/app/code/Magento/User/Model/UserValidationRules.php +++ b/app/code/Magento/User/Model/UserValidationRules.php @@ -12,6 +12,8 @@ /** * Class for adding validation rules to an Admin user + * + * @api */ class UserValidationRules { diff --git a/app/code/Magento/User/view/adminhtml/web/js/roles-tree.js b/app/code/Magento/User/view/adminhtml/web/js/roles-tree.js index cc211d886402d..838d73bb9467f 100644 --- a/app/code/Magento/User/view/adminhtml/web/js/roles-tree.js +++ b/app/code/Magento/User/view/adminhtml/web/js/roles-tree.js @@ -3,6 +3,9 @@ * See COPYING.txt for license details. */ +/** + * @api + */ define([ 'jquery', 'jquery/ui', diff --git a/app/code/Magento/Webapi/Controller/Rest.php b/app/code/Magento/Webapi/Controller/Rest.php index c480f86b758a0..78b3ad8b9c472 100644 --- a/app/code/Magento/Webapi/Controller/Rest.php +++ b/app/code/Magento/Webapi/Controller/Rest.php @@ -26,8 +26,6 @@ /** * Front controller for WebAPI REST area. * - * TODO: Consider warnings suppression removal - * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) * @SuppressWarnings(PHPMD.TooManyFields) */ diff --git a/app/code/Magento/Webapi/Model/AbstractSchemaGenerator.php b/app/code/Magento/Webapi/Model/AbstractSchemaGenerator.php index 4b4f31e68ff0d..e566313af51ac 100644 --- a/app/code/Magento/Webapi/Model/AbstractSchemaGenerator.php +++ b/app/code/Magento/Webapi/Model/AbstractSchemaGenerator.php @@ -75,22 +75,13 @@ public function __construct( } /** - * Retrieve a list of services visible to current user. + * Retrieve a list of all services. * * @return string[] */ public function getListOfServices() { - $listOfAllowedServices = []; - foreach ($this->serviceMetadata->getServicesConfig() as $serviceName => $service) { - foreach ($service[ServiceMetadata::KEY_SERVICE_METHODS] as $method) { - if ($this->authorization->isAllowed($method[ServiceMetadata::KEY_ACL_RESOURCES])) { - $listOfAllowedServices[] = $serviceName; - break; - } - } - } - return $listOfAllowedServices; + return array_keys($this->serviceMetadata->getServicesConfig()); } /** diff --git a/app/code/Magento/Webapi/Model/Config.php b/app/code/Magento/Webapi/Model/Config.php index fb6648f50df8c..7e5e015ec07e4 100644 --- a/app/code/Magento/Webapi/Model/Config.php +++ b/app/code/Magento/Webapi/Model/Config.php @@ -12,9 +12,9 @@ use Magento\Framework\Serialize\SerializerInterface; /** - * Web API Config Model. + * This class gives access to consolidated web API configuration from /etc/webapi.xml files. * - * This is a parent class for storing information about service configuration. + * @api */ class Config { diff --git a/app/code/Magento/Webapi/Model/Plugin/Manager.php b/app/code/Magento/Webapi/Model/Plugin/Manager.php index 93608c6ec642e..91808f8c658d3 100644 --- a/app/code/Magento/Webapi/Model/Plugin/Manager.php +++ b/app/code/Magento/Webapi/Model/Plugin/Manager.php @@ -10,7 +10,7 @@ use Magento\Integration\Model\IntegrationConfig; /** - * Plugin for ConfigBasedIntegrationManager model to manage resource permissions of + * Plugin for @see \Magento\Integration\Model\ConfigBasedIntegrationManager model to manage resource permissions of * integration installed from config file */ class Manager diff --git a/app/code/Magento/Webapi/Model/Rest/Swagger/Generator.php b/app/code/Magento/Webapi/Model/Rest/Swagger/Generator.php index 3b17ab43a32b4..ee7d65e484792 100644 --- a/app/code/Magento/Webapi/Model/Rest/Swagger/Generator.php +++ b/app/code/Magento/Webapi/Model/Rest/Swagger/Generator.php @@ -15,6 +15,7 @@ use Magento\Webapi\Model\Config\Converter; use Magento\Webapi\Model\Rest\Swagger; use Magento\Webapi\Model\Rest\SwaggerFactory; +use Magento\Webapi\Model\ServiceMetadata; /** * REST Swagger schema generator. @@ -897,4 +898,23 @@ private function generateMethodExceptionErrorResponses($exceptionClass, $respons return $responses; } + + /** + * Retrieve a list of services visible to current user. + * + * @return string[] + */ + public function getListOfServices() + { + $listOfAllowedServices = []; + foreach ($this->serviceMetadata->getServicesConfig() as $serviceName => $service) { + foreach ($service[ServiceMetadata::KEY_SERVICE_METHODS] as $method) { + if ($this->authorization->isAllowed($method[ServiceMetadata::KEY_ACL_RESOURCES])) { + $listOfAllowedServices[] = $serviceName; + break; + } + } + } + return $listOfAllowedServices; + } } diff --git a/app/code/Magento/Weee/Helper/Data.php b/app/code/Magento/Weee/Helper/Data.php index 67e1ffa6161ae..2e3ea36f8f4b3 100644 --- a/app/code/Magento/Weee/Helper/Data.php +++ b/app/code/Magento/Weee/Helper/Data.php @@ -12,8 +12,10 @@ /** * WEEE data helper + * * @SuppressWarnings(PHPMD.ExcessiveClassComplexity) * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class Data extends \Magento\Framework\App\Helper\AbstractHelper { diff --git a/app/code/Magento/Weee/Model/ResourceModel/Tax.php b/app/code/Magento/Weee/Model/ResourceModel/Tax.php index 53a53a5ede1eb..54052eae01a48 100644 --- a/app/code/Magento/Weee/Model/ResourceModel/Tax.php +++ b/app/code/Magento/Weee/Model/ResourceModel/Tax.php @@ -10,6 +10,8 @@ /** * Wee tax resource model + * + * @api */ class Tax extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb { diff --git a/app/code/Magento/Weee/Model/Sales/Pdf/Weee.php b/app/code/Magento/Weee/Model/Sales/Pdf/Weee.php index 687fd6bc32946..fa71e81281763 100644 --- a/app/code/Magento/Weee/Model/Sales/Pdf/Weee.php +++ b/app/code/Magento/Weee/Model/Sales/Pdf/Weee.php @@ -5,6 +5,9 @@ */ namespace Magento\Weee\Model\Sales\Pdf; +/** + * Sales order total for PDF, taking into account WEEE tax + */ class Weee extends \Magento\Sales\Model\Order\Pdf\Total\DefaultTotal { /** @@ -32,6 +35,7 @@ public function __construct( /** * Check if weee total amount should be included + * * array( * $index => array( * 'amount' => $amount, diff --git a/app/code/Magento/Weee/Model/Tax.php b/app/code/Magento/Weee/Model/Tax.php index 3d69232b0c06e..6f970f683d926 100644 --- a/app/code/Magento/Weee/Model/Tax.php +++ b/app/code/Magento/Weee/Model/Tax.php @@ -13,6 +13,7 @@ /** * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class Tax extends \Magento\Framework\Model\AbstractModel { diff --git a/app/code/Magento/Weee/README.md b/app/code/Magento/Weee/README.md index 0218dcd85ed9c..61f9b8d6d8970 100644 --- a/app/code/Magento/Weee/README.md +++ b/app/code/Magento/Weee/README.md @@ -21,5 +21,6 @@ Magento installation with existing products with FPT: * Remove all FPT attributes from attribute sets * Delete all FPT attributes * Remove module directory from the code base -* New Magento installation: -* Can be removed without additional actions \ No newline at end of file + +New Magento installation: +* Can be removed without additional actions diff --git a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_excl_tax.js b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_excl_tax.js index 02ff7d0407b6f..4ab7b1b6acbf1 100644 --- a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_excl_tax.js +++ b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_excl_tax.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Weee/js/view/checkout/summary/item/price/weee' ], function (weee) { diff --git a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_incl_tax.js b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_incl_tax.js index e63e628d93b2c..718bb4a8ad8fa 100644 --- a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_incl_tax.js +++ b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/row_incl_tax.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Weee/js/view/checkout/summary/item/price/weee' ], function (weee) { diff --git a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/weee.js b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/weee.js index d5115791409d7..220e327b77ddc 100644 --- a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/weee.js +++ b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/item/price/weee.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Checkout/js/view/summary/abstract-total', 'Magento_Checkout/js/model/quote' diff --git a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/weee.js b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/weee.js index 70dc346506fc3..a5623c372c602 100644 --- a/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/weee.js +++ b/app/code/Magento/Weee/view/frontend/web/js/view/checkout/summary/weee.js @@ -3,6 +3,10 @@ * See COPYING.txt for license details. */ +/** + * @api + */ + define([ 'Magento_Checkout/js/view/summary/abstract-total', 'Magento_Checkout/js/model/quote', diff --git a/dev/tests/integration/testsuite/Magento/Webapi/Controller/SoapTest.php b/dev/tests/integration/testsuite/Magento/Webapi/Controller/SoapTest.php new file mode 100644 index 0000000000000..31c496ef27532 --- /dev/null +++ b/dev/tests/integration/testsuite/Magento/Webapi/Controller/SoapTest.php @@ -0,0 +1,39 @@ +objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager(); + $this->soapController = $this->objectManager->get(\Magento\Webapi\Controller\Soap::class); + } + + /* + * Get the public wsdl with anonymous credentials + */ + public function testDispatchWsdlRequest() + { + $request = $this->objectManager->get(\Magento\Framework\Webapi\Request::class); + $request->setParam(\Magento\Webapi\Model\Soap\Server::REQUEST_PARAM_LIST_WSDL, true); + $response = $this->soapController->dispatch($request); + $decoded_wsdl = json_decode($response->getContent(), true); + $this->assertArrayHasKey("customerAccountManagementV1", $decoded_wsdl); + $this->assertArrayHasKey("integrationAdminTokenServiceV1", $decoded_wsdl); + } +} diff --git a/dev/tests/static/testsuite/Magento/Test/Legacy/_files/obsolete_classes.php b/dev/tests/static/testsuite/Magento/Test/Legacy/_files/obsolete_classes.php index 6e2cdf1ab5309..a5f52b02d1439 100755 --- a/dev/tests/static/testsuite/Magento/Test/Legacy/_files/obsolete_classes.php +++ b/dev/tests/static/testsuite/Magento/Test/Legacy/_files/obsolete_classes.php @@ -37,7 +37,11 @@ ['Mage_Admin_Model_Resource_Rules_Collection', 'Magento\Authorization\Model\ResourceModel\Rules\Collection'], [ 'Mage_Admin_Model_Resource_Permissions_Collection', + 'Magento\Authorization\Model\ResourceModel\Rules\Collection' + ], + [ 'Magento\Authorization\Model\ResourceModel\Permissions\Collection', + 'Magento\Authorization\Model\ResourceModel\Rules\Collection' ], ['Mage_Adminhtml_Block_Abstract', 'Magento\Backend\Block\AbstractBlock'], ['Mage_Adminhtml_Block_Backup_Grid'], diff --git a/lib/internal/Magento/Framework/Acl/Data/CacheInterface.php b/lib/internal/Magento/Framework/Acl/Data/CacheInterface.php index 34f46d88166ee..1ef0129515c86 100644 --- a/lib/internal/Magento/Framework/Acl/Data/CacheInterface.php +++ b/lib/internal/Magento/Framework/Acl/Data/CacheInterface.php @@ -6,6 +6,9 @@ namespace Magento\Framework\Acl\Data; +/** + * Interface for caching ACL data + */ interface CacheInterface extends \Magento\Framework\Cache\FrontendInterface { } diff --git a/lib/internal/Magento/Framework/Backup/BackupException.php b/lib/internal/Magento/Framework/Backup/BackupException.php index d356811995eb3..7694c084c10a7 100644 --- a/lib/internal/Magento/Framework/Backup/BackupException.php +++ b/lib/internal/Magento/Framework/Backup/BackupException.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup; +/** + * @api + */ class BackupException extends \Magento\Framework\Exception\LocalizedException { } diff --git a/lib/internal/Magento/Framework/Backup/Exception/CantLoadSnapshot.php b/lib/internal/Magento/Framework/Backup/Exception/CantLoadSnapshot.php index 6c2cf12f582ad..45d1cc21b06da 100644 --- a/lib/internal/Magento/Framework/Backup/Exception/CantLoadSnapshot.php +++ b/lib/internal/Magento/Framework/Backup/Exception/CantLoadSnapshot.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup\Exception; +/** + * @api + */ class CantLoadSnapshot extends \Magento\Framework\Backup\BackupException { } diff --git a/lib/internal/Magento/Framework/Backup/Exception/FtpConnectionFailed.php b/lib/internal/Magento/Framework/Backup/Exception/FtpConnectionFailed.php index 1b7c6859738f8..9b722da10a1bd 100644 --- a/lib/internal/Magento/Framework/Backup/Exception/FtpConnectionFailed.php +++ b/lib/internal/Magento/Framework/Backup/Exception/FtpConnectionFailed.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup\Exception; +/** + * @api + */ class FtpConnectionFailed extends \Magento\Framework\Backup\BackupException { } diff --git a/lib/internal/Magento/Framework/Backup/Exception/FtpValidationFailed.php b/lib/internal/Magento/Framework/Backup/Exception/FtpValidationFailed.php index 18ef6fba7dab5..53af4bfd3061b 100644 --- a/lib/internal/Magento/Framework/Backup/Exception/FtpValidationFailed.php +++ b/lib/internal/Magento/Framework/Backup/Exception/FtpValidationFailed.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup\Exception; +/** + * @api + */ class FtpValidationFailed extends \Magento\Framework\Backup\BackupException { } diff --git a/lib/internal/Magento/Framework/Backup/Exception/NotEnoughFreeSpace.php b/lib/internal/Magento/Framework/Backup/Exception/NotEnoughFreeSpace.php index 42e008a9da52b..b373134d2e9a6 100644 --- a/lib/internal/Magento/Framework/Backup/Exception/NotEnoughFreeSpace.php +++ b/lib/internal/Magento/Framework/Backup/Exception/NotEnoughFreeSpace.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup\Exception; +/** + * @api + */ class NotEnoughFreeSpace extends \Magento\Framework\Backup\BackupException { } diff --git a/lib/internal/Magento/Framework/Backup/Exception/NotEnoughPermissions.php b/lib/internal/Magento/Framework/Backup/Exception/NotEnoughPermissions.php index 761f2783932eb..ba7e80a503f4f 100644 --- a/lib/internal/Magento/Framework/Backup/Exception/NotEnoughPermissions.php +++ b/lib/internal/Magento/Framework/Backup/Exception/NotEnoughPermissions.php @@ -4,13 +4,11 @@ * See COPYING.txt for license details. */ -/** - * \Exception - * - * @author Magento Core Team - */ namespace Magento\Framework\Backup\Exception; +/** + * @api + */ class NotEnoughPermissions extends \Magento\Framework\Backup\BackupException { } diff --git a/lib/internal/Magento/Framework/Communication/ConfigInterface.php b/lib/internal/Magento/Framework/Communication/ConfigInterface.php index bd3e073068226..0c6a90f5c0b17 100644 --- a/lib/internal/Magento/Framework/Communication/ConfigInterface.php +++ b/lib/internal/Magento/Framework/Communication/ConfigInterface.php @@ -9,6 +9,8 @@ /** * Class for accessing to communication configuration. + * + * @api */ interface ConfigInterface { diff --git a/lib/internal/Magento/Framework/Config/Dom/ValidationSchemaException.php b/lib/internal/Magento/Framework/Config/Dom/ValidationSchemaException.php index c70ae47cf4dcc..b4e558c0298b1 100644 --- a/lib/internal/Magento/Framework/Config/Dom/ValidationSchemaException.php +++ b/lib/internal/Magento/Framework/Config/Dom/ValidationSchemaException.php @@ -11,6 +11,9 @@ use Magento\Framework\Exception\LocalizedException; +/** + * @api + */ class ValidationSchemaException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php index 4d1b2fd0e339a..14e711429827c 100644 --- a/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php +++ b/lib/internal/Magento/Framework/Exception/AbstractAggregateException.php @@ -8,6 +8,9 @@ use Magento\Framework\Phrase; +/** + * @api + */ abstract class AbstractAggregateException extends LocalizedException { /** diff --git a/lib/internal/Magento/Framework/Exception/AlreadyExistsException.php b/lib/internal/Magento/Framework/Exception/AlreadyExistsException.php index 0511be22ce43b..1917385148031 100644 --- a/lib/internal/Magento/Framework/Exception/AlreadyExistsException.php +++ b/lib/internal/Magento/Framework/Exception/AlreadyExistsException.php @@ -8,7 +8,7 @@ use Magento\Framework\Phrase; /** - * Class AlreadyExistsException + * @api */ class AlreadyExistsException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/AuthenticationException.php b/lib/internal/Magento/Framework/Exception/AuthenticationException.php index 089d3cc5c9db5..fc097dc5562bd 100644 --- a/lib/internal/Magento/Framework/Exception/AuthenticationException.php +++ b/lib/internal/Magento/Framework/Exception/AuthenticationException.php @@ -7,6 +7,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class AuthenticationException extends LocalizedException { /** diff --git a/lib/internal/Magento/Framework/Exception/AuthorizationException.php b/lib/internal/Magento/Framework/Exception/AuthorizationException.php index 9c3a7b6f7f3cd..79bf95b22bccf 100644 --- a/lib/internal/Magento/Framework/Exception/AuthorizationException.php +++ b/lib/internal/Magento/Framework/Exception/AuthorizationException.php @@ -7,6 +7,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class AuthorizationException extends LocalizedException { /** diff --git a/lib/internal/Magento/Framework/Exception/ConfigurationMismatchException.php b/lib/internal/Magento/Framework/Exception/ConfigurationMismatchException.php index dd5e2e4475c3f..0c31c0b420f61 100644 --- a/lib/internal/Magento/Framework/Exception/ConfigurationMismatchException.php +++ b/lib/internal/Magento/Framework/Exception/ConfigurationMismatchException.php @@ -7,7 +7,7 @@ namespace Magento\Framework\Exception; /** - * Class ConfigurationException + * @api */ class ConfigurationMismatchException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/CouldNotDeleteException.php b/lib/internal/Magento/Framework/Exception/CouldNotDeleteException.php index cc334f391c6c4..af8e4c3c0ec57 100644 --- a/lib/internal/Magento/Framework/Exception/CouldNotDeleteException.php +++ b/lib/internal/Magento/Framework/Exception/CouldNotDeleteException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class CouldNotDeleteException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/CouldNotSaveException.php b/lib/internal/Magento/Framework/Exception/CouldNotSaveException.php index 155e2afccfd78..ea265864afd24 100644 --- a/lib/internal/Magento/Framework/Exception/CouldNotSaveException.php +++ b/lib/internal/Magento/Framework/Exception/CouldNotSaveException.php @@ -6,6 +6,9 @@ namespace Magento\Framework\Exception; +/** + * @api + */ class CouldNotSaveException extends AbstractAggregateException { } diff --git a/lib/internal/Magento/Framework/Exception/CronException.php b/lib/internal/Magento/Framework/Exception/CronException.php index d34c864731ad9..22d23526a6558 100644 --- a/lib/internal/Magento/Framework/Exception/CronException.php +++ b/lib/internal/Magento/Framework/Exception/CronException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class CronException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/EmailNotConfirmedException.php b/lib/internal/Magento/Framework/Exception/EmailNotConfirmedException.php index d75932699c044..330f34fb565ce 100644 --- a/lib/internal/Magento/Framework/Exception/EmailNotConfirmedException.php +++ b/lib/internal/Magento/Framework/Exception/EmailNotConfirmedException.php @@ -6,7 +6,7 @@ namespace Magento\Framework\Exception; /** - * Class EmailNotConfirmedException + * @api */ class EmailNotConfirmedException extends AuthenticationException { diff --git a/lib/internal/Magento/Framework/Exception/FileSystemException.php b/lib/internal/Magento/Framework/Exception/FileSystemException.php index eeae5728e5465..6c85314b6f2a6 100644 --- a/lib/internal/Magento/Framework/Exception/FileSystemException.php +++ b/lib/internal/Magento/Framework/Exception/FileSystemException.php @@ -7,6 +7,8 @@ /** * Magento filesystem exception + * + * @api */ class FileSystemException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/InputException.php b/lib/internal/Magento/Framework/Exception/InputException.php index bb62ea80d0149..2dc3033be1da5 100644 --- a/lib/internal/Magento/Framework/Exception/InputException.php +++ b/lib/internal/Magento/Framework/Exception/InputException.php @@ -9,6 +9,8 @@ /** * Exception to be thrown when there is an issue with the Input to a function call. + * + * @api */ class InputException extends AbstractAggregateException { diff --git a/lib/internal/Magento/Framework/Exception/IntegrationException.php b/lib/internal/Magento/Framework/Exception/IntegrationException.php index b44349f2df51e..9adf9c740f0e2 100644 --- a/lib/internal/Magento/Framework/Exception/IntegrationException.php +++ b/lib/internal/Magento/Framework/Exception/IntegrationException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class IntegrationException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/InvalidEmailOrPasswordException.php b/lib/internal/Magento/Framework/Exception/InvalidEmailOrPasswordException.php index bb246972ab73b..ba5b7d94f5328 100644 --- a/lib/internal/Magento/Framework/Exception/InvalidEmailOrPasswordException.php +++ b/lib/internal/Magento/Framework/Exception/InvalidEmailOrPasswordException.php @@ -6,7 +6,7 @@ namespace Magento\Framework\Exception; /** - * Class InvalidEmailOrPasswordException + * @api */ class InvalidEmailOrPasswordException extends AuthenticationException { diff --git a/lib/internal/Magento/Framework/Exception/MailException.php b/lib/internal/Magento/Framework/Exception/MailException.php index 50197482992d8..1475ba04257c9 100644 --- a/lib/internal/Magento/Framework/Exception/MailException.php +++ b/lib/internal/Magento/Framework/Exception/MailException.php @@ -7,6 +7,8 @@ /** * Magento mail exception + * + * @api */ class MailException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/NoSuchEntityException.php b/lib/internal/Magento/Framework/Exception/NoSuchEntityException.php index 6fd875537c7ff..6e160c6ec6da2 100644 --- a/lib/internal/Magento/Framework/Exception/NoSuchEntityException.php +++ b/lib/internal/Magento/Framework/Exception/NoSuchEntityException.php @@ -9,6 +9,9 @@ use Magento\Framework\Phrase; +/** + * @api + */ class NoSuchEntityException extends LocalizedException { /** diff --git a/lib/internal/Magento/Framework/Exception/NotFoundException.php b/lib/internal/Magento/Framework/Exception/NotFoundException.php index 82dc660916349..40e02e70fa37c 100644 --- a/lib/internal/Magento/Framework/Exception/NotFoundException.php +++ b/lib/internal/Magento/Framework/Exception/NotFoundException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class NotFoundException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/PaymentException.php b/lib/internal/Magento/Framework/Exception/PaymentException.php index b0be0cb08b043..83b189d020ee3 100644 --- a/lib/internal/Magento/Framework/Exception/PaymentException.php +++ b/lib/internal/Magento/Framework/Exception/PaymentException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class PaymentException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/Exception/Plugin/AuthenticationException.php b/lib/internal/Magento/Framework/Exception/Plugin/AuthenticationException.php index 96910124c1301..2a5564181d43f 100644 --- a/lib/internal/Magento/Framework/Exception/Plugin/AuthenticationException.php +++ b/lib/internal/Magento/Framework/Exception/Plugin/AuthenticationException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception\Plugin; +/** + * @api + */ class AuthenticationException extends \Magento\Framework\Exception\AuthenticationException { } diff --git a/lib/internal/Magento/Framework/Exception/RemoteServiceUnavailableException.php b/lib/internal/Magento/Framework/Exception/RemoteServiceUnavailableException.php index 4846a1a3d5442..a9af31b003333 100644 --- a/lib/internal/Magento/Framework/Exception/RemoteServiceUnavailableException.php +++ b/lib/internal/Magento/Framework/Exception/RemoteServiceUnavailableException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class RemoteServiceUnavailableException extends AuthenticationException { } diff --git a/lib/internal/Magento/Framework/Exception/SecurityViolationException.php b/lib/internal/Magento/Framework/Exception/SecurityViolationException.php index 8a7b73093a560..246548149c749 100644 --- a/lib/internal/Magento/Framework/Exception/SecurityViolationException.php +++ b/lib/internal/Magento/Framework/Exception/SecurityViolationException.php @@ -7,6 +7,8 @@ /** * Exception for Security violation cases + * + * @api */ class SecurityViolationException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/SerializationException.php b/lib/internal/Magento/Framework/Exception/SerializationException.php index ed1e00d9095a4..5346425a9b545 100644 --- a/lib/internal/Magento/Framework/Exception/SerializationException.php +++ b/lib/internal/Magento/Framework/Exception/SerializationException.php @@ -9,6 +9,8 @@ /** * Serialization Exception + * + * @api */ class SerializationException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/SessionException.php b/lib/internal/Magento/Framework/Exception/SessionException.php index 4f4fd19b7d5d7..b3af3ea5b5bb0 100644 --- a/lib/internal/Magento/Framework/Exception/SessionException.php +++ b/lib/internal/Magento/Framework/Exception/SessionException.php @@ -7,6 +7,8 @@ /** * Session exception + * + * @api */ class SessionException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/State/ExpiredException.php b/lib/internal/Magento/Framework/Exception/State/ExpiredException.php index fc4d82ace23b8..29748b52c8351 100644 --- a/lib/internal/Magento/Framework/Exception/State/ExpiredException.php +++ b/lib/internal/Magento/Framework/Exception/State/ExpiredException.php @@ -9,6 +9,9 @@ use Magento\Framework\Exception\StateException; +/** + * @api + */ class ExpiredException extends StateException { } diff --git a/lib/internal/Magento/Framework/Exception/State/InitException.php b/lib/internal/Magento/Framework/Exception/State/InitException.php index 05c0ac2d4e091..8a2ec8b742979 100644 --- a/lib/internal/Magento/Framework/Exception/State/InitException.php +++ b/lib/internal/Magento/Framework/Exception/State/InitException.php @@ -9,6 +9,8 @@ /** * An exception that indicates application initialization error + * + * @api */ class InitException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/State/InputMismatchException.php b/lib/internal/Magento/Framework/Exception/State/InputMismatchException.php index 07a2230ccad55..752ebcf4804b1 100644 --- a/lib/internal/Magento/Framework/Exception/State/InputMismatchException.php +++ b/lib/internal/Magento/Framework/Exception/State/InputMismatchException.php @@ -9,6 +9,9 @@ use Magento\Framework\Exception\StateException; +/** + * @api + */ class InputMismatchException extends StateException { } diff --git a/lib/internal/Magento/Framework/Exception/State/InvalidTransitionException.php b/lib/internal/Magento/Framework/Exception/State/InvalidTransitionException.php index 1ae498748cde3..2667d1745767e 100644 --- a/lib/internal/Magento/Framework/Exception/State/InvalidTransitionException.php +++ b/lib/internal/Magento/Framework/Exception/State/InvalidTransitionException.php @@ -9,6 +9,9 @@ use Magento\Framework\Exception\StateException; +/** + * @api + */ class InvalidTransitionException extends StateException { } diff --git a/lib/internal/Magento/Framework/Exception/State/UserLockedException.php b/lib/internal/Magento/Framework/Exception/State/UserLockedException.php index ef1987aa38ebd..fa39556f6eecc 100644 --- a/lib/internal/Magento/Framework/Exception/State/UserLockedException.php +++ b/lib/internal/Magento/Framework/Exception/State/UserLockedException.php @@ -7,6 +7,9 @@ use Magento\Framework\Exception\AuthenticationException; +/** + * @api + */ class UserLockedException extends AuthenticationException { } diff --git a/lib/internal/Magento/Framework/Exception/StateException.php b/lib/internal/Magento/Framework/Exception/StateException.php index 3d797e7a1d0e6..580ef6fabe2fa 100644 --- a/lib/internal/Magento/Framework/Exception/StateException.php +++ b/lib/internal/Magento/Framework/Exception/StateException.php @@ -7,6 +7,8 @@ /** * State Exception + * + * @api */ class StateException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Exception/TemporaryState/CouldNotSaveException.php b/lib/internal/Magento/Framework/Exception/TemporaryState/CouldNotSaveException.php index 0ac6a350af6a7..d8ce8dee035db 100644 --- a/lib/internal/Magento/Framework/Exception/TemporaryState/CouldNotSaveException.php +++ b/lib/internal/Magento/Framework/Exception/TemporaryState/CouldNotSaveException.php @@ -11,6 +11,8 @@ /** * CouldNotSaveException caused by recoverable error + * + * @api */ class CouldNotSaveException extends LocalizedCouldNotSaveException implements TemporaryStateExceptionInterface { diff --git a/lib/internal/Magento/Framework/Exception/ValidatorException.php b/lib/internal/Magento/Framework/Exception/ValidatorException.php index 8575271ea6134..1066fe268df44 100644 --- a/lib/internal/Magento/Framework/Exception/ValidatorException.php +++ b/lib/internal/Magento/Framework/Exception/ValidatorException.php @@ -5,6 +5,9 @@ */ namespace Magento\Framework\Exception; +/** + * @api + */ class ValidatorException extends LocalizedException { } diff --git a/lib/internal/Magento/Framework/File/Uploader.php b/lib/internal/Magento/Framework/File/Uploader.php index f4b7f1fa50109..f95ad96cec822 100644 --- a/lib/internal/Magento/Framework/File/Uploader.php +++ b/lib/internal/Magento/Framework/File/Uploader.php @@ -13,7 +13,7 @@ * ATTENTION! This class must be used like abstract class and must added * validation by protected file extension list to extended class * - * @author Magento Core Team + * @api */ class Uploader { diff --git a/lib/internal/Magento/Framework/Mview/View/ChangelogTableNotExistsException.php b/lib/internal/Magento/Framework/Mview/View/ChangelogTableNotExistsException.php index 8b5dc94c16d57..96e4d6efd52b9 100644 --- a/lib/internal/Magento/Framework/Mview/View/ChangelogTableNotExistsException.php +++ b/lib/internal/Magento/Framework/Mview/View/ChangelogTableNotExistsException.php @@ -9,8 +9,7 @@ use Magento\Framework\Exception\LocalizedException; /** - * Class ChangelogTableNotExistsException - * @package Magento\Framework\Mview\View + * @api */ class ChangelogTableNotExistsException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Oauth/Exception.php b/lib/internal/Magento/Framework/Oauth/Exception.php index 729582894e7ef..6e6753654fdd2 100644 --- a/lib/internal/Magento/Framework/Oauth/Exception.php +++ b/lib/internal/Magento/Framework/Oauth/Exception.php @@ -8,7 +8,9 @@ use Magento\Framework\Exception\AuthenticationException; /** - * OAuth \Exception + * OAuth Exception + * + * @api */ class Exception extends AuthenticationException { diff --git a/lib/internal/Magento/Framework/Oauth/OauthInputException.php b/lib/internal/Magento/Framework/Oauth/OauthInputException.php index 301154dcb986f..1c526dd220f25 100644 --- a/lib/internal/Magento/Framework/Oauth/OauthInputException.php +++ b/lib/internal/Magento/Framework/Oauth/OauthInputException.php @@ -9,7 +9,7 @@ use Magento\Framework\Exception\InputException; /** - * OAuth \OAuthInputException + * @api */ class OauthInputException extends InputException { diff --git a/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php b/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php index 7ab2cb0dce6e9..ef0a3d233e387 100644 --- a/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php +++ b/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php @@ -15,6 +15,8 @@ /** * Data object processor for array serialization using class reflection + * + * @api */ class DataObjectProcessor { diff --git a/lib/internal/Magento/Framework/ShellInterface.php b/lib/internal/Magento/Framework/ShellInterface.php index e821ce013db95..96607b8a072af 100644 --- a/lib/internal/Magento/Framework/ShellInterface.php +++ b/lib/internal/Magento/Framework/ShellInterface.php @@ -7,6 +7,8 @@ /** * Shell command line wrapper encapsulates command execution and arguments escaping + * + * @api */ interface ShellInterface { diff --git a/lib/internal/Magento/Framework/Validator/Exception.php b/lib/internal/Magento/Framework/Validator/Exception.php index b84c5c336cd5d..0e245b2a4a7e9 100644 --- a/lib/internal/Magento/Framework/Validator/Exception.php +++ b/lib/internal/Magento/Framework/Validator/Exception.php @@ -13,7 +13,9 @@ use Magento\Framework\Message\Error; /** - * Exception to be thrown when an validation data is failed + * Exception to be thrown when data validation fails + * + * @api */ class Exception extends InputException { diff --git a/lib/internal/Magento/Framework/View/Asset/ContentProcessorException.php b/lib/internal/Magento/Framework/View/Asset/ContentProcessorException.php index 2300b5d6a0191..86daba29e5be8 100644 --- a/lib/internal/Magento/Framework/View/Asset/ContentProcessorException.php +++ b/lib/internal/Magento/Framework/View/Asset/ContentProcessorException.php @@ -8,7 +8,7 @@ use Magento\Framework\Exception\LocalizedException; /** - * Class ContentProcessorException + * @api */ class ContentProcessorException extends LocalizedException { diff --git a/lib/internal/Magento/Framework/Webapi/Authorization.php b/lib/internal/Magento/Framework/Webapi/Authorization.php index 52cce19ce1f6c..8cad2996fd874 100644 --- a/lib/internal/Magento/Framework/Webapi/Authorization.php +++ b/lib/internal/Magento/Framework/Webapi/Authorization.php @@ -7,6 +7,8 @@ /** * Web API authorization model. + * + * @api */ class Authorization { diff --git a/lib/internal/Magento/Framework/Webapi/ErrorProcessor.php b/lib/internal/Magento/Framework/Webapi/ErrorProcessor.php index 184b48374bc0c..4b69e822ea169 100644 --- a/lib/internal/Magento/Framework/Webapi/ErrorProcessor.php +++ b/lib/internal/Magento/Framework/Webapi/ErrorProcessor.php @@ -21,6 +21,7 @@ * Helper for errors processing. * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class ErrorProcessor { diff --git a/lib/internal/Magento/Framework/Webapi/Exception.php b/lib/internal/Magento/Framework/Webapi/Exception.php index 46f163f595558..01a9848c63282 100644 --- a/lib/internal/Magento/Framework/Webapi/Exception.php +++ b/lib/internal/Magento/Framework/Webapi/Exception.php @@ -11,6 +11,12 @@ use Magento\Framework\Exception\LocalizedException; use Magento\Framework\Phrase; +/** + * Web API exception should not be used directly by any modules except for Magento_Webapi. + * + * During web API requests, all exceptions are converted to this exception, + * which is then used for proper error response generation. + */ class Exception extends LocalizedException { /**#@+ diff --git a/lib/internal/Magento/Framework/Webapi/Rest/Request/ParamOverriderInterface.php b/lib/internal/Magento/Framework/Webapi/Rest/Request/ParamOverriderInterface.php index 59b380c37493a..21741a2c16c1d 100644 --- a/lib/internal/Magento/Framework/Webapi/Rest/Request/ParamOverriderInterface.php +++ b/lib/internal/Magento/Framework/Webapi/Rest/Request/ParamOverriderInterface.php @@ -25,6 +25,8 @@ * ParamOverriderCustomerId would return the current authenticated user's customer id. If you * create new ParamOverriderInterface implementations, you can register new implementations by * adding to the parameter list for ParamsOverrider's dependency injection configuration. + * + * @api */ interface ParamOverriderInterface { diff --git a/lib/internal/Magento/Framework/Webapi/Rest/Response/RendererInterface.php b/lib/internal/Magento/Framework/Webapi/Rest/Response/RendererInterface.php index 1deda6ae4edf0..9d905ce599779 100644 --- a/lib/internal/Magento/Framework/Webapi/Rest/Response/RendererInterface.php +++ b/lib/internal/Magento/Framework/Webapi/Rest/Response/RendererInterface.php @@ -7,6 +7,11 @@ */ namespace Magento\Framework\Webapi\Rest\Response; +/** + * Renderer interface allows REST response data rendering in a specific format (e.g. Json or Xml) + * + * @api + */ interface RendererInterface { /** diff --git a/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php b/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php index d0ed69bfdadd6..bd930a3d3829e 100644 --- a/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php +++ b/lib/internal/Magento/Framework/Webapi/ServiceInputProcessor.php @@ -23,6 +23,7 @@ * Deserialize arguments from API requests. * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) + * @api */ class ServiceInputProcessor implements ServicePayloadConverterInterface { diff --git a/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php b/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php index 61705c7561fcf..d8e1a3de3670a 100644 --- a/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php +++ b/lib/internal/Magento/Framework/Webapi/ServiceOutputProcessor.php @@ -12,7 +12,9 @@ use Magento\Framework\Webapi\ServicePayloadConverterInterface; /** - * Data object converter for REST + * Data object converter + * + * @api */ class ServiceOutputProcessor implements ServicePayloadConverterInterface { diff --git a/lib/internal/Magento/Framework/Webapi/ServicePayloadConverterInterface.php b/lib/internal/Magento/Framework/Webapi/ServicePayloadConverterInterface.php index aa782a18859c3..30f93efdb9ef9 100644 --- a/lib/internal/Magento/Framework/Webapi/ServicePayloadConverterInterface.php +++ b/lib/internal/Magento/Framework/Webapi/ServicePayloadConverterInterface.php @@ -9,6 +9,8 @@ /** * Interface for data conversion based on data type. + * + * @api */ interface ServicePayloadConverterInterface {