Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: PHPDoc @template and @return in database #7436

Merged
merged 5 commits into from
May 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions system/Database/BaseConnection.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@
* @property bool $transFailure
* @property bool $transStatus
*
* @template TConnection of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TResult
*
* @implements ConnectionInterface<TConnection, TResult>
*/
Expand Down
6 changes: 3 additions & 3 deletions system/Database/BasePreparedQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@
use ErrorException;

/**
* @template TConnection of object|resource
* @template TStatement of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TStatement
* @template TResult
*
* @implements PreparedQueryInterface<TConnection, TStatement, TResult>
*/
Expand Down
8 changes: 5 additions & 3 deletions system/Database/BaseResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
use stdClass;

/**
* @template TConnection of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TResult
*
* @implements ResultInterface<TConnection, TResult>
*/
Expand Down Expand Up @@ -499,6 +499,8 @@ abstract public function getFieldData(): array;

/**
* Frees the current result.
*
* @return void
*/
abstract public function freeResult();

Expand All @@ -525,7 +527,7 @@ abstract protected function fetchAssoc();
*
* Overridden by child classes.
*
* @return object
* @return Entity|false|object|stdClass
*/
abstract protected function fetchObject(string $className = 'stdClass');
}
4 changes: 2 additions & 2 deletions system/Database/ConnectionInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
namespace CodeIgniter\Database;

/**
* @template TConnection of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TResult
*/
interface ConnectionInterface
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/MySQLi/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ public function getFieldData(): array

/**
* Frees the current result.
*
* @return void
*/
public function freeResult()
{
Expand Down
1 change: 1 addition & 0 deletions system/Database/OCI8/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@

use CodeIgniter\Database\BaseResult;
use CodeIgniter\Entity\Entity;
use stdClass;

/**
* Result for OCI8
Expand Down
2 changes: 2 additions & 0 deletions system/Database/Postgre/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ public function getFieldData(): array

/**
* Frees the current result.
*
* @return void
*/
public function freeResult()
{
Expand Down
6 changes: 3 additions & 3 deletions system/Database/PreparedQueryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@
use BadMethodCallException;

/**
* @template TConnection of object|resource
* @template TStatement of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TStatement
* @template TResult
*/
interface PreparedQueryInterface
{
Expand Down
4 changes: 2 additions & 2 deletions system/Database/ResultInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
use stdClass;

/**
* @template TConnection of object|resource
* @template TResult of object|resource
* @template TConnection
* @template TResult
*/
interface ResultInterface
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/SQLSRV/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,8 @@ public function getFieldData(): array

/**
* Frees the current result.
*
* @return void
*/
public function freeResult()
{
Expand Down
2 changes: 2 additions & 0 deletions system/Database/SQLite3/Result.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ public function getFieldData(): array

/**
* Frees the current result.
*
* @return void
*/
public function freeResult()
{
Expand Down
5 changes: 3 additions & 2 deletions system/Test/Mock/MockResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public function getFieldData(): array
/**
* Frees the current result.
*
* @return mixed
* @return void
*/
public function freeResult()
{
Expand All @@ -59,10 +59,11 @@ public function freeResult()
*
* @param int $n
*
* @return mixed
* @return bool
*/
public function dataSeek($n = 0)
{
return true;
}

/**
Expand Down