Fix CakePHP 5.3 behavior method call deprecations (#22)

Use $table->getBehavior('Expose')->methodName() instead of calling
behavior methods directly on the table instance.

- Updated commands to use getBehavior() for getExposedKey() and initExposedField()
- Updated tests to use the same pattern
- Removed phpstan ignores that are no longer needed

Author: dereuromark

phpstan.neon

@@ -7,5 +7,3 @@ parameters:
 	ignoreErrors:
 		- identifier: missingType.iterableValue
 		- identifier: missingType.generics
-		- '#Call to an undefined method Cake\\ORM\\Table::getExposedKey\(\).#'
-		- '#PHPDoc tag @\w+ for \w+ \$table contains unresolvable type.#'

src/Command/AddExposedFieldCommand.php

@@ -51,8 +51,9 @@ public function execute(Arguments $args, ConsoleIo $io): ?int {
 			$io->abort('You need to attach the Expose.Expose behavior to this model first (' . $table::class . '). Then we can create the migration for it.');
 		}
 
-		/** @phpstan-var \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $table */
-		$field = $table->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $table->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$fieldExists = $table->hasField($field);
 
 		if ($fieldExists) {
@@ -162,7 +163,7 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption
 
 	/**
 	 * @param string $migrationName
-	 * @param \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $table
+	 * @param \Cake\ORM\Table $table
 	 * @param bool $containsRecords
 	 * @param bool $binary
 	 *
@@ -191,14 +192,16 @@ public function change(): void
 	}
 
 	/**
-	 * @param \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $table
+	 * @param \Cake\ORM\Table $table
 	 * @param bool $containsRecords
 	 * @param bool $binary
 	 *
 	 * @return string
 	 */
 	protected function generateOperations(Table $table, bool $containsRecords, bool $binary): string {
-		$field = $table->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $table->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$tableName = $table->getTable();
 		$null = $containsRecords ? 'true' : 'false';
 		$type = $binary ? 'binary' : 'uuid';
@@ -229,12 +232,14 @@ protected function generateOperations(Table $table, bool $containsRecords, bool
 	}
 
 	/**
-	 * @param \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $table
+	 * @param \Cake\ORM\Table $table
 	 *
 	 * @return string
 	 */
 	protected function generateUpdateOperation(Table $table): string {
-		$field = $table->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $table->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$tableName = $table->getTable();
 
 		$operations = <<<TXT

src/Command/PopulateExposedFieldCommand.php

@@ -34,13 +34,14 @@ public function execute(Arguments $args, ConsoleIo $io): ?int {
 			$io->abort('Model missing');
 		}
 
-		/** @var \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $table */
 		$table = $this->getTableLocator()->get($model);
 
-		$field = $table->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $table->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$io->out('Populating ' . $model . ' `' . $field . '` field ...');
 
-		$count = $table->initExposedField();
+		$count = $exposeBehavior->initExposedField();
 
 		$io->success('Populated ' . $count . ' records. Nothing else left.');
 

tests/TestCase/Model/Behavior/ExposeBehaviorTest.php

@@ -110,15 +110,17 @@ public function testFindExposed(): void {
 
 		$uuid = $user->uuid;
 
-		$field = $this->Users->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $this->Users->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$this->assertSame('uuid', $field);
 
 		/** @var \TestApp\Model\Entity\User $result */
 		$result = $this->Users->find('exposed', $uuid)->firstOrFail();
 
 		$this->assertSame($user->id, $result->id);
 
-		$field = $this->Users->getExposedKey(true);
+		$field = $exposeBehavior->getExposedKey(true);
 		$this->assertSame('Users.uuid', $field);
 	}
 
@@ -130,15 +132,17 @@ public function testFindExposedLegacy(): void {
 
 		$uuid = $user->uuid;
 
-		$field = $this->Users->getExposedKey();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $this->Users->getBehavior('Expose');
+		$field = $exposeBehavior->getExposedKey();
 		$this->assertSame('uuid', $field);
 
 		/** @var \TestApp\Model\Entity\User $result */
 		$result = $this->Users->find('exposed', ...[$field => $uuid])->firstOrFail();
 
 		$this->assertSame($user->id, $result->id);
 
-		$field = $this->Users->getExposedKey(true);
+		$field = $exposeBehavior->getExposedKey(true);
 		$this->assertSame('Users.uuid', $field);
 	}
 
@@ -197,11 +201,11 @@ public function testCustomExposedFieldBeforeMarshal(): void {
 	 */
 	public function testInitExposedField(): void {
 		$customFieldRecordsTable = TableRegistry::getTableLocator()->get('ExistingRecords');
-
-		/** @var \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $customFieldRecordsTable */
 		$customFieldRecordsTable->addBehavior('Expose.Expose');
 
-		$count = $customFieldRecordsTable->initExposedField();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $customFieldRecordsTable->getBehavior('Expose');
+		$count = $exposeBehavior->initExposedField();
 		$this->assertSame(1, $count);
 
 		$records = $customFieldRecordsTable->find()->find('list', ...['valueField' => 'uuid'])->toArray();
@@ -237,14 +241,14 @@ public function testBinaryUuidField(): void {
 	 */
 	public function testInitExposedFieldWithCustomPrimaryKey(): void {
 		$customPrimaryKeyTable = TableRegistry::getTableLocator()->get('CustomPrimaryKeyRecords');
-
-		/** @var \Cake\ORM\Table&\Expose\Model\Behavior\ExposeBehavior $customPrimaryKeyTable */
 		$customPrimaryKeyTable->addBehavior('Expose.Expose');
 
 		$primaryKey = $customPrimaryKeyTable->getPrimaryKey();
 		$this->assertSame('code', $primaryKey);
 
-		$count = $customPrimaryKeyTable->initExposedField();
+		/** @var \Expose\Model\Behavior\ExposeBehavior $exposeBehavior */
+		$exposeBehavior = $customPrimaryKeyTable->getBehavior('Expose');
+		$count = $exposeBehavior->initExposedField();
 		$this->assertSame(2, $count);
 
 		$records = $customPrimaryKeyTable->find()->toArray();