Merge pull request #7 from weierophinney/feature/php-8.1-support

Provide PHP 8.1 support
laminas · Dec 2, 2021 · 570b206 · 570b206
2 parents 2557446 + 9149aa3
commit 570b206
Show file tree

Hide file tree

Showing 34 changed files with 817 additions and 630 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+/.phpcs-cache
 /.phpunit.result.cache
 /clover.xml
 /coveralls-upload.json

diff --git a/composer.json b/composer.json
@@ -19,15 +19,14 @@
         "sort-packages": true
     },
     "require": {
-        "php": "^7.3 || ~8.0.0",
-        "laminas/laminas-escaper": "^2.7",
-        "laminas/laminas-stdlib": "^3.3",
-        "laminas/laminas-zendframework-bridge": "^1.0"
+        "php": "^7.4 || ~8.0.0 || ~8.1.0",
+        "laminas/laminas-escaper": "^2.9",
+        "laminas/laminas-stdlib": "^3.6"
     },
     "require-dev": {
-        "laminas/laminas-coding-standard": "~1.0.0",
-        "laminas/laminas-servicemanager": "^3.4.1",
-        "phpunit/phpunit": "^9.3"
+        "laminas/laminas-coding-standard": "~2.3",
+        "laminas/laminas-servicemanager": "^3.8",
+        "phpunit/phpunit": "^9.5.5"
     },
     "suggest": {
         "laminas/laminas-servicemanager": "Laminas\\ServiceManager component"
@@ -52,7 +51,7 @@
         "test": "phpunit --colors=always",
         "test-coverage": "phpunit --colors=always --coverage-clover clover.xml"
     },
-    "replace": {
-        "zendframework/zend-tag": "^2.7.1"
+    "conflict": {
+        "zendframework/zend-tag": "*"
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -1,8 +1,21 @@
-<?xml version="1.0"?>
-<ruleset name="Laminas coding standard">
-    <rule ref="./vendor/laminas/laminas-coding-standard/ruleset.xml"/>
+<?xml version="1.0"?>
+<ruleset
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+
+    <!-- Show progress -->
+    <arg value="p"/>
 
     <!-- Paths to check -->
     <file>src</file>
     <file>test</file>
+
+    <!-- Include all rules from Laminas Coding Standard -->
+    <rule ref="LaminasCodingStandard"/>
 </ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,17 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
-         bootstrap="vendor/autoload.php"
-         colors="true">
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    bootstrap="vendor/autoload.php"
+    convertDeprecationsToExceptions="true"
+    colors="true">
+    <coverage processUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
+
     <testsuites>
         <testsuite name="laminas-tag Test Suite">
             <directory>./test</directory>
         </testsuite>
     </testsuites>
-
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>
diff --git a/src/Cloud.php b/src/Cloud.php
@@ -1,48 +1,60 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag;
 
+use Exception;
 use Laminas\ServiceManager\ServiceManager;
 use Laminas\Stdlib\ArrayUtils;
 use Laminas\Tag\Cloud\Decorator\HtmlCloud;
 use Laminas\Tag\Cloud\Decorator\HtmlTag;
+use Laminas\Tag\Exception\InvalidArgumentException;
 use Traversable;
 
+use function count;
+use function get_class;
+use function gettype;
+use function in_array;
+use function is_array;
+use function is_object;
+use function is_string;
+use function method_exists;
+use function sprintf;
+use function strtolower;
+use function trigger_error;
+
+use const E_USER_WARNING;
+
 class Cloud
 {
     /**
      * DecoratorInterface for the cloud
      *
      * @var Cloud\Decorator\AbstractCloud
      */
-    protected $cloudDecorator = null;
+    protected $cloudDecorator;
 
     /**
      * DecoratorInterface for the tags
      *
      * @var Cloud\Decorator\AbstractTag
      */
-    protected $tagDecorator = null;
+    protected $tagDecorator;
 
     /**
      * List of all tags
      *
      * @var ItemList
      */
-    protected $tags = null;
+    protected $tags;
 
     /**
      * Plugin manager for decorators
      *
      * @var Cloud\DecoratorPluginManager
      */
-    protected $decorators = null;
+    protected $decorators;
 
     /**
      * Option keys to skip when calling setOptions()
@@ -101,7 +113,7 @@ public function setOptions(array $options)
      * decorators.
      *
      * @param  array $tags
-     * @throws Exception\InvalidArgumentException
+     * @throws InvalidArgumentException
      * @return Cloud
      */
     public function setTags(array $tags)
@@ -116,7 +128,7 @@ public function setTags(array $tags)
      * Append a single tag to the cloud
      *
      * @param  TaggableInterface|array $tag
-     * @throws Exception\InvalidArgumentException
+     * @throws InvalidArgumentException
      * @return Cloud
      */
     public function appendTag($tag)
@@ -129,10 +141,10 @@ public function appendTag($tag)
         }
 
         if (! is_array($tag)) {
-            throw new Exception\InvalidArgumentException(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'Tag must be an instance of %s\TaggableInterface or an array; received "%s"',
                 __NAMESPACE__,
-                (is_object($tag) ? get_class($tag) : gettype($tag))
+                is_object($tag) ? get_class($tag) : gettype($tag)
             ));
         }
 
@@ -144,7 +156,6 @@ public function appendTag($tag)
     /**
      * Set the item list
      *
-     * @param  ItemList $itemList
      * @return Cloud
      */
     public function setItemList(ItemList $itemList)
@@ -172,7 +183,7 @@ public function getItemList()
      * Set the decorator for the cloud
      *
      * @param  mixed $decorator
-     * @throws Exception\InvalidArgumentException
+     * @throws InvalidArgumentException
      * @return Cloud
      */
     public function setCloudDecorator($decorator)
@@ -193,8 +204,8 @@ public function setCloudDecorator($decorator)
             $decorator = $this->getDecoratorPluginManager()->get($decorator, $options);
         }
 
-        if (! ($decorator instanceof Cloud\Decorator\AbstractCloud)) {
-            throw new Exception\InvalidArgumentException(
+        if (! $decorator instanceof Cloud\Decorator\AbstractCloud) {
+            throw new InvalidArgumentException(
                 'DecoratorInterface is no instance of Cloud\Decorator\AbstractCloud'
             );
         }
@@ -221,7 +232,7 @@ public function getCloudDecorator()
      * Set the decorator for the tags
      *
      * @param  mixed $decorator
-     * @throws Exception\InvalidArgumentException
+     * @throws InvalidArgumentException
      * @return Cloud
      */
     public function setTagDecorator($decorator)
@@ -242,8 +253,8 @@ public function setTagDecorator($decorator)
             $decorator = $this->getDecoratorPluginManager()->get($decorator, $options);
         }
 
-        if (! ($decorator instanceof Cloud\Decorator\AbstractTag)) {
-            throw new Exception\InvalidArgumentException(
+        if (! $decorator instanceof Cloud\Decorator\AbstractTag) {
+            throw new InvalidArgumentException(
                 'DecoratorInterface is no instance of Cloud\Decorator\AbstractTag'
             );
         }
@@ -269,7 +280,6 @@ public function getTagDecorator()
     /**
      * Set plugin manager for use with decorators
      *
-     * @param  Cloud\DecoratorPluginManager $decorators
      * @return Cloud
      */
     public function setDecoratorPluginManager(Cloud\DecoratorPluginManager $decorators)
@@ -305,10 +315,8 @@ public function render()
             return '';
         }
 
-        $tagsResult  = $this->getTagDecorator()->render($tags);
-        $cloudResult = $this->getCloudDecorator()->render($tagsResult);
-
-        return $cloudResult;
+        $tagsResult = $this->getTagDecorator()->render($tags);
+        return $this->getCloudDecorator()->render($tagsResult);
     }
 
     /**
@@ -319,11 +327,13 @@ public function render()
     public function __toString()
     {
         try {
-            $result = $this->render();
-            return $result;
-        } catch (\Exception $e) {
-            $message = "Exception caught by tag cloud: " . $e->getMessage()
-                     . "\nStack Trace:\n" . $e->getTraceAsString();
+            return $this->render();
+        } catch (Exception $e) {
+            $message = sprintf(
+                "Exception caught by tag cloud: %s\nStack Trace:\n%s",
+                $e->getMessage(),
+                $e->getTraceAsString()
+            );
             trigger_error($message, E_USER_WARNING);
             return '';
         }

diff --git a/src/Cloud/Decorator/AbstractCloud.php b/src/Cloud/Decorator/AbstractCloud.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator;
 

diff --git a/src/Cloud/Decorator/AbstractDecorator.php b/src/Cloud/Decorator/AbstractDecorator.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator;
 
@@ -14,19 +10,22 @@
 use Laminas\Tag\Exception;
 use Traversable;
 
+use function in_array;
+use function is_array;
+use function method_exists;
+use function preg_match;
+use function sprintf;
+use function strtolower;
+
 /**
  * Abstract class for decorators
  */
 abstract class AbstractDecorator implements Decorator
 {
-    /**
-     * @var string Encoding to use
-     */
+    /** @var string Encoding to use */
     protected $encoding = 'UTF-8';
 
-    /**
-     * @var Escaper
-     */
+    /** @var Escaper */
     protected $escaper;
 
     /**
@@ -89,7 +88,7 @@ public function getEncoding()
     /**
      * Set encoding
      *
-     * @param string
+     * @param string $value
      * @return HTMLCloud
      */
     public function setEncoding($value)

diff --git a/src/Cloud/Decorator/AbstractTag.php b/src/Cloud/Decorator/AbstractTag.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator;
 

diff --git a/src/Cloud/Decorator/DecoratorInterface.php b/src/Cloud/Decorator/DecoratorInterface.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator;
 

diff --git a/src/Cloud/Decorator/Exception/ExceptionInterface.php b/src/Cloud/Decorator/Exception/ExceptionInterface.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator\Exception;
 

diff --git a/src/Cloud/Decorator/Exception/InvalidArgumentException.php b/src/Cloud/Decorator/Exception/InvalidArgumentException.php
@@ -1,10 +1,6 @@
 <?php
 
-/**
- * @see       https://github.com/laminas/laminas-tag for the canonical source repository
- * @copyright https://github.com/laminas/laminas-tag/blob/master/COPYRIGHT.md
- * @license   https://github.com/laminas/laminas-tag/blob/master/LICENSE.md New BSD License
- */
+declare(strict_types=1);
 
 namespace Laminas\Tag\Cloud\Decorator\Exception;