MAGETWO-65470: The visibility conditions improvements

docblocks

Author: valdislav

lib/internal/Magento/Framework/View/Layout/AclCondition.php

@@ -8,18 +8,21 @@
 use Magento\Framework\View\Layout\Condition\VisibilityConditionInterface;
 
 /**
- * Class AclCondition.
+ * Check that user is allowed to watch resource with given acl resource..
  */
 class AclCondition implements VisibilityConditionInterface
 {
+    /**
+     * Unique name.
+     */
+    const NAME = 'acl';
+
     /**
      * @var \Magento\Framework\AuthorizationInterface
      */
     private $authorization;
 
     /**
-     * AclCondition constructor.
-     *
      * @param \Magento\Framework\AuthorizationInterface $authorization
      */
     public function __construct(\Magento\Framework\AuthorizationInterface $authorization)
@@ -28,12 +31,7 @@ public function __construct(\Magento\Framework\AuthorizationInterface $authoriza
     }
 
     /**
-     * Validate logical condition for ui component
-     * If validation passed block will be displayed
-     *
-     * @param array $arguments Attributes from element node.
-     *
-     * @return bool
+     * @inheritdoc
      */
     public function isVisible(array $arguments)
     {
@@ -45,6 +43,6 @@ public function isVisible(array $arguments)
      */
     public function getName()
     {
-        return 'acl';
+        return self::NAME;
     }
 }

lib/internal/Magento/Framework/View/Layout/Condition/VisibilityConditionInterface.php

@@ -8,14 +8,21 @@
 /**
  * Class VisibilityConditionInterface
  *
- * Introduces family of visibility conditions for layout elements at the backend.
+ * Introduces family of visibility conditions for layout elements.
  * By using this interface a developer can specify dynamic rule for ui component visibility.
  *
  * Condition can be used by ui component declaration in layout
  *
- * <uiComponent name="form" visibilityCondition="ConditionFullClassPath" />
+ * <uiComponent name="form">
+ *      <visibilityCondition name='can_show_awesome_element'>
+ *          <arguments>
+ *              <argument name="aclResource" xsi:type="string">Magento_Framework::awesome_page</argument>
+ *              <argument name="extraData" xsi:type="array"></argument>
+ *          <arguments>
+ *      </visibilityCondition>
+ * </uiComponent>
  *
- * "visibilityCondition" just another optional attribute of ui component declaration
+ * "visibilityCondition" just another optional child element of ui component declaration
  */
 interface VisibilityConditionInterface
 {

lib/internal/Magento/Framework/View/Layout/ConfigCondition.php

@@ -11,10 +11,15 @@
 use Magento\Framework\App\ScopeResolverInterface;
 
 /**
- * Class ConfigCondition
+ * Check that config flag is set to true,
  */
 class ConfigCondition implements VisibilityConditionInterface
 {
+    /**
+     * Unique name.
+     */
+    const NAME = 'ifconfig';
+
     /**
      * @var ScopeConfigInterface
      */
@@ -48,12 +53,7 @@ public function __construct(
     }
 
     /**
-     * Validate logical condition for ui component
-     * If validation passed block will be displayed
-     *
-     * @param array $arguments Attributes from element node.
-     *
-     * @return bool
+     * @inheritdoc
      */
     public function isVisible(array $arguments)
     {
@@ -69,6 +69,6 @@ public function isVisible(array $arguments)
      */
     public function getName()
     {
-        return 'ifconfig';
+        return self::NAME;
     }
 }

lib/internal/Magento/Framework/View/Layout/Reader/Visibility/Condition.php

@@ -10,7 +10,7 @@
 use Magento\Framework\View\Layout\Argument\Parser;
 
 /**
- * Class Condition
+ * Parse conditions from element.
  */
 class Condition
 {
@@ -50,15 +50,6 @@ public function __construct(
     public function parseConditions(Element $element)
     {
         $visibilityConditions = [];
-        /** @var $childElement Element */
-        foreach ($element as $childElement) {
-            if ($childElement->getName() === 'visibilityCondition') {
-                $visibilityConditions[$childElement->getAttribute('name')] = [
-                    'name' => $childElement->getAttribute('className'),
-                    'arguments' => $this->evaluateArguments($childElement),
-                ];
-            }
-        }
         $configPath = (string)$element->getAttribute('ifconfig');
         if (!empty($configPath)) {
             $visibilityConditions['ifconfig'] = [
@@ -79,6 +70,16 @@ public function parseConditions(Element $element)
             ];
         }
 
+        /** @var $childElement Element */
+        foreach ($element as $childElement) {
+            if ($childElement->getName() === 'visibilityCondition') {
+                $visibilityConditions[$childElement->getAttribute('name')] = [
+                    'name' => $childElement->getAttribute('className'),
+                    'arguments' => $this->evaluateArguments($childElement),
+                ];
+            }
+        }
+
         return $visibilityConditions;
     }
 
@@ -110,14 +111,13 @@ private function evaluateArguments(Element $blockElement)
     }
 
     /**
-     * Get block arguments
+     * @param Element $element
      *
-     * @param Element $blockElement
      * @return array
      */
-    private function getArguments(Element $blockElement)
+    private function getArguments(Element $element)
     {
-        $arguments = $this->getElementsByType($blockElement, self::TYPE_ARGUMENTS);
+        $arguments = $this->getElementsByType($element, self::TYPE_ARGUMENTS);
         // We have only one declaration of <arguments> node in block or its reference
         $argumentElement = reset($arguments);
         return $argumentElement ? $this->parseArguments($argumentElement) : [];