nystudio107\imageoptimize\imagetransforms\ThumborImageTransform

Complexity

Total Complexity

21

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getTransformUrl()	0	3	1
A	purgeUrl()	0	3	1
A	getQuality()	0	3	1
A	getTransformParams()	0	9	1
A	getWebPUrl()	0	6	1
A	getFormat()	0	9	2
A	getFocalPoint()	0	23	2
C	getUrlBuilderForTransform()	0	64	12

<?php
/**
 * ImageOptimize plugin for Craft CMS 3.x
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\imageoptimize\imagetransforms;

use nystudio107\imageoptimize\ImageOptimize;

use craft\elements\Asset;
use craft\helpers\ArrayHelper;
use craft\helpers\UrlHelper;
use craft\models\AssetTransform;
use Thumbor\Url\Builder as UrlBuilder;
use Psr\Http\Message\ResponseInterface;

use Craft;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value indented incorrectly; expected 2 spaces but found 4

 * @package   ImageOptimize

Tag value indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class ThumborImageTransform extends ImageTransform implements ImageTransformInterface
{
    // Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @param Asset               $asset

Missing parameter comment

     * @param AssetTransform|null $transform

Missing parameter comment

     * @param array               $params

Missing parameter comment

     *
     * @return string|null
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    public static function getTransformUrl(Asset $asset, $transform, array $params = [])
    {
        return (string) self::getUrlBuilderForTransform($asset, $transform, $params);
    }

    /**

Missing short description in doc comment

Parameter $asset should have a doc-comment as per coding-style.

Parameter $transform should have a doc-comment as per coding-style.

Parameter $params should have a doc-comment as per coding-style.

     * @param string $url

Missing parameter comment

     *
     * @return string
     */
     public static function getWebPUrl(string $url, Asset $asset, $transform, array $params = []): string

Line indented incorrectly; expected 4 spaces, found 5

    {

Opening brace indented incorrectly; expected 5 spaces, found 4

        $builder = self::getUrlBuilderForTransform($asset, $transform, $params)
            ->addFilter('format', 'webp');

        return (string) $builder;
    }

Closing brace indented incorrectly; expected 5 spaces, found 4

    /**

Missing short description in doc comment

     * @param string $url

Missing parameter comment

     * @param array  $params

Missing parameter comment

     *
     * @return bool
     */
    public static function purgeUrl(string $url, array $params = []): bool
    {
        return false;
    }

    /**

Missing short description in doc comment

     * @return array
     */
    public static function getTransformParams(): array
    {
        $settings = ImageOptimize::$plugin->getSettings();
        $params = [
            'baseUrl' => $settings->thumborBaseUrl,
            'securityKey' => $settings->thumborSecurityKey,
        ];

        return $params;
    }

    /**

Missing short description in doc comment

     * @param Asset               $asset

Missing parameter comment

     * @param AssetTransform|null $transform

Missing parameter comment

     * @param array               $params

Missing parameter comment

     *
     * @return UrlBuilder
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    private static function getUrlBuilderForTransform(Asset $asset, $transform, array $params = []): UrlBuilder

Private method name "ThumborImageTransform::getUrlBuilderForTransform" must be prefixed with an underscore

    {
        $assetUri = self::getAssetUri($asset);
        $baseUrl = $params['baseUrl'];
        $securityKey = $params['securityKey'] ?: null;
        $builder = UrlBuilder::construct($baseUrl, $securityKey, $assetUri);
        $settings = ImageOptimize::$plugin->getSettings();

        if ($transform->mode === 'fit') {

            // https://thumbor.readthedocs.io/en/latest/usage.html#fit-in
            $builder->fitIn($transform->width, $transform->height);
        } elseif ($transform->mode === 'stretch') {
            $builder

The call to Thumbor\Url\Builder::addFilter() has too few arguments starting with args.

                ->resize($transform->width, $transform->height)
                ->addFilter('upscale');

            // https://github.com/thumbor/thumbor/issues/1123
            Craft::warning('Thumbor has no equivalent to the "stretch" transform mode. The resulting image will be resized and cropped, but not stretched.', __METHOD__);
        } else {

            // https://thumbor.readthedocs.io/en/latest/usage.html#image-size
            $builder->resize($transform->width, $transform->height);

            if ($focalPoint = self::getFocalPoint($asset)) {

                // https://thumbor.readthedocs.io/en/latest/focal.html
                $builder->addFilter('focal', $focalPoint);
            } elseif (preg_match('/(top|center|bottom)-(left|center|right)/', $transform->position, $matches)) {
                $v = str_replace('center', 'middle', $matches[1]);
                $h = $matches[2];

                // https://thumbor.readthedocs.io/en/latest/usage.html#horizontal-align
                $builder->valign($v)->halign($h);
            }
        }

        // https://thumbor.readthedocs.io/en/latest/format.html
        if ($format = self::getFormat($transform)) {
            $builder->addFilter('format', $format);
        }

        // https://thumbor.readthedocs.io/en/latest/quality.html
        if ($quality = self::getQuality($transform)) {
            $builder->addFilter('quality', $quality);
        }

        if (property_exists($transform, 'interlace')) {
            Craft::warning('Thumbor enables progressive JPEGs on the server-level, not as a request option. See https://thumbor.readthedocs.io/en/latest/jpegtran.html', __METHOD__);
        }

        if ($settings->autoSharpenScaledImages) {

            // See if the image has been scaled >= 50%
            $widthScale = $asset->getWidth() / ($transform->width ?? $asset->getWidth());
            $heightScale = $asset->getHeight() / ($transform->height ?? $asset->getHeight());
            if (($widthScale >= 2.0) || ($heightScale >= 2.0)) {

                // https://thumbor.readthedocs.io/en/latest/sharpen.html
                $builder->addFilter('sharpen', .5, .5, 'true');

The call to Thumbor\Url\Builder::addFilter() has too many arguments starting with 'true'.

            }
        }

        return $builder;
    }

    /**

Missing short description in doc comment

Parameter $asset should have a doc-comment as per coding-style.

     * @return string|null
     */
    private static function getFocalPoint(Asset $asset)

Private method name "ThumborImageTransform::getFocalPoint" must be prefixed with an underscore

    {
        $focalPoint = $asset->getFocalPoint();

        if (!$focalPoint) {
            return null;
        }

        $box = array_map('intval', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            'top' => $focalPoint['y'] * $asset->height - 1,
            'left' => $focalPoint['x'] * $asset->width - 1,
            'bottom' => $focalPoint['y'] * $asset->height + 1,
            'right' => $focalPoint['x'] * $asset->width + 1,
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        return implode('', [

The opening parenthesis of a multi-line function call should be the last content on the line.

            $box['top'],
            'x',
            $box['left'],
            ':',
            $box['bottom'],
            'x',
            $box['right'],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

    }

    /**

Missing short description in doc comment

     * @param AssetTransform|null $transform

Missing parameter comment

     *
     * @return string|null
     */
    private static function getFormat($transform)

Private method name "ThumborImageTransform::getFormat" must be prefixed with an underscore

    {
        $format = str_replace(
            ['Auto', 'jpg'],
            ['', 'jpeg'],
            $transform->format
        );

        return $format ?: null;
    }

    /**

Missing short description in doc comment

     * @param AssetTransform|null $transform

Missing parameter comment

     *
     * @return int
     */
    private static function getQuality($transform)

Private method name "ThumborImageTransform::getQuality" must be prefixed with an underscore

    {
        return $transform->quality ?? Craft::$app->getConfig()->getGeneral()->defaultImageQuality;
    }
}