Apply fixes from StyleCI

src/Controllers/Admin/ManagePostsController.php

@@ -73,9 +73,9 @@ public function create_post()
     /**
      * Save a new post.
      *
-     * @throws Exception
-     *
      * @return RedirectResponse|Redirector
+     *
+     * @throws Exception
      */
     public function store(CreateBlogEtcPostRequest $request)
     {
@@ -96,7 +96,6 @@ public function store_post(CreateBlogEtcPostRequest $request)
      * Show form to edit post.
      *
      * @param $blogPostId
-     *
      * @return mixed
      */
     public function edit($blogPostId)
@@ -120,10 +119,9 @@ public function edit_post($blogPostId)
      * This uses some legacy code. This will get refactored soon into something nicer.
      *
      * @param $blogPostId
+     * @return RedirectResponse|Redirector
      *
      * @throws Exception
-     *
-     * @return RedirectResponse|Redirector
      */
     public function update(UpdateBlogEtcPostRequest $request, $blogPostId)
     {
@@ -144,7 +142,6 @@ public function update_post(UpdateBlogEtcPostRequest $request, $blogPostId)
      * Delete a post.
      *
      * @param $blogPostId
-     *
      * @return mixed
      */
     public function destroy(DeleteBlogEtcPostRequest $request, $blogPostId)

src/Controllers/BlogEtcAdminController.php

@@ -6,6 +6,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use ManagePostsController
  */
 class BlogEtcAdminController extends ManagePostsController

src/Controllers/BlogEtcCategoryAdminController.php

@@ -6,6 +6,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use ManageCategoriesController
  */
 class BlogEtcCategoryAdminController extends ManageCategoriesController

src/Controllers/BlogEtcCommentWriterController.php

@@ -4,6 +4,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use CommentsController instead
  */
 class BlogEtcCommentWriterController extends CommentsController

src/Controllers/BlogEtcCommentsAdminController.php

@@ -6,6 +6,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use ManageCommentsController
  */
 class BlogEtcCommentsAdminController extends ManageCommentsController

src/Controllers/BlogEtcImageUploadController.php

@@ -6,6 +6,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use ManageUploadsController
  */
 class BlogEtcImageUploadController extends ManageUploadsController

src/Controllers/BlogEtcReaderController.php

@@ -4,6 +4,7 @@
 
 /**
  * For backwards compatibility only.
+ *
  * @deprecated - use PostsController instead
  */
 class BlogEtcReaderController extends PostsController

src/Controllers/BlogEtcRssFeedController.php

@@ -4,6 +4,7 @@
 
 /**
  * Legacy class for backwards compatibility.
+ *
  * @deprecated - use FeedController instead
  */
 class BlogEtcRssFeedController extends FeedController

src/Controllers/FeedController.php

@@ -65,7 +65,6 @@ protected function makeFreshFeed(Feed $feed)
 
     /**
      * @param $posts
-     *
      * @return mixed
      */
     protected function setupFeed(Feed $feed, $posts)

src/Controllers/PostsController.php

@@ -52,7 +52,8 @@ public function search(SearchRequest $request): \Illuminate\Contracts\View\View
 
         // Map it so the post is actually accessible with ->indexable, for backwards compatibility in old view files.
         $searchResultsMappedWithIndexable = $searchResults->map(function (Post $post) {
-            return new class($post) {
+            return new class($post)
+            {
                 public $indexable;
 
                 public function __construct(Post $post)
@@ -89,8 +90,7 @@ public function showCategory($categorySlug): \Illuminate\Contracts\View\View
      * Show blog posts
      * If $categorySlug is set, then only show from that category.
      *
-     * @param string $categorySlug
-     *
+     * @param  string  $categorySlug
      * @return mixed
      */
     public function index(string $categorySlug = null)

src/Events/UploadedImage.php

@@ -26,7 +26,7 @@ class UploadedImage
      * UploadedImage constructor.
      *
      * @param $image_filename - the new filename
-     * @param Post $blogEtcPost
+     * @param  Post  $blogEtcPost
      * @param $image
      * @param $source string|null  the __METHOD__  firing this event (or other string)
      */

src/Interfaces/LegacyGetImageFileInterface.php

@@ -6,6 +6,7 @@ interface LegacyGetImageFileInterface
 {
     /**
      * legacy.
+     *
      * @param $size
      * @return mixed
      */

src/Models/BlogEtcCategory.php

@@ -4,6 +4,7 @@
 
 /**
  * Legacy class for backwards compatibility.
+ *
  * @deprecated
  */
 class BlogEtcCategory extends Category

src/Models/BlogEtcComment.php

@@ -4,6 +4,7 @@
 
 /**
  * Legacy class for backwards compatibility.
+ *
  * @deprecated
  */
 class BlogEtcComment extends Comment

src/Models/BlogEtcPost.php

@@ -4,6 +4,7 @@
 
 /**
  * Legacy class name for backwards compatibility.
+ *
  * @deprecated
  */
 class BlogEtcPost extends Post

src/Models/BlogEtcUploadedPhoto.php

@@ -4,6 +4,7 @@
 
 /**
  * legacy class for backwards compatibility.
+ *
  * @deprecated
  */
 class BlogEtcUploadedPhoto extends UploadedPhoto

src/Models/Post.php

@@ -160,7 +160,7 @@ public function genSeoTitle(): ?string
     }
 
     /**
-     * @param mixed ...$args
+     * @param  mixed  ...$args
      *
      * @deprecated - use imageTag() instead
      */
@@ -177,10 +177,10 @@ public function image_tag($size = 'medium',
      *
      * TODO - return HtmlString
      *
-     * @param string $size - large, medium, thumbnail
-     * @param bool $addAHref - if true then it will add <a href=''>...</a> around the <img> tag
-     * @param string|null $imgTagClass - if you want any additional CSS classes for this tag for the <IMG>
-     * @param string|null $anchorTagClass - is you want any additional CSS classes in the <a> anchor tag
+     * @param  string  $size  - large, medium, thumbnail
+     * @param  bool  $addAHref  - if true then it will add <a href=''>...</a> around the <img> tag
+     * @param  string|null  $imgTagClass  - if you want any additional CSS classes for this tag for the <IMG>
+     * @param  string|null  $anchorTagClass  - is you want any additional CSS classes in the <a> anchor tag
      */
     public function imageTag(
         $size = 'medium',
@@ -205,7 +205,7 @@ public function imageTag(
      * Returns true if the database record indicates that this blog post
      * has a featured image of size $size.
      *
-     * @param string $size
+     * @param  string  $size
      */
     public function hasImage($size = 'medium'): bool
     {
@@ -233,7 +233,7 @@ protected function checkValidImageSize(string $size = 'medium'): bool
      * Get the full URL for an image
      * You should use ::has_image($size) to check if the size is valid.
      *
-     * @param string $size - should be 'medium' , 'large' or 'thumbnail'
+     * @param  string  $size  - should be 'medium' , 'large' or 'thumbnail'
      */
     public function imageUrl($size = 'medium'): string
     {

src/Repositories/PostsRepository.php

@@ -31,7 +31,7 @@ public function __construct(Post $model)
     /**
      * Return blog posts ordered by posted_at, paginated.
      *
-     * @param int $categoryID
+     * @param  int  $categoryID
      */
     public function indexPaginated(int $perPage = 10, int $categoryID = null): LengthAwarePaginator
     {
@@ -147,7 +147,7 @@ public function find(int $blogEtcPostID): Post
      *
      * TODO - currently untested.
      *
-     * @param array $uploadedImages
+     * @param  array  $uploadedImages
      */
     public function updateImageSizes(Post $post, ?array $uploadedImages): Post
     {

src/Requests/Traits/HasImageUploadTrait.php

@@ -8,7 +8,6 @@ trait HasImageUploadTrait
 {
     /**
      * @param $size
-     *
      * @return UploadedFile|null
      */
     public function get_image_file($size)

src/Services/PostsService.php

@@ -83,7 +83,7 @@ public function repository(): PostsRepository
     /**
      * Return all results, paginated.
      *
-     * @param int $perPage
+     * @param  int  $perPage
      */
     public function indexPaginated($perPage = 10, int $categoryID = null): LengthAwarePaginator
     {
@@ -133,9 +133,9 @@ public function update(/** @scrutinizer ignore-unused */ int $blogPostID, /*Post
      * Delete a blog etc post, return the deleted post and an array of featured images which were associated
      * to the blog post (but which were not deleted form the filesystem).
      *
-     * @throws Exception
-     *
      * @return array - [Post (deleted post), array (remaining featured photos)
+     *
+     * @throws Exception
      */
     public function delete(int $postID): array
     {

src/Services/UploadsService.php

@@ -98,10 +98,10 @@ public function legacyUpdatePost(UpdateBlogEtcPostRequest $request, $blogPostId)
      *
      * Process any uploaded images (for featured image).
      *
-     * @throws Exception
-     *
      * @return array returns an array of details about each file resized
      *
+     * @throws Exception
+     *
      * @todo - This class was added after the other main features, so this duplicates some code from the main blog post admin controller (BlogEtcAdminController). For next full release this should be tided up.
      */
     public function legacyProcessUploadedImagesSingle(UploadImageRequest $request)
@@ -177,14 +177,13 @@ public function legacyProcessUploadedImages(LegacyGetImageFileInterface $request
     }
 
     /**
-     * @param Post $new_blog_post
+     * @param  Post  $new_blog_post
      * @param $suggested_title string - used to help generate the filename
      * @param $image_size_details mixed - either an array (with 'w' and 'h') or a string (and it'll be uploaded at full size, no size reduction, but will use this string to generate the filename)
      * @param $photo
+     * @return array
      *
      * @throws Exception
-     *
-     * @return array
      */
     protected function legacyUploadAndResize(Post $new_blog_post = null, $suggested_title, $image_size_details, $photo)
     {
@@ -223,9 +222,9 @@ protected function legacyUploadAndResize(Post $new_blog_post = null, $suggested_
     }
 
     /**
-     * @throws RuntimeException
-     *
      * @return string
+     *
+     * @throws RuntimeException
      */
     public function image_destination_path()
     {
@@ -258,10 +257,9 @@ protected function check_image_destination_path_is_writable($path)
      * Todo: support multiple filesystem locations.
      *
      * @param $image_size_details - either an array (with w/h attributes) or a string
+     * @return string
      *
      * @throws RuntimeException
-     *
-     * @return string
      */
     public function legacyGetImageFilename(string $suggested_title, $image_size_details, UploadedFile $photo)
     {
@@ -381,10 +379,10 @@ public function increaseMemoryLimit(): void
     /**
      * Resize and store an image.
      *
-     * @param Post $new_blog_post
+     * @param  Post  $new_blog_post
      * @param $suggested_title - used to help generate the filename
-     * @param array|string $imageSizeDetails - either an array (with 'w' and 'h') or a string (and it'll be uploaded at full size,
-     *                                       no size reduction, but will use this string to generate the filename)
+     * @param  array|string  $imageSizeDetails  - either an array (with 'w' and 'h') or a string (and it'll be uploaded at full size,
+     *                                          no size reduction, but will use this string to generate the filename)
      * @param $photo
      *
      * @throws Exception
@@ -491,7 +489,7 @@ protected function baseFilename(string $suggestedTitle): string
      * If a string is given:
      * getWhForFilename("some string") it will return -some-string". (max len: 30)
      *
-     * @param array|string $imageSize
+     * @param  array|string  $imageSize
      *
      * @throws RuntimeException
      */
@@ -606,7 +604,6 @@ protected function storeInDatabase(
      * Legacy function, will be refactored soon.
      *
      * @param $blogPostId
-     *
      * @return mixed
      */
     public function legacyDestroyPost(/* @scrutinizer ignore-unused */ DeleteBlogEtcPostRequest $request, $blogPostId)

tests/TestCase.php

@@ -102,8 +102,7 @@ protected function mockView(string $expectedView, array $viewArgumentTypes): voi
         /**
          * Used for Orchestra\Testbench package.
          *
-         * @param Application $app
-         *
+         * @param  Application  $app
          * @return array
          */
         protected function getPackageProviders($app)
@@ -181,8 +180,7 @@ protected function loadMigrations(): void
         /**
          * Define environment setup.
          *
-         * @param Application $app
-         *
+         * @param  Application  $app
          * @return void
          */
         protected function getEnvironmentSetUp($app)