Skip to content

Commit 285f379

Browse files
committed
docs: fix PHPDoc types
1 parent fc2bff7 commit 285f379

2 files changed

Lines changed: 19 additions & 14 deletions

File tree

system/BaseModel.php

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -824,10 +824,11 @@ public function insert($data = null, bool $returnID = true)
824824
/**
825825
* Compiles batch insert runs the queries, validating each row prior.
826826
*
827-
* @param array|null $set an associative array of insert values
828-
* @param bool|null $escape Whether to escape values
829-
* @param int $batchSize The size of the batch to run
830-
* @param bool $testing True means only number of records is returned, false will execute the query
827+
* @param list<array|object>|null $set an associative array of insert values
828+
* @phpstan-param list<row_array|object>|null $set
829+
* @param bool|null $escape Whether to escape values
830+
* @param int $batchSize The size of the batch to run
831+
* @param bool $testing True means only number of records is returned, false will execute the query
831832
*
832833
* @return bool|int Number of rows inserted or FALSE on failure
833834
*
@@ -912,6 +913,7 @@ public function insertBatch(?array $set = null, ?bool $escape = null, int $batch
912913
*
913914
* @param array|int|string|null $id
914915
* @param array|object|null $data
916+
* @phpstan-param row_array|object|null $data
915917
*
916918
* @throws ReflectionException
917919
*/
@@ -973,7 +975,8 @@ public function update($id = null, $data = null): bool
973975
/**
974976
* Compiles an update and runs the query.
975977
*
976-
* @param array|null $set An associative array of update values
978+
* @param list<array|object>|null $set an associative array of insert values
979+
* @phpstan-param list<row_array|object>|null $set
977980
* @param string|null $index The where key
978981
* @param int $batchSize The size of the batch to run
979982
* @param bool $returnSQL True means SQL is returned, false will execute the query
@@ -1656,9 +1659,9 @@ public function asObject(string $class = 'object')
16561659
* This method uses objectToRawArray() internally and does conversion
16571660
* to string on all Time instances
16581661
*
1659-
* @param object|string $data Data
1660-
* @param bool $onlyChanged Only Changed Property
1661-
* @param bool $recursive If true, inner entities will be cast as array as well
1662+
* @param object|null $data Data
1663+
* @param bool $onlyChanged Only Changed Property
1664+
* @param bool $recursive If true, inner entities will be cast as array as well
16621665
*
16631666
* @return array Array
16641667
*
@@ -1688,9 +1691,9 @@ protected function objectToArray($data, bool $onlyChanged = true, bool $recursiv
16881691
* Takes a class and returns an array of its public and protected
16891692
* properties as an array with raw values.
16901693
*
1691-
* @param object|string $data Data
1692-
* @param bool $onlyChanged Only Changed Property
1693-
* @param bool $recursive If true, inner entities will be casted as array as well
1694+
* @param object|null $data Data
1695+
* @param bool $onlyChanged Only Changed Property
1696+
* @param bool $recursive If true, inner entities will be casted as array as well
16941697
*
16951698
* @return array|null Array
16961699
*
@@ -1722,7 +1725,8 @@ protected function objectToRawArray($data, bool $onlyChanged = true, bool $recur
17221725
* Transform data to array.
17231726
*
17241727
* @param array|object|null $data Data
1725-
* @param string $type Type of data (insert|update)
1728+
* @phpstan-param row_array|object|null $data
1729+
* @param string $type Type of data (insert|update)
17261730
*
17271731
* @throws DataException
17281732
* @throws InvalidArgumentException

system/Model.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -778,6 +778,7 @@ protected function doProtectFieldsForInsert(array $data): array
778778
*
779779
* @param array|int|string|null $id
780780
* @param array|object|null $data
781+
* @phpstan-param row_array|object|null $data
781782
*
782783
* @throws ReflectionException
783784
*/
@@ -802,8 +803,8 @@ public function update($id = null, $data = null): bool
802803
* Takes a class and returns an array of its public and protected
803804
* properties as an array with raw values.
804805
*
805-
* @param object|string $data
806-
* @param bool $recursive If true, inner entities will be cast as array as well
806+
* @param object|null $data
807+
* @param bool $recursive If true, inner entities will be cast as array as well
807808
*
808809
* @return array|null Array
809810
*

0 commit comments

Comments
 (0)