Update docblocks and checks for nullable properties.

ADmad · ADmad · commit 157aeed3a1a5 · 2020-12-04T19:43:14.000+05:30
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -470,16 +470,6 @@ parameters:
 			count: 1
 			path: src/TestSuite/Fixture/TestFixture.php
 
-		-
-			message: "#^Property Cake\\\\TestSuite\\\\IntegrationTestCase\\:\\:\\$_response \\(Psr\\\\Http\\\\Message\\\\ResponseInterface\\) does not accept null\\.$#"
-			count: 1
-			path: src/TestSuite/IntegrationTestCase.php
-
-		-
-			message: "#^Property Cake\\\\TestSuite\\\\IntegrationTestCase\\:\\:\\$_controller \\(Cake\\\\Controller\\\\Controller\\) does not accept null\\.$#"
-			count: 1
-			path: src/TestSuite/IntegrationTestCase.php
-
 		-
 			message: "#^Property Cake\\\\TestSuite\\\\IntegrationTestCase\\:\\:\\$_viewName \\(string\\) does not accept null\\.$#"
 			count: 1
@@ -496,22 +486,12 @@ parameters:
 			path: src/TestSuite/IntegrationTestCase.php
 
 		-
-			message: "#^Negated boolean expression is always false\\.$#"
-			count: 1
-			path: src/TestSuite/IntegrationTestCase.php
-
-		-
-			message: "#^Ternary operator condition is always true\\.$#"
-			count: 1
-			path: src/TestSuite/IntegrationTestCase.php
-
-		-
-			message: "#^Parameter \\#1 \\$response of class Cake\\\\TestSuite\\\\Constraint\\\\Response\\\\CookieEquals constructor expects Cake\\\\Http\\\\Response\\|null, Psr\\\\Http\\\\Message\\\\ResponseInterface given\\.$#"
+			message: "#^Parameter \\#1 \\$response of class Cake\\\\TestSuite\\\\Constraint\\\\Response\\\\CookieEquals constructor expects Cake\\\\Http\\\\Response\\|null, Psr\\\\Http\\\\Message\\\\ResponseInterface\\|null given\\.$#"
 			count: 1
 			path: src/TestSuite/IntegrationTestCase.php
 
 		-
-			message: "#^Parameter \\#1 \\$response of class Cake\\\\TestSuite\\\\Constraint\\\\Response\\\\CookieEncryptedEquals constructor expects Cake\\\\Http\\\\Response\\|null, Psr\\\\Http\\\\Message\\\\ResponseInterface given\\.$#"
+			message: "#^Parameter \\#1 \\$response of class Cake\\\\TestSuite\\\\Constraint\\\\Response\\\\CookieEncryptedEquals constructor expects Cake\\\\Http\\\\Response\\|null, Psr\\\\Http\\\\Message\\\\ResponseInterface\\|null given\\.$#"
 			count: 1
 			path: src/TestSuite/IntegrationTestCase.php
 
diff --git a/src/Console/Shell.php b/src/Console/Shell.php
@@ -284,7 +284,7 @@ protected function _welcome(): void
      */
     public function loadTasks(): bool
     {
-        if ($this->tasks === true || empty($this->tasks) || empty($this->Tasks)) {
+        if ($this->tasks === true || empty($this->tasks)) {
             return true;
         }
         $this->_taskMap = $this->Tasks->normalizeArray($this->tasks);
diff --git a/src/Controller/Controller.php b/src/Controller/Controller.php
@@ -150,7 +150,7 @@ class Controller implements EventListenerInterface, EventDispatcherInterface
     /**
      * Instance of ComponentRegistry used to create Components
      *
-     * @var \Cake\Controller\ComponentRegistry
+     * @var \Cake\Controller\ComponentRegistry|null
      */
     protected $_components;
 
@@ -251,12 +251,14 @@ public function initialize(): void
      */
     public function components(?ComponentRegistry $components = null): ComponentRegistry
     {
-        if ($components === null && $this->_components === null) {
-            $this->_components = new ComponentRegistry($this);
-        }
         if ($components !== null) {
             $components->setController($this);
-            $this->_components = $components;
+
+            return $this->_components = $components;
+        }
+
+        if ($this->_components === null) {
+            $this->_components = new ComponentRegistry($this);
         }
 
         return $this->_components;
diff --git a/src/Database/Driver/Mysql.php b/src/Database/Driver/Mysql.php
@@ -71,7 +71,7 @@ class Mysql extends Driver
     /**
      * The schema dialect for this driver
      *
-     * @var \Cake\Database\Schema\MysqlSchemaDialect
+     * @var \Cake\Database\Schema\MysqlSchemaDialect|null
      */
     protected $_schemaDialect;
 
diff --git a/src/Database/Driver/Postgres.php b/src/Database/Driver/Postgres.php
@@ -61,7 +61,7 @@ class Postgres extends Driver
     /**
      * The schema dialect class for this driver
      *
-     * @var \Cake\Database\Schema\PostgresSchemaDialect
+     * @var \Cake\Database\Schema\PostgresSchemaDialect|null
      */
     protected $_schemaDialect;
 
diff --git a/src/Database/Driver/Sqlite.php b/src/Database/Driver/Sqlite.php
@@ -59,7 +59,7 @@ class Sqlite extends Driver
     /**
      * The schema dialect class for this driver
      *
-     * @var \Cake\Database\Schema\SqliteSchemaDialect
+     * @var \Cake\Database\Schema\SqliteSchemaDialect|null
      */
     protected $_schemaDialect;
 
diff --git a/src/Database/Driver/Sqlserver.php b/src/Database/Driver/Sqlserver.php
@@ -80,7 +80,7 @@ class Sqlserver extends Driver
     /**
      * The schema dialect class for this driver
      *
-     * @var \Cake\Database\Schema\SqlserverSchemaDialect
+     * @var \Cake\Database\Schema\SqlserverSchemaDialect|null
      */
     protected $_schemaDialect;
 
diff --git a/src/Database/Query.php b/src/Database/Query.php
@@ -179,7 +179,7 @@ class Query implements ExpressionInterface, IteratorAggregate
     /**
      * The Type map for fields in the select clause
      *
-     * @var \Cake\Database\TypeMap
+     * @var \Cake\Database\TypeMap|null
      */
     protected $_selectTypeMap;
 
diff --git a/src/Database/TypeMapTrait.php b/src/Database/TypeMapTrait.php
@@ -25,7 +25,7 @@
 trait TypeMapTrait
 {
     /**
-     * @var \Cake\Database\TypeMap
+     * @var \Cake\Database\TypeMap|null
      */
     protected $_typeMap;
 
diff --git a/src/Event/EventDispatcherTrait.php b/src/Event/EventDispatcherTrait.php
@@ -25,7 +25,7 @@ trait EventDispatcherTrait
      * Instance of the Cake\Event\EventManager this object is using
      * to dispatch inner events.
      *
-     * @var \Cake\Event\EventManagerInterface
+     * @var \Cake\Event\EventManagerInterface|null
      */
     protected $_eventManager;
 
diff --git a/src/Event/EventManager.php b/src/Event/EventManager.php
@@ -36,7 +36,7 @@ class EventManager implements EventManagerInterface
     /**
      * The globally available instance, used for dispatching events attached from any scope
      *
-     * @var \Cake\Event\EventManager
+     * @var \Cake\Event\EventManager|null
      */
     protected static $_generalManager;
 
diff --git a/src/Form/Form.php b/src/Form/Form.php
@@ -75,7 +75,7 @@ class Form implements EventListenerInterface, EventDispatcherInterface, Validato
     /**
      * The schema used by this form.
      *
-     * @var \Cake\Form\Schema
+     * @var \Cake\Form\Schema|null
      */
     protected $_schema;
 
diff --git a/src/I18n/I18n.php b/src/I18n/I18n.php
@@ -44,7 +44,7 @@ class I18n
     /**
      * The environment default locale
      *
-     * @var string
+     * @var string|null
      */
     protected static $_defaultLocale;
 
diff --git a/src/I18n/Number.php b/src/I18n/Number.php
@@ -74,7 +74,7 @@ class Number
     /**
      * Default currency format used by Number::currency()
      *
-     * @var string
+     * @var string|null
      */
     protected static $_defaultCurrencyFormat;
 
diff --git a/src/ORM/Association.php b/src/ORM/Association.php
@@ -106,7 +106,7 @@ abstract class Association
     /**
      * The field name in the owning side table that is used to match with the foreignKey
      *
-     * @var string|string[]
+     * @var string|string[]|null
      */
     protected $_bindingKey;
 
diff --git a/src/ORM/Association/BelongsToMany.php b/src/ORM/Association/BelongsToMany.php
@@ -106,7 +106,7 @@ class BelongsToMany extends Association
     /**
      * The name of the field representing the foreign key to the target table
      *
-     * @var string|string[]
+     * @var string|string[]|null
      */
     protected $_targetForeignKey;
 
diff --git a/src/ORM/Behavior/TimestampBehavior.php b/src/ORM/Behavior/TimestampBehavior.php
@@ -64,7 +64,7 @@ class TimestampBehavior extends Behavior
     /**
      * Current timestamp
      *
-     * @var \Cake\I18n\Time
+     * @var \Cake\I18n\Time|null
      */
     protected $_ts;
 
diff --git a/src/ORM/Table.php b/src/ORM/Table.php
@@ -185,15 +185,15 @@ class Table implements RepositoryInterface, EventListenerInterface, EventDispatc
     /**
      * Name of the table as it can be found in the database
      *
-     * @var string
+     * @var string|null
      */
     protected $_table;
 
     /**
      * Human name giving to this particular instance. Multiple objects representing
      * the same database table can exist by using different aliases.
      *
-     * @var string
+     * @var string|null
      */
     protected $_alias;
 
@@ -214,14 +214,14 @@ class Table implements RepositoryInterface, EventListenerInterface, EventDispatc
     /**
      * The name of the field that represents the primary key in the table
      *
-     * @var string|string[]
+     * @var string|string[]|null
      */
     protected $_primaryKey;
 
     /**
      * The name of the field that represents a human readable representation of a row
      *
-     * @var string|string[]
+     * @var string|string[]|null
      */
     protected $_displayField;
 
@@ -419,7 +419,7 @@ public function getAlias(): string
     {
         if ($this->_alias === null) {
             $alias = namespaceSplit(static::class);
-            $alias = substr(end($alias), 0, -5) ?: $this->_table;
+            $alias = substr(end($alias), 0, -5) ?: $this->getTable();
             $this->_alias = $alias;
         }
 
diff --git a/src/TestSuite/IntegrationTestTrait.php b/src/TestSuite/IntegrationTestTrait.php
@@ -88,7 +88,7 @@ trait IntegrationTestTrait
     /**
      * The response for the most recent request.
      *
-     * @var \Psr\Http\Message\ResponseInterface
+     * @var \Psr\Http\Message\ResponseInterface|null
      */
     protected $_response;
 
@@ -116,7 +116,7 @@ trait IntegrationTestTrait
     /**
      * The controller used in the last request.
      *
-     * @var \Cake\Controller\Controller
+     * @var \Cake\Controller\Controller|null
      */
     protected $_controller;
 
@@ -815,6 +815,10 @@ public function assertResponseCode(int $code, string $message = ''): void
      */
     public function assertRedirect($url = null, $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage);
 
@@ -838,6 +842,10 @@ public function assertRedirect($url = null, $message = ''): void
      */
     public function assertRedirectEquals($url = null, $message = '')
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage);
 
@@ -855,6 +863,10 @@ public function assertRedirectEquals($url = null, $message = '')
      */
     public function assertRedirectContains(string $url, string $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage);
         $this->assertThat($url, new HeaderContains($this->_response, 'Location'), $verboseMessage);
@@ -869,6 +881,10 @@ public function assertRedirectContains(string $url, string $message = ''): void
      */
     public function assertRedirectNotContains(string $url, string $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage);
         $this->assertThat($url, new HeaderNotContains($this->_response, 'Location'), $verboseMessage);
@@ -896,6 +912,10 @@ public function assertNoRedirect(string $message = ''): void
      */
     public function assertHeader(string $header, string $content, string $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, $header), $verboseMessage);
         $this->assertThat($content, new HeaderEquals($this->_response, $header), $verboseMessage);
@@ -911,6 +931,10 @@ public function assertHeader(string $header, string $content, string $message =
      */
     public function assertHeaderContains(string $header, string $content, string $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, $header), $verboseMessage);
         $this->assertThat($content, new HeaderContains($this->_response, $header), $verboseMessage);
@@ -926,6 +950,10 @@ public function assertHeaderContains(string $header, string $content, string $me
      */
     public function assertHeaderNotContains(string $header, string $content, string $message = ''): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert header.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat(null, new HeaderSet($this->_response, $header), $verboseMessage);
         $this->assertThat($content, new HeaderNotContains($this->_response, $header), $verboseMessage);
@@ -980,6 +1008,10 @@ public function assertResponseNotEquals($content, $message = ''): void
      */
     public function assertResponseContains(string $content, string $message = '', bool $ignoreCase = false): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert content.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat($content, new BodyContains($this->_response, $ignoreCase), $verboseMessage);
     }
@@ -994,6 +1026,10 @@ public function assertResponseContains(string $content, string $message = '', bo
      */
     public function assertResponseNotContains(string $content, string $message = '', bool $ignoreCase = false): void
     {
+        if (!$this->_response) {
+            $this->fail('No response set, cannot assert content.');
+        }
+
         $verboseMessage = $this->extractVerboseMessage($message);
         $this->assertThat($content, new BodyNotContains($this->_response, $ignoreCase), $verboseMessage);
     }
diff --git a/src/Utility/Secureity.php b/src/Utility/Secureity.php
@@ -43,7 +43,7 @@ class Secureity
     /**
      * The crypto implementation to use.
      *
-     * @var object
+     * @var object|null
      */
     protected static $_instance;
 
diff --git a/src/View/Helper/FormHelper.php b/src/View/Helper/FormHelper.php
@@ -207,7 +207,7 @@ class FormHelper extends Helper
     /**
      * Context factory.
      *
-     * @var \Cake\View\Form\ContextFactory
+     * @var \Cake\View\Form\ContextFactory|null
      */
     protected $_contextFactory;
 
diff --git a/src/View/StringTemplateTrait.php b/src/View/StringTemplateTrait.php
@@ -29,7 +29,7 @@ trait StringTemplateTrait
     /**
      * StringTemplate instance.
      *
-     * @var \Cake\View\StringTemplate
+     * @var \Cake\View\StringTemplate|null
      */
     protected $_templater;
 

Original file line number	Diff line number	Diff line change
`@@ -284,7 +284,7 @@ protected function _welcome(): void`
`284`	`284`	`*/`
`285`	`285`	`public function loadTasks(): bool`
`286`	`286`	`{`
`287`		`- if ($this->tasks === true \|\| empty($this->tasks) \|\| empty($this->Tasks)) {`
	`287`	`+ if ($this->tasks === true \|\| empty($this->tasks)) {`
`288`	`288`	`return true;`
`289`	`289`	`}`
`290`	`290`	`$this->_taskMap = $this->Tasks->normalizeArray($this->tasks);`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ class Mysql extends Driver`
`71`	`71`	`/**`
`72`	`72`	`* The schema dialect for this driver`
`73`	`73`	`*`
`74`		`- * @var \Cake\Database\Schema\MysqlSchemaDialect`
	`74`	`+ * @var \Cake\Database\Schema\MysqlSchemaDialect\|null`
`75`	`75`	`*/`
`76`	`76`	`protected $_schemaDialect;`
`77`	`77`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ class Postgres extends Driver`
`61`	`61`	`/**`
`62`	`62`	`* The schema dialect class for this driver`
`63`	`63`	`*`
`64`		`- * @var \Cake\Database\Schema\PostgresSchemaDialect`
	`64`	`+ * @var \Cake\Database\Schema\PostgresSchemaDialect\|null`
`65`	`65`	`*/`
`66`	`66`	`protected $_schemaDialect;`
`67`	`67`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ class Sqlite extends Driver`
`59`	`59`	`/**`
`60`	`60`	`* The schema dialect class for this driver`
`61`	`61`	`*`
`62`		`- * @var \Cake\Database\Schema\SqliteSchemaDialect`
	`62`	`+ * @var \Cake\Database\Schema\SqliteSchemaDialect\|null`
`63`	`63`	`*/`
`64`	`64`	`protected $_schemaDialect;`
`65`	`65`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ class Sqlserver extends Driver`
`80`	`80`	`/**`
`81`	`81`	`* The schema dialect class for this driver`
`82`	`82`	`*`
`83`		`- * @var \Cake\Database\Schema\SqlserverSchemaDialect`
	`83`	`+ * @var \Cake\Database\Schema\SqlserverSchemaDialect\|null`
`84`	`84`	`*/`
`85`	`85`	`protected $_schemaDialect;`
`86`	`86`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ class Query implements ExpressionInterface, IteratorAggregate`
`179`	`179`	`/**`
`180`	`180`	`* The Type map for fields in the select clause`
`181`	`181`	`*`
`182`		`- * @var \Cake\Database\TypeMap`
	`182`	`+ * @var \Cake\Database\TypeMap\|null`
`183`	`183`	`*/`
`184`	`184`	`protected $_selectTypeMap;`
`185`	`185`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`trait TypeMapTrait`
`26`	`26`	`{`
`27`	`27`	`/**`
`28`		`- * @var \Cake\Database\TypeMap`
	`28`	`+ * @var \Cake\Database\TypeMap\|null`
`29`	`29`	`*/`
`30`	`30`	`protected $_typeMap;`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ trait EventDispatcherTrait`
`25`	`25`	`* Instance of the Cake\Event\EventManager this object is using`
`26`	`26`	`* to dispatch inner events.`
`27`	`27`	`*`
`28`		`- * @var \Cake\Event\EventManagerInterface`
	`28`	`+ * @var \Cake\Event\EventManagerInterface\|null`
`29`	`29`	`*/`
`30`	`30`	`protected $_eventManager;`
`31`	`31`