Fix CS errors

Author: ADmad

.gitignore

@@ -5,3 +5,4 @@ vendor/
 composer.lock
 tmp
 .phpunit.result.cache
+.phpunit.cache

src/Listener/JsonApiListener.php

@@ -138,26 +138,18 @@ public function beforeHandle(EventInterface $event): void
      * `?include=` query parameter was passed because that would override/break previously generated data.
      *
      * @param \Cake\Event\EventInterface $event Event
-     * @return null
+     * @return void
      */
-    public function afterFind(EventInterface $event)
+    public function afterFind(EventInterface $event): void
     {
         if (!$this->_request()->is('get')) {
-            return null;
+            return;
         }
 
         // set property so we can check inside `_renderWithResources()`
         if (!empty($event->getSubject()->query->getContain())) {
             $this->_ControllerHasSetContain = true;
-
-            return null;
         }
-
-        if ($this->getConfig('include')) {
-            return null;
-        }
-
-        return null;
     }
 
     /**
@@ -203,16 +195,12 @@ public function beforeSave(EventInterface $event): void
             // hasMany found in the entity, extract ids from the request data
             $primaryResourceId = $this->_controller()->getRequest()->getData('id');
 
-            /**
- * @var array $hasManyIds
-*/
+            /** @var array $hasManyIds */
             $hasManyIds = Hash::extract($this->_controller()->getRequest()->getData($key), '{n}.id');
             $hasManyTable = $this->getTableLocator()->get($associationName);
 
             // query database only for hasMany that match both passed id and the id of the primary resource
-            /**
- * @var string $entityForeignKey
-*/
+            /** @var string $entityForeignKey */
             $entityForeignKey = $hasManyTable->getAssociation($entity->getSource())->getForeignKey();
             $primaryKey = current((array)$hasManyTable->getPrimaryKey());
             $query = $hasManyTable->find()
@@ -245,17 +233,21 @@ public function beforeSave(EventInterface $event): void
      * afterSave() event.
      *
      * @param \Cake\Event\EventInterface $event Event
-     * @return bool|null
+     * @return void
      */
-    public function afterSave(EventInterface $event): ?bool
+    public function afterSave(EventInterface $event): void
     {
         if (!$event->getSubject()->success) {
-            return false;
+            $event->setResult(false);
+
+            return;
         }
 
         // `created` will be set for add actions, `id` for edit actions
         if (!$event->getSubject()->created && !$event->getSubject()->id) {
-            return false;
+            $event->setResult(false);
+
+            return;
         }
 
         // The `add`action (new Resource) MUST respond with HTTP Status Code 201,
@@ -269,8 +261,6 @@ public function afterSave(EventInterface $event): ?bool
          */
         $subject = $event->getSubject();
         $this->render($subject);
-
-        return null;
     }
 
     /**
@@ -281,17 +271,17 @@ public function afterSave(EventInterface $event): ?bool
      * been implemented here yet. http://jsonapi.org/format/#crud-deleting
      *
      * @param \Cake\Event\EventInterface $event Event
-     * @return bool|null
+     * @return void
      */
-    public function afterDelete(EventInterface $event): ?bool
+    public function afterDelete(EventInterface $event): void
     {
         if (!$event->getSubject()->success) {
-            return false;
+            $event->setResult(false);
+
+            return;
         }
 
         $this->_controller()->setResponse($this->_controller()->getResponse()->withStatus(204));
-
-        return null;
     }
 
     /**

src/Schema/JsonApi/DynamicEntitySchema.php

@@ -89,6 +89,7 @@ public function getType(): string
      * @param \Cake\ORM\Entity $resource Entity
      * @return string
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getId($resource): ?string
     {
@@ -161,6 +162,7 @@ protected function entityToShallowArray(EntityInterface $entity): array
      * @param \Neomerx\JsonApi\Contracts\Schema\ContextInterface $context The Context
      * @return array
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getAttributes($resource, ContextInterface $context): iterable
     {
@@ -205,6 +207,7 @@ public function getAttributes($resource, ContextInterface $context): iterable
      * @param \Neomerx\JsonApi\Contracts\Schema\ContextInterface $context The Context
      * @return array
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getRelationships($resource, ContextInterface $context): iterable
     {
@@ -282,6 +285,7 @@ public function getRelationships($resource, ContextInterface $context): iterable
      * @param \Cake\ORM\Entity|null $resource Entity, null only to be compatible with the Neomerx method
      * @return string
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getSelfSubUrl($resource = null): string
     {
@@ -326,6 +330,7 @@ protected function getAssociationByProperty(string $name): ?Association
      * @param string                           $name   Relationship name in lowercase singular or plural
      * @return \Neomerx\JsonApi\Contracts\Schema\LinkInterface
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getRelationshipSelfLink($resource, string $name): LinkInterface
     {
@@ -366,6 +371,7 @@ public function getRelationshipSelfLink($resource, string $name): LinkInterface
      * @param string                           $name   Relationship name in lowercase singular or plural
      * @return \Neomerx\JsonApi\Contracts\Schema\LinkInterface
      * @psalm-suppress MoreSpecificImplementedParamType
+     * @phpcs:disable SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
      */
     public function getRelationshipRelatedLink($resource, string $name): LinkInterface
     {

tests/TestCase/Listener/JsonApiListenerTest.php

@@ -252,13 +252,15 @@ public function testAfterSave()
 
         // assert nothing happens if `success` is false
         $event->getSubject()->success = false;
-        $this->assertFalse($this->callProtectedMethod('afterSave', [$event], $listener));
+        $this->callProtectedMethod('afterSave', [$event], $listener);
+        $this->assertFalse($event->getResult());
 
         // assert nothing happens if `success` is true but both `created` and `id` are false
         $event->getSubject()->success = true;
         $event->getSubject()->created = false;
         $event->getSubject()->id = false;
-        $this->assertFalse($this->callProtectedMethod('afterSave', [$event], $listener));
+        $this->callProtectedMethod('afterSave', [$event], $listener);
+        $this->assertFalse($event->getResult());
 
         // assert success
         $table = $this->fetchTable('Countries');
@@ -331,7 +333,8 @@ public function testAfterDelete()
 
         // assert nothing happens if `success` is false
         $event->getSubject()->success = false;
-        $this->assertFalse($this->callProtectedMethod('afterDelete', [$event], $listener));
+        $this->callProtectedMethod('afterDelete', [$event], $listener);
+        $this->assertFalse($event->getResult());
 
         $event->getSubject()->success = true;
         $this->assertNull($this->callProtectedMethod('afterDelete', [$event], $listener));