Skip to content

Commit 6f30e3c

Browse files
kenjiskenjis
committed
docs: fix PHPDoc types in Database
1 parent 518b912 commit 6f30e3c

File tree

8 files changed

+21
-45
lines changed

8 files changed

+21
-45
lines changed

‎phpstan-baseline.php‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2851,16 +2851,6 @@
28512851
'count' => 1,
28522852
'path' => __DIR__ . '/system/Database/BaseConnection.php',
28532853
];
2854-
$ignoreErrors[] = [
2855-
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:_foreignKeyData\\(\\) return type has no value type specified in iterable type array\\.$#',
2856-
'count' => 1,
2857-
'path' => __DIR__ . '/system/Database/BaseConnection.php',
2858-
];
2859-
$ignoreErrors[] = [
2860-
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:_indexData\\(\\) return type has no value type specified in iterable type array\\.$#',
2861-
'count' => 1,
2862-
'path' => __DIR__ . '/system/Database/BaseConnection.php',
2863-
];
28642854
$ignoreErrors[] = [
28652855
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:callFunction\\(\\) has parameter \\$params with no value type specified in iterable type array\\.$#',
28662856
'count' => 1,
@@ -2896,11 +2886,6 @@
28962886
'count' => 1,
28972887
'path' => __DIR__ . '/system/Database/BaseConnection.php',
28982888
];
2899-
$ignoreErrors[] = [
2900-
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:foreignKeyDataToObjects\\(\\) return type has no value type specified in iterable type array\\.$#',
2901-
'count' => 1,
2902-
'path' => __DIR__ . '/system/Database/BaseConnection.php',
2903-
];
29042889
$ignoreErrors[] = [
29052890
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:getFieldNames\\(\\) return type has no value type specified in iterable type array\\.$#',
29062891
'count' => 1,
@@ -2911,11 +2896,6 @@
29112896
'count' => 1,
29122897
'path' => __DIR__ . '/system/Database/BaseConnection.php',
29132898
];
2914-
$ignoreErrors[] = [
2915-
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:getIndexData\\(\\) return type has no value type specified in iterable type array\\.$#',
2916-
'count' => 1,
2917-
'path' => __DIR__ . '/system/Database/BaseConnection.php',
2918-
];
29192899
$ignoreErrors[] = [
29202900
'message' => '#^Method CodeIgniter\\\\Database\\\\BaseConnection\\:\\:listTables\\(\\) return type has no value type specified in iterable type array\\.$#',
29212901
'count' => 1,
@@ -9391,16 +9371,6 @@
93919371
'count' => 1,
93929372
'path' => __DIR__ . '/system/Test/Mock/MockConnection.php',
93939373
];
9394-
$ignoreErrors[] = [
9395-
'message' => '#^Method CodeIgniter\\\\Test\\\\Mock\\\\MockConnection\\:\\:_foreignKeyData\\(\\) return type has no value type specified in iterable type array\\.$#',
9396-
'count' => 1,
9397-
'path' => __DIR__ . '/system/Test/Mock/MockConnection.php',
9398-
];
9399-
$ignoreErrors[] = [
9400-
'message' => '#^Method CodeIgniter\\\\Test\\\\Mock\\\\MockConnection\\:\\:_indexData\\(\\) return type has no value type specified in iterable type array\\.$#',
9401-
'count' => 1,
9402-
'path' => __DIR__ . '/system/Test/Mock/MockConnection.php',
9403-
];
94049374
$ignoreErrors[] = [
94059375
'message' => '#^Method CodeIgniter\\\\Test\\\\Mock\\\\MockConnection\\:\\:shouldReturn\\(\\) has no return type specified\\.$#',
94069376
'count' => 1,

‎system/Database/BaseConnection.php‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ public function getFieldData(string $table)
15271527
/**
15281528
* Returns an object with key data
15291529
*
1530-
* @return array
1530+
* @return array<string, stdClass>
15311531
*/
15321532
public function getIndexData(string $table)
15331533
{
@@ -1547,7 +1547,9 @@ public function getForeignKeyData(string $table)
15471547
/**
15481548
* Converts array of arrays generated by _foreignKeyData() to array of objects
15491549
*
1550-
* @return array[
1550+
* @return array<string, stdClass>
1551+
*
1552+
* array[
15511553
* {constraint_name} =>
15521554
* stdClass[
15531555
* 'constraint_name' => string,
@@ -1704,13 +1706,17 @@ abstract protected function _fieldData(string $table): array;
17041706
* Platform-specific index data.
17051707
*
17061708
* @see getIndexData()
1709+
*
1710+
* @return array<string, stdClass>
17071711
*/
17081712
abstract protected function _indexData(string $table): array;
17091713

17101714
/**
17111715
* Platform-specific foreign keys data.
17121716
*
17131717
* @see getForeignKeyData()
1718+
*
1719+
* @return array<string, stdClass>
17141720
*/
17151721
abstract protected function _foreignKeyData(string $table): array;
17161722

‎system/Database/MySQLi/Connection.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ protected function _fieldData(string $table): array
443443
/**
444444
* Returns an array of objects with index data
445445
*
446-
* @return list<stdClass>
446+
* @return array<string, stdClass>
447447
*
448448
* @throws DatabaseException
449449
* @throws LogicException
@@ -489,7 +489,7 @@ protected function _indexData(string $table): array
489489
/**
490490
* Returns an array of objects with Foreign key data
491491
*
492-
* @return list<stdClass>
492+
* @return array<string, stdClass>
493493
*
494494
* @throws DatabaseException
495495
*/

‎system/Database/OCI8/Connection.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,7 +325,7 @@ protected function _fieldData(string $table): array
325325
/**
326326
* Returns an array of objects with index data
327327
*
328-
* @return list<stdClass>
328+
* @return array<string, stdClass>
329329
*
330330
* @throws DatabaseException
331331
*/
@@ -374,7 +374,7 @@ protected function _indexData(string $table): array
374374
/**
375375
* Returns an array of objects with Foreign key data
376376
*
377-
* @return list<stdClass>
377+
* @return array<string, stdClass>
378378
*
379379
* @throws DatabaseException
380380
*/

‎system/Database/Postgre/Connection.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ protected function _fieldData(string $table): array
332332
/**
333333
* Returns an array of objects with index data
334334
*
335-
* @return list<stdClass>
335+
* @return array<string, stdClass>
336336
*
337337
* @throws DatabaseException
338338
*/
@@ -371,7 +371,7 @@ protected function _indexData(string $table): array
371371
/**
372372
* Returns an array of objects with Foreign key data
373373
*
374-
* @return list<stdClass>
374+
* @return array<string, stdClass>
375375
*
376376
* @throws DatabaseException
377377
*/

‎system/Database/SQLSRV/Connection.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ protected function _listColumns(string $table = ''): string
231231
/**
232232
* Returns an array of objects with index data
233233
*
234-
* @return list<stdClass>
234+
* @return array<string, stdClass>
235235
*
236236
* @throws DatabaseException
237237
*/
@@ -269,7 +269,7 @@ protected function _indexData(string $table): array
269269
* Returns an array of objects with Foreign key data
270270
* referenced_object_id parent_object_id
271271
*
272-
* @return list<stdClass>
272+
* @return array<string, stdClass>
273273
*
274274
* @throws DatabaseException
275275
*/

‎system/Database/SQLite3/Connection.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ protected function _fieldData(string $table): array
286286
/**
287287
* Returns an array of objects with index data
288288
*
289-
* @return list<stdClass>
289+
* @return array<string, stdClass>
290290
*
291291
* @throws DatabaseException
292292
*/
@@ -343,7 +343,7 @@ protected function _indexData(string $table): array
343343
/**
344344
* Returns an array of objects with Foreign key data
345345
*
346-
* @return list<stdClass>
346+
* @return array<string, stdClass>
347347
*/
348348
protected function _foreignKeyData(string $table): array
349349
{

‎system/Database/SQLite3/Table.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ public function addForeignKey(array $foreignKeys)
280280
/**
281281
* Creates the new table based on our current fields.
282282
*
283-
* @return mixed
283+
* @return bool
284284
*/
285285
protected function createTable()
286286
{
@@ -449,9 +449,9 @@ private function isNumericType(string $type): bool
449449
* Converts keys retrieved from the database to
450450
* the format needed to create later.
451451
*
452-
* @param mixed $keys
452+
* @param array<string, stdClass> $keys
453453
*
454-
* @return mixed
454+
* @return array<string, array{fields: string, type: string}>
455455
*/
456456
protected function formatKeys($keys)
457457
{

0 commit comments

Comments
 (0)