used PhpStorm Language attribute [WIP]

nette · Sep 25, 2023 · 4e1c94a · 4e1c94a
1 parent a97e07e
commit 4e1c94a
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 13 deletions.
diff --git a/composer.json b/composer.json
@@ -25,7 +25,8 @@
 		"nette/di": "^3.1 || ^4.0",
 		"mockery/mockery": "^1.4.3",
 		"tracy/tracy": "^2.8",
-		"phpstan/phpstan-nette": "^1.0"
+		"phpstan/phpstan-nette": "^1.0",
+		"jetbrains/phpstorm-attributes": "dev-master"
 	},
 	"autoload": {
 		"classmap": ["src/"]

diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -9,6 +9,7 @@
 
 namespace Nette\Database;
 
+use JetBrains\PhpStorm\Language;
 use Nette\Utils\Arrays;
 
 
@@ -198,7 +199,7 @@ public function transaction(callable $callback): mixed
 	 * Generates and executes SQL query.
 	 * @param  literal-string  $sql
 	 */
-	public function query(string $sql, ...$params): ResultSet
+	public function query(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ResultSet
 	{
 		[$this->sql, $params] = $this->preprocess($sql, ...$params);
 		try {
@@ -247,7 +248,7 @@ public function getLastQueryString(): ?string
 	 * Shortcut for query()->fetch()
 	 * @param  literal-string  $sql
 	 */
-	public function fetch(string $sql, ...$params): ?Row
+	public function fetch(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ?Row
 	{
 		return $this->query($sql, ...$params)->fetch();
 	}
@@ -257,7 +258,7 @@ public function fetch(string $sql, ...$params): ?Row
 	 * Shortcut for query()->fetchField()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchField(string $sql, ...$params): mixed
+	public function fetchField(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): mixed
 	{
 		return $this->query($sql, ...$params)->fetchField();
 	}
@@ -267,7 +268,7 @@ public function fetchField(string $sql, ...$params): mixed
 	 * Shortcut for query()->fetchFields()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchFields(string $sql, ...$params): ?array
+	public function fetchFields(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ?array
 	{
 		return $this->query($sql, ...$params)->fetchFields();
 	}
@@ -277,7 +278,7 @@ public function fetchFields(string $sql, ...$params): ?array
 	 * Shortcut for query()->fetchPairs()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchPairs(string $sql, ...$params): array
+	public function fetchPairs(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): array
 	{
 		return $this->query($sql, ...$params)->fetchPairs();
 	}
@@ -287,7 +288,7 @@ public function fetchPairs(string $sql, ...$params): array
 	 * Shortcut for query()->fetchAll()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchAll(string $sql, ...$params): array
+	public function fetchAll(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): array
 	{
 		return $this->query($sql, ...$params)->fetchAll();
 	}

diff --git a/src/Database/Explorer.php b/src/Database/Explorer.php
@@ -9,6 +9,7 @@
 
 namespace Nette\Database;
 
+use JetBrains\PhpStorm\Language;
 use Nette;
 use Nette\Database\Conventions\StaticConventions;
 
@@ -74,7 +75,7 @@ public function getInsertId(?string $sequence = null): string
 	 * Generates and executes SQL query.
 	 * @param  literal-string  $sql
 	 */
-	public function query(string $sql, ...$params): ResultSet
+	public function query(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ResultSet
 	{
 		return $this->connection->query($sql, ...$params);
 	}
@@ -119,7 +120,7 @@ public function getConventions(): Conventions
 	 * Shortcut for query()->fetch()
 	 * @param  literal-string  $sql
 	 */
-	public function fetch(string $sql, ...$params): ?Row
+	public function fetch(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ?Row
 	{
 		return $this->connection->query($sql, ...$params)->fetch();
 	}
@@ -129,7 +130,7 @@ public function fetch(string $sql, ...$params): ?Row
 	 * Shortcut for query()->fetchField()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchField(string $sql, ...$params): mixed
+	public function fetchField(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): mixed
 	{
 		return $this->connection->query($sql, ...$params)->fetchField();
 	}
@@ -139,7 +140,7 @@ public function fetchField(string $sql, ...$params): mixed
 	 * Shortcut for query()->fetchFields()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchFields(string $sql, ...$params): ?array
+	public function fetchFields(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): ?array
 	{
 		return $this->connection->query($sql, ...$params)->fetchFields();
 	}
@@ -149,7 +150,7 @@ public function fetchFields(string $sql, ...$params): ?array
 	 * Shortcut for query()->fetchPairs()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchPairs(string $sql, ...$params): array
+	public function fetchPairs(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): array
 	{
 		return $this->connection->query($sql, ...$params)->fetchPairs();
 	}
@@ -159,7 +160,7 @@ public function fetchPairs(string $sql, ...$params): array
 	 * Shortcut for query()->fetchAll()
 	 * @param  literal-string  $sql
 	 */
-	public function fetchAll(string $sql, ...$params): array
+	public function fetchAll(#[Language('SQL')] string $sql, #[Language('GenericSQL')] ...$params): array
 	{
 		return $this->connection->query($sql, ...$params)->fetchAll();
 	}