CakePHP 5.1 deprecations (#155)

* Handle cakephp 5.1.0: Calling `Cake\ORM\ResultSet` methods, such as `first()`, on PaginatedResultSet is deprecated. You must call `items()` first (for example, `items()->first()`)

* CakePHP 5.1

* resolve phpstan errors

Author: cnizzardini

.github/workflows/pull-request.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-versions: ['8.3']
+        php-versions: ['8.1', '8.4']
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -115,3 +115,33 @@ jobs:
           rm -rf composer.lock
           composer install
           vendor/bin/phpunit plugins/${{matrix.plugin}}
+
+  #
+  # CakePHP version compatability
+  #
+  cakephp_version_compatibility:
+    name: CakePHP ${{ matrix.version }} Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['~5.0', '~5.1']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          extensions: mbstring, intl
+
+      - name: PHP Version
+        run: php -v
+
+      - name: CakePHP ${{matrix.version}} Compatability
+        run: |
+          composer self-update
+          rm -rf composer.lock
+          composer require cakephp/cakephp:${{matrix.version}} --no-update
+          composer install --prefer-dist --no-progress
+          composer test

config/app.php

@@ -108,7 +108,7 @@
          * Duration will be set to '+2 minutes' in bootstrap.php when debug = true
          * If you set 'className' => 'Null' core cache will be disabled.
          */
-        '_cake_core_' => [
+        '_cake_translations_' => [
             'className' => FileEngine::class,
             'prefix' => 'myapp_cake_core_',
             'path' => CACHE . 'persistent' . DS,

phpstan.neon

@@ -3,5 +3,6 @@ parameters:
 	checkGenericClassInNonGenericObjectType: false
 	checkMissingIterableValueType: false
 	treatPhpDocTypesAsCertain: false
+	reportUnmatchedIgnoredErrors: false
 	excludePaths:
 		- plugins/exception-render/src/OpenApiExceptionSchema.php

plugins/hal-view/src/JsonSerializer.php

@@ -117,7 +117,11 @@ private function recursion(mixed &$mixed): mixed
     private function collection(mixed $collection): array
     {
         try {
-            $entity = $collection->first();
+            if ($collection instanceof PaginatedResultSet) {
+                $entity = $collection->toArray()[0];
+            } else {
+                $entity = $collection->first();
+            }
             $tableName = Inflector::tableize((new ReflectionClass($entity))->getShortName());
         } catch (ReflectionException $e) {
             $tableName = 'data';

plugins/json-ld-view/src/JsonSerializer.php

@@ -138,7 +138,12 @@ private function collection(mixed $jsonLd): array
         $return = [];
 
         try {
-            $entity = $jsonLd->first();
+            if ($jsonLd instanceof PaginatedResultSet) {
+                $entity = $jsonLd->toArray()[0];
+            } else {
+                $entity = $jsonLd->first();
+            }
+
             if ($entity instanceof JsonLdDataInterface) {
                 $return['@context'] = $entity->getJsonLdContext();
             }