StateMachine update.

phpstan.neon

@@ -6,11 +6,13 @@ parameters:
 	level: 8
 
 	checkGenericClassInNonGenericObjectType: false
+	treatPhpDocTypesAsCertain: false
 
 	paths:
 		- src/
 		- plugins/Sandbox/src/
 		- plugins/AuthSandbox/src/
+		- plugins/StateMachineSandbox/src/
 
 	bootstrapFiles:
 		- %rootDir%/../../../tests/bootstrap.php

plugins/StateMachineSandbox/src/Controller/RegistrationDemoController.php

@@ -3,6 +3,7 @@
 namespace StateMachineSandbox\Controller;
 
 use App\Controller\AppController;
+use Cake\Datasource\ModelAwareTrait;
 use Cake\Http\Exception\NotFoundException;
 use StateMachine\Business\StateMachineFacade;
 use StateMachine\Dto\StateMachine\ItemDto;
@@ -14,10 +15,12 @@
  */
 class RegistrationDemoController extends AppController {
 
+	use ModelAwareTrait;
+
 	/**
 	 * @var string
 	 */
-	protected ?string $modelClass = 'StateMachineSandbox.Registrations';
+	protected ?string $defaultTable = 'StateMachineSandbox.Registrations';
 
 	/**
 	 * @return \Cake\Http\Response|null|void
@@ -29,8 +32,8 @@ public function index() {
 	 * @return \Cake\Http\Response|null|void
 	 */
 	public function register() {
-		$this->loadModel('Users');
-		$users = $this->Users->find()
+		$Users = $this->fetchModel('Users');
+		$users = $Users->find()
 			->select(['Users.id', 'Users.username'])
 			->where(['Users.username IN' => ['user', 'mod']])
 			->find('list')
@@ -57,7 +60,8 @@ public function register() {
 	 * @return \Cake\Http\Response|null|void
 	 */
 	public function process() {
-		$registrations = $this->Registrations->find()
+		$Registrations = $this->fetchModel('StateMachineSandbox.Registrations');
+		$registrations = $Registrations->find()
 			->where(['session_id' => $this->request->getSession()->id()])
 			->contain(['Users', 'RegistrationStates'])
 			->all()
@@ -79,10 +83,10 @@ public function moderatorPanel($id = null) {
 			->all()
 			->toArray();
 
-		if ($this->request->isPost()) {
+		if ($this->request->is('post')) {
 			$stateMachineFacade = new StateMachineFacade();
 			$itemDto = new ItemDto();
-			$itemDto->setIdentifier($id);
+			$itemDto->setIdentifier((int)$id);
 			$registrationEntity = null;
 			foreach ($registrations as $registration) {
 				if ($registration->id === (int)$id) {
@@ -97,6 +101,7 @@ public function moderatorPanel($id = null) {
 
 			$itemDto->setStateMachineName(RegistrationStateMachineHandler::NAME);
 			$itemDto->setStateName(RegistrationStateMachineHandler::STATE_WAITING_FOR_APPROVAL);
+			assert($registrationEntity->registration_state !== null);
 			$itemDto->setProcessName($registrationEntity->registration_state->process);
 
 			$stateMachineFacade->triggerEvent(RegistrationStateMachineHandler::EVENT_APPROVE, $itemDto);
@@ -120,10 +125,10 @@ public function adminPanel($id = null) {
 			->all()
 			->toArray();
 
-		if ($this->request->isPost()) {
+		if ($this->request->is('post')) {
 			$stateMachineFacade = new StateMachineFacade();
 			$itemDto = new ItemDto();
-			$itemDto->setIdentifier($id);
+			$itemDto->setIdentifier((int)$id);
 			$registrationEntity = null;
 			foreach ($registrations as $registration) {
 				if ($registration->id === (int)$id) {
@@ -161,7 +166,7 @@ public function removeJob($id = null) {
 		$jobType = 'StateMachineSandbox.SimulatePaymentResult';
 		$queuedJobsTable = $this->getTableLocator()->get('Queue.QueuedJobs');
 		$queuedJob = $queuedJobsTable->get($id);
-		if ($queuedJob->completed || $queuedJob->job_type !== $jobType || strpos($queuedJob->reference, 'registration-') !== 0) {
+		if ($queuedJob->completed || $queuedJob->job_task !== $jobType || strpos((string)$queuedJob->reference, 'registration-') !== 0) {
 			throw new NotFoundException('Invalid queue job ID');
 		}
 		$queuedJobsTable->deleteOrFail($queuedJob);

plugins/StateMachineSandbox/src/Controller/RegistrationsController.php

@@ -4,6 +4,7 @@
 namespace StateMachineSandbox\Controller;
 
 use App\Controller\AppController;
+use Cake\Datasource\ModelAwareTrait;
 use Cake\Http\Exception\NotFoundException;
 
 /**
@@ -14,6 +15,8 @@
  */
 class RegistrationsController extends AppController {
 
+	use ModelAwareTrait;
+
 	/**
 	 * @return \Cake\Http\Response|null|void Renders view
 	 */
@@ -41,11 +44,14 @@ public function view($id = null) {
 			throw new NotFoundException();
 		}
 
-		$this->loadModel('StateMachine.StateMachineTransitionLogs');
-		$logs = $this->StateMachineTransitionLogs->getLogs($registration->registration_state->id);
+		/** @var \StateMachine\Model\Table\StateMachineTransitionLogsTable $StateMachineTransitionLogs */
+		$StateMachineTransitionLogs = $this->fetchModel('StateMachine.StateMachineTransitionLogs');
+		assert($registration->registration_state !== null);
+		$logs = $StateMachineTransitionLogs->getLogs($registration->registration_state->id);
 
-		$this->loadModel('StateMachine.StateMachineItemStateLogs');
-		$history = $this->StateMachineItemStateLogs->getHistory($registration->registration_state);
+		/** @var \StateMachine\Model\Table\StateMachineItemStateLogsTable $StateMachineItemStateLogs */
+		$StateMachineItemStateLogs = $this->fetchModel('StateMachine.StateMachineItemStateLogs');
+		$history = $StateMachineItemStateLogs->getHistory($registration->registration_state);
 
 		$this->set(compact('registration', 'logs', 'history'));
 	}

plugins/StateMachineSandbox/src/Controller/StateMachineSandboxController.php

@@ -12,7 +12,7 @@ class StateMachineSandboxController extends AppController {
 	/**
 	 * @var string
 	 */
-	protected ?string $modelClass = 'Users';
+	protected ?string $defaultTable = 'Users';
 
 	/**
 	 * @return \Cake\Http\Response|null|void

plugins/StateMachineSandbox/src/Model/Entity/Registration.php

@@ -27,7 +27,7 @@ class Registration extends Entity {
 	 * be mass assigned. For security purposes, it is advised to set '*' to false
 	 * (or remove it), and explicitly make individual fields accessible as needed.
 	 *
-	 * @var array
+	 * @var array<string, bool>
 	 */
 	protected array $_accessible = [
 		'*' => true,

plugins/StateMachineSandbox/src/Model/Table/RegistrationsTable.php

@@ -21,7 +21,7 @@
  * @method \StateMachineSandbox\Model\Entity\Registration newEmptyEntity()
  * @method \StateMachineSandbox\Model\Entity\Registration newEntity(array $data, array $options = [])
  * @method array<\StateMachineSandbox\Model\Entity\Registration> newEntities(array $data, array $options = [])
- * @method \StateMachineSandbox\Model\Entity\Registration get($primaryKey, $options = [])
+ * @method \StateMachineSandbox\Model\Entity\Registration get(mixed $primaryKey, array|string $finder = 'all', \Psr\SimpleCache\CacheInterface|string|null $cache = null, \Closure|string|null $cacheKey = null, mixed ...$args)
  * @method \StateMachineSandbox\Model\Entity\Registration findOrCreate($search, ?callable $callback = null, $options = [])
  * @method \StateMachineSandbox\Model\Entity\Registration patchEntity(\Cake\Datasource\EntityInterface $entity, array $data, array $options = [])
  * @method array<\StateMachineSandbox\Model\Entity\Registration> patchEntities(iterable $entities, array $data, array $options = [])

plugins/StateMachineSandbox/src/Queue/Task/SimulatePaymentResultTask.php

@@ -24,9 +24,10 @@ class SimulatePaymentResultTask extends Task {
 	 * @return void
 	 */
 	public function run(array $data, int $jobId): void {
-		$this->loadModel('StateMachineSandbox.Registrations');
+		/** @var \StateMachineSandbox\Model\Table\RegistrationsTable $Registrations */
+		$Registrations = $this->fetchModel('StateMachineSandbox.Registrations');
 		try {
-			$registration = $this->Registrations->get($data['id'], contain: ['RegistrationStates']);
+			$registration = $Registrations->get($data['id'], contain: ['RegistrationStates']);
 		} catch (RecordNotFoundException $e) {
 			// Someone already removed the registration, for demo we can ignore
 			return;
@@ -37,6 +38,7 @@ public function run(array $data, int $jobId): void {
 		$itemDto->setIdentifier($registration->id);
 		$itemDto->setStateMachineName(RegistrationStateMachineHandler::NAME);
 		$itemDto->setStateName(RegistrationStateMachineHandler::STATE_WAITING_FOR_PAYMENT);
+		assert($registration->registration_state !== null);
 		$itemDto->setProcessName($registration->registration_state->process);
 
 		$stateMachineFacade->triggerEvent(RegistrationStateMachineHandler::EVENT_CONFIRM_PAYMENT, $itemDto);

plugins/StateMachineSandbox/src/StateMachine/Command/Registration/CompleteCommand.php

@@ -6,9 +6,6 @@
 use StateMachine\Dependency\StateMachineCommandInterface;
 use StateMachine\Dto\StateMachine\ItemDto;
 
-/**
- * @property \StateMachineSandbox\Model\Table\RegistrationsTable $Registrations
- */
 class CompleteCommand implements StateMachineCommandInterface {
 
 	use ModelAwareTrait;
@@ -21,11 +18,12 @@ class CompleteCommand implements StateMachineCommandInterface {
 	public function run(ItemDto $itemDto): void {
 		$registrationId = $itemDto->getIdentifierOrFail();
 
-		$this->loadModel('StateMachineSandbox.Registrations');
-		$registration = $this->Registrations->get($registrationId);
+		/** @var \StateMachineSandbox\Model\Table\RegistrationsTable $Registrations */
+		$Registrations = $this->fetchModel('StateMachineSandbox.Registrations');
+		$registration = $Registrations->get($registrationId);
 		$registration->status = 'complete';
 
-		$this->Registrations->saveOrFail($registration);
+		$Registrations->saveOrFail($registration);
 	}
 
 }

plugins/StateMachineSandbox/src/StateMachine/Condition/Registration/CheckApprovalCondition.php

@@ -23,8 +23,9 @@ class CheckApprovalCondition implements StateMachineConditionInterface {
 	public function check(ItemDto $itemDto): bool {
 		$registrationId = $itemDto->getIdentifierOrFail();
 
-		$this->loadModel('StateMachineSandbox.Registrations');
-		$registration = $this->Registrations->get($registrationId, contain: ['Users' => ['Roles']]);
+		/** @var \StateMachineSandbox\Model\Table\RegistrationsTable $Registrations */
+		$Registrations = $this->fetchModel('StateMachineSandbox.Registrations');
+		$registration = $Registrations->get($registrationId, contain: ['Users' => ['Roles']]);
 		if ($registration->user && $registration->user->role && $registration->user->role->alias === 'mod') {
 			return true;
 		}

plugins/StateMachineSandbox/templates/Registrations/index.php

@@ -32,7 +32,7 @@
             <tbody>
                 <?php foreach ($registrations as $registration): ?>
                 <tr>
-                    <td><?= h($registration->user->username) ?></td>
+                    <td><?= $registration->user ? h($registration->user->username) : 'anonymous' ?></td>
                     <td><?= h($registration->status) ?></td>
                     <td><?= $this->Time->nice($registration->created) ?></td>
                     <td><?= $this->Time->nice($registration->modified) ?></td>