article images documentation

article images basic methods

api/app/Http/Controllers/ArticleImageController.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Models\Image;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Http\Request;
+use Spira\Model\Collection\Collection;
+use Spira\Model\Model\BaseModel;
+use Spira\Responder\Response\ApiResponse;
+
+class ArticleImageController extends ChildEntityController
+{
+    public function getAll(Request $request, $id, $group = null)
+    {
+        $model = $this->findParentEntity($id);
+        $childEntities = $this->findAllChildren($model, $group);
+        $childEntities = $this->getWithNested($childEntities, $request);
+
+        return $this->getResponse()
+            ->transformer($this->getTransformer())
+            ->collection($childEntities);
+    }
+
+    /**
+     * Put many entities.
+     *
+     * @param  Request $request
+     * @param string $id
+     * @param $group
+     * @return ApiResponse
+     */
+    public function putMany(Request $request, $id, $group)
+    {
+        $parent = $this->findParentEntity($id);
+
+        $requestCollection = $request->data;
+        $this->validateRequestCollection($requestCollection, $this->getValidationRules());
+
+        $existingChildModels = Image::whereIn('image_id', $this->getIds($requestCollection, 'image_id'))->get();
+
+        $childModels = $this->getChildModel()
+            ->hydrateRequestCollection($requestCollection, $existingChildModels)
+            ->each(function (BaseModel $model) {
+                if (!$model->exists) {
+                    $model->save();
+                }
+            });
+
+        foreach ($childModels as $childModel) {
+            $this->getRelation($parent)->attach($childModel,['group_type'=>$group]);
+        }
+
+        return $this->getResponse()
+            ->transformer($this->getTransformer())
+            ->createdCollection($childModels);
+    }
+
+    /**
+     * Delete an entity.
+     *
+     * @param  string $id
+     * @param string $childId
+     * @param $group
+     * @return ApiResponse
+     * @throws \Exception
+     */
+    public function deleteOne($id, $childId, $group)
+    {
+        $model = $this->findParentEntity($id);
+        $childModel = $this->findOrFailChildEntity($childId, $model, $group);
+
+        $childModel->pivot->delete();
+
+        return $this->getResponse()->noContent();
+    }
+
+
+    /**
+     * @param $parent
+     * @param null $group
+     * @return Collection
+     */
+    protected function findAllChildren($parent, $group = null)
+    {
+        $relation = $this->getRelation($parent);
+        if (!is_null($group)){
+            $relation->wherePivot('group_type','=',$group);
+        }
+
+        return $relation->getResults();
+    }
+
+    /**
+     * @param $id
+     * @param BaseModel $parent
+     * @param $group
+     * @return BaseModel
+     */
+    protected function findOrFailChildEntity($id, BaseModel $parent, $group)
+    {
+        try {
+            return $this->getRelation($parent)->wherePivot('group_type','=',$group)->findOrFail($id);
+        } catch (ModelNotFoundException $e) {
+            throw $this->notFoundException($this->getChildModel()->getKeyName());
+        }
+    }
+}

api/app/Http/routes.php

@@ -47,6 +47,11 @@
 
     $app->get('{id}/tags', 'App\Http\Controllers\ArticleTagController@getAll');
     $app->put('{id}/tags', 'App\Http\Controllers\ArticleTagController@putMany');
+
+    $app->get('{id}/images', 'App\Http\Controllers\ArticleImageController@getAll');
+    $app->get('{id}/images/{group}', 'App\Http\Controllers\ArticleImageController@getAll');
+    $app->put('{id}/images', 'App\Http\Controllers\ArticleImageController@putMany');
+    $app->delete('{id}/image/{childId}/{group}', 'App\Http\Controllers\ArticleImageController@deleteOne');
 });
 
 $app->group(['prefix' => 'tags'], function (Application $app) {

api/app/Models/Article.php

@@ -1,6 +1,7 @@
 <?php namespace App\Models;
 
 use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Support\Str;
 use Rhumsaa\Uuid\Uuid;
 use Spira\Model\Collection\Collection;
@@ -120,7 +121,7 @@ public function setPermalinkAttribute($permalink)
     }
 
     /**
-     * If there is no defined exerpt for the text, create it from the content
+     * If there is no defined excerpt for the text, create it from the content
      * @param $excerpt
      * @return string
      */
@@ -147,4 +148,12 @@ public function tags()
     {
         return $this->belongsToMany(Tag::class, 'tag_article');
     }
+
+    /**
+     * @return BelongsToMany
+     */
+    public function images()
+    {
+        return $this->belongsToMany(Image::class, 'image_article')->withPivot('group_type');
+    }
 }

api/database/migrations/2015_08_25_170420_create_article_image_table.php

@@ -15,7 +15,7 @@ public function up()
         Schema::create('image_article', function (Blueprint $table) {
             $table->uuid('image_id');
             $table->uuid('article_id');
-            $table->enum('group_type',['primary','carousel','extra']);
+            $table->enum('group_type',['primary','thumbnail','carousel']);
             $table->smallInteger('position',false,true)->default(1);
 
             $table->primary(['image_id','article_id','group_type']);

api/database/seeds/ArticleSeeder.php

@@ -2,6 +2,7 @@
 
 use App\Models\Article;
 use App\Models\ArticleMeta;
+use App\Models\Image;
 use App\Models\Tag;
 use App\Models\ArticlePermalink;
 use Illuminate\Database\Seeder;
@@ -23,10 +24,16 @@ public function run()
                 $permalinks = factory(ArticlePermalink::class, rand(0, 4))->make()->all();
                 $metas = factory(ArticleMeta::class, 2)->make()->all();
                 $tags = factory(Tag::class, 2)->make()->all();
+                $image1 = $entity = factory(Image::class)->create();
+                $image2 = $entity = factory(Image::class)->create();
+                $image3 = $entity = factory(Image::class)->create();
                 $article->save();
                 $article->metas()->saveMany($metas);
                 $article->permalinks()->saveMany($permalinks);
                 $article->tags()->saveMany($tags);
+                $article->images()->save($image1,['group_type'=>'primary']);
+                $article->images()->save($image2,['group_type'=>'thumbnail']);
+                $article->images()->save($image3,['group_type'=>'carousel']);
             })
         ;
 

api/resources/views/documentation/sections/article.blade.apib

@@ -186,3 +186,61 @@ Note that this route returns paginated results as defined in the `Content-Range`
                     ->json()
             !!}
 
+## Article Images [/articles/{articleId}/images]
++ Parameters
+    + articleId (required, uuid, `{!! $faker->uuid !!}`) ... Unique `id` or `uri` of the article to perform action with.
+
+### Retrieve all article's images [GET]
+#### Restrictions
+* Allowed - [all]
+
++ Response 200 (application/json)
+    + Body
+
+            {!!
+                $factory->get(\App\Models\Image::class)
+                    ->count(3)
+                    ->json()
+            !!}
+
+## Article Images with group [/articles/{articleId}/images/{group}]
++ Parameters
+    + articleId (required, uuid, `{!! $faker->uuid !!}`) ... Unique `id` or `uri` of the article to perform action with.
+    + group (required, string, `primary`) ... `group` image belongs to
+
+### Retrieve all article's images [GET]
+#### Restrictions
+* Allowed - [all]
+
++ Response 200 (application/json)
+    + Body
+
+            {!!
+                $factory->get(\App\Models\Image::class)
+                    ->count(3)
+                    ->json()
+            !!}
+
+### Add images to article [PUT]
+#### Restrictions
+* Allowed - [admin]
+
++ Request
+    + Body
+
+            {!!
+                $factory->get(\App\Models\Image::class)
+                    ->count(3)
+                    ->hide(['_self'])
+                    ->json()
+            !!}
+
++ Response 201 (application/json)
+    + Body
+
+            {!!
+                $factory->get(\App\Models\Image::class)
+                    ->showOnly(['_self'])
+                    ->json()
+            !!}
+

api/src/Model/Model/BaseModel.php

@@ -35,6 +35,7 @@
  * @method static Collection get
  * @method static Collection findMany($ids)
  * @method static Builder where($value,$operator,$operand)
+ * @method static Builder whereIn($column,$ids)
  * @method static BaseModel skip($offset)
  * @method static BaseModel take($limit)
  *

api/tests/integration/ArticleImageTest.php

@@ -0,0 +1,6 @@
+<?php
+
+class ArticleImageTest extends TestCase
+{
+
+}