Feature/24 (#62)

* #55 - change routes for admin

* #43 - permission policy
#94 - add permissions

* #50 - maintain response style

* #51 - search elements by title and/or library_id

* #24 - add QueryExtendable

Co-authored-by: KD <do>
Co-authored-by: krz <krzysztof.dziedziech@escola.pl>

Author: KrzysztofDziedziechEscolasoft

src/Dtos/ContentFilterCriteriaDto.php

@@ -16,10 +16,10 @@ public static function instantiateFromRequest(Request $request): self
         $criteria = new Collection();
 
         if ($request->has('title')) {
-            $criteria->push(new LikeCriterion('title', $request->input('title')));
+            $criteria->push(new LikeCriterion('hh5p_contents.title', $request->input('title')));
         }
         if ($request->has('library_id')) {
-            $criteria->push(new EqualCriterion('library_id', $request->input('library_id')));
+            $criteria->push(new EqualCriterion('hh5p_contents.library_id', $request->input('library_id')));
         }
 
         return new self($criteria);

src/Http/Controllers/Swagger/ContentApiSwagger.php

@@ -95,7 +95,6 @@
 
 interface ContentApiSwagger
 {
-
     /**
     * @OA\Post(
     *      path="/api/hh5p/content",

src/Http/Controllers/Swagger/EditorApiSwagger.php

@@ -7,8 +7,6 @@
 
 interface EditorApiSwagger
 {
-
-
     /**
      *
      * @OA\Schema(

src/Http/Controllers/Swagger/FilesApiSwagger.php

@@ -9,7 +9,6 @@
 
 interface FilesApiSwagger
 {
-
     /**
     * @OA\Schema(
     *      schema="H5PContentFile",

src/Models/H5PContent.php

@@ -131,12 +131,12 @@ public function getMetadataAttribute($value)
         return $parameters->metadata;
     }
 
-    public function user():BelongsTo
+    public function user(): BelongsTo
     {
         return $this->belongsTo(User::class);
     }
 
-    public function library():BelongsTo
+    public function library(): BelongsTo
     {
         return $this->belongsTo(H5PLibrary::class, 'library_id');
     }

src/Repositories/H5PContentRepository.php

@@ -11,12 +11,15 @@
 use EscolaLms\HeadlessH5P\Models\H5PTempFile;
 use EscolaLms\HeadlessH5P\Repositories\Contracts\H5PContentRepositoryContract;
 use EscolaLms\HeadlessH5P\Services\Contracts\HeadlessH5PServiceContract;
+use EscolaLms\HeadlessH5P\Traits\QueryExtendable;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Support\Collection;
 
 class H5PContentRepository implements H5PContentRepositoryContract
 {
+    use QueryExtendable;
+
     private HeadlessH5PServiceContract $hh5pService;
 
     public function __construct(HeadlessH5PServiceContract $hh5pService)
@@ -124,7 +127,7 @@ private function moveTmpFilesToContentFolders($nonce, $contentId): bool
     public function list(
         ContentFilterCriteriaDto $contentFilterDto,
         $per_page = 15,
-        array $columns = ['*']
+        array $columns = ['hh5p_contents.*']
     ): LengthAwarePaginator {
         $query = $this->getQueryContent($contentFilterDto, $columns);
         $paginator = $query->paginate(intval($per_page));
@@ -239,6 +242,10 @@ private function getQueryContent(ContentFilterCriteriaDto $contentFilterDto, arr
             ['library']
         )->select($columns);
 
+        $query = self::applyQueryJoin($query);
+        $query = self::applyQuerySelect($query);
+        $query = self::applyQueryGroupBy($query);
+
         return $this->applyCriteria($query, $contentFilterDto->toArray());
     }
 }

src/Traits/QueryExtendable.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace EscolaLms\HeadlessH5P\Traits;
+
+use Illuminate\Database\Eloquent\Builder;
+
+trait QueryExtendable
+{
+    private static array $extensionsJoin = [];
+    private static array $extensionsSelect = [];
+    private static array $extendQueryGroupBy = [];
+
+    public static function extendQueryJoin(callable $extension, string $tableName): void
+    {
+        self::$extensionsJoin[$tableName] = $extension;
+    }
+
+    public static function applyQueryJoin(Builder $query): Builder
+    {
+        foreach (self::$extensionsJoin as $tableName => $extension) {
+            $query->leftJoin($tableName, $extension());
+        }
+
+        return $query;
+    }
+
+    public static function extendQuerySelect(callable $extension): void
+    {
+        self::$extensionsSelect[] = $extension;
+    }
+
+    public static function applyQuerySelect(Builder $query): Builder
+    {
+        foreach (self::$extensionsSelect as $extension) {
+            $query->addSelect($extension());
+        }
+
+        return $query;
+    }
+
+    public static function extendQueryGroupBy(callable $extension): void
+    {
+        self::$extendQueryGroupBy[] = $extension;
+    }
+
+    public static function applyQueryGroupBy(Builder $query): Builder
+    {
+        $groupBy = '';
+        foreach (self::$extendQueryGroupBy as $extension) {
+            $groupBy .= ($groupBy ? ', ' : '' ) . $extension();
+        }
+        if ($groupBy) {
+            $query->groupBy($groupBy);
+        }
+
+        return $query;
+    }
+}

tests/Api/ContentApiTest.php

@@ -4,6 +4,7 @@
 
 use EscolaLms\HeadlessH5P\Models\H5PContent;
 use EscolaLms\HeadlessH5P\Models\H5PLibrary;
+use EscolaLms\HeadlessH5P\Repositories\H5PContentRepository;
 use EscolaLms\HeadlessH5P\Tests\TestCase;
 use Illuminate\Http\UploadedFile;
 

tests/Api/LibraryApiTest.php

@@ -75,7 +75,7 @@ public function testGuestCannotIndexLibrary(): void
         $response->assertForbidden();
     }
 
-    public function testGuestCannotUploadLibrary()
+    public function testGuestCannotUploadLibrary(): void
     {
         $filename = 'arithmetic-quiz.h5p';
         $filepath = realpath(__DIR__.'/../mocks/'.$filename);