Fix phpstan issue with PreparedQuery classes' statement property

paulbalandan · paulbalandan · commit 0490d9fdef86 · 2020-10-25T01:17:00.000+08:00
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -33,7 +33,6 @@ parameters:
 		- '#Call to an undefined method CodeIgniter\\Database\\ConnectionInterface::(tableExists|protectIdentifiers|setAliasedTables|escapeIdentifiers|affectedRows|addTableAlias|getIndexData)\(\)#'
 		- '#Call to an undefined method CodeIgniter\\HTTP\\Request::(getPath|getSegments|getMethod|setLocale|getPost)\(\)#'
 		- '#Call to an undefined method CodeIgniter\\Router\\RouteCollectionInterface::(getDefaultNamespace|isFiltered|getFilterForRoute|getRoutesOptions)\(\)#'
-		- '#Call to function is_null\(\) with mysqli_stmt\|resource will always evaluate to false#'
 		- '#Cannot access property [\$a-z_]+ on ((bool\|)?object\|resource)#'
 		- '#Cannot call method [a-zA-Z_]+\(\) on ((bool\|)?object\|resource)#'
 		- '#Method CodeIgniter\\Database\\ConnectionInterface::query\(\) invoked with 3 parameters, 1-2 required#'
diff --git a/system/Database/MySQLi/PreparedQuery.php b/system/Database/MySQLi/PreparedQuery.php
@@ -48,7 +48,6 @@
  */
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
-
 	/**
 	 * Prepares the query against the database, and saves the connection
 	 * info necessary to execute the query later.
@@ -77,8 +76,6 @@ public function _prepare(string $sql, array $options = [])
 		return $this;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Takes a new set of data and runs it against the currently
 	 * prepared query. Upon success, will return a Results object.
@@ -89,7 +86,7 @@ public function _prepare(string $sql, array $options = [])
 	 */
 	public function _execute(array $data): bool
 	{
-		if (is_null($this->statement))
+		if (! isset($this->statement))
 		{
 			throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');
 		}
@@ -120,8 +117,6 @@ public function _execute(array $data): bool
 		return $this->statement->execute();
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Returns the result object for the prepared query.
 	 *
@@ -131,6 +126,4 @@ public function _getResult()
 	{
 		return $this->statement->get_result();
 	}
-
-	//--------------------------------------------------------------------
 }
diff --git a/system/Database/Postgre/PreparedQuery.php b/system/Database/Postgre/PreparedQuery.php
@@ -49,7 +49,6 @@
  */
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
-
 	/**
 	 * Stores the name this query can be
 	 * used under by postgres. Only used internally.
@@ -66,8 +65,6 @@ class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 	 */
 	protected $result;
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Prepares the query against the database, and saves the connection
 	 * info necessary to execute the query later.
@@ -101,8 +98,6 @@ public function _prepare(string $sql, array $options = [])
 		return $this;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Takes a new set of data and runs it against the currently
 	 * prepared query. Upon success, will return a Results object.
@@ -113,7 +108,7 @@ public function _prepare(string $sql, array $options = [])
 	 */
 	public function _execute(array $data): bool
 	{
-		if (is_null($this->statement))
+		if (! isset($this->statement))
 		{
 			throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');
 		}
@@ -123,8 +118,6 @@ public function _execute(array $data): bool
 		return (bool) $this->result;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Returns the result object for the prepared query.
 	 *
@@ -135,8 +128,6 @@ public function _getResult()
 		return $this->result;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Replaces the ? placeholders with $1, $2, etc parameters for use
 	 * within the prepared query.
@@ -155,6 +146,4 @@ public function parameterize(string $sql): string
 			return "\${$count}";
 		}, $sql);
 	}
-
-	//--------------------------------------------------------------------
 }
diff --git a/system/Database/SQLite3/PreparedQuery.php b/system/Database/SQLite3/PreparedQuery.php
@@ -49,16 +49,13 @@
 
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
-
 	/**
 	 * The SQLite3Result resource, or false.
 	 *
 	 * @var Result|boolean
 	 */
 	protected $result;
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Prepares the query against the database, and saves the connection
 	 * info necessary to execute the query later.
@@ -74,18 +71,15 @@ class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 	 */
 	public function _prepare(string $sql, array $options = [])
 	{
-		// @phpstan-ignore-next-line
 		if (! ($this->statement = $this->db->connID->prepare($sql)))
 		{
-			$this->errorCode   = $this->db->connID->lastErrorCode(); // @phpstan-ignore-line
-			$this->errorString = $this->db->connID->lastErrorMsg(); // @phpstan-ignore-line
+			$this->errorCode   = $this->db->connID->lastErrorCode();
+			$this->errorString = $this->db->connID->lastErrorMsg();
 		}
 
 		return $this;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Takes a new set of data and runs it against the currently
 	 * prepared query. Upon success, will return a Results object.
@@ -98,7 +92,7 @@ public function _prepare(string $sql, array $options = [])
 	 */
 	public function _execute(array $data): bool
 	{
-		if (is_null($this->statement))
+		if (! isset($this->statement))
 		{
 			throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');
 		}
@@ -128,8 +122,6 @@ public function _execute(array $data): bool
 		return $this->result !== false;
 	}
 
-	//--------------------------------------------------------------------
-
 	/**
 	 * Returns the result object for the prepared query.
 	 *
@@ -139,7 +131,4 @@ public function _getResult()
 	{
 		return $this->result;
 	}
-
-	//--------------------------------------------------------------------
-
 }
diff --git a/system/Database/Sqlsrv/PreparedQuery.php b/system/Database/Sqlsrv/PreparedQuery.php
@@ -49,7 +49,6 @@
  */
 class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 {
-
 	/**
 	 * Parameters array used to store the dynamic variables.
 	 *
@@ -64,7 +63,6 @@ class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface
 	 */
 	protected $result;
 
-	//--------------------------------------------------------------------
 	/**
 	 * Prepares the query against the database, and saves the connection
 	 * info necessary to execute the query later.
@@ -108,7 +106,7 @@ public function _prepare(string $sql, array $options = [])
 	 */
 	public function _execute(array $data): bool
 	{
-		if (is_null($this->statement))
+		if (! isset($this->statement))
 		{
 			throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');
 		}
@@ -154,5 +152,4 @@ protected function parameterize(string $queryString): array
 
 		return $params;
 	}
-
 }

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,6 @@`
`48`	`48`	`*/`
`49`	`49`	`class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface`
`50`	`50`	`{`
`51`		`-`
`52`	`51`	`/**`
`53`	`52`	`* Prepares the query against the database, and saves the connection`
`54`	`53`	`* info necessary to execute the query later.`
`@@ -77,8 +76,6 @@ public function _prepare(string $sql, array $options = [])`
`77`	`76`	`return $this;`
`78`	`77`	`}`
`79`	`78`
`80`		`- //--------------------------------------------------------------------`
`81`		`-`
`82`	`79`	`/**`
`83`	`80`	`* Takes a new set of data and runs it against the currently`
`84`	`81`	`* prepared query. Upon success, will return a Results object.`
`@@ -89,7 +86,7 @@ public function _prepare(string $sql, array $options = [])`
`89`	`86`	`*/`
`90`	`87`	`public function _execute(array $data): bool`
`91`	`88`	`{`
`92`		`- if (is_null($this->statement))`
	`89`	`+ if (! isset($this->statement))`
`93`	`90`	`{`
`94`	`91`	`throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');`
`95`	`92`	`}`
`@@ -120,8 +117,6 @@ public function _execute(array $data): bool`
`120`	`117`	`return $this->statement->execute();`
`121`	`118`	`}`
`122`	`119`
`123`		`- //--------------------------------------------------------------------`
`124`		`-`
`125`	`120`	`/**`
`126`	`121`	`* Returns the result object for the prepared query.`
`127`	`122`	`*`
`@@ -131,6 +126,4 @@ public function _getResult()`
`131`	`126`	`{`
`132`	`127`	`return $this->statement->get_result();`
`133`	`128`	`}`
`134`		`-`
`135`		`- //--------------------------------------------------------------------`
`136`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,6 @@`
`49`	`49`	`*/`
`50`	`50`	`class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface`
`51`	`51`	`{`
`52`		`-`
`53`	`52`	`/**`
`54`	`53`	`* Stores the name this query can be`
`55`	`54`	`* used under by postgres. Only used internally.`
`@@ -66,8 +65,6 @@ class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface`
`66`	`65`	`*/`
`67`	`66`	`protected $result;`
`68`	`67`
`69`		`- //--------------------------------------------------------------------`
`70`		`-`
`71`	`68`	`/**`
`72`	`69`	`* Prepares the query against the database, and saves the connection`
`73`	`70`	`* info necessary to execute the query later.`
`@@ -101,8 +98,6 @@ public function _prepare(string $sql, array $options = [])`
`101`	`98`	`return $this;`
`102`	`99`	`}`
`103`	`100`
`104`		`- //--------------------------------------------------------------------`
`105`		`-`
`106`	`101`	`/**`
`107`	`102`	`* Takes a new set of data and runs it against the currently`
`108`	`103`	`* prepared query. Upon success, will return a Results object.`
`@@ -113,7 +108,7 @@ public function _prepare(string $sql, array $options = [])`
`113`	`108`	`*/`
`114`	`109`	`public function _execute(array $data): bool`
`115`	`110`	`{`
`116`		`- if (is_null($this->statement))`
	`111`	`+ if (! isset($this->statement))`
`117`	`112`	`{`
`118`	`113`	`throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');`
`119`	`114`	`}`
`@@ -123,8 +118,6 @@ public function _execute(array $data): bool`
`123`	`118`	`return (bool) $this->result;`
`124`	`119`	`}`
`125`	`120`
`126`		`- //--------------------------------------------------------------------`
`127`		`-`
`128`	`121`	`/**`
`129`	`122`	`* Returns the result object for the prepared query.`
`130`	`123`	`*`
`@@ -135,8 +128,6 @@ public function _getResult()`
`135`	`128`	`return $this->result;`
`136`	`129`	`}`
`137`	`130`
`138`		`- //--------------------------------------------------------------------`
`139`		`-`
`140`	`131`	`/**`
`141`	`132`	`* Replaces the ? placeholders with $1, $2, etc parameters for use`
`142`	`133`	`* within the prepared query.`
`@@ -155,6 +146,4 @@ public function parameterize(string $sql): string`
`155`	`146`	`return "\${$count}";`
`156`	`147`	`}, $sql);`
`157`	`148`	`}`
`158`		`-`
`159`		`- //--------------------------------------------------------------------`
`160`	`149`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,16 +49,13 @@`
`49`	`49`
`50`	`50`	`class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface`
`51`	`51`	`{`
`52`		`-`
`53`	`52`	`/**`
`54`	`53`	`* The SQLite3Result resource, or false.`
`55`	`54`	`*`
`56`	`55`	`* @var Result\|boolean`
`57`	`56`	`*/`
`58`	`57`	`protected $result;`
`59`	`58`
`60`		`- //--------------------------------------------------------------------`
`61`		`-`
`62`	`59`	`/**`
`63`	`60`	`* Prepares the query against the database, and saves the connection`
`64`	`61`	`* info necessary to execute the query later.`
`@@ -74,18 +71,15 @@ class PreparedQuery extends BasePreparedQuery implements PreparedQueryInterface`
`74`	`71`	`*/`
`75`	`72`	`public function _prepare(string $sql, array $options = [])`
`76`	`73`	`{`
`77`		`- // @phpstan-ignore-next-line`
`78`	`74`	`if (! ($this->statement = $this->db->connID->prepare($sql)))`
`79`	`75`	`{`
`80`		`- $this->errorCode = $this->db->connID->lastErrorCode(); // @phpstan-ignore-line`
`81`		`- $this->errorString = $this->db->connID->lastErrorMsg(); // @phpstan-ignore-line`
	`76`	`+ $this->errorCode = $this->db->connID->lastErrorCode();`
	`77`	`+ $this->errorString = $this->db->connID->lastErrorMsg();`
`82`	`78`	`}`
`83`	`79`
`84`	`80`	`return $this;`
`85`	`81`	`}`
`86`	`82`
`87`		`- //--------------------------------------------------------------------`
`88`		`-`
`89`	`83`	`/**`
`90`	`84`	`* Takes a new set of data and runs it against the currently`
`91`	`85`	`* prepared query. Upon success, will return a Results object.`
`@@ -98,7 +92,7 @@ public function _prepare(string $sql, array $options = [])`
`98`	`92`	`*/`
`99`	`93`	`public function _execute(array $data): bool`
`100`	`94`	`{`
`101`		`- if (is_null($this->statement))`
	`95`	`+ if (! isset($this->statement))`
`102`	`96`	`{`
`103`	`97`	`throw new BadMethodCallException('You must call prepare before trying to execute a prepared statement.');`
`104`	`98`	`}`
`@@ -128,8 +122,6 @@ public function _execute(array $data): bool`
`128`	`122`	`return $this->result !== false;`
`129`	`123`	`}`
`130`	`124`
`131`		`- //--------------------------------------------------------------------`
`132`		`-`
`133`	`125`	`/**`
`134`	`126`	`* Returns the result object for the prepared query.`
`135`	`127`	`*`
`@@ -139,7 +131,4 @@ public function _getResult()`
`139`	`131`	`{`
`140`	`132`	`return $this->result;`
`141`	`133`	`}`
`142`		`-`
`143`		`- //--------------------------------------------------------------------`
`144`		`-`
`145`	`134`	`}`