diff --git a/app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php b/app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php index fcd1243ffa9d1..3c18c5b37633e 100644 --- a/app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php +++ b/app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php @@ -10,8 +10,6 @@ /** * Adminhtml dashboard tab abstract - * - * @author Magento Core Team */ abstract class AbstractDashboard extends \Magento\Backend\Block\Widget { @@ -40,6 +38,8 @@ public function __construct( } /** + * Return a collection + * * @return array|AbstractCollection|\Magento\Eav\Model\Entity\Collection\Abstract */ public function getCollection() @@ -48,6 +48,8 @@ public function getCollection() } /** + * Return items count + * * @return int */ public function getCount() @@ -66,6 +68,8 @@ public function getDataHelper() } /** + * Prepare any data for display, if required + * * @return $this */ protected function _prepareData() @@ -74,6 +78,8 @@ protected function _prepareData() } /** + * Ensure data is prepared before layout + * * @return $this */ protected function _prepareLayout() diff --git a/app/code/Magento/Backend/Block/Dashboard/Bar.php b/app/code/Magento/Backend/Block/Dashboard/Bar.php index 65c0aa961edf6..0b39e6e9dd7a4 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Bar.php +++ b/app/code/Magento/Backend/Block/Dashboard/Bar.php @@ -10,8 +10,6 @@ /** * Adminhtml dashboard bar block - * - * @author Magento Core Team */ class Bar extends \Magento\Backend\Block\Dashboard\AbstractDashboard { diff --git a/app/code/Magento/Backend/Block/Dashboard/Diagrams.php b/app/code/Magento/Backend/Block/Dashboard/Diagrams.php index 7ebb81e3e2fbf..944b5ed31a740 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Diagrams.php +++ b/app/code/Magento/Backend/Block/Dashboard/Diagrams.php @@ -9,8 +9,6 @@ * Adminhtml dashboard diagram tabs * @deprecated dashboard graphs were migrated to dynamic chart.js solution * @see dashboard.diagrams in adminhtml_dashboard_index.xml - * - * @author Magento Core Team */ class Diagrams extends \Magento\Backend\Block\Widget\Tabs { diff --git a/app/code/Magento/Backend/Block/Dashboard/Graph.php b/app/code/Magento/Backend/Block/Dashboard/Graph.php index 7811ee948f763..fde2b3b49b7f6 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Graph.php +++ b/app/code/Magento/Backend/Block/Dashboard/Graph.php @@ -11,37 +11,27 @@ * Adminhtml dashboard google chart block * @deprecated dashboard graphs were migrated to dynamic chart.js solution * @see dashboard.chart.amounts and dashboard.chart.orders in adminhtml_dashboard_index.xml - * - * @author Magento Core Team */ class Graph extends \Magento\Backend\Block\Dashboard\AbstractDashboard { - const API_URL = 'https://image-charts.com/chart'; + public const API_URL = 'https://image-charts.com/chart'; /** - * All series - * * @var array */ protected $_allSeries = []; /** - * Axis labels - * * @var array */ protected $_axisLabels = []; /** - * Axis maps - * * @var array */ protected $_axisMaps = []; /** - * Data rows - * * @var array */ protected $_dataRows = []; @@ -78,6 +68,7 @@ class Graph extends \Magento\Backend\Block\Dashboard\AbstractDashboard * Google chart api data encoding * * @deprecated 101.0.2 since the Google Image Charts API not accessible from March 14, 2019 + * @see Nothing * @var string */ protected $_encoding = 'e'; diff --git a/app/code/Magento/Backend/Block/Dashboard/Grid.php b/app/code/Magento/Backend/Block/Dashboard/Grid.php index f7f9a79f17eb0..9c4cc6269b66d 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Grid.php +++ b/app/code/Magento/Backend/Block/Dashboard/Grid.php @@ -8,7 +8,6 @@ /** * Adminhtml dashboard grid * - * @author Magento Core Team * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Block/Dashboard/Grids.php b/app/code/Magento/Backend/Block/Dashboard/Grids.php index 9820d8b868d86..2e919e88013b7 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Grids.php +++ b/app/code/Magento/Backend/Block/Dashboard/Grids.php @@ -14,7 +14,6 @@ * Adminhtml dashboard bottom tabs * * @api - * @author Magento Core Team * @since 100.0.2 */ class Grids extends Tabs diff --git a/app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php b/app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php index dd21a215ea6fe..ea25822320203 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php +++ b/app/code/Magento/Backend/Block/Dashboard/Orders/Grid.php @@ -14,7 +14,6 @@ * Adminhtml dashboard recent orders grid * * @api - * @author Magento Core Team * @SuppressWarnings(PHPMD.DepthOfInheritance) * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Block/Dashboard/Sales.php b/app/code/Magento/Backend/Block/Dashboard/Sales.php index 098580b1369e9..2e58d7edd1424 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Sales.php +++ b/app/code/Magento/Backend/Block/Dashboard/Sales.php @@ -15,7 +15,6 @@ * Adminhtml dashboard sales statistics bar * * @api - * @author Magento Core Team * @since 100.0.2 */ class Sales extends Bar diff --git a/app/code/Magento/Backend/Block/Dashboard/Tab/Amounts.php b/app/code/Magento/Backend/Block/Dashboard/Tab/Amounts.php index 26243891fa007..1dbfee48e03ac 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Tab/Amounts.php +++ b/app/code/Magento/Backend/Block/Dashboard/Tab/Amounts.php @@ -10,8 +10,6 @@ * Adminhtml dashboard order amounts diagram * @deprecated dashboard graphs were migrated to dynamic chart.js solution * @see dashboard.chart.amounts in adminhtml_dashboard_index.xml - * - * @author Magento Core Team */ class Amounts extends \Magento\Backend\Block\Dashboard\Graph { diff --git a/app/code/Magento/Backend/Block/Dashboard/Tab/Orders.php b/app/code/Magento/Backend/Block/Dashboard/Tab/Orders.php index f88e6bb694671..a5cfadbc7c507 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Tab/Orders.php +++ b/app/code/Magento/Backend/Block/Dashboard/Tab/Orders.php @@ -10,8 +10,6 @@ * Adminhtml dashboard orders diagram * @deprecated dashboard graphs were migrated to dynamic chart.js solution * @see dashboard.chart.orders in adminhtml_dashboard_index.xml - * - * @author Magento Core Team */ class Orders extends \Magento\Backend\Block\Dashboard\Graph { diff --git a/app/code/Magento/Backend/Block/Dashboard/Tab/Products/Ordered.php b/app/code/Magento/Backend/Block/Dashboard/Tab/Products/Ordered.php index a0b1571bd17bb..68e5b8ba1c4ea 100644 --- a/app/code/Magento/Backend/Block/Dashboard/Tab/Products/Ordered.php +++ b/app/code/Magento/Backend/Block/Dashboard/Tab/Products/Ordered.php @@ -8,7 +8,6 @@ /** * Adminhtml dashboard most ordered products grid * - * @author Magento Core Team * @SuppressWarnings(PHPMD.DepthOfInheritance) */ class Ordered extends \Magento\Backend\Block\Dashboard\Grid diff --git a/app/code/Magento/Backend/Block/Page.php b/app/code/Magento/Backend/Block/Page.php index 6c9bb15417c90..c9e29eedf729d 100644 --- a/app/code/Magento/Backend/Block/Page.php +++ b/app/code/Magento/Backend/Block/Page.php @@ -6,8 +6,6 @@ /** * Adminhtml page - * - * @author Magento Core Team */ namespace Magento\Backend\Block; @@ -62,6 +60,8 @@ public function getLang() } /** + * Returns true if we are running in single store mode + * * @return bool */ public function isSingleStoreMode() diff --git a/app/code/Magento/Backend/Block/Page/Footer.php b/app/code/Magento/Backend/Block/Page/Footer.php index 610d28b0f53e3..bf776e518a44f 100644 --- a/app/code/Magento/Backend/Block/Page/Footer.php +++ b/app/code/Magento/Backend/Block/Page/Footer.php @@ -9,7 +9,6 @@ * Adminhtml footer block * * @api - * @author Magento Core Team * @since 100.0.2 */ class Footer extends \Magento\Backend\Block\Template diff --git a/app/code/Magento/Backend/Block/Page/Header.php b/app/code/Magento/Backend/Block/Page/Header.php index c2c5f7472b370..b4e41895c3bd1 100644 --- a/app/code/Magento/Backend/Block/Page/Header.php +++ b/app/code/Magento/Backend/Block/Page/Header.php @@ -10,7 +10,6 @@ * Adminhtml header block * * @api - * @author Magento Core Team * @since 100.0.2 */ class Header extends \Magento\Backend\Block\Template @@ -21,8 +20,6 @@ class Header extends \Magento\Backend\Block\Template protected $_template = 'Magento_Backend::page/header.phtml'; /** - * Backend data - * * @var \Magento\Backend\Helper\Data */ protected $_backendData = null; @@ -50,6 +47,8 @@ public function __construct( } /** + * Return URL to homepage + * * @return string */ public function getHomeLink() @@ -58,6 +57,8 @@ public function getHomeLink() } /** + * Return the current user + * * @return \Magento\User\Model\User|null */ public function getUser() @@ -66,6 +67,8 @@ public function getUser() } /** + * Return URL to log out from admin + * * @return string */ public function getLogoutLink() diff --git a/app/code/Magento/Backend/Block/Page/Notices.php b/app/code/Magento/Backend/Block/Page/Notices.php index d34b50d21f933..da25fd4944750 100644 --- a/app/code/Magento/Backend/Block/Page/Notices.php +++ b/app/code/Magento/Backend/Block/Page/Notices.php @@ -6,8 +6,6 @@ /** * Adminhtml header notices block - * - * @author Magento Core Team */ namespace Magento\Backend\Block\Page; diff --git a/app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php b/app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php index d290b89b2a6bc..ec783004e5d43 100644 --- a/app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php +++ b/app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php @@ -12,25 +12,15 @@ * "Reset to Defaults" button renderer * * @deprecated 100.1.6 - * @author Magento Core Team + * @see Nothing */ class Reset extends \Magento\Config\Block\System\Config\Form\Field { /** - * Pasge robots default instructions + * Page robots default instructions */ - const XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS = 'design/search_engine_robots/default_custom_instructions'; - - /** - * @param \Magento\Backend\Block\Template\Context $context - * @param array $data - */ - public function __construct( - \Magento\Backend\Block\Template\Context $context, - array $data = [] - ) { - parent::__construct($context, $data); - } + public const XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS = + 'design/search_engine_robots/default_custom_instructions'; /** * Set template diff --git a/app/code/Magento/Backend/Block/System/Account/Edit.php b/app/code/Magento/Backend/Block/System/Account/Edit.php index f12c1f4211417..baea47683602d 100644 --- a/app/code/Magento/Backend/Block/System/Account/Edit.php +++ b/app/code/Magento/Backend/Block/System/Account/Edit.php @@ -9,12 +9,13 @@ * Adminhtml edit admin user account * * @api - * @author Magento Core Team * @since 100.0.2 */ class Edit extends \Magento\Backend\Block\Widget\Form\Container { /** + * Initialise the page + * * @return void */ protected function _construct() @@ -29,6 +30,8 @@ protected function _construct() } /** + * Return a Phrase for the header text + * * @return \Magento\Framework\Phrase */ public function getHeaderText() diff --git a/app/code/Magento/Backend/Block/System/Account/Edit/Form.php b/app/code/Magento/Backend/Block/System/Account/Edit/Form.php index effd0f214a144..f95d3ebfdda58 100644 --- a/app/code/Magento/Backend/Block/System/Account/Edit/Form.php +++ b/app/code/Magento/Backend/Block/System/Account/Edit/Form.php @@ -10,7 +10,6 @@ /** * Adminhtml edit admin user account form - * */ class Form extends \Magento\Backend\Block\Widget\Form\Generic { diff --git a/app/code/Magento/Backend/Block/System/Cache/Edit.php b/app/code/Magento/Backend/Block/System/Cache/Edit.php index be4de93460131..7ec8e224ad692 100644 --- a/app/code/Magento/Backend/Block/System/Cache/Edit.php +++ b/app/code/Magento/Backend/Block/System/Cache/Edit.php @@ -7,8 +7,6 @@ /** * Cache management edit page - * - * @author Magento Core Team */ class Edit extends \Magento\Backend\Block\Widget { @@ -18,6 +16,8 @@ class Edit extends \Magento\Backend\Block\Widget protected $_template = 'Magento_Backend::system/cache/edit.phtml'; /** + * Set the page title + * * @return void */ protected function _construct() @@ -28,7 +28,7 @@ protected function _construct() } /** - * {@inheritdoc} + * @inheritDoc */ protected function _prepareLayout() { @@ -47,6 +47,8 @@ protected function _prepareLayout() } /** + * Return the HTML for the save button + * * @return string */ public function getSaveButtonHtml() @@ -55,6 +57,8 @@ public function getSaveButtonHtml() } /** + * Return the URL to save an item + * * @return string */ public function getSaveUrl() @@ -63,6 +67,8 @@ public function getSaveUrl() } /** + * Initialise the form + * * @return $this */ public function initForm() diff --git a/app/code/Magento/Backend/Block/System/Cache/Form.php b/app/code/Magento/Backend/Block/System/Cache/Form.php index a0f495c784d2e..fae6717d9c582 100644 --- a/app/code/Magento/Backend/Block/System/Cache/Form.php +++ b/app/code/Magento/Backend/Block/System/Cache/Form.php @@ -7,8 +7,6 @@ /** * Cache management form page - * - * @author Magento Core Team */ class Form extends \Magento\Backend\Block\Widget\Form\Generic { diff --git a/app/code/Magento/Backend/Block/System/Store/Delete.php b/app/code/Magento/Backend/Block/System/Store/Delete.php index 8d2cc4039aaf4..ed1fa716116f5 100644 --- a/app/code/Magento/Backend/Block/System/Store/Delete.php +++ b/app/code/Magento/Backend/Block/System/Store/Delete.php @@ -7,8 +7,6 @@ /** * Store / store view / website delete form container - * - * @author Magento Core Team */ class Delete extends \Magento\Backend\Block\Widget\Form\Container { diff --git a/app/code/Magento/Backend/Block/System/Store/Delete/Form.php b/app/code/Magento/Backend/Block/System/Store/Delete/Form.php index 47a156c16ce3e..39a622a9a3a29 100644 --- a/app/code/Magento/Backend/Block/System/Store/Delete/Form.php +++ b/app/code/Magento/Backend/Block/System/Store/Delete/Form.php @@ -10,8 +10,6 @@ /** * Adminhtml cms block edit form - * - * @author Magento Core Team */ class Form extends \Magento\Backend\Block\Widget\Form\Generic { diff --git a/app/code/Magento/Backend/Block/System/Store/Delete/Group.php b/app/code/Magento/Backend/Block/System/Store/Delete/Group.php index e95f3bbf9f8c1..14e383f9a1bf7 100644 --- a/app/code/Magento/Backend/Block/System/Store/Delete/Group.php +++ b/app/code/Magento/Backend/Block/System/Store/Delete/Group.php @@ -7,13 +7,11 @@ /** * Adminhtml store delete group block - * - * @author Magento Core Team */ class Group extends \Magento\Backend\Block\Template { /** - * {@inheritdoc} + * @inheritDoc */ protected function _prepareLayout() { diff --git a/app/code/Magento/Backend/Block/System/Store/Delete/Website.php b/app/code/Magento/Backend/Block/System/Store/Delete/Website.php index 82cbb780137b8..e29e4d9279b34 100644 --- a/app/code/Magento/Backend/Block/System/Store/Delete/Website.php +++ b/app/code/Magento/Backend/Block/System/Store/Delete/Website.php @@ -7,13 +7,11 @@ /** * Adminhtml store delete group block - * - * @author Magento Core Team */ class Website extends \Magento\Backend\Block\Template { /** - * {@inheritdoc} + * @inheritDoc */ protected function _prepareLayout() { diff --git a/app/code/Magento/Backend/Block/System/Store/Edit/AbstractForm.php b/app/code/Magento/Backend/Block/System/Store/Edit/AbstractForm.php index 034887c67d1ee..be86ecb9dd044 100644 --- a/app/code/Magento/Backend/Block/System/Store/Edit/AbstractForm.php +++ b/app/code/Magento/Backend/Block/System/Store/Edit/AbstractForm.php @@ -8,8 +8,6 @@ /** * Adminhtml store edit form * - * @author Magento Core Team - * * @SuppressWarnings(PHPMD.DepthOfInheritance) */ abstract class AbstractForm extends \Magento\Backend\Block\Widget\Form\Generic diff --git a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Group.php b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Group.php index c8d04cef86d05..4141e5567872e 100644 --- a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Group.php +++ b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Group.php @@ -8,8 +8,6 @@ /** * Adminhtml store edit form for group * - * @author Magento Core Team - * * @SuppressWarnings(PHPMD.DepthOfInheritance) */ class Group extends \Magento\Backend\Block\System\Store\Edit\AbstractForm diff --git a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Store.php b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Store.php index fee756b5d66be..7101f98c35672 100644 --- a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Store.php +++ b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Store.php @@ -11,8 +11,6 @@ /** * Adminhtml store edit form for store * - * @author Magento Core Team - * * @SuppressWarnings(PHPMD.DepthOfInheritance) */ class Store extends \Magento\Backend\Block\System\Store\Edit\AbstractForm diff --git a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Website.php b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Website.php index 545620d99c4c5..f6baae9a87a23 100644 --- a/app/code/Magento/Backend/Block/System/Store/Edit/Form/Website.php +++ b/app/code/Magento/Backend/Block/System/Store/Edit/Form/Website.php @@ -11,8 +11,6 @@ /** * Adminhtml store edit form for website * - * @author Magento Core Team - * * @SuppressWarnings(PHPMD.DepthOfInheritance) */ class Website extends \Magento\Backend\Block\System\Store\Edit\AbstractForm diff --git a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Group.php b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Group.php index 11cca3717ba20..c0b9122fe6e08 100644 --- a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Group.php +++ b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Group.php @@ -9,8 +9,6 @@ /** * Store render group - * - * @author Magento Core Team */ class Group extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer { diff --git a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Store.php b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Store.php index 9cfc8bfc52691..f5635e8ab8a47 100644 --- a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Store.php +++ b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Store.php @@ -7,13 +7,11 @@ /** * Store render store - * - * @author Magento Core Team */ class Store extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer { /** - * {@inheritdoc} + * @inheritDoc */ public function render(\Magento\Framework\DataObject $row) { diff --git a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Website.php b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Website.php index 487eb4f8acfda..8b2b87e21cc64 100644 --- a/app/code/Magento/Backend/Block/System/Store/Grid/Render/Website.php +++ b/app/code/Magento/Backend/Block/System/Store/Grid/Render/Website.php @@ -7,13 +7,11 @@ /** * Store render website - * - * @author Magento Core Team */ class Website extends \Magento\Backend\Block\Widget\Grid\Column\Renderer\AbstractRenderer { /** - * {@inheritdoc} + * @inheritDoc */ public function render(\Magento\Framework\DataObject $row) { diff --git a/app/code/Magento/Backend/Block/System/Store/Store.php b/app/code/Magento/Backend/Block/System/Store/Store.php index 63187ec024064..7d95cdce6681f 100644 --- a/app/code/Magento/Backend/Block/System/Store/Store.php +++ b/app/code/Magento/Backend/Block/System/Store/Store.php @@ -9,7 +9,6 @@ * Adminhtml store content block * * @api - * @author Magento Core Team * @since 100.0.2 */ class Store extends \Magento\Backend\Block\Widget\Grid\Container diff --git a/app/code/Magento/Backend/Block/Text/ListText.php b/app/code/Magento/Backend/Block/Text/ListText.php index 9f24239abdc88..12eba6329858b 100644 --- a/app/code/Magento/Backend/Block/Text/ListText.php +++ b/app/code/Magento/Backend/Block/Text/ListText.php @@ -6,8 +6,6 @@ /** * Adminhtml text list block - * - * @author Magento Core Team */ namespace Magento\Backend\Block\Text; diff --git a/app/code/Magento/Backend/Block/Widget/Accordion/Item.php b/app/code/Magento/Backend/Block/Widget/Accordion/Item.php index 4650609a58025..6c3162f64de6f 100644 --- a/app/code/Magento/Backend/Block/Widget/Accordion/Item.php +++ b/app/code/Magento/Backend/Block/Widget/Accordion/Item.php @@ -9,8 +9,6 @@ /** * Accordion item - * - * @author Magento Core Team */ class Item extends \Magento\Backend\Block\Widget { @@ -20,6 +18,8 @@ class Item extends \Magento\Backend\Block\Widget protected $_accordion; /** + * Set accordion objet and return self + * * @param Accordion $accordion * @return $this */ @@ -30,6 +30,8 @@ public function setAccordion($accordion) } /** + * Return the target for this item + * * @return string */ public function getTarget() @@ -38,6 +40,8 @@ public function getTarget() } /** + * Return the HTML title for this item + * * @return string */ public function getTitle() @@ -52,6 +56,8 @@ public function getTitle() } /** + * Return the HTML content for this item + * * @return null|string */ public function getContent() @@ -67,6 +73,8 @@ public function getContent() } /** + * Get the CSS class for this item + * * @return string */ public function getClass() @@ -79,6 +87,8 @@ public function getClass() } /** + * Return formatted HTML + * * @return string */ protected function _toHtml() diff --git a/app/code/Magento/Backend/Block/Widget/Breadcrumbs.php b/app/code/Magento/Backend/Block/Widget/Breadcrumbs.php index d85ee72365e32..1d1f13c553d88 100644 --- a/app/code/Magento/Backend/Block/Widget/Breadcrumbs.php +++ b/app/code/Magento/Backend/Block/Widget/Breadcrumbs.php @@ -9,7 +9,6 @@ * Magento_Backend page breadcrumbs * * @api - * @author Magento Core Team * @since 100.0.2 */ class Breadcrumbs extends \Magento\Backend\Block\Template @@ -27,6 +26,8 @@ class Breadcrumbs extends \Magento\Backend\Block\Template protected $_template = 'Magento_Backend::widget/breadcrumbs.phtml'; /** + * Add homepage to breadcrumbs + * * @return void */ protected function _construct() @@ -35,6 +36,8 @@ protected function _construct() } /** + * Add a link to the breadcrumbs + * * @param string $label * @param string|null $title * @param string|null $url @@ -48,14 +51,4 @@ public function addLink($label, $title = null, $url = null) $this->_links[] = ['label' => $label, 'title' => $title, 'url' => $url]; return $this; } - - /** - * {@inheritdoc} - */ - protected function _beforeToHtml() - { - // TODO - Moved to Beta 2, no breadcrumbs displaying in Beta 1 - // $this->assign('links', $this->_links); - return parent::_beforeToHtml(); - } } diff --git a/app/code/Magento/Backend/Block/Widget/Button.php b/app/code/Magento/Backend/Block/Widget/Button.php index 8194d4fcf7ae6..e67c87603bce7 100644 --- a/app/code/Magento/Backend/Block/Widget/Button.php +++ b/app/code/Magento/Backend/Block/Widget/Button.php @@ -14,7 +14,6 @@ * Button widget * * @api - * @author Magento Core Team * @since 100.0.2 */ class Button extends \Magento\Backend\Block\Widget diff --git a/app/code/Magento/Backend/Block/Widget/Form/Element.php b/app/code/Magento/Backend/Block/Widget/Form/Element.php index c3224d62b627e..db28cacdcf59c 100644 --- a/app/code/Magento/Backend/Block/Widget/Form/Element.php +++ b/app/code/Magento/Backend/Block/Widget/Form/Element.php @@ -9,8 +9,6 @@ /** * Form element widget block - * - * @author Magento Core Team */ class Element extends \Magento\Backend\Block\Template { @@ -35,6 +33,8 @@ class Element extends \Magento\Backend\Block\Template protected $_template = 'Magento_Backend::widget/form/element.phtml'; /** + * Set element and return self + * * @param string $element * @return $this */ @@ -45,6 +45,8 @@ public function setElement($element) } /** + * Set form and return self + * * @param Form $form * @return $this */ @@ -55,6 +57,8 @@ public function setForm($form) } /** + * Set form block and return self + * * @param \Magento\Framework\DataObject $formBlock * @return $this */ @@ -65,7 +69,7 @@ public function setFormBlock($formBlock) } /** - * {@inheritdoc} + * @inheritDoc */ protected function _beforeToHtml() { diff --git a/app/code/Magento/Backend/Block/Widget/Form/Element/Gallery.php b/app/code/Magento/Backend/Block/Widget/Form/Element/Gallery.php index 25ea5b6100e28..934e6a83102f0 100644 --- a/app/code/Magento/Backend/Block/Widget/Form/Element/Gallery.php +++ b/app/code/Magento/Backend/Block/Widget/Form/Element/Gallery.php @@ -13,8 +13,6 @@ /** * Backend image gallery item renderer - * - * @author Magento Core Team */ class Gallery extends \Magento\Backend\Block\Template implements \Magento\Framework\Data\Form\Element\Renderer\RendererInterface diff --git a/app/code/Magento/Backend/Block/Widget/Form/Renderer/Fieldset.php b/app/code/Magento/Backend/Block/Widget/Form/Renderer/Fieldset.php index 99a931d0f6b75..a31ee9cac15c4 100644 --- a/app/code/Magento/Backend/Block/Widget/Form/Renderer/Fieldset.php +++ b/app/code/Magento/Backend/Block/Widget/Form/Renderer/Fieldset.php @@ -13,7 +13,6 @@ * Form fieldset default renderer * * @api - * @author Magento Core Team * @since 100.0.2 */ class Fieldset extends \Magento\Backend\Block\Template implements RendererInterface diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Checkbox.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Checkbox.php index 6ba8c37b0e4a8..02e3077b217ed 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Checkbox.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Checkbox.php @@ -7,12 +7,12 @@ /** * Checkbox grid column filter - * - * @author Magento Core Team */ class Checkbox extends \Magento\Backend\Block\Widget\Grid\Column\Filter\Select { /** + * Return formatted HTML + * * @return string */ public function getHtml() @@ -21,6 +21,8 @@ public function getHtml() } /** + * Return an array of options + * * @return array */ protected function _getOptions() @@ -33,6 +35,8 @@ protected function _getOptions() } /** + * Return expression for SQL 'where' clause + * * @return array */ public function getCondition() @@ -42,6 +46,5 @@ public function getCondition() } else { return [['neq' => $this->getColumn()->getValue()], ['is' => new \Zend_Db_Expr('NULL')]]; } - // return array('like'=>'%'.$this->getValue().'%'); } } diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php index c0c01c6201ce0..23703036b4557 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Datetime.php @@ -9,7 +9,6 @@ /** * Date grid column filter * - * @author Magento Core Team * @todo date format */ class Datetime extends \Magento\Backend\Block\Widget\Grid\Column\Filter\Date diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Massaction.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Massaction.php index 9da793dc9fc61..989192dbf6b31 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Massaction.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Massaction.php @@ -7,13 +7,11 @@ /** * Massaction grid column filter - * - * @author Magento Core Team */ class Massaction extends \Magento\Backend\Block\Widget\Grid\Column\Filter\Checkbox { /** - * {@inheritdoc} + * @inheritDoc */ public function getCondition() { diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Price.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Price.php index 40106833b6a9a..825ec5884a72a 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Price.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Price.php @@ -8,8 +8,6 @@ /** * Range grid column filter * - * @author Magento Core Team - * * @SuppressWarnings(PHPMD.CouplingBetweenObjects) */ class Price extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Radio.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Radio.php index 479a2b6b20293..453b679739eac 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Radio.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Radio.php @@ -7,12 +7,12 @@ /** * Checkbox grid column filter - * - * @author Magento Core Team */ class Radio extends \Magento\Backend\Block\Widget\Grid\Column\Filter\Select { /** + * Return array of options + * * @return array */ protected function _getOptions() @@ -25,7 +25,7 @@ protected function _getOptions() } /** - * {@inheritdoc} + * @inheritDoc */ public function getCondition() { diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Range.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Range.php index 5c7793b6312a7..05b1a7dd74cd2 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Range.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Range.php @@ -6,8 +6,6 @@ /** * Range grid column filter - * - * @author Magento Core Team */ namespace Magento\Backend\Block\Widget\Grid\Column\Filter; @@ -18,6 +16,8 @@ class Range extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter { /** + * Return formatted HTML + * * @return string */ public function getHtml() @@ -56,6 +56,8 @@ public function getHtml() } /** + * Return the value at the specified index + * * @param string|null $index * @return mixed */ @@ -72,7 +74,7 @@ public function getValue($index = null) } /** - * {@inheritdoc} + * @inheritDoc */ public function getCondition() { diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/SkipList.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/SkipList.php index 4256732a1f258..3b0a9936d0fe2 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/SkipList.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/SkipList.php @@ -7,13 +7,11 @@ /** * Massaction grid column filter - * - * @author Magento Core Team */ class SkipList extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter { /** - * {@inheritdoc} + * @inheritDoc */ public function getCondition() { diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Text.php b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Text.php index 0cc6a852ef1e6..216477357f086 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Text.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Column/Filter/Text.php @@ -8,14 +8,13 @@ /** * Text grid column filter * - * @author Magento Core Team * @api * @since 100.0.2 */ class Text extends \Magento\Backend\Block\Widget\Grid\Column\Filter\AbstractFilter { /** - * {@inheritdoc} + * @inheritDoc */ public function getHtml() { diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Extended.php b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Extended.php index 28200323a3aec..8c1cb36c21dd9 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Extended.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Extended.php @@ -13,9 +13,9 @@ * * @api * @deprecated 100.2.0 in favour of UI component implementation + * @see Nothing * @method \Magento\Quote\Model\Quote setHideFormElement(boolean $value) Hide Form element to prevent IE errors * @method boolean getHideFormElement() - * @author Magento Core Team * @TODO MAGETWO-31510: Remove deprecated class * @since 100.0.2 */ @@ -36,8 +36,6 @@ class Extended extends \Magento\Backend\Block\Widget protected $_template = 'Magento_Backend::widget/grid/massaction_extended.phtml'; /** - * Backend data - * * @var \Magento\Backend\Helper\Data */ protected $_backendData = null; diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/AdditionalInterface.php b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/AdditionalInterface.php index eb35f14d43fda..316d53e591c31 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/AdditionalInterface.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/AdditionalInterface.php @@ -8,7 +8,6 @@ /** * Backend grid widget massaction item additional action interface * - * @author Magento Core Team * @api */ interface AdditionalInterface diff --git a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/DefaultAdditional.php b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/DefaultAdditional.php index be7bd4105a373..11fc7fa56b678 100644 --- a/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/DefaultAdditional.php +++ b/app/code/Magento/Backend/Block/Widget/Grid/Massaction/Item/Additional/DefaultAdditional.php @@ -7,14 +7,12 @@ /** * Backend grid widget massaction item additional action default - * - * @author Magento Core Team */ class DefaultAdditional extends \Magento\Backend\Block\Widget\Form\Generic implements \Magento\Backend\Block\Widget\Grid\Massaction\Item\Additional\AdditionalInterface { /** - * {@inheritdoc} + * @inheritDoc */ public function createFromConfiguration(array $configuration) { diff --git a/app/code/Magento/Backend/Controller/Adminhtml/Dashboard.php b/app/code/Magento/Backend/Controller/Adminhtml/Dashboard.php index 9fb3a27190428..84129b6c53be0 100644 --- a/app/code/Magento/Backend/Controller/Adminhtml/Dashboard.php +++ b/app/code/Magento/Backend/Controller/Adminhtml/Dashboard.php @@ -6,8 +6,6 @@ /** * Dashboard admin controller - * - * @author Magento Core Team */ namespace Magento\Backend\Controller\Adminhtml; @@ -18,5 +16,5 @@ abstract class Dashboard extends \Magento\Backend\App\Action * * @see _isAllowed() */ - const ADMIN_RESOURCE = 'Magento_Backend::dashboard'; + public const ADMIN_RESOURCE = 'Magento_Backend::dashboard'; } diff --git a/app/code/Magento/Backend/Controller/Adminhtml/System.php b/app/code/Magento/Backend/Controller/Adminhtml/System.php index ce7bd87cb95d5..506ef106837ad 100644 --- a/app/code/Magento/Backend/Controller/Adminhtml/System.php +++ b/app/code/Magento/Backend/Controller/Adminhtml/System.php @@ -9,8 +9,6 @@ /** * System admin controller - * - * @author Magento Core Team */ abstract class System extends AbstractAction { @@ -19,5 +17,5 @@ abstract class System extends AbstractAction * * @see _isAllowed() */ - const ADMIN_RESOURCE = 'Magento_Backend::system'; + public const ADMIN_RESOURCE = 'Magento_Backend::system'; } diff --git a/app/code/Magento/Backend/Controller/Adminhtml/System/Account.php b/app/code/Magento/Backend/Controller/Adminhtml/System/Account.php index be2cbbdeb804e..b47e8c87925c7 100644 --- a/app/code/Magento/Backend/Controller/Adminhtml/System/Account.php +++ b/app/code/Magento/Backend/Controller/Adminhtml/System/Account.php @@ -9,8 +9,6 @@ /** * Adminhtml account controller - * - * @author Magento Core Team */ abstract class Account extends Action { @@ -19,5 +17,5 @@ abstract class Account extends Action * * @see _isAllowed() */ - const ADMIN_RESOURCE = 'Magento_Backend::myaccount'; + public const ADMIN_RESOURCE = 'Magento_Backend::myaccount'; } diff --git a/app/code/Magento/Backend/Controller/Adminhtml/System/Store.php b/app/code/Magento/Backend/Controller/Adminhtml/System/Store.php index 7bef74862f029..4f7a5bbf33092 100644 --- a/app/code/Magento/Backend/Controller/Adminhtml/System/Store.php +++ b/app/code/Magento/Backend/Controller/Adminhtml/System/Store.php @@ -13,7 +13,6 @@ /** * Store controller * - * @author Magento Core Team * @SuppressWarnings(PHPMD.AllPurposeAction) */ abstract class Store extends Action @@ -23,11 +22,9 @@ abstract class Store extends Action * * @see _isAllowed() */ - const ADMIN_RESOURCE = 'Magento_Backend::store'; + public const ADMIN_RESOURCE = 'Magento_Backend::store'; /** - * Core registry - * * @var \Magento\Framework\Registry */ protected $_coreRegistry; @@ -89,6 +86,7 @@ protected function createPage() * @return bool * * @deprecated 100.2.7 Backup module is to be removed. + * @see Nothing */ protected function _backupDatabase() { diff --git a/app/code/Magento/Backend/Helper/Js.php b/app/code/Magento/Backend/Helper/Js.php index a71b9c6763383..375815a59cac7 100644 --- a/app/code/Magento/Backend/Helper/Js.php +++ b/app/code/Magento/Backend/Helper/Js.php @@ -6,8 +6,6 @@ /** * Adminhtml JavaScript helper - * - * @author Magento Core Team */ namespace Magento\Backend\Helper; @@ -39,6 +37,7 @@ public function decodeGridSerializedInput($encoded) { $isSimplified = false === strpos($encoded, '='); $result = []; + // phpcs:ignore Magento2.Functions.DiscouragedFunction.Discouraged parse_str($encoded, $decoded); foreach ($decoded as $key => $value) { if (is_numeric($key)) { @@ -46,6 +45,7 @@ public function decodeGridSerializedInput($encoded) $result[] = $key; } else { $result[$key] = null; + // phpcs:ignore Magento2.Functions.DiscouragedFunction.Discouraged parse_str(base64_decode($value), $result[$key]); } } diff --git a/app/code/Magento/Backend/Model/Auth/Credential/StorageInterface.php b/app/code/Magento/Backend/Model/Auth/Credential/StorageInterface.php index a303418cfe59b..1b157548ff6cf 100644 --- a/app/code/Magento/Backend/Model/Auth/Credential/StorageInterface.php +++ b/app/code/Magento/Backend/Model/Auth/Credential/StorageInterface.php @@ -8,7 +8,6 @@ /** * Backend Auth Credential Storage interface * - * @author Magento Core Team * @api * @since 100.0.2 */ diff --git a/app/code/Magento/Backend/Model/Locale/Manager.php b/app/code/Magento/Backend/Model/Locale/Manager.php index 24adafc7635af..33cf615b9924a 100644 --- a/app/code/Magento/Backend/Model/Locale/Manager.php +++ b/app/code/Magento/Backend/Model/Locale/Manager.php @@ -8,8 +8,8 @@ /** * Locale manager model * - * @author Magento Core Team * @api + * @SuppressWarnings(PHPMD.CookieAndSessionMisuse) * @since 100.0.2 */ class Manager diff --git a/app/code/Magento/Backend/Model/Search/Order.php b/app/code/Magento/Backend/Model/Search/Order.php index 728cf7414f3d8..05cb109f6112d 100644 --- a/app/code/Magento/Backend/Model/Search/Order.php +++ b/app/code/Magento/Backend/Model/Search/Order.php @@ -8,15 +8,12 @@ /** * Search Order Model * - * @author Magento Core Team * @api * @since 100.0.2 */ class Order extends \Magento\Framework\DataObject { /** - * Adminhtml data - * * @var \Magento\Backend\Helper\Data */ protected $_adminhtmlData = null;