Fix errors reported by phpstan.

ADmad · ADmad · commit e475be71eecf · 2017-11-29T20:09:32.000+05:30
diff --git a/phpstan.neon b/phpstan.neon
@@ -15,14 +15,13 @@ parameters:
         - '#Call to an undefined method Psr\\Http\\Message\\ResponseInterface::getCookies\(\)#'
         - '#Access to an undefined property Psr\\Http\\Message\\UriInterface::\$webroot#'
         - '#Access to an undefined property Psr\\Http\\Message\\UriInterface::\$base#'
-        - '#Call to an undefined method Cake\\Collection\\Iterator\\ZipIterator::getInnerIterator\(\)#'
-        - '#Call to an undefined method Cake\\ORM\\ResultSet::getInnerIterator\(\)#'
         - '#Result of method Cake\\Http\\Response::send\(\) \(void\) is used#'
         - '#Method Cake\\View\\Form\\ContextInterface::val\(\) invoked with 2 parameters, 1 required#'
         - '#Access to an undefined property Exception::\$queryString#'
         - '#Access to an undefined property PHPUnit\\Framework\\Test::\$fixtureManager#'
         - '#Method Redis::#'
         - '#Call to an undefined method Traversable::getArrayCopy().#'
+        - '#Variable $config in isset\(\) is never defined#'
     earlyTerminatingMethodCalls:
         Cake\Shell\Shell:
             - abort
diff --git a/src/Cache/Engine/ApcEngine.php b/src/Cache/Engine/ApcEngine.php
@@ -14,7 +14,7 @@
  */
 namespace Cake\Cache\Engine;
 
-use APCUIterator;
+use APCuIterator;
 use Cake\Cache\CacheEngine;
 
 /**
@@ -144,8 +144,8 @@ public function clear($check)
         if ($check) {
             return true;
         }
-        if (class_exists('APCUIterator', false)) {
-            $iterator = new APCUIterator(
+        if (class_exists('APCuIterator', false)) {
+            $iterator = new APCuIterator(
                 '/^' . preg_quote($this->_config['prefix'], '/') . '/',
                 APC_ITER_NONE
             );
diff --git a/src/Console/ConsoleInputArgument.php b/src/Console/ConsoleInputArgument.php
@@ -15,7 +15,7 @@
 namespace Cake\Console;
 
 use Cake\Console\Exception\ConsoleException;
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * An object to represent a single argument used in the command line.
@@ -178,10 +178,10 @@ public function validChoice($value)
     /**
      * Append this arguments XML representation to the passed in SimpleXml object.
      *
-     * @param \SimpleXmlElement $parent The parent element.
-     * @return \SimpleXmlElement The parent with this argument appended.
+     * @param \SimpleXMLElement $parent The parent element.
+     * @return \SimpleXMLElement The parent with this argument appended.
      */
-    public function xml(SimpleXmlElement $parent)
+    public function xml(SimpleXMLElement $parent)
     {
         $option = $parent->addChild('argument');
         $option->addAttribute('name', $this->_name);
diff --git a/src/Console/ConsoleInputOption.php b/src/Console/ConsoleInputOption.php
@@ -15,7 +15,7 @@
 namespace Cake\Console;
 
 use Cake\Console\Exception\ConsoleException;
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * An object to represent a single option used in the command line.
@@ -240,10 +240,10 @@ public function validChoice($value)
     /**
      * Append the option's xml into the parent.
      *
-     * @param \SimpleXmlElement $parent The parent element.
-     * @return \SimpleXmlElement The parent with this option appended.
+     * @param \SimpleXMLElement $parent The parent element.
+     * @return \SimpleXMLElement The parent with this option appended.
      */
-    public function xml(SimpleXmlElement $parent)
+    public function xml(SimpleXMLElement $parent)
     {
         $option = $parent->addChild('option');
         $option->addAttribute('name', '--' . $this->_name);
diff --git a/src/Console/ConsoleInputSubcommand.php b/src/Console/ConsoleInputSubcommand.php
@@ -16,7 +16,7 @@
  */
 namespace Cake\Console;
 
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * An object to represent a single subcommand used in the command line.
@@ -126,10 +126,10 @@ public function parser()
     /**
      * Append this subcommand to the Parent element
      *
-     * @param \SimpleXmlElement $parent The parent element.
-     * @return \SimpleXmlElement The parent with this subcommand appended.
+     * @param \SimpleXMLElement $parent The parent element.
+     * @return \SimpleXMLElement The parent with this subcommand appended.
      */
-    public function xml(SimpleXmlElement $parent)
+    public function xml(SimpleXMLElement $parent)
     {
         $command = $parent->addChild('command');
         $command->addAttribute('name', $this->_name);
diff --git a/src/Console/HelpFormatter.php b/src/Console/HelpFormatter.php
@@ -16,7 +16,7 @@
 
 use Cake\Console\Exception\ConsoleException;
 use Cake\Utility\Text;
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * HelpFormatter formats help for console shells. Can format to either
@@ -211,12 +211,12 @@ protected function _getMaxLength($collection)
      * Get the help as an xml string.
      *
      * @param bool $string Return the SimpleXml object or a string. Defaults to true.
-     * @return string|\SimpleXmlElement See $string
+     * @return string|\SimpleXMLElement See $string
      */
     public function xml($string = true)
     {
         $parser = $this->_parser;
-        $xml = new SimpleXmlElement('<shell></shell>');
+        $xml = new SimpleXMLElement('<shell></shell>');
         $xml->addChild('command', $parser->getCommand());
         $xml->addChild('description', $parser->getDescription());
 
diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php
@@ -123,15 +123,15 @@ class Controller implements EventListenerInterface, EventDispatcherInterface
      * This object contains all the information about a request and several methods for reading
      * additional information about the request.
      *
-     * @var \Cake\Http\ServerRequest
+     * @var \Cake\Http\ServerRequest|null
      * @link https://book.cakephp.org/3.0/en/controllers/request-response.html#request
      */
     public $request;
 
     /**
      * An instance of a Response object that contains information about the impending response
      *
-     * @var \Cake\Http\Response
+     * @var \Cake\Http\Response|null
      * @link https://book.cakephp.org/3.0/en/controllers/request-response.html#response
      */
     public $response;
diff --git a/src/Core/ObjectRegistry.php b/src/Core/ObjectRegistry.php
@@ -126,6 +126,7 @@ protected function _checkDuplicate($name, $config)
         if (empty($config)) {
             return;
         }
+        /* @var \Cake\Core\InstanceConfigTrait $existing */
         $existingConfig = $existing->getConfig();
         unset($config['enabled'], $existingConfig['enabled']);
 
diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -827,7 +827,7 @@ public function logger($instance = null)
     /**
      * Sets a logger
      *
-     * @param object $logger Logger object
+     * @param \Cake\Database\Log\QueryLogger $logger Logger object
      * @return $this
      */
     public function setLogger($logger)
@@ -840,7 +840,7 @@ public function setLogger($logger)
     /**
      * Gets the logger object
      *
-     * @return object logger instance
+     * @return \Cake\Database\Log\QueryLogger logger instance
      */
     public function getLogger()
     {
diff --git a/src/Database/Log/LoggingStatement.php b/src/Database/Log/LoggingStatement.php
@@ -110,8 +110,8 @@ public function bindValue($column, $value, $type = 'string')
      * it returns the currently setup logger instance
      *
      * @deprecated 3.5.0 Use getLogger() and setLogger() instead.
-     * @param object|null $instance Logger object instance.
-     * @return object|null Logger instance
+     * @param \Cake\Database\Log\QueryLogger|null $instance Logger object instance.
+     * @return \Cake\Database\Log\QueryLogger|null Logger instance
      */
     public function logger($instance = null)
     {
@@ -125,7 +125,7 @@ public function logger($instance = null)
     /**
      * Sets a logger
      *
-     * @param object $logger Logger object
+     * @param \Cake\Database\Log\QueryLogger $logger Logger object
      * @return void
      */
     public function setLogger($logger)
@@ -136,7 +136,7 @@ public function setLogger($logger)
     /**
      * Gets the logger object
      *
-     * @return object logger instance
+     * @return \Cake\Database\Log\QueryLogger logger instance
      */
     public function getLogger()
     {
diff --git a/src/Event/EventManager.php b/src/Event/EventManager.php
@@ -63,7 +63,7 @@ class EventManager
     /**
      * Enables automatic adding of events to the event list object if it is present.
      *
-     * @param bool
+     * @var bool
      */
     protected $_trackEvents = false;
 
diff --git a/src/Http/Cookie/Cookie.php b/src/Http/Cookie/Cookie.php
@@ -16,7 +16,7 @@
 use Cake\Chronos\Chronos;
 use Cake\Utility\Hash;
 use DateTimeImmutable;
-use DateTimezone;
+use DateTimeZone;
 use InvalidArgumentException;
 
 /**
@@ -146,7 +146,7 @@ public function __construct(
         $this->validateBool($secure);
         $this->secure = $secure;
         if ($expiresAt) {
-            $expiresAt = $expiresAt->setTimezone(new DateTimezone('GMT'));
+            $expiresAt = $expiresAt->setTimezone(new DateTimeZone('GMT'));
         }
         $this->expiresAt = $expiresAt;
     }
@@ -397,7 +397,7 @@ public function isHttpOnly()
     public function withExpiry($dateTime)
     {
         $new = clone $this;
-        $new->expiresAt = $dateTime->setTimezone(new DateTimezone('GMT'));
+        $new->expiresAt = $dateTime->setTimezone(new DateTimeZone('GMT'));
 
         return $new;
     }
@@ -439,7 +439,7 @@ public function getFormattedExpires()
      */
     public function isExpired($time = null)
     {
-        $time = $time ?: new DateTimeImmutable('now', new DateTimezone('UTC'));
+        $time = $time ?: new DateTimeImmutable('now', new DateTimeZone('UTC'));
         if (!$this->expiresAt) {
             return false;
         }
diff --git a/src/Http/Middleware/CsrfProtectionMiddleware.php b/src/Http/Middleware/CsrfProtectionMiddleware.php
@@ -157,7 +157,7 @@ protected function _addTokenToRequest($token, ServerRequest $request)
      * @param string $token The token to add.
      * @param \Cake\Http\ServerRequest $request The request to validate against.
      * @param \Cake\Http\Response $response The response.
-     * @return @param \Cake\Http\Response $response Modified response.
+     * @return \Cake\Http\Response $response Modified response.
      */
     protected function _addTokenCookie($token, ServerRequest $request, Response $response)
     {
diff --git a/src/Http/Server.php b/src/Http/Server.php
@@ -109,7 +109,7 @@ public function emit(ResponseInterface $response, EmitterInterface $emitter = nu
     /**
      * Set the application.
      *
-     * @param Cake\Core\HttpApplicationInterface $app The application to set.
+     * @param \Cake\Core\HttpApplicationInterface $app The application to set.
      * @return $this
      */
     public function setApp(HttpApplicationInterface $app)
diff --git a/src/I18n/I18n.php b/src/I18n/I18n.php
@@ -168,7 +168,7 @@ public static function translator($name = 'default', $locale = null, callable $l
      * ```
      *
      * @param string $name The domain of the translation messages.
-     * @param callable|null $loader A callback function or callable class responsible for
+     * @param callable $loader A callback function or callable class responsible for
      *   constructing a translations package instance.
      * @param string|null $locale The locale for the translator.
      * @return void
diff --git a/src/I18n/RelativeTimeFormatter.php b/src/I18n/RelativeTimeFormatter.php
@@ -15,7 +15,7 @@
 namespace Cake\I18n;
 
 use Cake\Chronos\ChronosInterface;
-use DatetimeInterface;
+use DateTimeInterface;
 
 /**
  * Helper class for formatting relative dates & times.
@@ -91,7 +91,7 @@ public function diffForHumans(ChronosInterface $date, ChronosInterface $other =
      * @return string Relative time string.
      * @see \Cake\I18n\Time::timeAgoInWords()
      */
-    public function timeAgoInWords(DatetimeInterface $time, array $options = [])
+    public function timeAgoInWords(DateTimeInterface $time, array $options = [])
     {
         $options = $this->_options($options, FrozenTime::class);
         if ($options['timezone'] && $time instanceof ChronosInterface) {
@@ -276,12 +276,12 @@ protected function _diffData($futureTime, $pastTime, $backwards, $options)
     /**
      * Format a into a relative date string.
      *
-     * @param \DatetimeInterface $date The date to format.
+     * @param \DateTimeInterface $date The date to format.
      * @param array $options Array of options.
      * @return string Relative date string.
      * @see \Cake\I18n\Date::timeAgoInWords()
      */
-    public function dateAgoInWords(DatetimeInterface $date, array $options = [])
+    public function dateAgoInWords(DateTimeInterface $date, array $options = [])
     {
         $options = $this->_options($options, FrozenDate::class);
         if ($options['timezone'] && $date instanceof ChronosInterface) {
diff --git a/src/Mailer/Email.php b/src/Mailer/Email.php
@@ -33,7 +33,7 @@
 use PDO;
 use RuntimeException;
 use Serializable;
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * CakePHP Email class.
@@ -2694,7 +2694,7 @@ protected function _getContentTypeCharset()
      * It has certain limitations for viewVars that are good to know:
      *
      *    - ORM\Query executed and stored as resultset
-     *    - SimpleXmlElements stored as associative array
+     *    - SimpleXMLElements stored as associative array
      *    - Exceptions stored as strings
      *    - Resources, \Closure and \PDO are not supported.
      *
@@ -2784,7 +2784,7 @@ public function serialize()
     {
         $array = $this->jsonSerialize();
         array_walk_recursive($array, function (&$item, $key) {
-            if ($item instanceof SimpleXmlElement) {
+            if ($item instanceof SimpleXMLElement) {
                 $item = json_decode(json_encode((array)$item), true);
             }
         });
diff --git a/src/ORM/Association.php b/src/ORM/Association.php
@@ -1431,7 +1431,7 @@ abstract public function isOwningSide(Table $side);
      * the saving operation to the target table.
      *
      * @param \Cake\Datasource\EntityInterface $entity the data to be saved
-     * @param array|\ArrayObject $options The options for saving associated data.
+     * @param array $options The options for saving associated data.
      * @return bool|\Cake\Datasource\EntityInterface false if $entity could not be saved, otherwise it returns
      * the saved entity
      * @see \Cake\ORM\Table::save()
diff --git a/src/ORM/EagerLoadable.php b/src/ORM/EagerLoadable.php
@@ -35,7 +35,7 @@ class EagerLoadable
     /**
      * A list of other associations to load from this level.
      *
-     * @var \Cake\Orm\EagerLoadable[]
+     * @var \Cake\ORM\EagerLoadable[]
      */
     protected $_associations = [];
 
diff --git a/src/ORM/Query.php b/src/ORM/Query.php
@@ -424,7 +424,7 @@ public function clearContain()
      * Used to recursively add contained association column types to
      * the query.
      *
-     * @param \Cake\ORM\Table|\Cake\Datasource\RepositoryInterface $table The table instance to pluck associations from.
+     * @param \Cake\ORM\Table $table The table instance to pluck associations from.
      * @param \Cake\Database\TypeMap $typeMap The typemap to check for columns in.
      *   This typemap is indirectly mutated via Cake\ORM\Query::addDefaultTypes()
      * @param array $associations The nested tree of associations to walk.
diff --git a/src/ORM/TableRegistry.php b/src/ORM/TableRegistry.php
@@ -97,7 +97,7 @@ public static function getTableLocator()
     /**
      * Sets singleton instance of LocatorInterface implementation.
      *
-     * @param \Cake\ORM\Locator\LocatorInterface|null $tableLocator Instance of a locator to use.
+     * @param \Cake\ORM\Locator\LocatorInterface $tableLocator Instance of a locator to use.
      * @return void
      */
     public static function setTableLocator(LocatorInterface $tableLocator)
diff --git a/src/Routing/RouteCollection.php b/src/Routing/RouteCollection.php
@@ -181,7 +181,7 @@ public function parse($url, $method = '')
     /**
      * Takes the ServerRequestInterface, iterates the routes until one is able to parse the route.
      *
-     * @param \Psr\Http\Messages\ServerRequestInterface $request The request to parse route data from.
+     * @param \Psr\Http\Message\ServerRequestInterface $request The request to parse route data from.
      * @return array An array of request parameters parsed from the URL.
      * @throws \Cake\Routing\Exception\MissingRouteException When a URL has no matching route.
      */
diff --git a/src/Shell/CommandListShell.php b/src/Shell/CommandListShell.php
@@ -19,7 +19,7 @@
 use Cake\Core\Configure;
 use Cake\Core\Plugin;
 use Cake\Utility\Inflector;
-use SimpleXmlElement;
+use SimpleXMLElement;
 
 /**
  * Shows a list of commands available from the console.
@@ -128,7 +128,7 @@ protected function _asText($shellList)
     protected function _asXml($shellList)
     {
         $plugins = Plugin::loaded();
-        $shells = new SimpleXmlElement('<shells></shells>');
+        $shells = new SimpleXMLElement('<shells></shells>');
         foreach ($shellList as $plugin => $commands) {
             foreach ($commands as $command) {
                 $callable = $command;
diff --git a/src/Shell/HelpShell.php b/src/Shell/HelpShell.php
diff --git a/src/Shell/OrmCacheShell.php b/src/Shell/OrmCacheShell.php
diff --git a/src/TestSuite/Fixture/TestFixture.php b/src/TestSuite/Fixture/TestFixture.php
diff --git a/src/TestSuite/TestCase.php b/src/TestSuite/TestCase.php
diff --git a/src/Utility/Hash.php b/src/Utility/Hash.php
diff --git a/src/Utility/Security.php b/src/Utility/Security.php
diff --git a/src/Utility/Xml.php b/src/Utility/Xml.php
diff --git a/src/Validation/Validation.php b/src/Validation/Validation.php
diff --git a/src/View/Form/EntityContext.php b/src/View/Form/EntityContext.php
diff --git a/src/View/Helper/HtmlHelper.php b/src/View/Helper/HtmlHelper.php

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,7 @@ protected function _checkDuplicate($name, $config)`
`126`	`126`	`if (empty($config)) {`
`127`	`127`	`return;`
`128`	`128`	`}`
	`129`	`+ /* @var \Cake\Core\InstanceConfigTrait $existing */`
`129`	`130`	`$existingConfig = $existing->getConfig();`
`130`	`131`	`unset($config['enabled'], $existingConfig['enabled']);`
`131`	`132`
Original file line number	Diff line number	Diff line change
`@@ -827,7 +827,7 @@ public function logger($instance = null)`
`827`	`827`	`/**`
`828`	`828`	`* Sets a logger`
`829`	`829`	`*`
`830`		`- * @param object $logger Logger object`
	`830`	`+ * @param \Cake\Database\Log\QueryLogger $logger Logger object`
`831`	`831`	`* @return $this`
`832`	`832`	`*/`
`833`	`833`	`public function setLogger($logger)`
`@@ -840,7 +840,7 @@ public function setLogger($logger)`
`840`	`840`	`/**`
`841`	`841`	`* Gets the logger object`
`842`	`842`	`*`
`843`		`- * @return object logger instance`
	`843`	`+ * @return \Cake\Database\Log\QueryLogger logger instance`
`844`	`844`	`*/`
`845`	`845`	`public function getLogger()`
`846`	`846`	`{`
Original file line number	Diff line number	Diff line change
`@@ -110,8 +110,8 @@ public function bindValue($column, $value, $type = 'string')`
`110`	`110`	`* it returns the currently setup logger instance`
`111`	`111`	`*`
`112`	`112`	`* @deprecated 3.5.0 Use getLogger() and setLogger() instead.`
`113`		`- * @param object\|null $instance Logger object instance.`
`114`		`- * @return object\|null Logger instance`
	`113`	`+ * @param \Cake\Database\Log\QueryLogger\|null $instance Logger object instance.`
	`114`	`+ * @return \Cake\Database\Log\QueryLogger\|null Logger instance`
`115`	`115`	`*/`
`116`	`116`	`public function logger($instance = null)`
`117`	`117`	`{`
`@@ -125,7 +125,7 @@ public function logger($instance = null)`
`125`	`125`	`/**`
`126`	`126`	`* Sets a logger`
`127`	`127`	`*`
`128`		`- * @param object $logger Logger object`
	`128`	`+ * @param \Cake\Database\Log\QueryLogger $logger Logger object`
`129`	`129`	`* @return void`
`130`	`130`	`*/`
`131`	`131`	`public function setLogger($logger)`
`@@ -136,7 +136,7 @@ public function setLogger($logger)`
`136`	`136`	`/**`
`137`	`137`	`* Gets the logger object`
`138`	`138`	`*`
`139`		`- * @return object logger instance`
	`139`	`+ * @return \Cake\Database\Log\QueryLogger logger instance`
`140`	`140`	`*/`
`141`	`141`	`public function getLogger()`
`142`	`142`	`{`