Fix minor CS violations

gsteel · gsteel · commit 24e0f5258602 · 2024-10-25T09:57:23.000+01:00
Signed-off-by: George Steel &lt;george@net-glue.co.uk&gt;
diff --git a/phpcs.xml b/phpcs.xml
@@ -3,6 +3,7 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
 >
+    <arg value="ps" />
     <!-- Paths to check -->
     <file>src</file>
     <file>test</file>
diff --git a/src/Generator/ClassGenerator.php b/src/Generator/ClassGenerator.php
@@ -23,7 +23,6 @@
 use function sprintf;
 use function str_contains;
 use function str_replace;
-use function strpos;
 use function strrpos;
 use function strtolower;
 use function substr;
@@ -185,7 +184,6 @@ public static function fromReflection(ClassReflection $classReflection)
      * @configkey properties
      * @configkey methods
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return static
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/DocBlockGenerator.php b/src/Generator/DocBlockGenerator.php
@@ -61,7 +61,6 @@ public static function fromReflection(DocBlockReflection $reflectionDocBlock)
      * @configkey longdescription  string The long description for this doc block
      * @configkey tags             array
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return DocBlockGenerator
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/FileGenerator.php b/src/Generator/FileGenerator.php
@@ -93,7 +93,6 @@ public function __construct($options = null)
      * @deprecated this API is deprecated, and will be removed in the next major release. Please
      *             use the other constructors of this class instead.
      *
-     * @param  array $values
      * @return FileGenerator
      */
     public static function fromArray(array $values)
diff --git a/src/Generator/InterfaceGenerator.php b/src/Generator/InterfaceGenerator.php
@@ -79,7 +79,6 @@ public static function fromReflection(ClassReflection $classReflection)
      * @configkey constants
      * @configkey methods
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return static
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/MethodGenerator.php b/src/Generator/MethodGenerator.php
@@ -134,7 +134,6 @@ protected static function clearBodyIndention($body)
      * @configkey static           bool
      * @configkey visibility       string
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return MethodGenerator
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/ParameterGenerator.php b/src/Generator/ParameterGenerator.php
@@ -72,7 +72,6 @@ public static function fromReflection(ParameterReflection $reflectionParameter)
      * @configkey sourcecontent         string
      * @configkey omitdefaultvalue      bool
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return ParameterGenerator
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/PropertyGenerator.php b/src/Generator/PropertyGenerator.php
@@ -113,7 +113,6 @@ public static function fromReflection(PropertyReflection $reflectionProperty)
      * @configkey omitdefaultvalue   bool
      * @configkey readonly           bool
      * @configkey type               null|TypeGenerator
-     * @param  array  $array
      * @return static
      * @throws Exception\InvalidArgumentException
      */
diff --git a/src/Generator/TraitGenerator.php b/src/Generator/TraitGenerator.php
@@ -70,7 +70,6 @@ public static function fromReflection(ClassReflection $classReflection)
      * @configkey properties
      * @configkey methods
      * @throws Exception\InvalidArgumentException
-     * @param  array $array
      * @return static
      */
     public static function fromArray(array $array)
diff --git a/src/Generator/ValueGenerator.php b/src/Generator/ValueGenerator.php
@@ -62,7 +62,6 @@ class ValueGenerator extends AbstractGenerator
     /** @var self::OUTPUT_* */
     protected string $outputMode = self::OUTPUT_MULTIPLE_LINE;
 
-    /** @var array */
     protected array $allowedTypes = [];
 
     /**
diff --git a/test/Reflection/ClassReflectionTest.php b/test/Reflection/ClassReflectionTest.php
@@ -10,7 +10,6 @@
 use PHPUnit\Framework\TestCase;
 
 use function array_shift;
-use function get_class;
 use function trim;
 use function uniqid;
 
@@ -69,67 +68,72 @@ public function testInterfaceReturn()
     public function testGetContentsReturnsContents()
     {
         $reflectionClass = new ClassReflection(TestAsset\TestSampleClass2::class);
-        $target          = <<<EOS
-{
-    protected \$_prop1 = null;
-
-    /**
-     * @Sample({"foo":"bar"})
-     */
-    protected \$_prop2 = null;
 
-    public function getProp1()
-    {
-        return \$this->_prop1;
-    }
-
-    public function getProp2(\$param1, TestSampleClass \$param2)
-    {
-        return \$this->_prop2;
-    }
-
-    public function getIterator(): \Traversable
-    {
-        return new \EmptyIterator();
-    }
-
-}
-EOS;
-        $contents        = $reflectionClass->getContents();
+        // phpcs:disable SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
+        $target   = <<<EOS
+            {
+                protected \$_prop1 = null;
+            
+                /**
+                 * @Sample({"foo":"bar"})
+                 */
+                protected \$_prop2 = null;
+            
+                public function getProp1()
+                {
+                    return \$this->_prop1;
+                }
+            
+                public function getProp2(\$param1, TestSampleClass \$param2)
+                {
+                    return \$this->_prop2;
+                }
+            
+                public function getIterator(): \Traversable
+                {
+                    return new \EmptyIterator();
+                }
+            
+            }
+            EOS;
+        $contents = $reflectionClass->getContents();
         self::assertEquals(trim($target), trim($contents));
+        // phpcs:enable
     }
 
     public function testGetContentsReturnsContentsWithImplementsOnSeparateLine()
     {
         $reflectionClass = new ClassReflection(TestAsset\TestSampleClass9::class);
-        $target          = <<<EOS
-{
-    protected \$_prop1 = null;
-
-    /**
-     * @Sample({"foo":"bar"})
-     */
-    protected \$_prop2 = null;
-
-    public function getProp1()
-    {
-        return \$this->_prop1;
-    }
-
-    public function getProp2(\$param1, TestSampleClass \$param2)
-    {
-        return \$this->_prop2;
-    }
-
-    public function getIterator(): \Traversable
-    {
-        return new \EmptyIterator();
-    }
-
-}
-EOS;
-        $contents        = $reflectionClass->getContents();
+        // phpcs:disable SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
+        $target   = <<<EOS
+            {
+                protected \$_prop1 = null;
+            
+                /**
+                 * @Sample({"foo":"bar"})
+                 */
+                protected \$_prop2 = null;
+            
+                public function getProp1()
+                {
+                    return \$this->_prop1;
+                }
+            
+                public function getProp2(\$param1, TestSampleClass \$param2)
+                {
+                    return \$this->_prop2;
+                }
+            
+                public function getIterator(): \Traversable
+                {
+                    return new \EmptyIterator();
+                }
+            
+            }
+            EOS;
+        $contents = $reflectionClass->getContents();
         self::assertEquals(trim($target), trim($contents));
+        // phpcs:enable
     }
 
     public function testStartLine()

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`
`4`	`4`	`xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"`
`5`	`5`	`>`
	`6`	`+ <arg value="ps" />`
`6`	`7`	`<!-- Paths to check -->`
`7`	`8`	`<file>src</file>`
`8`	`9`	`<file>test</file>`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,6 @@ public function __construct($options = null)`
`93`	`93`	`* @deprecated this API is deprecated, and will be removed in the next major release. Please`
`94`	`94`	`* use the other constructors of this class instead.`
`95`	`95`	`*`
`96`		`- * @param array $values`
`97`	`96`	`* @return FileGenerator`
`98`	`97`	`*/`
`99`	`98`	`public static function fromArray(array $values)`