PerfectCMSImages::move_to_right_folder() - Code Metrics - Inspection of "MAJOR: adding lazy loading and sizes" - sunnysideup/silverstripe-perfect_cms_images - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( a06d21...f74981 )

by Nicolaas
created 2022-10-01 07:42 UTC
PerfectCMSImages::move_to_right_folder() A

↳ Parent: PerfectCMSImages
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
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	3
rs	10
<?php

namespace Sunnysideup\PerfectCmsImages\Api;

use Psr\Log\LoggerInterface;
use SilverStripe\Assets\Filesystem;
use SilverStripe\Assets\Folder;
use SilverStripe\Assets\Image;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Flushable;
use SilverStripe\Core\Injector\Injector;
use Sunnysideup\PerfectCmsImages\Forms\PerfectCmsImagesUploadField;
use Sunnysideup\PerfectCmsImages\Model\File\PerfectCmsImageDataExtension;

class PerfectCMSImages implements Flushable
{
    /**
     *.htaccess content for assets ...
     *
     * @var string
     */
    private static $htaccess_content = <<<'EOT'
<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteBase /

    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.+)\.(v[A-Za-z0-9]+)\.(js|css|png|jpg|gif|svg|webp)$ $1.$3 [L]
</IfModule>

EOT;

    /**
     * background image for padded images...
     *
     * @var string
     */
    private static $perfect_cms_images_background_padding_color = '#cccccc';

    /**
     * used to set the max width of the media value for mobile images,
     * eg <source srcset="small.jpg, small2x.jpg 2x" media="(max-width: 600px)">.
     *
     * @var string
     */
    private static $mobile_media_max_width = '600px';

    /*
     * details of the images
     *     - width: 3200
     *     - height: 3200
     *     - folder: "myfolder"
     *     - filetype: "try jpg"
     *     - enforce_size: false
     *     - folder: my-image-folder-a
     *     - filetype: "jpg or a png with a transparant background"
     *     - use_retina: true
     *     - padding_bg_colour: '#dddddd'
     *     - crop: true
     *
     * @var array
     */
    private static $perfect_cms_images_image_definitions = [];

    /*
     * Images Titles will be appended to the links only
     * if the ClassName of the Image is in this array
     * @var array
     *
     */
    private static $perfect_cms_images_append_title_to_image_links_classes = [
        Image::class,
    ];

    private static $retina_multiplier = 2;

    /**
     * force resample, put htaccess content if it does not exists.
     */
    public static function flush()
    {
        if (! Config::inst()->get(Image::class, 'force_resample')) {
            Config::modify()->update(Image::class, 'force_resample', true);
        }

        if (class_exists('HashPathExtension')) {
            if (! file_exists(ASSETS_PATH)) {
                Filesystem::makeFolder(ASSETS_PATH);
            }

            $fileName = ASSETS_PATH . '/.htaccess';
            if (! file_exists($fileName)) {
                $string = Config::inst()->get(PerfectCMSImages::class, 'htaccess_content');
                file_put_contents($fileName, $string);
            }
        }
    }

    public static function get_description_for_cms(string $name): string
    {
        $widthRecommendation = PerfectCMSImages::get_width($name);
        $heightRecommendation = PerfectCMSImages::get_height($name);
        $useRetina = PerfectCMSImages::use_retina($name);
        $recommendedFileType = PerfectCMSImages::get_file_type($name);
        $multiplier = PerfectCMSImages::get_multiplier($useRetina);
        if ('' === $recommendedFileType) {
            $recommendedFileType = 'jpg';
        }

        if (0 !== (int) $widthRecommendation) {
            //cater for retina
            $widthRecommendation *= $multiplier;
            $actualWidthDescription = $widthRecommendation . 'px';
        } else {
            $actualWidthDescription = $widthRecommendation;

            $actualWidthDescription = 'flexible';
        }

        if (0 !== (int) $heightRecommendation) {
            //cater for retina
            $heightRecommendation *= $multiplier;
            $actualHeightDescription = $heightRecommendation . 'px';
        } else {
            $actualHeightDescription = $heightRecommendation;

            $actualHeightDescription = 'flexible';
        }

        $rightTitle = '<span>';

        if ('flexible' === $actualWidthDescription) {
            $rightTitle .= 'Image width is flexible';
        } else {
            $rightTitle .= "Image should to be <strong>{$actualWidthDescription}</strong> wide";
        }

        $rightTitle .= ' and ';

        if ('flexible' === $actualHeightDescription) {
            $rightTitle .= 'height is flexible';
        } else {
            $rightTitle .= " <strong>{$actualHeightDescription}</strong> tall";
        }

        $rightTitle .= '<br />';
        $maxSizeInKilobytes = PerfectCMSImages::max_size_in_kilobytes($name);
        if (0 !== $maxSizeInKilobytes) {
            $rightTitle .= 'Maximum file size: ' . round($maxSizeInKilobytes / 1024, 2) . ' megabyte.';
            $rightTitle .= '<br />';
        }

        if ('' !== $recommendedFileType) {
            if (strlen($recommendedFileType) < 5) {
                $rightTitle .= 'The recommend file type (file extension) is <strong>' . $recommendedFileType . '</strong>.';
            } else {
                $rightTitle .= '<strong>' . $recommendedFileType . '</strong>';
            }
        }

        return $rightTitle . '</span>';
    }

    public static function use_retina(string $name): bool
    {
        return self::get_one_value_for_image($name, 'use_retina', true);
        return self::get_one_value_for_image($name, 'use_retina', /** @scrutinizer ignore-type */ true);
    }

    public static function get_multiplier(bool $useRetina): int
    {
        $multiplier = 1;
        if ($useRetina) {
            $multiplier = Config::inst()->get(PerfectCMSImages::class, 'retina_multiplier');
        }

        if (! $multiplier) {
            $multiplier = 1;
        }

        return $multiplier;
    }

    public static function is_crop(string $name): bool
    {
        return self::get_one_value_for_image($name, 'crop', false);
        return self::get_one_value_for_image($name, 'crop', /** @scrutinizer ignore-type */ false);
    }

    /**
     * @return int?string

     */
    public static function get_width(string $name, bool $forceInteger = false)
    {
        $v = self::get_one_value_for_image($name, 'width', 0);
        if ($forceInteger) {
            $v = (int) $v - 0;
        }

        return $v;
    }

    /**
     * @return int|string
     */
    public static function get_height(string $name, bool $forceInteger = false)
    {
        $v = self::get_one_value_for_image($name, 'height', 0);
        if ($forceInteger) {
            $v = (int) $v - 0;
        }

        return $v;
    }

    /**
     * @return int?string

     */
    public static function get_mobile_width(string $name, bool $forceInteger = false)
    {
        $v = self::get_one_value_for_image($name, 'mobile_width', 0);
        if ($forceInteger) {
            $v = (int) $v - 0;
        }

        return $v;
    }

    /**
     * @return int|string
     */
    public static function get_mobile_height(string $name, bool $forceInteger = false)
    {
        $v = self::get_one_value_for_image($name, 'mobile_height', 0);
        if ($forceInteger) {
            $v = (int) $v - 0;
        }

        return $v;
    }

    public static function get_folder(string $name): string
    {
        return self::get_one_value_for_image($name, 'folder', 'other-images');
    }

    public static function move_to_right_folder(string $name): bool
    {
        return self::get_one_value_for_image($name, 'move_to_right_folder', true);
        return self::get_one_value_for_image($name, 'move_to_right_folder', /** @scrutinizer ignore-type */ true);
    }

    public static function loading_style(string $name) : string
    {
        return self::get_one_value_for_image($name, 'loading_style', 'lazy');
    }

    public static function max_size_in_kilobytes(string $name): int
    {
        $maxSizeInKilobytes = self::get_one_value_for_image($name, 'max_size_in_kilobytes', 0);
        if (! $maxSizeInKilobytes) {
            $maxSizeInKilobytes = Config::inst()->get(PerfectCmsImagesUploadField::class, 'max_size_in_kilobytes');
        }

        return (int) $maxSizeInKilobytes - 0;
    }

    public static function get_file_type(string $name): string
    {
        return self::get_one_value_for_image($name, 'filetype', 'jpg');
    }

    public static function get_enforce_size(string $name): bool
    {
        return self::get_one_value_for_image($name, 'enforce_size', false);
        return self::get_one_value_for_image($name, 'enforce_size', /** @scrutinizer ignore-type */ false);
    }

    /**
     * @return null|string
     */
    public static function get_mobile_media_width(string $name)
    {
        return self::get_one_value_for_image(
            $name,
            'mobile_media_max_width',
            Config::inst()->get(PerfectCMSImages::class, 'mobile_media_max_width')
        );
    }

    public static function get_padding_bg_colour(string $name): string
    {
        return self::get_one_value_for_image(

            $name,
            'padding_bg_colour',
            Config::inst()->get(PerfectCmsImageDataExtension::class, 'perfect_cms_images_background_padding_color')
        );
    }

    public static function image_info_available(string $name): bool
    {
        $sizes = self::get_all_values_for_images();
        //print_r($sizes);die();
        return isset($sizes[$name]);
    }

    /**
     * @param string $default
     *
     * @return mixed
     */
    protected static function get_one_value_for_image(string $name, string $key, ?string $default = '')
    {
        $sizes = self::get_all_values_for_images();
        if (isset($sizes[$name], $sizes[$name][$key])) {
            return $sizes[$name][$key];
        }

        // Injector::inst()->get(LoggerInterface::class)->info('no information for image with the name: ' . $name . '.' . $key);

        return $default;
    }

    protected static function get_all_values_for_images(): array
    {
        return Config::inst()->get(
            PerfectCmsImageDataExtension::class,
            'perfect_cms_images_image_definitions'
        ) ?: [];
    }
}

sunnysideup / silverstripe-perfect_cms_images

Push — master ( a06d21...f74981 )

PerfectCMSImages::move_to_right_folder() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
