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.

Sign up for GitHub

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

docs: replace mixed in Database doc comments #6502

Merged
merged 3 commits into from
Sep 7, 2022
Merged

docs: replace mixed in Database doc comments #6502

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a2ecbd2
docs: fix types in doc comments
kenjis Aug 30, 2022
555b7ca
docs: fix types in doc comments
kenjis Sep 7, 2022
b45760f
docs: add @phpstan-return
kenjis Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions system/Database/BaseConnection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* @property mixed $encrypt
* @property array $failover
* @property string $hostname
* @property mixed $lastQuery
* @property Query $lastQuery
* @property string $password
* @property bool $pConnect
* @property int|string $port
Expand Down Expand Up @@ -154,7 +154,7 @@ abstract class BaseConnection implements ConnectionInterface
/**
* Encryption flag/data
*
* @var mixed
* @var array|bool
*/
protected $encrypt = false;

Expand Down Expand Up @@ -185,7 +185,7 @@ abstract class BaseConnection implements ConnectionInterface
* The last query object that was executed
* on this connection.
*
* @var mixed
* @var Query
*/
protected $lastQuery;

Expand Down Expand Up @@ -932,7 +932,7 @@ public function prepare(Closure $func, array $options = [])
/**
* Returns the last query's statement object.
*
* @return mixed
* @return Query
*/
public function getLastQuery()
{
Expand Down Expand Up @@ -1149,9 +1149,10 @@ private function protectDotItem(string $item, string $alias, bool $protectIdenti
*
* This function escapes column and table names
*
* @param mixed $item
* @param array|string $item
*
* @return mixed
* @return array|string
* @phpstan-return ($item is array ? array : string)
*/
public function escapeIdentifiers($item)
{
Expand Down Expand Up @@ -1231,9 +1232,10 @@ abstract public function affectedRows(): int;
* Escapes data based on type.
* Sets boolean and null types
*
* @param mixed $str
* @param array|bool|float|int|object|string|null $str
*
* @return mixed
* @return array|float|int|string
* @phpstan-return ($str is array ? array : float|int|string)
*/
public function escape($str)
{
Expand Down
5 changes: 3 additions & 2 deletions system/Database/ConnectionInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,10 @@ public function getLastQuery();
* Escapes data based on type.
* Sets boolean and null types.
*
* @param mixed $str
* @param array|bool|float|int|object|string|null $str
*
* @return mixed
* @return array|float|int|string
* @phpstan-return ($str is array ? array : float|int|string)
*/
public function escape($str);

Expand Down
5 changes: 3 additions & 2 deletions system/Database/Postgre/Connection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,10 @@ public function affectedRows(): int
*
* Escapes data based on type
*
* @param mixed $str
* @param array|bool|float|int|object|string|null $str
*
* @return mixed
* @return array|float|int|string
* @phpstan-return ($str is array ? array : float|int|string)
*/
public function escape($str)
{
Expand Down