Added phpstan

.github/workflows/phpstan.yml

@@ -0,0 +1,39 @@
+name: Tests PHPStan in environments
+
+on: [pull_request]
+
+jobs:
+  php82-laravel-latest-phpstan-postgres:
+    runs-on: ubuntu-latest
+    container:
+      image: escolalms/php:8.2
+
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: test
+          TZ: Europe/Warsaw
+        ports:
+          - 5432:5432
+
+    steps:
+      - name: Instantiate package
+        uses: actions/checkout@v2
+
+      - name: Setup environment
+        run: cp env/postgres/* .
+
+      - name: Update composer
+        run: COMPOSER_ROOT_VERSION=0.9.9 composer update
+
+      - name: Clear config
+        run: vendor/bin/testbench config:clear
+
+      - name: Publish things
+        run: vendor/bin/testbench migrate:fresh
+
+      - name: Run tests
+        run: vendor/bin/phpstan analyse

composer.json

@@ -14,7 +14,8 @@
   "require-dev": {
     "phpunit/phpunit": "^9.0",
     "orchestra/testbench": ">=5.0",
-    "escolalms/courses-import-export": "^0"
+    "escolalms/courses-import-export": "^0",
+    "nunomaduro/larastan": "^2.0"
   },
   "suggest": {
     "escolalms/courses": "Topic types is a package related to escolalms/courses without which it may not work properly.",

phpstan.neon

@@ -0,0 +1,10 @@
+includes:
+    - ./vendor/nunomaduro/larastan/extension.neon
+
+parameters:
+
+    paths:
+        - src/
+
+    # The level 9 is the highest level
+    level: 5

src/Helpers/Markdown.php

@@ -57,6 +57,7 @@ function ($match) use ($destinationPrefix, &$results) {
                     str_contains($filepath, 'api/images/img') => $results[] = $this->convertFilePathByApiPattern($destinationPrefix, $filepath, $destination),
                     str_contains($filepath, 'storage') => $results[] = $this->convertFilePathByStorage($filepath, $destination),
                     str_contains($filepath, 'http') => $results[] = $this->convertFilePathByHttp($destinationPrefix, $filepath, $destination),
+                    default => $results[] = null,
                 };
 
                 return str_replace($match[3], $destination, $match[0]);

src/Http/Resources/TopicType/Admin/AudioResource.php

@@ -11,12 +11,12 @@ class AudioResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => Storage::url($this->value),
-            'length' => $this->length,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => Storage::url($this->resource->value),
+            'length' => $this->resource->length,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/Cmi5AuResource.php

@@ -10,10 +10,10 @@ class Cmi5AuResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/H5PResource.php

@@ -11,11 +11,11 @@ class H5PResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'content' => isset($this->value) ? app(HeadlessH5PServiceContract::class)->getContentSettings($this->value) : null,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'content' => isset($this->resource->value) ? app(HeadlessH5PServiceContract::class)->getContentSettings($this->resource->value) : null,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/ImageResource.php

@@ -11,13 +11,13 @@ class ImageResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => $this->value ? Storage::url($this->value) : null,
-            'width' => $this->width,
-            'height' => $this->height,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => $this->resource->value ? Storage::url($this->resource->value) : null,
+            'width' => $this->resource->width,
+            'height' => $this->resource->height,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/OEmbedResource.php

@@ -10,10 +10,10 @@ class OEmbedResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/PDFResource.php

@@ -11,13 +11,13 @@ class PDFResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'length' => $this->length,
-            'page_count' => $this->page_count,
-            'url' => Storage::url($this->value),
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'length' => $this->resource->length,
+            'page_count' => $this->resource->page_count,
+            'url' => Storage::url($this->resource->value),
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/RichTextResource.php

@@ -10,11 +10,11 @@ class RichTextResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'length' => $this->length,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'length' => $this->resource->length,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/ScormScoResource.php

@@ -10,14 +10,15 @@ class ScormScoResource extends JsonResource implements TopicTypeResourceContract
 {
     public function toArray($request)
     {
-        $scormSco = ScormScoModel::find($this->value);
+        $scormSco = ScormScoModel::find($this->resource->value);
 
         return [
-            'id' => $this->id,
-            'value' => $this->value,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            // @phpstan-ignore-next-line
             'uuid' => $scormSco ? $scormSco->uuid : null,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }

src/Http/Resources/TopicType/Admin/VideoResource.php

@@ -14,16 +14,16 @@ class VideoResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         $fields = [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => $this->value ? Storage::url($this->value) : null,
-            'poster' => $this->poster,
-            'poster_url' => $this->poster ? Storage::url($this->poster) : null,
-            'width' => $this->width,
-            'height' => $this->height,
-            'length' => $this->length,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => $this->resource->value ? Storage::url($this->resource->value) : null,
+            'poster' => $this->resource->poster,
+            'poster_url' => $this->resource->poster ? Storage::url($this->resource->poster) : null,
+            'width' => $this->resource->width,
+            'height' => $this->resource->height,
+            'length' => $this->resource->length,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
 
         return self::apply($fields, $this);

src/Http/Resources/TopicType/Client/AudioResource.php

@@ -11,10 +11,10 @@ class AudioResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => Storage::url($this->value),
-            'length' => $this->length,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => Storage::url($this->resource->value),
+            'length' => $this->resource->length,
         ];
     }
 }

src/Http/Resources/TopicType/Client/Cmi5AuResource.php

@@ -10,8 +10,8 @@ class Cmi5AuResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
         ];
     }
 }

src/Http/Resources/TopicType/Client/H5PResource.php

@@ -11,9 +11,9 @@ class H5PResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'content' => isset($this->value) ? app(HeadlessH5PServiceContract::class)->getContentSettings($this->value) : null,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'content' => isset($this->resource->value) ? app(HeadlessH5PServiceContract::class)->getContentSettings($this->resource->value) : null,
         ];
     }
 }

src/Http/Resources/TopicType/Client/ImageResource.php

@@ -11,11 +11,11 @@ class ImageResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => $this->value ? Storage::url($this->value) : null,
-            'width' => $this->width,
-            'height' => $this->height,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => $this->resource->value ? Storage::url($this->resource->value) : null,
+            'width' => $this->resource->width,
+            'height' => $this->resource->height,
         ];
     }
 }

src/Http/Resources/TopicType/Client/OEmbedResource.php

@@ -10,8 +10,8 @@ class OEmbedResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
         ];
     }
 }

src/Http/Resources/TopicType/Client/PDFResource.php

@@ -11,11 +11,11 @@ class PDFResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'length' => $this->length,
-            'page_count' => $this->page_count,
-            'url' => Storage::url($this->value),
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'length' => $this->resource->length,
+            'page_count' => $this->resource->page_count,
+            'url' => Storage::url($this->resource->value),
         ];
     }
 }

src/Http/Resources/TopicType/Client/RichTextResource.php

@@ -10,9 +10,9 @@ class RichTextResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'id' => $this->id,
-            'value' => $this->value,
-            'length' => $this->length,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'length' => $this->resource->length,
         ];
     }
 }

src/Http/Resources/TopicType/Client/ScormScoResource.php

@@ -10,11 +10,12 @@ class ScormScoResource extends JsonResource implements TopicTypeResourceContract
 {
     public function toArray($request)
     {
-        $scormSco = ScormScoModel::find($this->value);
+        $scormSco = ScormScoModel::find($this->resource->value);
 
         return [
-            'id' => $this->id,
-            'value' => $this->value,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            // @phpstan-ignore-next-line
             'uuid' => $scormSco ? $scormSco->uuid : null,
         ];
     }

src/Http/Resources/TopicType/Client/VideoResource.php

@@ -14,14 +14,14 @@ class VideoResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         $fields = [
-            'id' => $this->id,
-            'value' => $this->value,
-            'url' => $this->value ? Storage::url($this->value) : null,
-            'poster' => $this->poster,
-            'poster_url' => $this->poster ? Storage::url($this->poster) : null,
-            'width' => $this->width,
-            'height' => $this->height,
-            'length' => $this->length,
+            'id' => $this->resource->id,
+            'value' => $this->resource->value,
+            'url' => $this->resource->value ? Storage::url($this->resource->value) : null,
+            'poster' => $this->resource->poster,
+            'poster_url' => $this->resource->poster ? Storage::url($this->resource->poster) : null,
+            'width' => $this->resource->width,
+            'height' => $this->resource->height,
+            'length' => $this->resource->length,
         ];
 
         return self::apply($fields, $this);

src/Http/Resources/TopicType/Export/AudioResource.php

@@ -11,10 +11,10 @@ class AudioResource extends JsonResource implements TopicTypeResourceContract
     public function toArray($request)
     {
         return [
-            'value' => TopicTypeService::sanitizePath($this->value),
-            'length' => $this->length,
-            'created_at' => $this->created_at,
-            'updated_at' => $this->updated_at,
+            'value' => TopicTypeService::sanitizePath($this->resource->value),
+            'length' => $this->resource->length,
+            'created_at' => $this->resource->created_at,
+            'updated_at' => $this->resource->updated_at,
         ];
     }
 }