Better syntax

stanfortonski · Sep 26, 2021 · 79f5dc4 · 79f5dc4
1 parent 89dc9e6
commit 79f5dc4
Show file tree

Hide file tree

Showing 45 changed files with 2,069 additions and 1,513 deletions.
diff --git a/app/Http/Controllers/API/AuthorsController.php b/app/Http/Controllers/API/AuthorsController.php
@@ -12,9 +12,9 @@ class AuthorsController extends Controller
      * Display the specified resource.
      *
      * @param  \App\Models\User $user
-     * @return \Illuminate\Http\Response
+     * @return \App\Http\Resources\UserResource
      */
-    public function __invoke(User $user)
+    public function __invoke(User $user): UserResource
     {
         return new UserResource($user);
     }

diff --git a/app/Http/Controllers/API/CategoriesController.php b/app/Http/Controllers/API/CategoriesController.php
@@ -13,7 +13,6 @@ class CategoriesController extends Controller
      * Display a listing of the resource.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
      */
     public function index(Request $request)
     {
@@ -25,9 +24,9 @@ public function index(Request $request)
      * Display the specified resource.
      *
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \App\Http\Resources\CategoryResource
      */
-    public function show(Category $category)
+    public function show(Category $category): CategoryResource
     {
         if (!empty($category->contents))
             return new CategoryResource($category);

diff --git a/app/Http/Controllers/API/PostsController.php b/app/Http/Controllers/API/PostsController.php
@@ -13,7 +13,6 @@ class PostsController extends Controller
      * Display a listing of the resource.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
      */
     public function index(Request $request)
     {
@@ -25,9 +24,9 @@ public function index(Request $request)
      * Display the specified resource.
      *
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \App\Http\Resources\PostResource
      */
-    public function show(Post $post)
+    public function show(Post $post): PostResource
     {
         if ($post->isVisible() && !empty($post->contents))
             return new PostResource($post);

diff --git a/app/Http/Controllers/Admin/AdminController.php b/app/Http/Controllers/Admin/AdminController.php
@@ -3,28 +3,38 @@
 namespace App\Http\Controllers\Admin;
 
 use App\Http\Controllers\Controller;
-use Illuminate\Http\Request;
+use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Cookie;
+use Illuminate\View\View;
 
 class AdminController extends Controller
 {
     /**
-     * Handle the incoming request.
+     * Handle the admin index page.
      *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function index(Request $request)
+    public function index(): View
     {
         return view('admin.index');
     }
 
-    public function filesManager()
+    /**
+     * Handle the file manager page.
+     *
+     * @return \Illuminate\View\View
+     */
+    public function filesManager(): View
     {
         return view('admin.files-manager');
     }
 
-    public function setLang($lang)
+    /**
+     * Handle the change lang method
+     *
+     * @return \Illuminate\Http\RedirectResponse
+     */
+    public function setLang(string $lang)
     {
         Cookie::queue('lang', $lang);
         return redirect()->back();

diff --git a/app/Http/Controllers/Admin/CategoriesController.php b/app/Http/Controllers/Admin/CategoriesController.php
@@ -13,6 +13,7 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\Log;
+use Illuminate\View\View;
 
 class CategoriesController extends Controller
 {
@@ -22,9 +23,9 @@ class CategoriesController extends Controller
      * Display a listing of the resource.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function index(Request $request)
+    public function index(Request $request): View
     {
         $categories = Category::with('content')->search($request->q)->paginate(config('blog.pagination'))->withQueryString();
         return view('admin.categories.index')->with([
@@ -36,9 +37,9 @@ public function index(Request $request)
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function create()
+    public function create(): View
     {
         return view('admin.categories.save');
     }
@@ -47,7 +48,7 @@ public function create()
      * Store a newly created resource in storage.
      *
      * @param  \App\Requests\CategoryStoreRequest  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(CategoryStoreRequest $request)
     {
@@ -78,9 +79,9 @@ public function store(CategoryStoreRequest $request)
      * Show the form for editing the specified resource.
      *
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function edit(Category $category)
+    public function edit(Category $category): View
     {
         return view('admin.categories.save')->with([
             'category' => $category,
@@ -93,7 +94,7 @@ public function edit(Category $category)
      *
      * @param  \App\Requests\CategoryStoreRequest  $request
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(CategoryStoreRequest $request, Category $category)
     {
@@ -135,7 +136,7 @@ public function update(CategoryStoreRequest $request, Category $category)
      * Remove the specified resource from storage.
      *
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroy(Category $category)
     {
@@ -148,7 +149,7 @@ public function destroy(Category $category)
      *
      * @param  \App\Http\Requests\ImageRequest   $request
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function updateImage(ImageRequest $request, Category $category)
     {
@@ -162,7 +163,7 @@ public function updateImage(ImageRequest $request, Category $category)
      * Remove the thumbnail from storage.
      *
      * @param  \App\Models\Category  $category
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroyImage(Category $category)
     {

diff --git a/app/Http/Controllers/Admin/ContentController.php b/app/Http/Controllers/Admin/ContentController.php
@@ -7,16 +7,27 @@
 use App\Models\Post;
 use App\Models\PostContent;
 use Illuminate\Support\Facades\DB;
-use Illuminate\Http\Request;
 
 class ContentController extends Controller
 {
+    /**
+     * Delete content of category
+     *
+     * @param  \App\Models\Content  $content
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function deleteCategoryContent(Content $content)
     {
         $content->delete();
         return redirect()->back()->withSuccess(__('This language data has been deleted.'));
     }
 
+    /**
+     * Delete content of post
+     *
+     * @param  \App\Models\PostContent  $content
+     * @return \Illuminate\Http\RedirectResponse
+     */
     public function deletePostContent(PostContent $postContent)
     {
         $result = DB::select('select post_id from contents_of_posts where content_id = ?', [$postContent->id]);

diff --git a/app/Http/Controllers/Admin/PostsController.php b/app/Http/Controllers/Admin/PostsController.php
@@ -14,6 +14,7 @@
 use Illuminate\Support\Facades\DB;
 use Exception;
 use Illuminate\Support\Facades\Log;
+use Illuminate\View\View;
 
 class PostsController extends Controller
 {
@@ -23,9 +24,9 @@ class PostsController extends Controller
      * Display a listing of the resource.
      *
      * @param \Illuminate\Http\Request $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function index(Request $request)
+    public function index(Request $request): View
     {
         $posts = Post::with(['author', 'categories', 'content'])->orderBy('id', 'desc')->search($request->q)->paginate(config('blog.pagination'))->withQueryString();
         return view('admin.posts.index')->with([
@@ -37,9 +38,9 @@ public function index(Request $request)
     /**
      * Show the form for creating a new resource.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function create()
+    public function create(): View
     {
         return view('admin.posts.save');
     }
@@ -48,7 +49,7 @@ public function create()
      * Store a newly created resource in storage.
      *
      * @param  \App\Requests\PostStoreRequest  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function store(PostStoreRequest $request)
     {
@@ -81,9 +82,9 @@ public function store(PostStoreRequest $request)
      * Show the form for editing the specified resource.
      *
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\View\View
      */
-    public function edit(Post $post)
+    public function edit(Post $post): View
     {
         if ($post->user_id == auth()->user()->id || auth()->user()->hasOneOfRoles(['admin', 'mod'])){
             return view('admin.posts.save')->with([
@@ -99,7 +100,7 @@ public function edit(Post $post)
      *
      * @param  \App\Requests\PostStoreRequest  $request
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(PostStoreRequest $request, Post $post)
     {
@@ -146,7 +147,7 @@ public function update(PostStoreRequest $request, Post $post)
      * Remove the specified resource from storage.
      *
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroy(Post $post)
     {
@@ -162,7 +163,7 @@ public function destroy(Post $post)
      *
      * @param  \App\Http\Requests\ImageRequest   $request
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function updateImage(ImageRequest $request, Post $post)
     {
@@ -179,7 +180,7 @@ public function updateImage(ImageRequest $request, Post $post)
      * Remove the thumbnail from storage.
      *
      * @param  \App\Models\Post  $post
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroyImage(Post $post)
     {
@@ -219,7 +220,7 @@ private function getValidatedData(PostStoreRequest $request): array
      * @param  \App\Models\Post  $post
      * @return void
      */
-    private function saveCategories(PostStoreRequest $request, Post $post)
+    private function saveCategories(PostStoreRequest $request, Post $post): void
     {
         DB::table('posts_of_categories')->where('post_id', '=', $post->id)->delete();
         if (!empty($request->categories)){

diff --git a/app/Http/Controllers/Admin/UserPanelController.php b/app/Http/Controllers/Admin/UserPanelController.php
@@ -17,10 +17,17 @@
 use Illuminate\Support\Facades\Hash;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Validation\Rule;
+use Illuminate\View\View;
 
 class UserPanelController extends Controller
 {
-    public function index()
+    /**
+     * Handle the user panel view
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @return \Illuminate\View\View
+     */
+    public function index(): View
     {
         return view('admin.user-panel.index')->with([
             'user' => auth()->user(),
@@ -32,7 +39,7 @@ public function index()
      * Update the specified resource in storage.
      *
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function update(Request $request)
     {
@@ -60,7 +67,6 @@ public function update(Request $request)
 
         DB::beginTransaction();
         try {
-
             $user->update([
                 'email' => $request->email,
                 'name' => $request->name,
@@ -93,7 +99,7 @@ public function update(Request $request)
      * Update the password resource in storage.
      *
      * @param  \App\Http\Requests\UserPasswordRequest  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function updatePassword(UserPasswordRequest $request)
     {
@@ -108,7 +114,7 @@ public function updatePassword(UserPasswordRequest $request)
      * Changes the thumbnail in storage.
      *
      * @param  \App\Http\Requests\ImageRequest   $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function updateImage(ImageRequest $request)
     {
@@ -122,7 +128,7 @@ public function updateImage(ImageRequest $request)
     /**
      * Remove the thumbnail from storage.
      *
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\RedirectResponse
      */
     public function destroyImage()
     {