Feature/new php cs fixer (#155)

* Applied a bunch of new linting rules. Small changes. * Implemented a few more PHP CS Fixer changes.
simplepie · May 3, 2019 · 4d87078 · 4d87078
1 parent 0c2f2c1
commit 4d87078
Show file tree

Hide file tree

Showing 124 changed files with 3,514 additions and 3,526 deletions.
diff --git a/.php_cs.dist b/.php_cs.dist
diff --git a/.phpunit.result.cache b/.phpunit.result.cache
diff --git a/src/Configuration/SetLoggerInterface.php b/src/Configuration/SetLoggerInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Dictionary/Entity.php b/src/Dictionary/Entity.php
diff --git a/src/Enum/AbstractEnum.php b/src/Enum/AbstractEnum.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/CharacterSet.php b/src/Enum/CharacterSet.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/DateFormat.php b/src/Enum/DateFormat.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/EnumInterface.php b/src/Enum/EnumInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/ErrorMessage.php b/src/Enum/ErrorMessage.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/FeedType.php b/src/Enum/FeedType.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Enum/Serialization.php b/src/Enum/Serialization.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Exception/ConfigurationException.php b/src/Exception/ConfigurationException.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Exception/ContainerException.php b/src/Exception/ContainerException.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Exception/MiddlewareException.php b/src/Exception/MiddlewareException.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Exception/NotFoundException.php b/src/Exception/NotFoundException.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Exception/SimplePieException.php b/src/Exception/SimplePieException.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/HandlerStack.php b/src/HandlerStack.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -171,8 +171,6 @@ public function registerNamespaces(Ns $ns): void
 
     /**
      * Returns information about the HandlerStack that is useful for debugging.
-     *
-     * @return array
      */
     public function debugStack(): array
     {
@@ -212,8 +210,8 @@ public function debugStack(): array
      */
     protected function validateMiddleware(
         callable $middleware,
-        ?string $name = null,
-        ?string $overrideType = null,
+        ?string $name,
+        ?string $overrideType,
         callable $fn
     ): void {
         // @phpcs:enable
@@ -253,8 +251,6 @@ protected function logRegistration(callable $middleware, ?string $name = null):
      *
      * @param callable    $middleware The middleware to add to the stack.
      * @param string|null $name       A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
-     *
-     * @return string
      */
     protected function exceptionMessage(callable $middleware, ?string $name = null): string
     {

diff --git a/src/HandlerStackInterface.php b/src/HandlerStackInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -36,8 +36,6 @@ interface HandlerStackInterface extends C\SetLoggerInterface
      *                                  will be thrown.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function append(callable $middleware, ?string $name = null, ?string $overrideType = null): self;
 
@@ -54,8 +52,6 @@ public function append(callable $middleware, ?string $name = null, ?string $over
      * @param string|null $name         A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function appendClosure(string $overrideType, callable $middleware, ?string $name = null): self;
 
@@ -72,8 +68,6 @@ public function appendClosure(string $overrideType, callable $middleware, ?strin
      *                                  will be thrown.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function prepend(callable $middleware, ?string $name = null, ?string $overrideType = null): self;
 
@@ -90,8 +84,6 @@ public function prepend(callable $middleware, ?string $name = null, ?string $ove
      * @param string|null $name         A name for the middleware. Can be used with `pushBefore()` and `pushAfter()`.
      *
      * @throws MiddlewareException
-     *
-     * @return self
      */
     public function prependClosure(string $overrideType, callable $middleware, ?string $name = null): self;
 

diff --git a/src/Middleware/AbstractMiddleware.php b/src/Middleware/AbstractMiddleware.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -68,8 +68,6 @@ public function addArrayProperty(&$object, string $property): void
      * @param array  $arr     The associative array to check.
      * @param string $key     The key in the associative array to return the value for.
      * @param mixed  $default The default value to return if there is no value. The default value is `null`.
-     *
-     * @return mixed
      */
     public function get(array $arr, string $key, $default = null)
     {

diff --git a/src/Middleware/Html/HtmlInterface.php b/src/Middleware/Html/HtmlInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Middleware/Json/JsonInterface.php b/src/Middleware/Json/JsonInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Middleware/MiddlewareInterface.php b/src/Middleware/MiddlewareInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Middleware/Xml/AbstractXmlMiddleware.php b/src/Middleware/Xml/AbstractXmlMiddleware.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -34,8 +34,6 @@ abstract class AbstractXmlMiddleware extends AbstractMiddleware
      * @param bool $makeInsensitive Whether or not the handling should be made case-insensitive. A value of `true`
      *                              means that the handling should be case-insensitive. A value of `false` means that
      *                              the handling should be case-sensitive. The default value is `true`.
-     *
-     * @return self
      */
     public function setCaseInsensitive(bool $makeInsensitive = true): self
     {
@@ -51,8 +49,6 @@ public function setCaseInsensitive(bool $makeInsensitive = true): self
      *
      * @param string $query          An XPath query where `%s` is used in-place of the XML namespace alias.
      * @param string $namespaceAlias The XML namespace alias to apply.
-     *
-     * @return string
      */
     public function applyNsToQuery(string $query, string $namespaceAlias): string
     {

diff --git a/src/Middleware/Xml/Atom.php b/src/Middleware/Xml/Atom.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */

diff --git a/src/Middleware/Xml/XmlInterface.php b/src/Middleware/Xml/XmlInterface.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -40,8 +40,6 @@ public function __invoke(stdClass $feedRoot, string $namespaceAlias, DOMXPath $x
      *     'http://www.w3.org/2005/Atom' => 'atom10'
      * ];
      * ```
-     *
-     * @return array
      */
     public function getSupportedNamespaces(): array;
 }
diff --git a/src/Mixin/DateTrait.php b/src/Mixin/DateTrait.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -36,8 +36,6 @@ trait DateTrait
      *
      * @param string $createFromFormat The format of the datestamp in the feed.
      *
-     * @return self
-     *
      * @see http://php.net/manual/en/datetime.createfromformat.php
      */
     public function setDateFormat(string $createFromFormat): self
@@ -59,8 +57,6 @@ public function setDateFormat(string $createFromFormat): self
      *
      * @param string $timezone The timezone identifier to use. Must be compatible with `DateTimeZone`. The default
      *                         value is `UTC`.
-     *
-     * @return self
      */
     public function setOutputTimezone(string $timezone = 'UTC'): self
     {

diff --git a/src/Mixin/DeepTypeTrait.php b/src/Mixin/DeepTypeTrait.php
@@ -1,7 +1,7 @@
 <?php
 /**
- * Copyright (c) 2017–2018 Ryan Parman <http://ryanparman.com>.
- * Copyright (c) 2017–2018 Contributors.
+ * Copyright (c) 2017–2019 Ryan Parman <http://ryanparman.com>.
+ * Copyright (c) 2017–2019 Contributors.
  *
  * http://opensource.org/licenses/Apache2.0
  */
@@ -10,7 +10,6 @@
 
 namespace SimplePie\Mixin;
 
-use SimplePie\Configuration as C;
 use SimplePie\Type\Node;
 use SimplePie\Type\TypeInterface;
 use Skyzyx\UtilityPack\Types;
@@ -36,8 +35,6 @@ trait DeepTypeTrait
      *                                    looking at the response from `getRoot()`.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return Node
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getScalarSingleValue(
@@ -66,8 +63,6 @@ protected function getScalarSingleValue(
      * @param string      $className      The class name to instantiate when there is not a defined value.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return TypeInterface
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getComplexSingleValue(
@@ -96,8 +91,6 @@ protected function getComplexSingleValue(
      *                                    looking at the response from `getRoot()`.
      * @param string|null $namespaceAlias The XML namespace alias to apply.
      *
-     * @return iterable
-     *
      * @phpcs:disable Generic.Functions.OpeningFunctionBraceBsdAllman.BraceOnSameLine
      */
     protected function getComplexMultipleValues(