added PHP 8 typehints

dg · dg · commit 935ef1f22a7a · 2021-04-23T20:59:30.000+02:00
diff --git a/src/Database/Connection.php b/src/Database/Connection.php
@@ -169,10 +169,7 @@ public function rollBack(): void
 	}
 
 
-	/**
-	 * @return mixed
-	 */
-	public function transaction(callable $callback)
+	public function transaction(callable $callback): mixed
 	{
 		if ($this->transactionDepth === 0) {
 			$this->beginTransaction();
@@ -253,9 +250,8 @@ public function fetch(string $sql, ...$params): ?Row
 
 	/**
 	 * Shortcut for query()->fetchField()
-	 * @return mixed
 	 */
-	public function fetchField(string $sql, ...$params)
+	public function fetchField(string $sql, ...$params): mixed
 	{
 		return $this->query($sql, ...$params)->fetchField();
 	}
diff --git a/src/Database/Conventions.php b/src/Database/Conventions.php
@@ -16,9 +16,8 @@ interface Conventions
 {
 	/**
 	 * Returns primary key for table.
-	 * @return string|string[]|null
 	 */
-	function getPrimary(string $table);
+	function getPrimary(string $table): string|array|null;
 
 	/**
 	 * Returns referenced table & referenced column.
diff --git a/src/Database/Conventions/DiscoveredConventions.php b/src/Database/Conventions/DiscoveredConventions.php
@@ -27,7 +27,7 @@ public function __construct(IStructure $structure)
 	}
 
 
-	public function getPrimary(string $table)
+	public function getPrimary(string $table): string|array|null
 	{
 		return $this->structure->getPrimaryKey($table);
 	}
diff --git a/src/Database/Driver.php b/src/Database/Driver.php
@@ -55,7 +55,6 @@ function formatLike(string $value, int $pos): string;
 
 	/**
 	 * Injects LIMIT/OFFSET to the SQL query.
-	 * @param  string  $sql query that will be modified.
 	 */
 	function applyLimit(string &$sql, ?int $limit, ?int $offset): void;
 
diff --git a/src/Database/DriverException.php b/src/Database/DriverException.php
@@ -20,10 +20,7 @@ class DriverException extends \PDOException
 	public ?array $params = null;
 
 
-	/**
-	 * @return static
-	 */
-	public static function from(\PDOException $src)
+	public static function from(\PDOException $src): static
 	{
 		$e = new static($src->message, 0, $src);
 		$e->file = $src->file;
@@ -41,10 +38,7 @@ public static function from(\PDOException $src)
 	}
 
 
-	/**
-	 * @return int|string|null  Driver-specific error code
-	 */
-	public function getDriverCode()
+	public function getDriverCode(): int|string|null
 	{
 		return $this->errorInfo[1] ?? null;
 	}
diff --git a/src/Database/Explorer.php b/src/Database/Explorer.php
@@ -60,10 +60,7 @@ public function rollBack(): void
 	}
 
 
-	/**
-	 * @return mixed
-	 */
-	public function transaction(callable $callback)
+	public function transaction(callable $callback): mixed
 	{
 		return $this->connection->transaction(fn() => $callback($this));
 	}
@@ -128,9 +125,8 @@ public function fetch(string $sql, ...$params): ?Row
 
 	/**
 	 * Shortcut for query()->fetchField()
-	 * @return mixed
 	 */
-	public function fetchField(string $sql, ...$params)
+	public function fetchField(string $sql, ...$params): mixed
 	{
 		return $this->connection->query($sql, ...$params)->fetchField();
 	}
diff --git a/src/Database/IStructure.php b/src/Database/IStructure.php
@@ -41,7 +41,7 @@ function getColumns(string $table): array;
 	 * Returns table primary key.
 	 * @return string|string[]|null
 	 */
-	function getPrimaryKey(string $table);
+	function getPrimaryKey(string $table): string|array|null;
 
 	/**
 	 * Returns autoincrement primary key name.
diff --git a/src/Database/ResultSet.php b/src/Database/ResultSet.php
@@ -244,9 +244,8 @@ public function fetch(): ?Row
 
 	/**
 	 * Fetches single field.
-	 * @return mixed
 	 */
-	public function fetchField($column = 0)
+	public function fetchField(int $column = 0): mixed
 	{
 		if (func_num_args()) {
 			trigger_error(__METHOD__ . '() argument is deprecated.', E_USER_DEPRECATED);
@@ -271,7 +270,7 @@ public function fetchFields(): ?array
 	 * @param  string|int  $key  column name used for an array key or null for numeric index
 	 * @param  string|int  $value  column name used for an array value or null for the whole row
 	 */
-	public function fetchPairs($key = null, $value = null): array
+	public function fetchPairs(string|int $key = null, string|int $value = null): array
 	{
 		return Helpers::toPairs($this->fetchAll(), $key, $value);
 	}
@@ -292,7 +291,6 @@ public function fetchAll(): array
 
 	/**
 	 * Fetches all rows and returns associative tree.
-	 * @param  string  $path  associative descriptor
 	 */
 	public function fetchAssoc(string $path): array
 	{
diff --git a/src/Database/Row.php b/src/Database/Row.php
@@ -33,9 +33,8 @@ public function __isset($key)
 	/**
 	 * Returns a item.
 	 * @param  string|int  $key  key or index
-	 * @return mixed
 	 */
-	public function offsetGet($key)
+	public function offsetGet($key): mixed
 	{
 		if (is_int($key)) {
 			$arr = array_slice((array) $this, $key, 1);
diff --git a/src/Database/Structure.php b/src/Database/Structure.php
@@ -54,7 +54,7 @@ public function getColumns(string $table): array
 	/**
 	 * @return string|string[]|null
 	 */
-	public function getPrimaryKey(string $table)
+	public function getPrimaryKey(string $table): string|array|null
 	{
 		$this->needStructure();
 		$table = $this->resolveFQTableName($table);
diff --git a/src/Database/Table/ActiveRow.php b/src/Database/Table/ActiveRow.php
@@ -67,7 +67,7 @@ public function toArray(): array
 	 * Returns primary key value.
 	 * @return mixed possible int, string, array, object (Nette\Utils\DateTime)
 	 */
-	public function getPrimary(bool $throw = true)
+	public function getPrimary(bool $throw = true): mixed
 	{
 		$primary = $this->table->getPrimary($throw);
 		if ($primary === null) {
@@ -216,9 +216,8 @@ public function offsetSet($column, $value): void
 	/**
 	 * Returns value of column.
 	 * @param  string  $column
-	 * @return mixed
 	 */
-	public function offsetGet($column)
+	public function offsetGet($column): mixed
 	{
 		return $this->__get($column);
 	}
@@ -254,7 +253,7 @@ public function __set($column, $value)
 	 * @return ActiveRow|mixed
 	 * @throws Nette\MemberAccessException
 	 */
-	public function &__get(string $key)
+	public function &__get(string $key): mixed
 	{
 		if ($this->accessColumn($key)) {
 			return $this->data[$key];
diff --git a/src/Database/Table/GroupedSelection.php b/src/Database/Table/GroupedSelection.php
@@ -54,19 +54,15 @@ public function __construct(
 	 * Sets active group.
 	 * @internal
 	 * @param  int|string  $active  primary key of grouped rows
-	 * @return static
 	 */
-	public function setActive($active)
+	public function setActive(int|string $active): static
 	{
 		$this->active = $active;
 		return $this;
 	}
 
 
-	/**
-	 * @return static
-	 */
-	public function select($columns, ...$params)
+	public function select($columns, ...$params): static
 	{
 		if (!$this->sqlBuilder->getSelect()) {
 			$this->sqlBuilder->addSelect("$this->name.$this->column");
@@ -76,10 +72,7 @@ public function select($columns, ...$params)
 	}
 
 
-	/**
-	 * @return static
-	 */
-	public function order(string $columns, ...$params)
+	public function order(string $columns, ...$params): static
 	{
 		if (!$this->sqlBuilder->getOrder()) {
 			// improve index utilization
@@ -93,10 +86,7 @@ public function order(string $columns, ...$params)
 	/********************* aggregations ****************d*g**/
 
 
-	/**
-	 * @return mixed
-	 */
-	public function aggregation(string $function)
+	public function aggregation(string $function): mixed
 	{
 		$aggregation = &$this->getRefTable($refPath)->aggregation[$refPath . $function . $this->sqlBuilder->getSelectQueryHash($this->getPreviousAccessedColumns())];
 
@@ -228,7 +218,7 @@ protected function emptyResultSet(bool $saveCache = true, bool $deleteRererenced
 	/********************* manipulation ****************d*g**/
 
 
-	public function insert(iterable $data)
+	public function insert(iterable $data): ActiveRow|array|int|bool
 	{
 		if ($data instanceof \Traversable && !$data instanceof Selection) {
 			$data = iterator_to_array($data);
diff --git a/src/Database/Table/Selection.php b/src/Database/Table/Selection.php

Original file line number	Diff line number	Diff line change
`@@ -169,10 +169,7 @@ public function rollBack(): void`
`169`	`169`	`}`
`170`	`170`
`171`	`171`
`172`		`- /**`
`173`		`- * @return mixed`
`174`		`- */`
`175`		`- public function transaction(callable $callback)`
	`172`	`+ public function transaction(callable $callback): mixed`
`176`	`173`	`{`
`177`	`174`	`if ($this->transactionDepth === 0) {`
`178`	`175`	`$this->beginTransaction();`
`@@ -253,9 +250,8 @@ public function fetch(string $sql, ...$params): ?Row`
`253`	`250`
`254`	`251`	`/**`
`255`	`252`	`* Shortcut for query()->fetchField()`
`256`		`- * @return mixed`
`257`	`253`	`*/`
`258`		`- public function fetchField(string $sql, ...$params)`
	`254`	`+ public function fetchField(string $sql, ...$params): mixed`
`259`	`255`	`{`
`260`	`256`	`return $this->query($sql, ...$params)->fetchField();`
`261`	`257`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public function __construct(IStructure $structure)`
`27`	`27`	`}`
`28`	`28`
`29`	`29`
`30`		`- public function getPrimary(string $table)`
	`30`	`+ public function getPrimary(string $table): string\|array\|null`
`31`	`31`	`{`
`32`	`32`	`return $this->structure->getPrimaryKey($table);`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,7 @@ class DriverException extends \PDOException`
`20`	`20`	`public ?array $params = null;`
`21`	`21`
`22`	`22`
`23`		`- /**`
`24`		`- * @return static`
`25`		`- */`
`26`		`- public static function from(\PDOException $src)`
	`23`	`+ public static function from(\PDOException $src): static`
`27`	`24`	`{`
`28`	`25`	`$e = new static($src->message, 0, $src);`
`29`	`26`	`$e->file = $src->file;`
`@@ -41,10 +38,7 @@ public static function from(\PDOException $src)`
`41`	`38`	`}`
`42`	`39`
`43`	`40`
`44`		`- /**`
`45`		`- * @return int\|string\|null Driver-specific error code`
`46`		`- */`
`47`		`- public function getDriverCode()`
	`41`	`+ public function getDriverCode(): int\|string\|null`
`48`	`42`	`{`
`49`	`43`	`return $this->errorInfo[1] ?? null;`
`50`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,10 +60,7 @@ public function rollBack(): void`
`60`	`60`	`}`
`61`	`61`
`62`	`62`
`63`		`- /**`
`64`		`- * @return mixed`
`65`		`- */`
`66`		`- public function transaction(callable $callback)`
	`63`	`+ public function transaction(callable $callback): mixed`
`67`	`64`	`{`
`68`	`65`	`return $this->connection->transaction(fn() => $callback($this));`
`69`	`66`	`}`
`@@ -128,9 +125,8 @@ public function fetch(string $sql, ...$params): ?Row`
`128`	`125`
`129`	`126`	`/**`
`130`	`127`	`* Shortcut for query()->fetchField()`
`131`		`- * @return mixed`
`132`	`128`	`*/`
`133`		`- public function fetchField(string $sql, ...$params)`
	`129`	`+ public function fetchField(string $sql, ...$params): mixed`
`134`	`130`	`{`
`135`	`131`	`return $this->connection->query($sql, ...$params)->fetchField();`
`136`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -244,9 +244,8 @@ public function fetch(): ?Row`
`244`	`244`
`245`	`245`	`/**`
`246`	`246`	`* Fetches single field.`
`247`		`- * @return mixed`
`248`	`247`	`*/`
`249`		`- public function fetchField($column = 0)`
	`248`	`+ public function fetchField(int $column = 0): mixed`
`250`	`249`	`{`
`251`	`250`	`if (func_num_args()) {`
`252`	`251`	`trigger_error(__METHOD__ . '() argument is deprecated.', E_USER_DEPRECATED);`
`@@ -271,7 +270,7 @@ public function fetchFields(): ?array`
`271`	`270`	`* @param string\|int $key column name used for an array key or null for numeric index`
`272`	`271`	`* @param string\|int $value column name used for an array value or null for the whole row`
`273`	`272`	`*/`
`274`		`- public function fetchPairs($key = null, $value = null): array`
	`273`	`+ public function fetchPairs(string\|int $key = null, string\|int $value = null): array`
`275`	`274`	`{`
`276`	`275`	`return Helpers::toPairs($this->fetchAll(), $key, $value);`
`277`	`276`	`}`
`@@ -292,7 +291,6 @@ public function fetchAll(): array`
`292`	`291`
`293`	`292`	`/**`
`294`	`293`	`* Fetches all rows and returns associative tree.`
`295`		`- * @param string $path associative descriptor`
`296`	`294`	`*/`
`297`	`295`	`public function fetchAssoc(string $path): array`
`298`	`296`	`{`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function getColumns(string $table): array`
`54`	`54`	`/**`
`55`	`55`	`* @return string\|string[]\|null`
`56`	`56`	`*/`
`57`		`- public function getPrimaryKey(string $table)`
	`57`	`+ public function getPrimaryKey(string $table): string\|array\|null`
`58`	`58`	`{`
`59`	`59`	`$this->needStructure();`
`60`	`60`	`$table = $this->resolveFQTableName($table);`