Merge pull request #62 from m4n1ok/typings-update

Typings updates
area17 · Sep 13, 2024 · 7075d45 · 7075d45
2 parents fd18822 + 20301b7
commit 7075d45
Show file tree

Hide file tree

Showing 11 changed files with 148 additions and 81 deletions.
diff --git a/composer.json b/composer.json
@@ -37,6 +37,13 @@
     }
   },
   "require-dev": {
-    "friendsofphp/php-cs-fixer": "^3.0"
+    "friendsofphp/php-cs-fixer": "^3.0",
+    "larastan/larastan": "^2.0",
+    "phpstan/phpstan": "^1.12"
+  },
+  "scripts": {
+    "lint": [
+      "vendor/bin/phpstan analyse -c phpstan.neon src"
+    ]
   }
 }
diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,9 @@
+parameters:
+    level: 5
+
+    paths:
+        - src
+
+    universalObjectCratesClasses:
+
+    reportUnmatchedIgnoredErrors: false
diff --git a/src/Facades/TwillImage.php b/src/Facades/TwillImage.php
@@ -6,7 +6,7 @@
 
 class TwillImage extends Facade
 {
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'twill.image';
     }

diff --git a/src/Http/Controllers/GlideController.php b/src/Http/Controllers/GlideController.php
@@ -7,7 +7,7 @@
 
 class GlideController
 {
-    public function __invoke($path, Application $app)
+    public function __invoke(string $path, Application $app)
     {
         return $app->make(Glide::class)->render($path);
     }

diff --git a/src/Models/Image.php b/src/Models/Image.php
@@ -7,9 +7,12 @@
 use A17\Twill\Image\Facades\TwillImage;
 use A17\Twill\Image\Services\MediaSource;
 use A17\Twill\Image\Services\ImageColumns;
+use A17\Twill\Services\MediaLibrary\ImageService;
+use Illuminate\Config\Repository;
 use Illuminate\Contracts\Support\Arrayable;
 use A17\Twill\Image\Exceptions\ImageException;
 use A17\Twill\Services\MediaLibrary\ImageServiceInterface;
+use Illuminate\Foundation\Application;
 
 class Image implements Arrayable
 {
@@ -59,16 +62,28 @@ class Image implements Arrayable
     protected $srcSetWidths = [];
 
     /**
-     * @var string|ImageServiceInterface ImageService instance or class name
+     * ImageService instance or class name
+     *
+     * @var string|ImageServiceInterface
      */
     protected $service;
 
+    /**
+     * @var ImageColumns|mixed
+     */
+    private $columnsService;
+
+    /**
+     * @var MediaSource|mixed
+     */
+    private $mediaSourceService;
+
     /**
      * @param object|Model $object
      * @param string $role
      * @param null|Media $media
      */
-    public function __construct($object, $role, $media = null)
+    public function __construct($object, string $role, ?Media $media = null)
     {
         $this->object = $object;
 
@@ -85,26 +100,26 @@ public function __construct($object, $role, $media = null)
 
     /**
      * @return MediaSource
+     * @throws ImageException
      */
-    private function mediaSourceService()
+    private function mediaSourceService(): MediaSource
     {
-        return isset($this->mediaSourceService)
-            ? $this->mediaSourceService
-            : $this->mediaSourceService = new MediaSource(
-                $this->object,
-                $this->role,
-                $this->media,
-                $this->service,
-            );
+        return $this->mediaSourceService ?? $this->mediaSourceService = new MediaSource(
+            $this->object,
+            $this->role,
+            $this->media,
+            $this->service
+        );
     }
 
     /**
      * Pick a preset from the configuration file or pass an array with the image configuration
      *
      * @param array|string $preset
      * @return $this
+     * @throws ImageException
      */
-    public function preset($preset)
+    public function preset($preset): Image
     {
         if (is_array($preset)) {
             $this->applyPreset($preset);
@@ -139,9 +154,8 @@ protected function mediaQueryColumns($args)
      * Set the list of srcset width to generate
      *
      * @param int[] $widths
-     * @return $this
      */
-    public function srcSetWidths($widths)
+    public function srcSetWidths(array $widths)
     {
         $this->srcSetWidths = $widths;
     }
@@ -152,7 +166,7 @@ public function srcSetWidths($widths)
      * @param string $crop
      * @return $this
      */
-    public function crop($crop)
+    public function crop($crop): Image
     {
         $this->crop = $crop;
 
@@ -165,7 +179,7 @@ public function crop($crop)
      * @param int $width
      * @return $this
      */
-    public function width($width)
+    public function width(int $width): Image
     {
         $this->width = $width;
 
@@ -178,7 +192,7 @@ public function width($width)
      * @param int $height
      * @return $this
      */
-    public function height($height)
+    public function height(int $height): Image
     {
         $this->height = $height;
 
@@ -191,7 +205,7 @@ public function height($height)
      * @param string $sizes
      * @return $this
      */
-    public function sizes($sizes)
+    public function sizes(string $sizes): Image
     {
         $this->sizes = $sizes;
 
@@ -204,7 +218,7 @@ public function sizes($sizes)
      * @param array $sources
      * @return $this
      */
-    public function sources($sources = [])
+    public function sources(array $sources = []): Image
     {
         $this->sources = $sources;
 
@@ -215,10 +229,10 @@ public function sources($sources = [])
      * Set the ImageService to use instead of the one provided
      * by the service container
      *
-     * @param array $service
+     * @param string|ImageServiceInterface $service
      * @return $this
      */
-    public function service($service)
+    public function service($service): Image
     {
         $this->service = $service;
 
@@ -228,14 +242,13 @@ public function service($service)
     /**
      * Set alternative sources for the media.
      *
-     * @param array $sources
-     * @return $this
+     * @throws ImageException
      */
-    public function generateSources()
+    public function generateSources(): array
     {
         $sources = [];
 
-        foreach ($this->sources ?? [] as $source) {
+        foreach ($this->sources as $source) {
             if (!isset($source['media_query']) && !isset($source['mediaQuery']) && !isset($source['columns'])) {
                 throw new ImageException("Media query is mandatory in sources.");
             }
@@ -252,7 +265,7 @@ public function generateSources()
                     $source['crop'],
                     $source['width'] ?? null,
                     $source['height'] ?? null,
-                    $source['srcSetWidths'] ?? [],
+                    $source['srcSetWidths'] ?? []
                 )->toArray()
             ];
         }
@@ -267,10 +280,14 @@ public function generateSources()
      */
     public function render($overrides = [])
     {
+        /* @phpstan-ignore-next-line */
         return TwillImage::render($this, $overrides);
     }
 
-    public function toArray()
+    /**
+     * @throws ImageException
+     */
+    public function toArray(): array
     {
         $arr = [
             "image" => $this->mediaSourceService()->generate(

diff --git a/src/Models/StaticImage.php b/src/Models/StaticImage.php
@@ -3,7 +3,7 @@
 namespace A17\Twill\Image\Models;
 
 use A17\Twill\Models\Model;
-use A17\Twill\Image\Models\Image;
+use A17\Twill\Image\Models\Image as TwillImageModel;
 use A17\Twill\Models\Behaviors\HasMedias;
 use A17\Twill\Image\Exceptions\ImageException;
 
@@ -13,12 +13,14 @@ class StaticImage extends Model
 
     protected $fillable = [];
 
-    public $mediasParams = [];
-
     public static $role = 'static-image';
 
-    public static function makeFromSrc($args)
+    /**
+     * @throws ImageException
+     */
+    public static function makeFromSrc($args): TwillImageModel
     {
+        /* @phpstan-ignore-next-line */
         $model = self::make();
 
         $role = self::$role;
@@ -39,7 +41,8 @@ public static function makeFromSrc($args)
             'alt' => $args['alt'] ?? null,
         ]);
 
-        if (!empty($preset['sources']) && $sources = $preset['sources']) {
+        if (!empty($preset['sources'])) {
+            $sources = $preset['sources'] ?? [];
             foreach ($sources as $source) {
                 $model->makeMedia([
                     'src' => self::getFile($files, $source['crop']),
@@ -114,6 +117,7 @@ public function makeMedia($args)
 
         $cropData = $this->calcCrop($width, $height, $ratio);
 
+        /* @phpstan-ignore-next-line */
         $media = \A17\Twill\Models\Media::make([
             'uuid' => $uuid,
             'filename' => basename($uuid),
@@ -131,15 +135,16 @@ public function makeMedia($args)
             $this,
             $data,
             config('twill.mediables_table', 'twill_mediables'),
-            true,
+            true
         );
 
         $media->setRelation('pivot', $pivot);
 
+        /* @phpstan-ignore-next-line */
         $this->medias->add($media);
     }
 
-    private function getInputSize($uuid)
+    private function getInputSize($uuid): array
     {
         $file_path = implode('/', [
             rtrim(config('twill-image.static_local_path'), '/'),

diff --git a/src/Services/ImageStyles.php b/src/Services/ImageStyles.php
@@ -23,21 +23,21 @@ class ImageStyles
      * Set up the service to generate view inline styles for the wrapper, main image and placeholder elements
      *
      * @param array $styles
-     * @param array $classes
+     * @param string $classes
      * @return void
      */
-    public function setup($styles = [], $classes = '')
+    public function setup(array $styles = [], string $classes = '')
     {
         $this->mode = config('twill-image.mode');
         $this->setBaseStyling($styles, $classes);
     }
 
     /**
-     * Return inline stylesand classes for the wrapper element
+     * Return inline styles and classes for the wrapper element
      *
      * @return array
      */
-    public function wrapper()
+    public function wrapper(): array
     {
         $styles = $this->inlineStyles['wrapper'] ?? [];
         $classes = $this->classes['wrapper'] ?? [];
@@ -46,11 +46,11 @@ public function wrapper()
     }
 
     /**
-     * Return inline stylesand classes for the placeholder element
+     * Return inline styles and classes for the placeholder element
      *
      * @return array
      */
-    public function placeholder()
+    public function placeholder(): array
     {
         $styles = array_merge(
             $this->inlineStyles['main'] ?? [],