Merge pull request #945 from cakephp/issue-944

Fix signature for Table::get() annotation.
cakephp · Sep 27, 2023 · 1069077 · 1069077
2 parents d0dd499 + 783e504
commit 1069077
Show file tree

Hide file tree

Showing 17 changed files with 17 additions and 17 deletions.
diff --git a/src/View/Helper/DocBlockHelper.php b/src/View/Helper/DocBlockHelper.php
@@ -266,7 +266,7 @@ public function buildTableAnnotations(
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} newEmptyEntity()";
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} newEntity(array \$data, array \$options = [])";
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity}[] newEntities(array \$data, array \$options = [])";
-        $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} get(\$primaryKey, \$options = [])";
+        $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} get(mixed \$primaryKey, array|string \$finder = 'all', \\Psr\\SimpleCache\\CacheInterface|string|null \$cache = null, \Closure|string|null \$cacheKey = null, mixed ...\$args)";
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} findOrCreate(\$search, ?callable \$callback = null, \$options = [])";
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity} patchEntity(\\Cake\\Datasource\\EntityInterface \$entity, array \$data, array \$options = [])";
         $annotations[] = "@method \\{$namespace}\\Model\\Entity\\{$entity}[] patchEntities(iterable \$entities, array \$data, array \$options = [])";

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionCategoriesProductsTable.php b/tests/comparisons/Model/testBakeAssociationDetectionCategoriesProductsTable.php
@@ -17,7 +17,7 @@
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\CategoriesProduct get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\CategoriesProduct get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\CategoriesProduct[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionCategoriesTable.php b/tests/comparisons/Model/testBakeAssociationDetectionCategoriesTable.php
@@ -16,7 +16,7 @@
  * @method \Bake\Test\App\Model\Entity\Category newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\Category newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Category[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\Category get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\Category get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\Category findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\Category patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Category[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionCategoriesTableSigned.php b/tests/comparisons/Model/testBakeAssociationDetectionCategoriesTableSigned.php
@@ -16,7 +16,7 @@
  * @method \Bake\Test\App\Model\Entity\Category newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\Category newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Category[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\Category get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\Category get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\Category findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\Category patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Category[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionOldProductsTable.php b/tests/comparisons/Model/testBakeAssociationDetectionOldProductsTable.php
@@ -14,7 +14,7 @@
  * @method \Bake\Test\App\Model\Entity\OldProduct newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\OldProduct newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\OldProduct get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\OldProduct get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\OldProduct findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionOldProductsTableSigned.php b/tests/comparisons/Model/testBakeAssociationDetectionOldProductsTableSigned.php
@@ -14,7 +14,7 @@
  * @method \Bake\Test\App\Model\Entity\OldProduct newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\OldProduct newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\OldProduct get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\OldProduct get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\OldProduct findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\OldProduct[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTable.php b/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTable.php
@@ -16,7 +16,7 @@
  * @method \Bake\Test\App\Model\Entity\ProductVersion newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\ProductVersion newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\ProductVersion get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\ProductVersion get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\ProductVersion findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTableSigned.php b/tests/comparisons/Model/testBakeAssociationDetectionProductVersionsTableSigned.php
@@ -16,7 +16,7 @@
  * @method \Bake\Test\App\Model\Entity\ProductVersion newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\ProductVersion newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\ProductVersion get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\ProductVersion get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\ProductVersion findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\ProductVersion[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableConfig.php b/tests/comparisons/Model/testBakeTableConfig.php
@@ -19,7 +19,7 @@
  * @method \Bake\Test\App\Model\Entity\Item newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\Item newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Item[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\Item get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\Item get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\Item findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\Item patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\Item[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableNullableForeignKey.php b/tests/comparisons/Model/testBakeTableNullableForeignKey.php
@@ -14,7 +14,7 @@
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\TestBakeArticle get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\TestBakeArticle get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableRules.php b/tests/comparisons/Model/testBakeTableRules.php
@@ -14,7 +14,7 @@
  * @method \Bake\Test\App\Model\Entity\UniqueField newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\UniqueField newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\UniqueField[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\UniqueField get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\UniqueField get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\UniqueField findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\UniqueField patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\UniqueField[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableValidation.php b/tests/comparisons/Model/testBakeTableValidation.php
@@ -14,7 +14,7 @@
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\TestBakeArticle get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\TestBakeArticle get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TestBakeArticle[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableWithCounterCache.php b/tests/comparisons/Model/testBakeTableWithCounterCache.php
@@ -16,7 +16,7 @@
  * @method \Bake\Test\App\Model\Entity\TodoTask newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\TodoTask newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoTask[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\TodoTask get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\TodoTask get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\TodoTask findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoTask patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoTask[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeTableWithPlugin.php b/tests/comparisons/Model/testBakeTableWithPlugin.php
@@ -17,7 +17,7 @@
  * @method \BakeTest\Model\Entity\User newEmptyEntity()
  * @method \BakeTest\Model\Entity\User newEntity(array $data, array $options = [])
  * @method \BakeTest\Model\Entity\User[] newEntities(array $data, array $options = [])
- * @method \BakeTest\Model\Entity\User get($primaryKey, $options = [])
+ * @method \BakeTest\Model\Entity\User get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \BakeTest\Model\Entity\User findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \BakeTest\Model\Entity\User patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \BakeTest\Model\Entity\User[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeUpdateTable.php b/tests/comparisons/Model/testBakeUpdateTable.php
@@ -21,7 +21,7 @@
  * @method \Bake\Test\App\Model\Entity\TodoItem newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\TodoItem newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\TodoItem get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\TodoItem get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\TodoItem findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeUpdateTableNoFile.php b/tests/comparisons/Model/testBakeUpdateTableNoFile.php
@@ -19,7 +19,7 @@
  * @method \Bake\Test\App\Model\Entity\TodoItem newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\TodoItem newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\TodoItem get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\TodoItem get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\TodoItem findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\TodoItem[] patchEntities(iterable $entities, array $data, array $options = [])

diff --git a/tests/comparisons/Model/testBakeWithRulesUnique.php b/tests/comparisons/Model/testBakeWithRulesUnique.php
@@ -17,7 +17,7 @@
  * @method \Bake\Test\App\Model\Entity\User newEmptyEntity()
  * @method \Bake\Test\App\Model\Entity\User newEntity(array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\User[] newEntities(array $data, array $options = [])
- * @method \Bake\Test\App\Model\Entity\User get($primaryKey, $options = [])
+ * @method \Bake\Test\App\Model\Entity\User get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \Bake\Test\App\Model\Entity\User findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \Bake\Test\App\Model\Entity\User patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method \Bake\Test\App\Model\Entity\User[] patchEntities(iterable $entities, array $data, array $options = [])