ThumborImageTransform::displayName() - Code Metrics - Inspection of "Add displayName()" - nystudio107/craft-imageoptimize - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( a3b096...881135 )

by Andrew
created 2018-12-24 04:05 UTC
ThumborImageTransform::displayName() A

↳ Parent: ThumborImageTransform
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * ImageOptimize plugin for Craft CMS 3.x
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

 * @copyright Copyright (c) 2017 nystudio107

 */


namespace nystudio107\imageoptimize\imagetransforms;

use nystudio107\imageoptimize\ImageOptimize;

use craft\elements\Asset;
use craft\models\AssetTransform;
use Thumbor\Url\Builder as UrlBuilder;

use Craft;

/**

 * @author    nystudio107

 * @package   ImageOptimize

 * @since     1.0.0

 */

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

    /**

     * @inheritdoc
     */

    public static function displayName(): string
    {
        return Craft::t('image-optimize', 'Thumbor');
    }

    // Public Methods
    // =========================================================================

    /**

     * @param Asset               $asset

     * @param AssetTransform|null $transform

     * @param array               $params

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

    /**

     * @param string              $url

     * @param Asset               $asset

     * @param AssetTransform|null $transform

     * @param array               $params

     *
     * @return string
     * @throws \yii\base\Exception
     * @throws \yii\base\InvalidConfigException
     */
    public function getWebPUrl(string $url, Asset $asset, $transform, array $params = []): string
    {
        $builder = $this->getUrlBuilderForTransform($asset, $transform, $params)
            ->addFilter('format', 'webp');

        return (string)$builder;
    }

    /**

     * @param string $url

     * @param array  $params

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

    /**

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

            'securityKey' => $settings->thumborSecurityKey,

        ];

        return $params;
    }

    // Private Methods
    // =========================================================================

    /**

     * @param Asset               $asset

     * @param AssetTransform|null $transform

     * @param array               $params

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

    {
        $assetUri = $this->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
                ->/** @scrutinizer ignore-call */ addFilter('upscale');
                ->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 = $this->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 = $this->getFormat($transform)) {
            $builder->addFilter('format', $format);
        }

        // https://thumbor.readthedocs.io/en/latest/quality.html
        if ($quality = $this->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');
                          addFilter('sharpen', .5, .5, 'true');
            }
        }

        return $builder;
    }

    /**

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

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

        if (!$focalPoint) {
            return null;
        }

        $box = array_map('intval', [

            'top' => $focalPoint['y'] * $asset->height - 1,
            'left' => $focalPoint['x'] * $asset->width - 1,
            'bottom' => $focalPoint['y'] * $asset->height + 1,
            'right' => $focalPoint['x'] * $asset->width + 1,
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.

        return implode('', [

            $box['left'],
            'x',
            $box['top'],
            ':',
            $box['right'],
            'x',
            $box['bottom'],
        ]);
someFunctionCall(
    $firstArgument,
    $secondArgument,
    $thirdArgument
); // Closing parenthesis on a new line.
    }

    /**

     * @param AssetTransform|null $transform

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

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

        return $format ?: null;
    }

    /**

     * @param AssetTransform|null $transform

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

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

nystudio107 / craft-imageoptimize

Push — develop ( a3b096...881135 )

ThumborImageTransform::displayName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
