AC-670: Create phpcs static check for LayoutTest

Author: svera

Magento2/Sniffs/Legacy/LayoutSniff.php

@@ -71,6 +71,11 @@ class LayoutSniff implements Sniff
         ],
     ];
 
+    /**
+     * List of allowed method names
+     *
+     * @var string[]
+     */
     private $allowedActionNodeMethods = [
         'addBodyClass',
         'addButtons',
@@ -233,6 +238,9 @@ public function process(File $phpcsFile, $stackPtr)
     }
 
     /**
+     * Check for obsolete block references
+     *
+     * @todo missing test
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
@@ -269,6 +277,8 @@ private function getFormattedXML(File $phpcsFile)
     }
 
     /**
+     * Check that CSS, Link and Script blocks are inside a head block
+     *
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
@@ -295,6 +305,8 @@ private function testHeadBlocks(SimpleXMLElement $layout, File $phpcsFile): void
     }
 
     /**
+     * Check that the output attribute has the right value
+     *
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
@@ -347,6 +359,7 @@ private function testObsoleteAttributes(SimpleXMLElement $layout, File $phpcsFil
     /**
      * Returns attribute value by attribute name
      *
+     * @param SimpleXMLElement $element
      * @param string $name
      * @return string|null
      */
@@ -357,6 +370,8 @@ private function getAttribute(SimpleXMLElement $element, string $name): string
     }
 
     /**
+     * Check values in helper attributes
+     *
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
@@ -381,6 +396,8 @@ private function testHelperAttribute(SimpleXMLElement $layout, File $phpcsFile):
     }
 
     /**
+     * Check that ListText is not used
+     *
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */
@@ -398,6 +415,8 @@ private function testListText(SimpleXMLElement $layout, File $phpcsFile): void
     }
 
     /**
+     * Check that action is calling an allowed method
+     *
      * @param SimpleXMLElement $layout
      * @param File $phpcsFile
      */