Narrow array phpdocs (#1234)

atk4 · Oct 26, 2024 · 9998be7 · 9998be7
1 parent 7f86f4d
commit 9998be7
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/src/Model.php b/src/Model.php
@@ -1520,7 +1520,7 @@ protected function validateEntityScope(): void
         }
     }
 
-    private function assertIsWriteable(): void
+    private function assertIsWritable(): void
     {
         if ($this->readOnly) {
             throw new Exception('Model is read-only');
@@ -1536,7 +1536,7 @@ private function assertIsWriteable(): void
      */
     public function save(array $data = [])
     {
-        $this->getModel()->assertIsWriteable();
+        $this->getModel()->assertIsWritable();
         $this->getModel()->assertHasPersistence();
 
         $this->setMulti($data);
@@ -1891,7 +1891,7 @@ public function delete($id = null)
             return $this;
         }
 
-        $this->getModel()->assertIsWriteable();
+        $this->getModel()->assertIsWritable();
         $this->getModel()->assertHasPersistence();
         $this->assertIsLoaded();
 

diff --git a/src/Model/Scope.php b/src/Model/Scope.php
@@ -12,7 +12,7 @@
 use Atk4\Data\Persistence\Sql\Expressionable;
 
 /**
- * @property array<AbstractScope> $elements
+ * @property array<int|string, AbstractScope> $elements
  */
 class Scope extends AbstractScope
 {
@@ -91,7 +91,7 @@ public function addCondition($field, $operator = null, $value = null)
     /**
      * Return array of nested conditions.
      *
-     * @return array<AbstractScope>
+     * @return array<int|string, AbstractScope>
      */
     public function getNestedConditions(): array
     {

diff --git a/src/Persistence.php b/src/Persistence.php
@@ -198,7 +198,7 @@ public function insert(Model $model, array $data)
     }
 
     /**
-     * @param array<scalar|null> $dataRaw
+     * @param array<string, scalar|null> $dataRaw
      *
      * @return scalar
      */
@@ -246,8 +246,8 @@ public function update(Model $model, $id, array $data): void
     }
 
     /**
-     * @param scalar             $idRaw
-     * @param array<scalar|null> $dataRaw
+     * @param scalar                     $idRaw
+     * @param array<string, scalar|null> $dataRaw
      */
     protected function updateRaw(Model $model, $idRaw, array $dataRaw): void
     {
@@ -299,7 +299,7 @@ protected function deleteRaw(Model $model, $idRaw): void
      *
      * @param array<string, mixed> $row
      *
-     * @return array<scalar|Persistence\Sql\Expressionable|null>
+     * @return array<string, scalar|Persistence\Sql\Expressionable|null>
      */
     public function typecastSaveRow(Model $model, array $row): array
     {

diff --git a/src/Persistence/Sql.php b/src/Persistence/Sql.php
@@ -559,7 +559,7 @@ private function assertExactlyOneRecordUpdated(Model $model, $idRaw, int $affect
     }
 
     /**
-     * @param array<scalar|Expressionable|null> $dataRaw
+     * @param array<string, scalar|Expressionable|null> $dataRaw
      */
     #[\Override]
     protected function insertRaw(Model $model, array $dataRaw)
@@ -596,7 +596,7 @@ protected function insertRaw(Model $model, array $dataRaw)
     }
 
     /**
-     * @param array<scalar|Expressionable|null> $dataRaw
+     * @param array<string, scalar|Expressionable|null> $dataRaw
      */
     #[\Override]
     protected function updateRaw(Model $model, $idRaw, array $dataRaw): void

diff --git a/src/Persistence/Sql/Expression.php b/src/Persistence/Sql/Expression.php
@@ -56,7 +56,7 @@ abstract class Expression implements Expressionable, \ArrayAccess
      * This property is made public to ease customization and make it accessible
      * from Connection class for example.
      *
-     * @var array<array<mixed>>
+     * @var array<string, array<int|string, mixed>>
      */
     public array $args = ['custom' => []];
 

diff --git a/src/Persistence/Sql/Query.php b/src/Persistence/Sql/Query.php
@@ -22,7 +22,7 @@ abstract class Query extends Expression
 
     public bool $wrapInParentheses = true;
 
-    /** @var array<string> */
+    /** @var list<string> */
     protected array $supportedOperators = ['=', '!=', '<', '>', '<=', '>=', 'in', 'not in', 'like', 'not like', 'regexp', 'not regexp'];
 
     protected string $templateSelect = '[with]select[option] [field] [from] [table][join][where][group][having][order][limit]';