PerfectCMSImages::use_retina() - Code Metrics - Inspection of "MAJOR: better image caching" - sunnysideup/silverstripe-perfect_cms_images - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f020d6...405d04 )

by Nicolaas

created 2023-02-13 02:51 UTC

PerfectCMSImages::use_retina() A

↳ Parent: PerfectCMSImages

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	2
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\Image;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Flushable;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\ORM\DB;
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;

    private static $unused_images_folder_name = 'unusedimages';

    /**
     * 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';

    /*
     * 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()->merge(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 = (int) PerfectCMSImages::get_width($name);
        $heightRecommendation = (int) 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);
    }

    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 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;
    }


    public static function has_mobile($name): bool
    {
        return (bool) (self::get_mobile_width($name, true) || self::get_mobile_height($name, true));
    }

    /**
     * @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);
    }

    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 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]);
    }

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

    /**
     * @param string $name
     * @param string $key
     * @param mixed $default - optional
     *
     * @return mixed
     */
    protected static function get_one_value_for_image(string $name, string $key, $default = '')
    {
        $sizes = self::get_all_values_for_images();

        return $sizes[$name][$key] ?? $default;
        // Injector::inst()->get(LoggerInterface::class)->info('no information for image with the name: ' . $name . '.' . $key);
    }
}


1			<?php
2
3			namespace Sunnysideup\PerfectCmsImages\Api;
4
5			use Psr\Log\LoggerInterface;
6			use SilverStripe\Assets\Filesystem;
7			use SilverStripe\Assets\Image;
8			use SilverStripe\Core\Config\Config;
9			use SilverStripe\Core\Flushable;
10			use SilverStripe\Core\Injector\Injector;
11			use SilverStripe\ORM\DB;
12			use Sunnysideup\PerfectCmsImages\Forms\PerfectCmsImagesUploadField;
13			use Sunnysideup\PerfectCmsImages\Model\File\PerfectCmsImageDataExtension;
14
15			class PerfectCMSImages implements Flushable
16			{
17			/**
18			*.htaccess content for assets ...
19			*
20			* @var string
21			*/
22			private static $htaccess_content = <<<'EOT'
23			<IfModule mod_rewrite.c>
24			RewriteEngine On
25			RewriteBase /
26
27			RewriteCond %{REQUEST_FILENAME} !-f
28			RewriteCond %{REQUEST_FILENAME} !-d
29			RewriteRule ^(.+)\.(v[A-Za-z0-9]+)\.(js\|css\|png\|jpg\|gif\|svg\|webp)$ $1.$3 [L]
30			</IfModule>
31
32			EOT;
33
34			private static $unused_images_folder_name = 'unusedimages';
35
36			/**
37			* used to set the max width of the media value for mobile images,
38			* eg <source srcset="small.jpg, small2x.jpg 2x" media="(max-width: 600px)">.
39			*
40			* @var string
41			*/
42			private static $mobile_media_max_width = '600px';
43
44			/*
45			* Images Titles will be appended to the links only
46			* if the ClassName of the Image is in this array
47			* @var array
48			*
49			*/
50			private static $perfect_cms_images_append_title_to_image_links_classes = [
51			Image::class,
52			];
53
54			private static $retina_multiplier = 2;
55
56			/**
57			* force resample, put htaccess content if it does not exists.
58			*/
59			public static function flush()
60			{
61			if (!Config::inst()->get(Image::class, 'force_resample')) {
62			Config::modify()->merge(Image::class, 'force_resample', true);
63			}
64
65			if (class_exists('HashPathExtension')) {
66			if (!file_exists(ASSETS_PATH)) {
67			Filesystem::makeFolder(ASSETS_PATH);
68			}
69
70			$fileName = ASSETS_PATH . '/.htaccess';
71			if (!file_exists($fileName)) {
72			$string = Config::inst()->get(PerfectCMSImages::class, 'htaccess_content');
73			file_put_contents($fileName, $string);
74			}
75			}
76			}
77
78			public static function get_description_for_cms(string $name): string
79			{
80			$widthRecommendation = (int) PerfectCMSImages::get_width($name);
81			$heightRecommendation = (int) PerfectCMSImages::get_height($name);
82			$useRetina = PerfectCMSImages::use_retina($name);
83			$recommendedFileType = PerfectCMSImages::get_file_type($name);
84			$multiplier = PerfectCMSImages::get_multiplier($useRetina);
85			if ('' === $recommendedFileType) {
86			$recommendedFileType = 'jpg';
87			}
88
89			if (0 !== (int) $widthRecommendation) {
90			//cater for retina
91			$widthRecommendation *= $multiplier;
92			$actualWidthDescription = $widthRecommendation . 'px';
93			} else {
94			$actualWidthDescription = $widthRecommendation;
			0 ignored issues – show Unused Code introduced 2021-07-18 21:58 UTC by Report Bug Copy Issue Report The assignment to `$actualWidthDescription` is dead and can be removed. Loading history...
95			$actualWidthDescription = 'flexible';
96			}
97
98			if (0 !== (int) $heightRecommendation) {
99			//cater for retina
100			$heightRecommendation *= $multiplier;
101			$actualHeightDescription = $heightRecommendation . 'px';
102			} else {
103			$actualHeightDescription = $heightRecommendation;
			0 ignored issues – show Unused Code introduced 2021-07-18 21:58 UTC by Report Bug Copy Issue Report The assignment to `$actualHeightDescription` is dead and can be removed. Loading history...
104			$actualHeightDescription = 'flexible';
105			}
106
107			$rightTitle = '<span>';
108
109			if ('flexible' === $actualWidthDescription) {
110			$rightTitle .= 'Image width is flexible';
111			} else {
112			$rightTitle .= "Image should to be <strong>{$actualWidthDescription}</strong> wide";
113			}
114
115			$rightTitle .= ' and ';
116
117			if ('flexible' === $actualHeightDescription) {
118			$rightTitle .= 'height is flexible';
119			} else {
120			$rightTitle .= " <strong>{$actualHeightDescription}</strong> tall";
121			}
122
123			$rightTitle .= '<br />';
124			$maxSizeInKilobytes = PerfectCMSImages::max_size_in_kilobytes($name);
125			if (0 !== $maxSizeInKilobytes) {
126			$rightTitle .= 'Maximum file size: ' . round($maxSizeInKilobytes / 1024, 2) . ' megabyte.';
127			$rightTitle .= '<br />';
128			}
129
130			if ('' !== $recommendedFileType) {
131			if (strlen($recommendedFileType) < 5) {
132			$rightTitle .= 'The recommend file type (file extension) is <strong>' . $recommendedFileType . '</strong>.';
133			} else {
134			$rightTitle .= '<strong>' . $recommendedFileType . '</strong>';
135			}
136			}
137
138			return $rightTitle . '</span>';
139			}
140
141			public static function use_retina(string $name): bool
142			{
143			return self::get_one_value_for_image($name, 'use_retina', true);
144			}
145
146			public static function get_multiplier(bool $useRetina): int
147			{
148			$multiplier = 1;
149			if ($useRetina) {
150			$multiplier = Config::inst()->get(PerfectCMSImages::class, 'retina_multiplier');
151			}
152
153			if (!$multiplier) {
154			$multiplier = 1;
155			}
156
157			return $multiplier;
158			}
159
160			public static function is_crop(string $name): bool
161			{
162			return self::get_one_value_for_image($name, 'crop', false);
163			}
164
165			/**
166			* @return int\|string
167			*/
168			public static function get_width(string $name, bool $forceInteger = false)
169			{
170			$v = self::get_one_value_for_image($name, 'width', 0);
171			if ($forceInteger) {
172			$v = (int) $v - 0;
173			}
174
175			return $v;
176			}
177
178			/**
179			* @return int\|string
180			*/
181			public static function get_height(string $name, bool $forceInteger = false)
182			{
183			$v = self::get_one_value_for_image($name, 'height', 0);
184			if ($forceInteger) {
185			$v = (int) $v - 0;
186			}
187
188			return $v;
189			}
190
191
192			public static function has_mobile($name): bool
193			{
194			return (bool) (self::get_mobile_width($name, true) \|\| self::get_mobile_height($name, true));
195			}
196
197			/**
198			* @return int?string
			0 ignored issues – show Documentation Bug introduced 2023-02-08 09:37 UTC by Report Bug Copy Issue Report The doc comment `int?string` at position `0` could not be parsed: Unknown type name 'int?string' at position 0 in int?string. Loading history...
199			*/
200			public static function get_mobile_width(string $name, bool $forceInteger = false)
201			{
202			$v = self::get_one_value_for_image($name, 'mobile_width', 0);
203			if ($forceInteger) {
204			$v = (int) $v - 0;
205			}
206
207			return $v;
208			}
209
210			/**
211			* @return int\|string
212			*/
213			public static function get_mobile_height(string $name, bool $forceInteger = false)
214			{
215			$v = self::get_one_value_for_image($name, 'mobile_height', 0);
216			if ($forceInteger) {
217			$v = (int) $v - 0;
218			}
219
220			return $v;
221			}
222
223			public static function get_folder(string $name): string
224			{
225			return self::get_one_value_for_image($name, 'folder', 'other-images');
226			}
227
228			public static function move_to_right_folder(string $name): bool
229			{
230			return self::get_one_value_for_image($name, 'move_to_right_folder', true);
231			}
232
233			public static function loading_style(string $name): string
234			{
235			return self::get_one_value_for_image($name, 'loading_style', 'lazy');
236			}
237
238			public static function max_size_in_kilobytes(string $name): int
239			{
240			$maxSizeInKilobytes = self::get_one_value_for_image($name, 'max_size_in_kilobytes', 0);
241			if (!$maxSizeInKilobytes) {
242			$maxSizeInKilobytes = Config::inst()->get(PerfectCmsImagesUploadField::class, 'max_size_in_kilobytes');
243			}
244
245			return (int) $maxSizeInKilobytes - 0;
246			}
247
248			public static function get_file_type(string $name): string
249			{
250			return self::get_one_value_for_image($name, 'filetype', 'jpg');
251			}
252
253			public static function get_enforce_size(string $name): bool
254			{
255			return self::get_one_value_for_image($name, 'enforce_size', false);
256			}
257
258			/**
259			* @return null\|string
260			*/
261			public static function get_mobile_media_width(string $name)
262			{
263			return self::get_one_value_for_image(
264			$name,
265			'mobile_media_max_width',
266			Config::inst()->get(PerfectCMSImages::class, 'mobile_media_max_width')
267			);
268			}
269
270			public static function get_padding_bg_colour(string $name): string
271			{
272			return self::get_one_value_for_image(
273			$name,
274			'padding_bg_colour',
275			Config::inst()->get(PerfectCmsImageDataExtension::class, 'perfect_cms_images_background_padding_color')
276			);
277			}
278
279			public static function image_info_available(string $name): bool
280			{
281			$sizes = self::get_all_values_for_images();
282			//print_r($sizes);die();
283			return isset($sizes[$name]);
284			}
285
286			public static function get_all_values_for_images(): array
287			{
288			return Config::inst()->get(
289			PerfectCmsImageDataExtension::class,
290			'perfect_cms_images_image_definitions'
291			) ?: [];
292			}
293
294			/**
295			* @param string $name
296			* @param string $key
297			* @param mixed $default - optional
298			*
299			* @return mixed
300			*/
301			protected static function get_one_value_for_image(string $name, string $key, $default = '')
302			{
303			$sizes = self::get_all_values_for_images();
304
305			return $sizes[$name][$key] ?? $default;
306			// Injector::inst()->get(LoggerInterface::class)->info('no information for image with the name: ' . $name . '.' . $key);
307			}
308			}
309

sunnysideup / silverstripe-perfect_cms_images

Push — master ( f020d6...405d04 )

PerfectCMSImages::use_retina() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like