Merge pull request #456 from thephpleague/coding-standard

Coding style

Author: ADmad

.github/workflows/test.yaml

@@ -27,7 +27,7 @@ jobs:
           coverage: pcov
 
       - name: Composer install
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@v4
         with:
           dependency-versions: ${{ matrix.dependencies }}
 
@@ -41,7 +41,7 @@ jobs:
 
       - name: Code Coverage Report
         if: matrix.php-version == '8.3'
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v7
 
   coding-style:
     runs-on: ubuntu-22.04
@@ -54,7 +54,7 @@ jobs:
           extensions: gd, imagick
 
       - name: Composer install
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@v4
 
       - name: php-cs-fixer
         run: |
@@ -71,7 +71,7 @@ jobs:
           extensions: gd, imagick
 
       - name: Composer install
-        uses: ramsey/composer-install@v3
+        uses: ramsey/composer-install@v4
 
       - name: phpstan
         if: always()

.php-cs-fixer.dist.php

@@ -1,22 +1,18 @@
 <?php
 
-$finder = (new PhpCsFixer\Finder())
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$finder = (new Finder())
     ->in('scripts')
     ->in('src')
-    ->in('tests')
-;
+    ->in('tests');
 
-return (new PhpCsFixer\Config())
+return (new Config())
     ->setRules([
-        '@Symfony' => true,
-        'declare_strict_types' => true,
-        'phpdoc_annotation_without_dot' => false,
-        'nullable_type_declaration_for_default_null_value' => [
-            'use_nullable_type_declaration' => true,
-        ],
-        'phpdoc_to_comment' => [
-            'ignored_tags' => ['psalm-suppress', 'phpstan-ignore-line', 'phpstan-ignore-next-line'],
-        ],
+        '@PER-CS3.0' => true,
+        'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
     ])
-    ->setFinder($finder)
-;
+    ->setFinder($finder);

CONTRIBUTING.md

@@ -6,7 +6,7 @@ We accept contributions via Pull Requests on [Github](https://github.com/thephpl
 
 ## Pull Requests
 
-- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
+- **[PER Coding Style 3.0](https://www.php-fig.org/per/coding-style/)** - The easiest way to apply the conventions is to run `./vendor/bin/php-cs-fixer fix --allow-risky=yes`.
 - **Add tests!** - Your patch won't be accepted if it doesn't have tests.
 - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
 - **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

composer.json

@@ -34,7 +34,7 @@
     "require-dev": {
         "mockery/mockery": "^1.6",
         "phpunit/phpunit": "^12.5 || ^13.0",
-        "friendsofphp/php-cs-fixer": "^3.48",
+        "friendsofphp/php-cs-fixer": "^3.95",
         "phpstan/phpstan": "^2.2"
     },
     "autoload": {

phpstan.neon

@@ -1,7 +1,5 @@
 parameters:
 	level: 8
+	treatPhpDocTypesAsCertain: false
 	paths:
 		- src/
-	ignoreErrors:
-		-
-			identifier: missingType.iterableValue

scripts/generate-image.php

@@ -22,7 +22,7 @@
 
 use League\Glide\ServerFactory;
 
-require __DIR__.'/../vendor/autoload.php';
+require __DIR__ . '/../vendor/autoload.php';
 
 /**
  * Translate legacy v0.3 Glide params to current equivalents.
@@ -40,10 +40,10 @@ function translateLegacyParams(array $params): array
 
     // fit=crop & crop=left → fit=crop-left
     if (isset($params['fit'], $params['crop'])
-        && 'crop' === $params['fit']
+        && $params['fit'] === 'crop'
         && !preg_match('/^\d/', $params['crop'])
     ) {
-        $params['fit'] = 'crop-'.$params['crop'];
+        $params['fit'] = 'crop-' . $params['crop'];
         unset($params['crop']);
     }
 
@@ -70,7 +70,7 @@ function buildOutputFilename(string $sourceImage, array $params): string
     }
 
     if (empty($params)) {
-        return $base.'.'.$ext;
+        return $base . '.' . $ext;
     }
 
     ksort($params);
@@ -85,10 +85,10 @@ function buildOutputFilename(string $sourceImage, array $params): string
         // Negative values → 'neg' (e.g. bri=-25 → bri-neg25)
         $safeValue = str_replace('-', 'neg', $safeValue);
 
-        $parts[] = $key.'-'.$safeValue;
+        $parts[] = $key . '-' . $safeValue;
     }
 
-    return $base.'-'.implode('_', $parts).'.'.$ext;
+    return $base . '-' . implode('_', $parts) . '.' . $ext;
 }
 
 /**
@@ -114,14 +114,14 @@ function generateImage(string $input, string $sourceDir, string $outputDir): str
     $params = translateLegacyParams($params);
 
     // Resolve source file
-    $sourcePath = $sourceDir.'/'.$sourceImage;
+    $sourcePath = $sourceDir . '/' . $sourceImage;
     if (!file_exists($sourcePath)) {
         throw new RuntimeException("Source image not found: {$sourcePath}");
     }
 
     // Build output filename
     $outputFilename = buildOutputFilename($sourceImage, $params);
-    $outputPath = $outputDir.'/'.$outputFilename;
+    $outputPath = $outputDir . '/' . $outputFilename;
 
     // Skip if already generated
     if (file_exists($outputPath)) {
@@ -153,8 +153,8 @@ function generateImage(string $input, string $sourceDir, string $outputDir): str
     exit(1);
 }
 
-$sourceDir = __DIR__.'/../docs/source-images';
-$outputDir = __DIR__.'/../docs/images';
+$sourceDir = __DIR__ . '/../docs/source-images';
+$outputDir = __DIR__ . '/../docs/images';
 
 try {
     $filename = generateImage($argv[1], $sourceDir, $outputDir);

src/Api/Api.php

@@ -25,7 +25,7 @@ class Api implements ApiInterface
     /**
      * Collection of manipulators.
      *
-     * @var ManipulatorInterface[]
+     * @var array<ManipulatorInterface>
      */
     protected array $manipulators;
 
@@ -45,8 +45,8 @@ class Api implements ApiInterface
      * Create API instance.
      *
      * @param ImageManagerInterface $imageManager Intervention image manager.
-     * @param array                 $manipulators Collection of manipulators.
-     * @param Encoder|null          $encoder      Image encoder.
+     * @param array<ManipulatorInterface> $manipulators Collection of manipulators.
+     * @param Encoder|null           $encoder      Image encoder.
      */
     public function __construct(ImageManagerInterface $imageManager, array $manipulators, ?Encoder $encoder = null)
     {
@@ -79,7 +79,7 @@ public function getImageManager(): ImageManagerInterface
     /**
      * Set the manipulators.
      *
-     * @param array $manipulators Collection of manipulators.
+     * @param array<ManipulatorInterface> $manipulators Collection of manipulators.
      */
     public function setManipulators(array $manipulators): void
     {
@@ -95,7 +95,7 @@ public function setManipulators(array $manipulators): void
     /**
      * Get the manipulators.
      *
-     * @return array Collection of manipulators.
+     * @return array<ManipulatorInterface> Collection of manipulators.
      */
     public function getManipulators(): array
     {
@@ -125,8 +125,8 @@ public function getEncoder(): Encoder
     /**
      * Perform image manipulations.
      *
-     * @param string $source Source image binary data.
-     * @param array  $params The manipulation params.
+     * @param string                $source Source image binary data.
+     * @param array<string, mixed>  $params The manipulation params.
      *
      * @return string Manipulated image binary data.
      */
@@ -145,8 +145,8 @@ public function run(string $source, array $params): string
     /**
      * Perform image encoding to a given format.
      *
-     * @param ImageInterface $image  Image object
-     * @param array          $params the manipulator params
+     * @param ImageInterface        $image  Image object
+     * @param array<string, mixed>  $params the manipulator params
      *
      * @return string Manipulated image binary data
      */

src/Api/ApiInterface.php

@@ -9,8 +9,8 @@ interface ApiInterface
     /**
      * Perform image manipulations.
      *
-     * @param string $source Source image binary data.
-     * @param array  $params The manipulation params.
+     * @param string               $source Source image binary data.
+     * @param array<string, mixed> $params The manipulation params.
      *
      * @return string Manipulated image binary data.
      */

src/Api/Encoder.php

@@ -15,13 +15,15 @@ class Encoder
 {
     /**
      * The manipulation params.
+     *
+     * @var array<string, mixed>
      */
     protected array $params;
 
     /**
      * Class constructor.
      *
-     * @param array $params the manipulator params
+     * @param array<string, mixed> $params the manipulator params
      */
     public function __construct(array $params = [])
     {
@@ -31,7 +33,7 @@ public function __construct(array $params = [])
     /**
      * Set the manipulation params.
      *
-     * @param array $params The manipulation params.
+     * @param array<string, mixed> $params The manipulation params.
      *
      * @return $this
      */
@@ -65,7 +67,7 @@ public function run(ImageInterface $image): EncodedImageInterface
         $quality = $this->getQuality();
         $shouldInterlace = filter_var($this->getParam('interlace'), FILTER_VALIDATE_BOOLEAN);
 
-        if ('pjpg' === $format) {
+        if ($format === 'pjpg') {
             $shouldInterlace = true;
             $format = 'jpg';
         }
@@ -112,7 +114,7 @@ public function getFormat(ImageInterface $image): string
         }
 
         $mediaType = MediaType::tryFrom($image->origin()->mediaType());
-        if (null === $mediaType) {
+        if ($mediaType === null) {
             return 'jpg';
         }
 

src/Filesystem/FileNotFoundException.php

@@ -4,6 +4,4 @@
 
 namespace League\Glide\Filesystem;
 
-class FileNotFoundException extends \Exception
-{
-}
+class FileNotFoundException extends \Exception {}