Merge remote-tracking branch 'mainline/develop' into NORD-FIXES

.travis.yml

@@ -1,5 +1,6 @@
 sudo: required
 dist: trusty
+group: edge
 addons:
   apt:
     packages:

app/code/Magento/Authorization/Model/ResourceModel/Rules.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Authorization\Model\ResourceModel;
 
 use Magento\Framework\App\ObjectManager;
@@ -101,7 +99,10 @@ public function saveRel(\Magento\Authorization\Model\Rules $rule)
 
                 // If all was selected save it only and nothing else.
                 if ($postedResources === [$this->_rootResource->getId()]) {
-                    $insertData = $this->_prepareDataForTable(new \Magento\Framework\DataObject($row), $this->getMainTable());
+                    $insertData = $this->_prepareDataForTable(
+                        new \Magento\Framework\DataObject($row),
+                        $this->getMainTable()
+                    );
 
                     $connection->insert($this->getMainTable(), $insertData);
                 } else {
@@ -113,7 +114,10 @@ public function saveRel(\Magento\Authorization\Model\Rules $rule)
                         $row['permission'] = in_array($resourceId, $postedResources) ? 'allow' : 'deny';
                         $row['resource_id'] = $resourceId;
 
-                        $insertData = $this->_prepareDataForTable(new \Magento\Framework\DataObject($row), $this->getMainTable());
+                        $insertData = $this->_prepareDataForTable(
+                            new \Magento\Framework\DataObject($row),
+                            $this->getMainTable()
+                        );
                         $connection->insert($this->getMainTable(), $insertData);
                     }
                 }

app/code/Magento/Backend/App/AbstractAction.php

@@ -8,6 +8,7 @@
 /**
  * Generic backend controller
  *
+ * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */

app/code/Magento/Backend/App/Action.php

@@ -10,6 +10,7 @@
 namespace Magento\Backend\App;
 
 /**
+ * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 abstract class Action extends \Magento\Backend\App\AbstractAction

app/code/Magento/Backend/App/Action/Context.php

@@ -8,7 +8,17 @@
 use Magento\Framework\Controller\ResultFactory;
 
 /**
- * Backend Controller context
+ * Constructor modification point for Magento\Backend\App\Action.
+ *
+ * All context classes were introduced to allow for backwards compatible constructor modifications
+ * of classes that were supposed to be extended by extension developers.
+ *
+ * Do not call methods of this class directly.
+ *
+ * As Magento moves from inheritance-based APIs all such classes will be deprecated together with
+ * the classes they were introduced for.
+ *
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Context extends \Magento\Framework\App\Action\Context

app/code/Magento/Backend/App/Config.php

@@ -6,8 +6,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\App;
 
 use Magento\Config\App\Config\Type\System;

app/code/Magento/Backend/Block/AbstractBlock.php

@@ -6,7 +6,12 @@
 namespace Magento\Backend\Block;
 
 /**
- * Backend abstract block
+ * Base for all admin blocks.
+ *
+ * Avoid using this class. Will be deprecated
+ *
+ * Marked as public API because it is actively used now.
+ * @api
  */
 class AbstractBlock extends \Magento\Framework\View\Element\AbstractBlock
 {

app/code/Magento/Backend/Block/Context.php

@@ -1,15 +1,22 @@
 <?php
 /**
- * Backend block context
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Backend\Block;
 
 /**
- * Backend block context
+ * Constructor modification point for Magento\Backend\Block\AbstractBlock.
+ *
+ * All context classes were introduced to allow for backwards compatible constructor modifications
+ * of classes that were supposed to be extended by extension developers.
+ *
+ * Do not call methods of this class directly.
+ *
+ * As Magento moves from inheritance-based APIs all such classes will be deprecated together with
+ * the classes they were introduced for.
  *
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Context extends \Magento\Framework\View\Element\Context

app/code/Magento/Backend/Block/Dashboard.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block;
 
 /**

app/code/Magento/Backend/Block/Dashboard/AbstractDashboard.php

@@ -4,10 +4,10 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\Dashboard;
 
+use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;
+
 /**
  * Adminhtml dashboard tab abstract
  *
@@ -40,7 +40,7 @@ public function __construct(
     }
 
     /**
-     * @return array|\Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection|\Magento\Eav\Model\Entity\Collection\Abstract
+     * @return array|AbstractCollection|\Magento\Eav\Model\Entity\Collection\Abstract
      */
     public function getCollection()
     {

app/code/Magento/Backend/Block/Menu.php

@@ -148,11 +148,13 @@ protected function _renderMouseEvent($menuItem)
     protected function _renderItemCssClass($menuItem, $level)
     {
         $isLast = 0 == $level && (bool)$this->getMenuModel()->isLast($menuItem) ? 'last' : '';
-        $output = ($this->menuItemChecker->isItemActive(
+        $isItemActive = $this->menuItemChecker->isItemActive(
             $this->getActiveItemModel(),
-                $menuItem,
-                $level
-            ) ? '_current _active' : '') .
+            $menuItem,
+            $level
+        ) ? '_current _active' : '';
+
+        $output =  $isItemActive .
             ' ' .
             ($menuItem->hasChildren() ? 'parent' : '') .
             ' ' .
@@ -411,7 +413,7 @@ public function renderNavigation($menu, $level = 0, $limit = 0, $colBrakes = [])
      */
     public function getActiveItemModel()
     {
-        if (is_null($this->_activeItemModel)) {
+        if ($this->_activeItemModel === null) {
             $this->_activeItemModel = $this->getMenuModel()->get($this->getActive());
             if (false == $this->_activeItemModel instanceof \Magento\Backend\Model\Menu\Item) {
                 $this->_activeItemModel = false;

app/code/Magento/Backend/Block/Page/Header.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\Page;
 
 /**
@@ -81,6 +79,9 @@ public function getLogoutLink()
      */
     public function displayNoscriptNotice()
     {
-        return $this->_scopeConfig->getValue('web/browser_capabilities/javascript', \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+        return $this->_scopeConfig->getValue(
+            'web/browser_capabilities/javascript',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
     }
 }

app/code/Magento/Backend/Block/Page/Notices.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 /**
  * Adminhtml header notices block
  *
@@ -25,7 +23,10 @@ class Notices extends \Magento\Backend\Block\Template
      */
     public function displayNoscriptNotice()
     {
-        return $this->_scopeConfig->getValue('web/browser_capabilities/javascript', \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+        return $this->_scopeConfig->getValue(
+            'web/browser_capabilities/javascript',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
     }
 
     /**
@@ -35,6 +36,9 @@ public function displayNoscriptNotice()
      */
     public function displayDemoNotice()
     {
-        return $this->_scopeConfig->getValue('design/head/demonotice', \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
+        return $this->_scopeConfig->getValue(
+            'design/head/demonotice',
+            \Magento\Store\Model\ScopeInterface::SCOPE_STORE
+        );
     }
 }

app/code/Magento/Backend/Block/Page/System/Config/Robots/Reset.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\Page\System\Config\Robots;
 
 use Magento\Framework\App\Config\ScopeConfigInterface;
@@ -53,7 +51,8 @@ protected function _construct()
     public function getRobotsDefaultCustomInstructions()
     {
         return trim((string)$this->_scopeConfig->getValue(
-            self::XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS, ScopeConfigInterface::SCOPE_TYPE_DEFAULT
+            self::XML_PATH_ROBOTS_DEFAULT_CUSTOM_INSTRUCTIONS,
+            ScopeConfigInterface::SCOPE_TYPE_DEFAULT
         ));
     }
 

app/code/Magento/Backend/Block/Store/Switcher/Form/Renderer/Fieldset.php

@@ -4,14 +4,14 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\Store\Switcher\Form\Renderer;
 
+use \Magento\Framework\Data\Form\Element\Renderer\RendererInterface;
+
 /**
  * Form fieldset renderer
  */
-class Fieldset extends \Magento\Backend\Block\Template implements \Magento\Framework\Data\Form\Element\Renderer\RendererInterface
+class Fieldset extends \Magento\Backend\Block\Template implements RendererInterface
 {
     /**
      * Form element which re-rendering

app/code/Magento/Backend/Block/System/Design/Edit/Tab/General.php

@@ -4,8 +4,6 @@
  * See COPYING.txt for license details.
  */
 
-// @codingStandardsIgnoreFile
-
 namespace Magento\Backend\Block\System\Design\Edit\Tab;
 
 class General extends \Magento\Backend\Block\Widget\Form\Generic
@@ -66,7 +64,7 @@ protected function _prepareForm()
                 ]
             );
             $renderer = $this->getLayout()->createBlock(
-                 \Magento\Backend\Block\Store\Switcher\Form\Renderer\Fieldset\Element::class
+                \Magento\Backend\Block\Store\Switcher\Form\Renderer\Fieldset\Element::class
             );
             $field->setRenderer($renderer);
         } else {

app/code/Magento/Backend/Block/Template.php

@@ -6,7 +6,20 @@
 namespace Magento\Backend\Block;
 
 /**
- * Backend abstract block
+ * Standard admin block. Adds admin-specific behavior and event.
+ * Should be used when you declare a block in admin layout handle.
+ *
+ * Avoid extending this class if possible.
+ *
+ * If you need custom presentation logic in your blocks, use this class as block, and declare
+ * custom view models in block arguments in layout handle file.
+ *
+ * Example:
+ * <block name="my.block" class="Magento\Backend\Block\Template" template="My_Module::template.phtml" >
+ *      <arguments>
+ *          <argument name="viewModel" xsi:type="object">My\Module\ViewModel\Custom</argument>
+ *      </arguments>
+ * </block>
  *
  * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)

app/code/Magento/Backend/Block/Template/Context.php

@@ -1,14 +1,22 @@
 <?php
 /**
- * Backend block template context
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Backend\Block\Template;
 
 /**
+ * Constructor modification point for Magento\Backend\Block\Template.
+ *
+ * All context classes were introduced to allow for backwards compatible constructor modifications
+ * of classes that were supposed to be extended by extension developers.
+ *
+ * Do not call methods of this class directly.
+ *
+ * As Magento moves from inheritance-based APIs all such classes will be deprecated together with
+ * the classes they were introduced for.
+ *
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Context extends \Magento\Framework\View\Element\Template\Context

app/code/Magento/Backend/Block/Widget.php

@@ -8,8 +8,7 @@
 /**
  * Base widget class
  *
- * @author     Magento Core Team <[email protected]>
- *
+ * @api
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 class Widget extends \Magento\Backend\Block\Template

app/code/Magento/Backend/Block/Widget/Accordion.php

@@ -8,7 +8,7 @@
 /**
  * Magento_Backend accordion widget
  *
- * @author      Magento Core Team <[email protected]>
+ * @api
  */
 class Accordion extends \Magento\Backend\Block\Widget
 {

app/code/Magento/Backend/Block/Widget/Context.php

@@ -3,10 +3,20 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
-
 namespace Magento\Backend\Block\Widget;
 
 /**
+ * Constructor modification point for Magento\Backend\Block\Widget.
+ *
+ * All context classes were introduced to allow for backwards compatible constructor modifications
+ * of classes that were supposed to be extended by extension developers.
+ *
+ * Do not call methods of this class directly.
+ *
+ * As Magento moves from inheritance-based APIs all such classes will be deprecated together with
+ * the classes they were introduced for.
+ *
+ * @api
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Context extends \Magento\Backend\Block\Template\Context

app/code/Magento/Backend/Block/Widget/Form.php

@@ -8,6 +8,8 @@
 /**
  * Backend form widget
  *
+ * @api
+ * @deprecated in favour of UI component implementation
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 class Form extends \Magento\Backend\Block\Widget

app/code/Magento/Backend/Block/Widget/Form/Container.php

@@ -8,7 +8,8 @@
 /**
  * Backend form container block
  *
- * @author      Magento Core Team <[email protected]>
+ * @api
+ * @deprecated in favour of UI component implementation
  * @SuppressWarnings(PHPMD.NumberOfChildren)
  */
 class Container extends \Magento\Backend\Block\Widget\Container