zhamao-robot/zhamao-framework
1
0
Fork 0
mirror of https://github.com/zhamao-robot/zhamao-framework.git synced 2026-07-23 16:45:35 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix MySQLWrapper related PHPDoc and variables

Browse Source
This commit is contained in:
crazywhalecc
2022-04-03 01:12:35 +08:00
committed by Jerry Ma
parent 7eea71e282
commit 30b2d2134b
1 changed files with 88 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
src/ZM/MySQL/MySQLWrapper.php
View File

@@ -13,6 +13,7 @@ use Doctrine\DBAL\Cache\QueryCacheProfile;
use Doctrine\DBAL\Connection; use Doctrine\DBAL\Connection;
use Doctrine\DBAL\DriverManager; use Doctrine\DBAL\DriverManager;
use Doctrine\DBAL\ParameterType; use Doctrine\DBAL\ParameterType;
use Doctrine\DBAL\Types\Type;
use Throwable; use Throwable;
use Traversable; use Traversable;
use ZM\Exception\DbException; use ZM\Exception\DbException;
@@ -113,10 +114,10 @@ class MySQLWrapper
} }
/** /**
* @param mixed $table * @param string $table 表
* @throws DbException * @throws DbException
*/ */
public function delete($table, array $criteria, array $types = []): int public function delete(string $table, array $criteria, array $types = []): int
{ {
try { try {
return $this->connection->delete($table, $criteria, $types); return $this->connection->delete($table, $criteria, $types);
@@ -127,9 +128,9 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $level * @param int $level Sets the transaction isolation level
*/ */
public function setTransactionIsolation($level): int public function setTransactionIsolation(int $level): int
{ {
return $this->connection->setTransactionIsolation($level); return $this->connection->setTransactionIsolation($level);
} }
@@ -144,10 +145,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $table * @param string $table 表名
* @throws DbException * @throws DbException
*/ */
public function update($table, array $data, array $criteria, array $types = []): int public function update(string $table, array $data, array $criteria, array $types = []): int
{ {
try { try {
return $this->connection->update($table, $data, $criteria, $types); return $this->connection->update($table, $data, $criteria, $types);
@@ -158,10 +159,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $table * @param string $table 表名
* @throws DbException * @throws DbException
*/ */
public function insert($table, array $data, array $types = []): int public function insert(string $table, array $data, array $types = []): int
{ {
try { try {
return $this->connection->insert($table, $data, $types); return $this->connection->insert($table, $data, $types);
@@ -172,18 +173,17 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $str * @param string $str The name to be quoted
*/ */
public function quoteIdentifier($str): string public function quoteIdentifier(string $str): string
{ {
return $this->connection->quoteIdentifier($str); return $this->connection->quoteIdentifier($str);
} }
/** /**
* wrapper method * wrapper method
* @param mixed $value * @param mixed $value
* @param int $type * @param null|int|string|Type $type
* @return mixed
*/ */
public function quote($value, $type = ParameterType::STRING) public function quote($value, $type = ParameterType::STRING)
{ {
@@ -192,7 +192,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return array<int,array<int,mixed>>
*/ */
public function fetchAllNumeric(string $query, array $params = [], array $types = []): array public function fetchAllNumeric(string $query, array $params = [], array $types = []): array
{ {
@@ -205,7 +210,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return array<int,array<string,mixed>>
*/ */
public function fetchAllAssociative(string $query, array $params = [], array $types = []): array public function fetchAllAssociative(string $query, array $params = [], array $types = []): array
{ {
@@ -218,6 +228,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, int|string>|array<string, int|string> $types Parameter types
*
* @throws DbException * @throws DbException
*/ */
public function fetchAllKeyValue(string $query, array $params = [], array $types = []): array public function fetchAllKeyValue(string $query, array $params = [], array $types = []): array
@@ -231,7 +245,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, int|string>|array<string, int|string> $types Parameter types
*
* @throws DbException * @throws DbException
* @return array<mixed,array<string,mixed>>
*/ */
public function fetchAllAssociativeIndexed(string $query, array $params = [], array $types = []): array public function fetchAllAssociativeIndexed(string $query, array $params = [], array $types = []): array
{ {
@@ -244,7 +263,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return array<int,mixed>
*/ */
public function fetchFirstColumn(string $query, array $params = [], array $types = []): array public function fetchFirstColumn(string $query, array $params = [], array $types = []): array
{ {
@@ -257,7 +281,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return Traversable<int,array<int,mixed>>
*/ */
public function iterateNumeric(string $query, array $params = [], array $types = []): Traversable public function iterateNumeric(string $query, array $params = [], array $types = []): Traversable
{ {
@@ -270,7 +299,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return Traversable<int,array<string,mixed>>
*/ */
public function iterateAssociative(string $query, array $params = [], array $types = []): Traversable public function iterateAssociative(string $query, array $params = [], array $types = []): Traversable
{ {
@@ -283,7 +317,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, int|string>|array<string, int|string> $types Parameter types
*
* @throws DbException * @throws DbException
* @return Traversable<mixed,mixed>
*/ */
public function iterateKeyValue(string $query, array $params = [], array $types = []): Traversable public function iterateKeyValue(string $query, array $params = [], array $types = []): Traversable
{ {
@@ -296,7 +335,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, int|string>|array<string, int|string> $types Parameter types
*
* @throws DbException * @throws DbException
* @return Traversable<mixed,array<string,mixed>>
*/ */
public function iterateAssociativeIndexed(string $query, array $params = [], array $types = []): Traversable public function iterateAssociativeIndexed(string $query, array $params = [], array $types = []): Traversable
{ {
@@ -309,7 +353,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param string $query SQL query
* @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return Traversable<int,mixed>
*/ */
public function iterateColumn(string $query, array $params = [], array $types = []): Traversable public function iterateColumn(string $query, array $params = [], array $types = []): Traversable
{ {
@@ -322,11 +371,13 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $sql * @param string $sql SQL query
* @param array $types * @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
*/ */
public function executeQuery($sql, array $params = [], $types = [], ?QueryCacheProfile $qcp = null): MySQLStatementWrapper public function executeQuery(string $sql, array $params = [], array $types = [], ?QueryCacheProfile $qcp = null): MySQLStatementWrapper
{ {
try { try {
$query = $this->connection->executeQuery($sql, $params, $types, $qcp); $query = $this->connection->executeQuery($sql, $params, $types, $qcp);
@@ -338,12 +389,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $sql * @param string $sql SQL query
* @param mixed $params * @param array<int, mixed>|array<string, mixed> $params Query parameters
* @param mixed $types * @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
* @throws DbException * @throws DbException
*/ */
public function executeCacheQuery($sql, $params, $types, QueryCacheProfile $qcp): MySQLStatementWrapper public function executeCacheQuery(string $sql, array $params, array $types, QueryCacheProfile $qcp): MySQLStatementWrapper
{ {
try { try {
$query = $this->connection->executeCacheQuery($sql, $params, $types, $qcp); $query = $this->connection->executeCacheQuery($sql, $params, $types, $qcp);
@@ -355,10 +406,14 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $sql * @param string $sql SQL statement
* @param array<int, mixed>|array<string, mixed> $params Statement parameters
* @param array<int, null|int|string|Type>|array<string, null|int|string|Type> $types Parameter types
*
* @throws DbException * @throws DbException
* @return int|string the number of affected rows
*/ */
public function executeStatement($sql, array $params = [], array $types = []): int public function executeStatement(string $sql, array $params = [], array $types = [])
{ {
try { try {
return $this->connection->executeStatement($sql, $params, $types); return $this->connection->executeStatement($sql, $params, $types);
@@ -377,9 +432,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param null $name * @param null|string $name name of the sequence object from which the ID should be returned
* @return false|int|string a string representation of the last inserted ID
*/ */
public function lastInsertId($name = null): string public function lastInsertId(?string $name = null)
{ {
return $this->connection->lastInsertId($name); return $this->connection->lastInsertId($name);
} }
@@ -404,13 +460,12 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $nestTransactionsWithSavepoints
* @throws DbException * @throws DbException
*/ */
public function setNestTransactionsWithSavepoints($nestTransactionsWithSavepoints) public function setNestTransactionsWithSavepoints(bool $nest_transactions_with_savepoints)
{ {
try { try {
$this->connection->setNestTransactionsWithSavepoints($nestTransactionsWithSavepoints); $this->connection->setNestTransactionsWithSavepoints($nest_transactions_with_savepoints);
} catch (Throwable $e) { } catch (Throwable $e) {
throw new DbException($e->getMessage(), $e->getCode(), $e); throw new DbException($e->getMessage(), $e->getCode(), $e);
} }
@@ -460,10 +515,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $savepoint * @param string $savepoint the name of the savepoint to create
* @throws DbException * @throws DbException
*/ */
public function createSavepoint($savepoint) public function createSavepoint(string $savepoint)
{ {
try { try {
$this->connection->createSavepoint($savepoint); $this->connection->createSavepoint($savepoint);
@@ -474,10 +529,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $savepoint * @param string $savepoint the name of the savepoint to release
* @throws DbException * @throws DbException
*/ */
public function releaseSavepoint($savepoint) public function releaseSavepoint(string $savepoint)
{ {
try { try {
$this->connection->releaseSavepoint($savepoint); $this->connection->releaseSavepoint($savepoint);
@@ -488,10 +543,10 @@ class MySQLWrapper
/** /**
* wrapper method * wrapper method
* @param mixed $savepoint * @param string $savepoint the name of the savepoint to rollback to
* @throws DbException * @throws DbException
*/ */
public function rollbackSavepoint($savepoint) public function rollbackSavepoint(string $savepoint)
{ {
try { try {
$this->connection->rollbackSavepoint($savepoint); $this->connection->rollbackSavepoint($savepoint);