standardebooks/web
1
0
Fork 0
mirror of https://github.com/standardebooks/web.git synced 2025-07-06 14:50:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Tweak some PHPDocs

Browse source
This commit is contained in:
Alex Cabal 2024-05-18 20:41:15 -05:00
parent cb9ff01615
commit 4cd7a1b72c
2 changed files with 5 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
lib/DbConnection.php
View file

@ -138,7 +138,7 @@ class DbConnection{
* ]
* ```
*
* **Important note:** When joining against two tables, SQL only returns one column for the join key (typically an ID value). Therefore, if both objects require an ID, the filler method must explicitly assign the ID to one of the two objects that's missing it. The above example shows this behavior: note how we join on UserId, but only the Users result has the UserId column, even though the Posts table also has a UserId column.
* **Important note:** When joining against two tables, SQL only returns one column for the join key (typically an ID value). Therefore, if both objects require an ID, the filler method must explicitly assign the ID to one of the two objects that's missing it. The above example shows this behavior: note how we join on `UserId`, but only the `Users` result has the `UserId` column, even though the `Posts` table also has a `UserId` column.
*
* @template T
*
@ -148,7 +148,7 @@ class DbConnection{
*
* @return array<T>|array<array<mixed>> An array of `$class` if `$class` is not `null`, otherwise an array of rows.
*
* @throws Exceptions\AppException If a class was specified but the class doesn't have a `FromMultiTableRow` method.
* @throws Exceptions\AppException If a class was specified but the class doesn't have a `FromMultiTableRow()` method.
* @throws Exceptions\DatabaseQueryException When an error occurs during execution of the query.
*/
public function MultiTableSelect(string $sql, array $params = [], ?string $class = null): array{