Size::runStretchResize() - Code Metrics - Inspection of "Add a zoom option to focal crop" - thephpleague/glide - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#259)

unknown

created 2019-04-03 20:43 UTC

Size::runStretchResize() A

↳ Parent: Size

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1.125

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	2
cts	4
cp	0.5
rs	10
cc	1
nc	1
nop	3
crap	1.125

<?php

namespace League\Glide\Manipulators;

use Intervention\Image\Image;

/**
 * @property string $dpr
 * @property string $fit
 * @property string $h
 * @property string $w
 */
class Size extends BaseManipulator
{
    /**
     * Maximum image size in pixels.
     * @var integer|null
     */
    protected $maxImageSize;

    /**
     * Create Size instance.
     * @param integer|null $maxImageSize Maximum image size in pixels.
     */
    public function __construct($maxImageSize = null)
    {
        $this->maxImageSize = $maxImageSize;
    }

    /**
     * Set the maximum image size.
     * @param integer|null Maximum image size in pixels.
     */
    public function setMaxImageSize($maxImageSize)
    {
        $this->maxImageSize = $maxImageSize;
    }

    /**
     * Get the maximum image size.
     * @return integer|null Maximum image size in pixels.
     */
    public function getMaxImageSize()
    {
        return $this->maxImageSize;
    }

    /**
     * Perform size image manipulation.
     * @param  Image $image The source image.
     * @return Image The manipulated image.
     */
    public function run(Image $image)
    {
        $width = $this->getWidth();
        $height = $this->getHeight();
        $fit = $this->getFit();
        $dpr = $this->getDpr();

        list($width, $height) = $this->resolveMissingDimensions($image, $width, $height);
        list($width, $height) = $this->applyDpr($width, $height, $dpr);
        list($width, $height) = $this->limitImageSize($width, $height);

        if ((int) $width !== (int) $image->width() or (int) $height !== (int) $image->height()) {
            $image = $this->runResize($image, $fit, (int) $width, (int) $height);
        }

        return $image;
    }

    /**
     * Resolve width.
     * @return integer|null The resolved width.
     */
    public function getWidth()
    {
        if (!is_numeric($this->w)) {
            return;
        }

        if ($this->w <= 0) {
            return;
        }

        return (int) $this->w;
    }

    /**
     * Resolve height.
     * @return integer|null The resolved height.
     */
    public function getHeight()
    {
        if (!is_numeric($this->h)) {
            return;
        }

        if ($this->h <= 0) {
            return;
        }

        return (int) $this->h;
    }

    /**
     * Resolve fit.
     * @return string The resolved fit.
     */
    public function getFit()
    {
        if (in_array($this->fit, ['contain', 'fill', 'max', 'stretch'], true)) {
            return $this->fit;
        }

        if (preg_match('/^(crop)(-top-left|-top|-top-right|-left|-center|-right|-bottom-left|-bottom|-bottom-right|-[\d]{1,3}-[\d]{1,3}(?:-[\d]{1,3}(?:\.\d+)?)?)*$/', $this->fit)) {
            return 'crop';
        }

        return 'contain';
    }

    /**
     * Resolve the device pixel ratio.
     * @return double The device pixel ratio.
     */
    public function getDpr()
    {
        if (!is_numeric($this->dpr)) {
            return 1.0;
        }

        if ($this->dpr < 0 or $this->dpr > 8) {
            return 1.0;
        }

        return (double) $this->dpr;
    }

    /**
     * Resolve missing image dimensions.
     * @param  Image        $image  The source image.
     * @param  integer|null $width  The image width.
     * @param  integer|null $height The image height.
     * @return integer[]    The resolved width and height.
     */
    public function resolveMissingDimensions(Image $image, $width, $height)
    {
        if (is_null($width) and is_null($height)) {
            $width = $image->width();
            $height = $image->height();
        }

        if (is_null($width)) {
            $width = $height * ($image->width() / $image->height());
        }

        if (is_null($height)) {
            $height = $width / ($image->width() / $image->height());
        }

        return [
            (int) $width,
            (int) $height,
        ];
    }

    /**
     * Apply the device pixel ratio.
     * @param  integer   $width  The target image width.
     * @param  integer   $height The target image height.
     * @param  integer   $dpr    The device pixel ratio.
     * @return integer[] The modified width and height.
     */
    public function applyDpr($width, $height, $dpr)
    {
        $width = $width * $dpr;
        $height = $height * $dpr;

        return [
            (int) $width,
            (int) $height,
        ];
    }

    /**
     * Limit image size to maximum allowed image size.
     * @param  integer   $width  The image width.
     * @param  integer   $height The image height.
     * @return integer[] The limited width and height.
     */
    public function limitImageSize($width, $height)
    {
        if ($this->maxImageSize !== null) {
            $imageSize = $width * $height;

            if ($imageSize > $this->maxImageSize) {
                $width = $width / sqrt($imageSize / $this->maxImageSize);
                $height = $height / sqrt($imageSize / $this->maxImageSize);
            }
        }

        return [
            (int) $width,
            (int) $height,
        ];
    }

    /**
     * Perform resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  string  $fit    The fit.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runResize(Image $image, $fit, $width, $height)
    {
        if ($fit === 'contain') {
            return $this->runContainResize($image, $width, $height);
        }

        if ($fit === 'fill') {
            return $this->runFillResize($image, $width, $height);
        }

        if ($fit === 'max') {
            return $this->runMaxResize($image, $width, $height);
        }

        if ($fit === 'stretch') {
            return $this->runStretchResize($image, $width, $height);
        }

        if ($fit === 'crop') {
            return $this->runCropResize($image, $width, $height);
        }

        return $image;
    }

    /**
     * Perform contain resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runContainResize(Image $image, $width, $height)
    {
        return $image->resize($width, $height, function ($constraint) {
            $constraint->aspectRatio();
        });
    }

    /**
     * Perform max resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runMaxResize(Image $image, $width, $height)
    {
        return $image->resize($width, $height, function ($constraint) {
            $constraint->aspectRatio();
            $constraint->upsize();
        });
    }

    /**
     * Perform fill resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runFillResize($image, $width, $height)
    {
        $image = $this->runMaxResize($image, $width, $height);

        return $image->resizeCanvas($width, $height, 'center');
    }

    /**
     * Perform stretch resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runStretchResize(Image $image, $width, $height)
    {
        return $image->resize($width, $height);
    }

    /**
     * Perform crop resize image manipulation.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return Image   The manipulated image.
     */
    public function runCropResize(Image $image, $width, $height)
    {
        list($resize_width, $resize_height) = $this->resolveCropResizeDimensions($image, $width, $height);

        $zoom = $this->getCrop()[2];

        $image->resize($resize_width * $zoom, $resize_height * $zoom, function ($constraint) {
            $constraint->aspectRatio();
        });

        list($offset_x, $offset_y) = $this->resolveCropOffset($image, $width, $height);

        return $image->crop($width, $height, $offset_x, $offset_y);
    }

    /**
     * Resolve the crop resize dimensions.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return array   The resize dimensions.
     */
    public function resolveCropResizeDimensions(Image $image, $width, $height)
    {
        if ($height > $width * ($image->height() / $image->width())) {
            return [$height * ($image->width() / $image->height()), $height];
        }

        return [$width, $width * ($image->height() / $image->width())];
    }

    /**
     * Resolve the crop offset.
     * @param  Image   $image  The source image.
     * @param  integer $width  The width.
     * @param  integer $height The height.
     * @return array   The crop offset.
     */
    public function resolveCropOffset(Image $image, $width, $height)
    {
        list($offset_percentage_x, $offset_percentage_y) = $this->getCrop();

        $offset_x = (int) (($image->width() * $offset_percentage_x / 100) - ($width / 2));
        $offset_y = (int) (($image->height() * $offset_percentage_y / 100) - ($height / 2));

        $max_offset_x = $image->width() - $width;
        $max_offset_y = $image->height() - $height;

        if ($offset_x < 0) {
            $offset_x = 0;
        }

        if ($offset_y < 0) {
            $offset_y = 0;
        }

        if ($offset_x > $max_offset_x) {
            $offset_x = $max_offset_x;
        }

        if ($offset_y > $max_offset_y) {
            $offset_y = $max_offset_y;
        }

        return [$offset_x, $offset_y];
    }

    /**
     * Resolve crop with zoom.
     * @return integer[] The resolved crop.
     */
    public function getCrop()
    {
        $cropMethods = [
            'crop-top-left' => [0, 0, 1.0],
            'crop-top' => [50, 0, 1.0],
            'crop-top-right' => [100, 0, 1.0],
            'crop-left' => [0, 50, 1.0],
            'crop-center' => [50, 50, 1.0],
            'crop-right' => [100, 50, 1.0],
            'crop-bottom-left' => [0, 100, 1.0],
            'crop-bottom' => [50, 100, 1.0],
            'crop-bottom-right' => [100, 100, 1.0],
        ];

        if (array_key_exists($this->fit, $cropMethods)) {
            return $cropMethods[$this->fit];
        }

        if (preg_match('/^crop-([\d]{1,3})-([\d]{1,3})(?:-([\d]{1,3}(?:\.\d+)?))*$/', $this->fit, $matches)) {
            $matches[3] = isset($matches[3]) ? $matches[3] : 1;

            if ($matches[1] > 100 or $matches[2] > 100 or $matches[3] > 100) {
                return [50, 50, 1.0];
            }

            return [
                (int) $matches[1],
                (int) $matches[2],
                (float) $matches[3],
            ];
        }

        return [50, 50, 1.0];
    }
}


1		<?php
2
3		namespace League\Glide\Manipulators;
4
5		use Intervention\Image\Image;
6
7		/**
8		* @property string $dpr
9		* @property string $fit
10		* @property string $h
11		* @property string $w
12		*/
13		class Size extends BaseManipulator
14		{
15		/**
16		* Maximum image size in pixels.
17		* @var integer\|null
18		*/
19		protected $maxImageSize;
20
21		/**
22		* Create Size instance.
23		* @param integer\|null $maxImageSize Maximum image size in pixels.
24		*/
25	44	public function __construct($maxImageSize = null)
26		{
27	44	$this->maxImageSize = $maxImageSize;
28	44	}
29
30		/**
31		* Set the maximum image size.
32		* @param integer\|null Maximum image size in pixels.
33		*/
34	4	public function setMaxImageSize($maxImageSize)
35		{
36	4	$this->maxImageSize = $maxImageSize;
37	4	}
38
39		/**
40		* Get the maximum image size.
41		* @return integer\|null Maximum image size in pixels.
42		*/
43	4	public function getMaxImageSize()
44		{
45	4	return $this->maxImageSize;
46		}
47
48		/**
49		* Perform size image manipulation.
50		* @param Image $image The source image.
51		* @return Image The manipulated image.
52		*/
53	4	public function run(Image $image)
54		{
55	4	$width = $this->getWidth();
56	4	$height = $this->getHeight();
57	4	$fit = $this->getFit();
58	4	$dpr = $this->getDpr();
59
60	4	list($width, $height) = $this->resolveMissingDimensions($image, $width, $height);
61	4	list($width, $height) = $this->applyDpr($width, $height, $dpr);
62	4	list($width, $height) = $this->limitImageSize($width, $height);
63
64	4	if ((int) $width !== (int) $image->width() or (int) $height !== (int) $image->height()) {
65	4	$image = $this->runResize($image, $fit, (int) $width, (int) $height);
66	4	}
67
68	4	return $image;
69		}
70
71		/**
72		* Resolve width.
73		* @return integer\|null The resolved width.
74		*/
75	6	public function getWidth()
76		{
77	6	if (!is_numeric($this->w)) {
78	2	return;
79		}
80
81	6	if ($this->w <= 0) {
82	2	return;
83		}
84
85	6	return (int) $this->w;
86		}
87
88		/**
89		* Resolve height.
90		* @return integer\|null The resolved height.
91		*/
92	6	public function getHeight()
93		{
94	6	if (!is_numeric($this->h)) {
95	4	return;
96		}
97
98	4	if ($this->h <= 0) {
99	2	return;
100		}
101
102	4	return (int) $this->h;
103		}
104
105		/**
106		* Resolve fit.
107		* @return string The resolved fit.
108		*/
109	6	public function getFit()
110		{
111	6	if (in_array($this->fit, ['contain', 'fill', 'max', 'stretch'], true)) {
112	2	return $this->fit;
113		}
114
115	6	if (preg_match('/^(crop)(-top-left\|-top\|-top-right\|-left\|-center\|-right\|-bottom-left\|-bottom\|-bottom-right\|-[\d]{1,3}-[\d]{1,3}(?:-[\d]{1,3}(?:\.\d+)?)?)*$/', $this->fit)) {
116	2	return 'crop';
117		}
118
119	6	return 'contain';
120		}
121
122		/**
123		* Resolve the device pixel ratio.
124		* @return double The device pixel ratio.
125		*/
126	6	public function getDpr()
127		{
128	6	if (!is_numeric($this->dpr)) {
129	6	return 1.0;
130		}
131
132	2	if ($this->dpr < 0 or $this->dpr > 8) {
133	2	return 1.0;
134		}
135
136	2	return (double) $this->dpr;
137		}
138
139		/**
140		* Resolve missing image dimensions.
141		* @param Image $image The source image.
142		* @param integer\|null $width The image width.
143		* @param integer\|null $height The image height.
144		* @return integer[] The resolved width and height.
145		*/
146	6	public function resolveMissingDimensions(Image $image, $width, $height)
147		{
148	6	if (is_null($width) and is_null($height)) {
149	2	$width = $image->width();
150	2	$height = $image->height();
151	2	}
152
153	6	if (is_null($width)) {
154	2	$width = $height * ($image->width() / $image->height());
155	2	}
156
157	6	if (is_null($height)) {
158	4	$height = $width / ($image->width() / $image->height());
159	4	}
160
161		return [
162	6	(int) $width,
163	6	(int) $height,
164	6	];
165		}
166
167		/**
168		* Apply the device pixel ratio.
169		* @param integer $width The target image width.
170		* @param integer $height The target image height.
171		* @param integer $dpr The device pixel ratio.
172		* @return integer[] The modified width and height.
173		*/
174	4	public function applyDpr($width, $height, $dpr)
175		{
176	4	$width = $width * $dpr;
177	4	$height = $height * $dpr;
178
179		return [
180	4	(int) $width,
181	4	(int) $height,
182	4	];
183		}
184
185		/**
186		* Limit image size to maximum allowed image size.
187		* @param integer $width The image width.
188		* @param integer $height The image height.
189		* @return integer[] The limited width and height.
190		*/
191	6	public function limitImageSize($width, $height)
192		{
193	6	if ($this->maxImageSize !== null) {
194	2	$imageSize = $width * $height;
195
196	2	if ($imageSize > $this->maxImageSize) {
197	2	$width = $width / sqrt($imageSize / $this->maxImageSize);
198	2	$height = $height / sqrt($imageSize / $this->maxImageSize);
199	2	}
200	2	}
201
202		return [
203	6	(int) $width,
204	6	(int) $height,
205	6	];
206		}
207
208		/**
209		* Perform resize image manipulation.
210		* @param Image $image The source image.
211		* @param string $fit The fit.
212		* @param integer $width The width.
213		* @param integer $height The height.
214		* @return Image The manipulated image.
215		*/
216	6	public function runResize(Image $image, $fit, $width, $height)
217		{
218	6	if ($fit === 'contain') {
219	6	return $this->runContainResize($image, $width, $height);
220		}
221
222	2	if ($fit === 'fill') {
223	2	return $this->runFillResize($image, $width, $height);
224		}
225
226	2	if ($fit === 'max') {
227	2	return $this->runMaxResize($image, $width, $height);
228		}
229
230	2	if ($fit === 'stretch') {
231	2	return $this->runStretchResize($image, $width, $height);
232		}
233
234	2	if ($fit === 'crop') {
235	2	return $this->runCropResize($image, $width, $height);
236		}
237
238	2	return $image;
239		}
240
241		/**
242		* Perform contain resize image manipulation.
243		* @param Image $image The source image.
244		* @param integer $width The width.
245		* @param integer $height The height.
246		* @return Image The manipulated image.
247		*/
248	8	public function runContainResize(Image $image, $width, $height)
249		{
250		return $image->resize($width, $height, function ($constraint) {
251		$constraint->aspectRatio();
252	8	});
253		}
254
255		/**
256		* Perform max resize image manipulation.
257		* @param Image $image The source image.
258		* @param integer $width The width.
259		* @param integer $height The height.
260		* @return Image The manipulated image.
261		*/
262	6	public function runMaxResize(Image $image, $width, $height)
263		{
264		return $image->resize($width, $height, function ($constraint) {
265		$constraint->aspectRatio();
266		$constraint->upsize();
267	6	});
268		}
269
270		/**
271		* Perform fill resize image manipulation.
272		* @param Image $image The source image.
273		* @param integer $width The width.
274		* @param integer $height The height.
275		* @return Image The manipulated image.
276		*/
277	4	public function runFillResize($image, $width, $height)
278		{
279	4	$image = $this->runMaxResize($image, $width, $height);
280
281	4	return $image->resizeCanvas($width, $height, 'center');
282		}
283
284		/**
285		* Perform stretch resize image manipulation.
286		* @param Image $image The source image.
287		* @param integer $width The width.
288		* @param integer $height The height.
289		* @return Image The manipulated image.
290		*/
291	4	public function runStretchResize(Image $image, $width, $height)
292		{
293	4	return $image->resize($width, $height);
294		}
295
296		/**
297		* Perform crop resize image manipulation.
298		* @param Image $image The source image.
299		* @param integer $width The width.
300		* @param integer $height The height.
301		* @return Image The manipulated image.
302		*/
303	4	public function runCropResize(Image $image, $width, $height)
304		{
305	4	list($resize_width, $resize_height) = $this->resolveCropResizeDimensions($image, $width, $height);
306
307	4	$zoom = $this->getCrop()[2];
308
309	4	$image->resize($resize_width * $zoom, $resize_height * $zoom, function ($constraint) {
310		$constraint->aspectRatio();
311	4	});
312
313	4	list($offset_x, $offset_y) = $this->resolveCropOffset($image, $width, $height);
314
315		return $image->crop($width, $height, $offset_x, $offset_y);
316		}
317
318		/**
319		* Resolve the crop resize dimensions.
320		* @param Image $image The source image.
321		* @param integer $width The width.
322		* @param integer $height The height.
323	4	* @return array The resize dimensions.
324		*/
325	4	public function resolveCropResizeDimensions(Image $image, $width, $height)
326		{
327		if ($height > $width * ($image->height() / $image->width())) {
328		return [$height * ($image->width() / $image->height()), $height];
329	4	}
330
331		return [$width, $width * ($image->height() / $image->width())];
332		}
333
334		/**
335		* Resolve the crop offset.
336		* @param Image $image The source image.
337		* @param integer $width The width.
338		* @param integer $height The height.
339	4	* @return array The crop offset.
340		*/
341	4	public function resolveCropOffset(Image $image, $width, $height)
342		{
343	4	list($offset_percentage_x, $offset_percentage_y) = $this->getCrop();
344	4
345		$offset_x = (int) (($image->width() * $offset_percentage_x / 100) - ($width / 2));
346	4	$offset_y = (int) (($image->height() * $offset_percentage_y / 100) - ($height / 2));
347	4
348		$max_offset_x = $image->width() - $width;
349	4	$max_offset_y = $image->height() - $height;
350
351		if ($offset_x < 0) {
352		$offset_x = 0;
353	4	}
354
355		if ($offset_y < 0) {
356		$offset_y = 0;
357	4	}
358
359		if ($offset_x > $max_offset_x) {
360		$offset_x = $max_offset_x;
361	4	}
362
363		if ($offset_y > $max_offset_y) {
364		$offset_y = $max_offset_y;
365	4	}
366
367		return [$offset_x, $offset_y];
368		}
369
370		/**
371		* Resolve crop with zoom.
372	6	* @return integer[] The resolved crop.
373		*/
374		public function getCrop()
375	6	{
376	6	$cropMethods = [
377	6	'crop-top-left' => [0, 0, 1.0],
378	6	'crop-top' => [50, 0, 1.0],
379	6	'crop-top-right' => [100, 0, 1.0],
380	6	'crop-left' => [0, 50, 1.0],
381	6	'crop-center' => [50, 50, 1.0],
382	6	'crop-right' => [100, 50, 1.0],
383	6	'crop-bottom-left' => [0, 100, 1.0],
384	6	'crop-bottom' => [50, 100, 1.0],
385		'crop-bottom-right' => [100, 100, 1.0],
386	6	];
387	2
388		if (array_key_exists($this->fit, $cropMethods)) {
389		return $cropMethods[$this->fit];
390	6	}
391	2
392	2	if (preg_match('/^crop-([\d]{1,3})-([\d]{1,3})(?:-([\d]{1,3}(?:\.\d+)?))*$/', $this->fit, $matches)) {
393		$matches[3] = isset($matches[3]) ? $matches[3] : 1;
394
395		if ($matches[1] > 100 or $matches[2] > 100 or $matches[3] > 100) {
396	2	return [50, 50, 1.0];
397	2	}
398	2
399		return [
400		(int) $matches[1],
401	6	(int) $matches[2],
402		(float) $matches[3],
403		];
404		}
405
406		return [50, 50, 1.0];
407		}
408		}
409

thephpleague / glide

Pull Request — master (#259)

Size::runStretchResize() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like