Merge pull request #181 from indranshastri/develop

Refactoring of blogs apis

app/Http/Controllers/Api/V1/BlogTagsController.php

@@ -24,9 +24,9 @@ class BlogTagsController extends APIController
     }
 
     /**
-     * Return the users.
+     * Return the BlogTags.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index(Request $request)
     {
@@ -40,9 +40,9 @@ class BlogTagsController extends APIController
     /**
      * Return the specified resource.
      *
-     * @param User $user
+     * @param BlogTag $blog_tag
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function show(BlogTag $blog_tag)
     {
@@ -54,7 +54,7 @@ class BlogTagsController extends APIController
      *
      * @param Request $request
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function store(Request $request)
     {
@@ -68,25 +68,13 @@ class BlogTagsController extends APIController
         return new BlogTagsResource(BlogTag::orderBy('created_at', 'desc')->first());
     }
 
-    /** NOTE This function is same as about but uses StoreApiBlogTagsRequest for validation of the api
-     * Creates the Resource for BlogTag.
-     *
-     * @param Request $request
-     *
-     * @return \Illuminate\Http\Response
-     */
-    // public function store(StoreApiBlogTagsRequest $request)
-    // {
-    //     $this->repository->create($request->all());
-
-    //     return new BlogTagsResource(BlogTag::orderBy('created_at', 'desc')->first());
-    // }
-
     /**
+     * Update BlogTag
+     * 
      * @param BlogTag              $blog_tag
-     * @param UpdateBlogTagRequest $request
+     * @param Request              $request
      *
-     * @return mixed
+     * @return \Illuminate\Http\JsonResponse
      */
     public function update(Request $request, BlogTag $blog_tag)
     {
@@ -103,20 +91,13 @@ class BlogTagsController extends APIController
         return new BlogTagsResource($blog_tag);
     }
 
-    public function validatingRequest(Request $request, $id = 0)
-    {
-        $validation = Validator::make($request->all(), [
-            'name' => 'required|max:191|unique:blog_tags,name,'.$id,
-        ]);
-
-        return $validation;
-    }
-
     /**
+     * Delete BlogTag
+     * 
      * @param BlogTag              $blog_tag
      * @param DeleteBlogTagRequest $request
      *
-     * @return mixed
+     * @return \Illuminate\Http\JsonResponse
      */
     public function destroy(BlogTag $blog_tag, Request $request)
     {
@@ -124,4 +105,21 @@ class BlogTagsController extends APIController
 
         return ['message'=>'success'];
     }
+
+    /**
+     * validate BlogTag.
+     *
+     * @param $request 
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function validatingRequest(Request $request, $id = 0)
+    {
+        $validation = Validator::make($request->all(), [
+            'name' => 'required|max:191|unique:blog_tags,name,' . $id,
+        ]);
+
+        return $validation;
+    }
+
 }

app/Http/Controllers/Api/V1/BlogsController.php

@@ -23,9 +23,9 @@ class BlogsController extends APIController
     }
 
     /**
-     * Return the users.
+     * Return the blogs.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index(Request $request)
     {
@@ -39,9 +39,9 @@ class BlogsController extends APIController
     /**
      * Return the specified resource.
      *
-     * @param User $user
+     * @param Blog blog
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function show(Blog $blog)
     {
@@ -53,29 +53,32 @@ class BlogsController extends APIController
      *
      * @param Request $request
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function store(Request $request)
     {
-        $validation = $this->validatingRequest($request);
+        $validation = $this->validateBlog($request);
+
         if ($validation->fails()) {
             return $this->throwValidation($validation->messages()->first());
         }
 
         $this->repository->create($request->all());
-
+        
         return new BlogsResource(Blog::orderBy('created_at', 'desc')->first());
     }
 
     /**
+     * Update blog
+     * 
      * @param Blog              $blog
-     * @param UpdateBlogRequest $request
+     * @param Request           $request
      *
-     * @return mixed
+     * @return \Illuminate\Http\JsonResponse
      */
     public function update(Request $request, Blog $blog)
     {
-        $validation = $this->validatingRequest($request, 'update');
+        $validation = $this->validateBlog($request, 'update');
 
         if ($validation->fails()) {
             return $this->throwValidation($validation->messages()->first());
@@ -88,9 +91,33 @@ class BlogsController extends APIController
         return new BlogsResource($blog);
     }
 
-    public function validatingRequest(Request $request, $type = 'insert')
+    /**
+     * Delete Blog 
+     * 
+     * @param Blog              $blog
+     * @param Request           $request
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function destroy(Blog $blog, Request $request)
+    {
+        $this->repository->delete($blog);
+
+        return $this->respond([
+            'message' => trans('alerts.backend.blogs.deleted'),
+        ]);
+    }
+
+    /**
+     * validate Blog.
+     *
+     * @param $request 
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
+    public function validateBlog(Request $request, $action = 'insert')
     {
-        $featured_image = ($type == 'insert') ? 'required' : '';
+        $featured_image = ($action == 'insert') ? 'required' : '';
 
         $validation = Validator::make($request->all(), [
             'name'           => 'required|max:191',
@@ -102,7 +129,11 @@ class BlogsController extends APIController
 
         return $validation;
     }
-
+    /**
+     * validate message for validate blog.
+     *
+     * @return \Illuminate\Http\JsonResponse
+     */
     public function messages()
     {
         return [
@@ -111,16 +142,4 @@ class BlogsController extends APIController
         ];
     }
 
-    /**
-     * @param Blog              $blog
-     * @param DeleteBlogRequest $request
-     *
-     * @return mixed
-     */
-    public function destroy(Blog $blog, Request $request)
-    {
-        $this->repository->delete($blog);
-
-        return ['message'=>'success'];
-    }
 }

app/Http/Controllers/Api/V1/FaqsController.php

@@ -25,7 +25,7 @@ class FaqsController extends APIController
     /**
      * Return the faqs.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function index(Request $request)
     {
@@ -41,7 +41,7 @@ class FaqsController extends APIController
      *
      * @param Faq $faq
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function show(Faq $faq)
     {
@@ -53,7 +53,7 @@ class FaqsController extends APIController
      *
      * @param Request $request
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse
      */
     public function store(Request $request)
     {
@@ -73,7 +73,7 @@ class FaqsController extends APIController
      * @param Faq     $faq
      * @param Request $request
      *
-     * @return mixed
+     * @return \Illuminate\Http\JsonResponse
      */
     public function update(Request $request, Faq $faq)
     {
@@ -96,7 +96,7 @@ class FaqsController extends APIController
      * @param Faq     $faq
      * @param Request $request
      *
-     * @return mixed
+     * @return \Illuminate\Http\JsonResponse
      */
     public function destroy(Faq $faq, Request $request)
     {