From fb2476b2f7937053a99d30b53c7e5731f6f7b96c Mon Sep 17 00:00:00 2001 From: David Grudl Date: Sun, 24 Oct 2021 19:17:51 +0200 Subject: [PATCH] improved phpDoc --- src/Database/Connection.php | 9 ++++++++- src/Database/Explorer.php | 6 ++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/src/Database/Connection.php b/src/Database/Connection.php index ca1b3afa8..65f7cb0fc 100644 --- a/src/Database/Connection.php +++ b/src/Database/Connection.php @@ -217,6 +217,7 @@ public function transaction(callable $callback) /** * Generates and executes SQL query. + * @param literal-string $sql */ public function query(string $sql, ...$params): ResultSet { @@ -240,7 +241,8 @@ public function queryArgs(string $sql, array $params): ResultSet /** - * @return array [string, array] + * @param literal-string $sql + * @return array{string, array} */ public function preprocess(string $sql, ...$params): array { @@ -262,6 +264,7 @@ public function getLastQueryString(): ?string /** * Shortcut for query()->fetch() + * @param literal-string $sql */ public function fetch(string $sql, ...$params): ?Row { @@ -271,6 +274,7 @@ public function fetch(string $sql, ...$params): ?Row /** * Shortcut for query()->fetchField() + * @param literal-string $sql * @return mixed */ public function fetchField(string $sql, ...$params) @@ -281,6 +285,7 @@ public function fetchField(string $sql, ...$params) /** * Shortcut for query()->fetchFields() + * @param literal-string $sql */ public function fetchFields(string $sql, ...$params): ?array { @@ -290,6 +295,7 @@ public function fetchFields(string $sql, ...$params): ?array /** * Shortcut for query()->fetchPairs() + * @param literal-string $sql */ public function fetchPairs(string $sql, ...$params): array { @@ -299,6 +305,7 @@ public function fetchPairs(string $sql, ...$params): array /** * Shortcut for query()->fetchAll() + * @param literal-string $sql */ public function fetchAll(string $sql, ...$params): array { diff --git a/src/Database/Explorer.php b/src/Database/Explorer.php index 4e33b8730..0b4bd45b0 100644 --- a/src/Database/Explorer.php +++ b/src/Database/Explorer.php @@ -83,6 +83,7 @@ public function getInsertId(string $sequence = null): string /** * Generates and executes SQL query. + * @param literal-string $sql */ public function query(string $sql, ...$params): ResultSet { @@ -126,6 +127,7 @@ public function getConventions(): Conventions /** * Shortcut for query()->fetch() + * @param literal-string $sql */ public function fetch(string $sql, ...$params): ?Row { @@ -135,6 +137,7 @@ public function fetch(string $sql, ...$params): ?Row /** * Shortcut for query()->fetchField() + * @param literal-string $sql * @return mixed */ public function fetchField(string $sql, ...$params) @@ -145,6 +148,7 @@ public function fetchField(string $sql, ...$params) /** * Shortcut for query()->fetchFields() + * @param literal-string $sql */ public function fetchFields(string $sql, ...$params): ?array { @@ -154,6 +158,7 @@ public function fetchFields(string $sql, ...$params): ?array /** * Shortcut for query()->fetchPairs() + * @param literal-string $sql */ public function fetchPairs(string $sql, ...$params): array { @@ -163,6 +168,7 @@ public function fetchPairs(string $sql, ...$params): array /** * Shortcut for query()->fetchAll() + * @param literal-string $sql */ public function fetchAll(string $sql, ...$params): array {