Image::setPath() - Code Metrics - rvdlee/zf-image-resizer - Measure and Improve Code Quality continuously with Scrutinizer

Image::setPath() A
last analyzed 2020-09-25 06:56 UTC

↳ Parent: Image

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	2
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	5
rs	10

<?php

namespace Rvdlee\ZfImageResizer\Model;

use Rvdlee\ZfImageResizer\Exception\InvalidArgumentException;
use SplFileInfo;

class Image
{
    const ONLY_RESIZE_MODUS     = 'resize';
    const CROP_AND_RESIZE_MODUS = 'crop-and-resize';
    const ONLY_CROP_MODUS       = 'crop';
    const MODUS                 = [
        self::ONLY_RESIZE_MODUS,
        self::CROP_AND_RESIZE_MODUS,
        self::ONLY_CROP_MODUS,
    ];

    const MANUAL_CROP       = 'manual';
    const UPPER_LEFT_CROP   = 'upper-left';
    const UPPER_MIDDLE_CROP = 'upper-middle';
    const UPPER_RIGHT_CROP  = 'upper-right';
    const MIDDLE_LEFT_CROP  = 'middle-left';
    const CENTERED_CROP     = 'centered';
    const MIDDLE_RIGHT_CROP = 'middle-right';
    const BOTTOM_LEFT       = 'bottom-left';
    const BOTTOM_MIDDLE     = 'bottom-middle';
    const BOTTOM_RIGHT      = 'bottom-right';
    const CROP_MODUS        = [
        self::MANUAL_CROP,
        self::UPPER_LEFT_CROP,
        self::UPPER_MIDDLE_CROP,
        self::UPPER_RIGHT_CROP,
        self::MIDDLE_LEFT_CROP,
        self::CENTERED_CROP,
        self::MIDDLE_RIGHT_CROP,
        self::BOTTOM_LEFT,
        self::BOTTOM_MIDDLE,
        self::BOTTOM_RIGHT,
    ];

    /**
     * @var string
     */
    protected $path;

    /**
     * @var string
     */
    protected $targetPath;

    /**
     * @var SplFileInfo
     */
    protected $splFileInfo;

    /**
     * @var int
     */
    protected $originalWidth;

    /**
     * @var int
     */
    protected $originalHeight;

    /**
     * @var int
     */
    protected $targetWidth = 0;

    /**
     * @var int
     */
    protected $targetHeight = 0;

    /**
     * @var int
     */
    protected $cropPositionX = 0;

    /**
     * @var int
     */
    protected $cropPositionY = 0;

    /**
     * Image constructor.
     *
     * @param string $path
     * @param int    $targetWidth
     * @param int    $targetHeight
     * @param string $cropMode
     * @param int    $x
     * @param int    $y
     * @throws InvalidArgumentException
     */
    public function __construct(string $path, int $targetWidth, int $targetHeight, string $cropMode = self::CENTERED_CROP, int $x = 0, int $y = 0)
    {
        // Check if given path exists
        if ( ! file_exists($path)) {
            throw new InvalidArgumentException(sprintf('The provided file(%s) does not exist.', $path));
        }

        // Get the original image dimensions and calculate ratio
        list($width, $height) = getimagesize($path);
        $ratio = ($width < $height ? $width : $height) / ($width > $height ? $width : $height);

        // If either of these is not set, scale to ratio
        if ($targetWidth === 0 || $targetHeight === 0) {
            if ($targetWidth === 0) {
                $targetWidth = $width * $ratio;
            }

            if ($targetHeight === 0) {
                $targetHeight = $height * $ratio;
            }
        }

        // Prep this model
        $this->setPath($path)
             ->setSplFileInfo(new SplFileInfo($path))
             ->setOriginalWidth($width)
             ->setOriginalHeight($height)
             ->setTargetWidth($targetWidth)
             ->setTargetHeight($targetHeight)
             ->calculateCropPositions($cropMode, $x, $y)
             ->setTargetPath($this->generateFileName());
    }

    /**
     * Generate a new unique name based on all the image parameters
     *
     * @return mixed
     */
    public function generateFileName()
    {
        // Extract the basename out of the path
        $filename = basename($this->getPath());
        // Get the filepath
        $explodedFilepath = explode(DIRECTORY_SEPARATOR, $this->getPath());
        // Reconstruct the base file path
        $baseFilepath = implode(DIRECTORY_SEPARATOR, array_slice($explodedFilepath, 0, count($explodedFilepath)-1));
        // Explode the filename
        $explodedFilename = explode('.', $filename);
        // Generate new name
        $thumbname = sprintf(
            '%s.%s',
            bin2hex(random_bytes(64)),
            end($explodedFilename)
        );

        return $baseFilepath . DIRECTORY_SEPARATOR . $thumbname;
    }


    /**
     * @param string $cropMode
     * @param int    $cropPositionX
     * @param int    $cropPositionY
     * @return Image
     * @throws InvalidArgumentException
     */
    public function calculateCropPositions(
        string $cropMode = self::CENTERED_CROP,
        int $cropPositionX = 0,
        int $cropPositionY = 0
    ): Image {
        // Check if we've recieved a valid crop modus
        if ( ! in_array($cropMode, self::CROP_MODUS)) {
            throw new InvalidArgumentException(
                sprintf(
                    'Crop mode \'%s\' is not a valid mode. Choose one of the following %s',
                    $cropMode,
                    implode(self::CROP_MODUS)
                )
            );
        }

        // If we want to manually control the crop just set it and return this (fluent interface)
        if ($cropMode === self::MANUAL_CROP) {
            return $this->setCropPositionX($cropPositionX)->setCropPositionY($cropPositionY);
        }

        // These need to be set with actual values
        if ($this->getTargetWidth() === 0 || $this->getTargetHeight() === 0) {
            throw new InvalidArgumentException('TargetWidth and TargetHeight cannot be 0.');
        }

        // Do some automatic (lazy) crop calculations
        switch ($cropMode) {
            case self::UPPER_LEFT_CROP:
                $cropPositionX = 0;
                $cropPositionY = 0;
            break;
            case self::UPPER_MIDDLE_CROP:
                $cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
                $cropPositionY = 0;
            break;
            case self::UPPER_RIGHT_CROP:
                $cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
                $cropPositionY = 0;
            break;
            case self::MIDDLE_LEFT_CROP:
                $cropPositionX = 0;
                $cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
            break;
            case self::CENTERED_CROP:
                $cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
                $cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
            break;
            case self::MIDDLE_RIGHT_CROP:
                $cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
                $cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
            break;
            case self::BOTTOM_LEFT:
                $cropPositionX = 0;
                $cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
            break;
            case self::BOTTOM_MIDDLE:
                $cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
                $cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
            break;
            case self::BOTTOM_RIGHT:
                $cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
                $cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
            break;
        }

        // Set the calculated crop positions and return this (fluent interface)
        return $this->setCropPositionX($cropPositionX)->setCropPositionY($cropPositionY);
    }

    /**
     * @return string
     */
    public function getPath(): string
    {
        return $this->path;
    }

    /**
     * @param string $path
     *
     * @return Image
     */
    public function setPath(string $path): Image
    {
        $this->path = $path;

        return $this;
    }

    /**
     * @return string
     */
    public function getTargetPath(): string
    {
        return $this->targetPath;
    }

    /**
     * @param string $targetPath
     * @return Image
     */
    public function setTargetPath(string $targetPath): Image
    {
        $this->targetPath = $targetPath;
        return $this;
    }

    /**
     * @return SplFileInfo
     */
    public function getSplFileInfo(): SplFileInfo
    {
        return $this->splFileInfo;
    }

    /**
     * @param SplFileInfo $splFileInfo
     *
     * @return Image
     */
    public function setSplFileInfo(SplFileInfo $splFileInfo): Image
    {
        $this->splFileInfo = $splFileInfo;

        return $this;
    }

    /**
     * @return int
     */
    public function getTargetWidth(): int
    {
        return $this->targetWidth;
    }

    /**
     * @param int $targetWidth
     * @return Image
     */
    public function setTargetWidth(int $targetWidth): Image
    {
        $this->targetWidth = $targetWidth;
        return $this;
    }

    /**
     * @return int
     */
    public function getOriginalWidth(): int
    {
        return $this->originalWidth;
    }

    /**
     * @param int $originalWidth
     * @return Image
     */
    public function setOriginalWidth(int $originalWidth): Image
    {
        $this->originalWidth = $originalWidth;
        return $this;
    }

    /**
     * @return int
     */
    public function getOriginalHeight(): int
    {
        return $this->originalHeight;
    }

    /**
     * @param int $originalHeight
     * @return Image
     */
    public function setOriginalHeight(int $originalHeight): Image
    {
        $this->originalHeight = $originalHeight;
        return $this;
    }

    /**
     * @return int
     */
    public function getTargetHeight(): int
    {
        return $this->targetHeight;
    }

    /**
     * @param int $targetHeight
     * @return Image
     */
    public function setTargetHeight(int $targetHeight): Image
    {
        $this->targetHeight = $targetHeight;
        return $this;
    }

    /**
     * @return int
     */
    public function getCropPositionX(): int
    {
        return $this->cropPositionX;
    }

    /**
     * @param int $cropPositionX
     * @return Image
     */
    public function setCropPositionX(int $cropPositionX): Image
    {
        $this->cropPositionX = $cropPositionX;
        return $this;
    }

    /**
     * @return int
     */
    public function getCropPositionY(): int
    {
        return $this->cropPositionY;
    }

    /**
     * @param int $cropPositionY
     * @return Image
     */
    public function setCropPositionY(int $cropPositionY): Image
    {
        $this->cropPositionY = $cropPositionY;
        return $this;
    }
}

1			<?php
2
3			namespace Rvdlee\ZfImageResizer\Model;
4
5			use Rvdlee\ZfImageResizer\Exception\InvalidArgumentException;
6			use SplFileInfo;
7
8			class Image
9			{
10			const ONLY_RESIZE_MODUS = 'resize';
11			const CROP_AND_RESIZE_MODUS = 'crop-and-resize';
12			const ONLY_CROP_MODUS = 'crop';
13			const MODUS = [
14			self::ONLY_RESIZE_MODUS,
15			self::CROP_AND_RESIZE_MODUS,
16			self::ONLY_CROP_MODUS,
17			];
18
19			const MANUAL_CROP = 'manual';
20			const UPPER_LEFT_CROP = 'upper-left';
21			const UPPER_MIDDLE_CROP = 'upper-middle';
22			const UPPER_RIGHT_CROP = 'upper-right';
23			const MIDDLE_LEFT_CROP = 'middle-left';
24			const CENTERED_CROP = 'centered';
25			const MIDDLE_RIGHT_CROP = 'middle-right';
26			const BOTTOM_LEFT = 'bottom-left';
27			const BOTTOM_MIDDLE = 'bottom-middle';
28			const BOTTOM_RIGHT = 'bottom-right';
29			const CROP_MODUS = [
30			self::MANUAL_CROP,
31			self::UPPER_LEFT_CROP,
32			self::UPPER_MIDDLE_CROP,
33			self::UPPER_RIGHT_CROP,
34			self::MIDDLE_LEFT_CROP,
35			self::CENTERED_CROP,
36			self::MIDDLE_RIGHT_CROP,
37			self::BOTTOM_LEFT,
38			self::BOTTOM_MIDDLE,
39			self::BOTTOM_RIGHT,
40			];
41
42			/**
43			* @var string
44			*/
45			protected $path;
46
47			/**
48			* @var string
49			*/
50			protected $targetPath;
51
52			/**
53			* @var SplFileInfo
54			*/
55			protected $splFileInfo;
56
57			/**
58			* @var int
59			*/
60			protected $originalWidth;
61
62			/**
63			* @var int
64			*/
65			protected $originalHeight;
66
67			/**
68			* @var int
69			*/
70			protected $targetWidth = 0;
71
72			/**
73			* @var int
74			*/
75			protected $targetHeight = 0;
76
77			/**
78			* @var int
79			*/
80			protected $cropPositionX = 0;
81
82			/**
83			* @var int
84			*/
85			protected $cropPositionY = 0;
86
87			/**
88			* Image constructor.
89			*
90			* @param string $path
91			* @param int $targetWidth
92			* @param int $targetHeight
93			* @param string $cropMode
94			* @param int $x
95			* @param int $y
96			* @throws InvalidArgumentException
97			*/
98			public function __construct(string $path, int $targetWidth, int $targetHeight, string $cropMode = self::CENTERED_CROP, int $x = 0, int $y = 0)
99			{
100			// Check if given path exists
101			if ( ! file_exists($path)) {
102			throw new InvalidArgumentException(sprintf('The provided file(%s) does not exist.', $path));
103			}
104
105			// Get the original image dimensions and calculate ratio
106			list($width, $height) = getimagesize($path);
107			$ratio = ($width < $height ? $width : $height) / ($width > $height ? $width : $height);
108
109			// If either of these is not set, scale to ratio
110			if ($targetWidth === 0 \|\| $targetHeight === 0) {
111			if ($targetWidth === 0) {
112			$targetWidth = $width * $ratio;
113			}
114
115			if ($targetHeight === 0) {
116			$targetHeight = $height * $ratio;
117			}
118			}
119
120			// Prep this model
121			$this->setPath($path)
122			->setSplFileInfo(new SplFileInfo($path))
123			->setOriginalWidth($width)
124			->setOriginalHeight($height)
125			->setTargetWidth($targetWidth)
126			->setTargetHeight($targetHeight)
127			->calculateCropPositions($cropMode, $x, $y)
128			->setTargetPath($this->generateFileName());
129			}
130
131			/**
132			* Generate a new unique name based on all the image parameters
133			*
134			* @return mixed
135			*/
136			public function generateFileName()
137			{
138			// Extract the basename out of the path
139			$filename = basename($this->getPath());
140			// Get the filepath
141			$explodedFilepath = explode(DIRECTORY_SEPARATOR, $this->getPath());
142			// Reconstruct the base file path
143			$baseFilepath = implode(DIRECTORY_SEPARATOR, array_slice($explodedFilepath, 0, count($explodedFilepath)-1));
144			// Explode the filename
145			$explodedFilename = explode('.', $filename);
146			// Generate new name
147			$thumbname = sprintf(
148			'%s.%s',
149			bin2hex(random_bytes(64)),
150			end($explodedFilename)
151			);
152
153			return $baseFilepath . DIRECTORY_SEPARATOR . $thumbname;
154			}
155
156
157			/**
158			* @param string $cropMode
159			* @param int $cropPositionX
160			* @param int $cropPositionY
161			* @return Image
162			* @throws InvalidArgumentException
163			*/
164			public function calculateCropPositions(
165			string $cropMode = self::CENTERED_CROP,
166			int $cropPositionX = 0,
167			int $cropPositionY = 0
168			): Image {
169			// Check if we've recieved a valid crop modus
170			if ( ! in_array($cropMode, self::CROP_MODUS)) {
171			throw new InvalidArgumentException(
172			sprintf(
173			'Crop mode \'%s\' is not a valid mode. Choose one of the following %s',
174			$cropMode,
175			implode(self::CROP_MODUS)
176			)
177			);
178			}
179
180			// If we want to manually control the crop just set it and return this (fluent interface)
181			if ($cropMode === self::MANUAL_CROP) {
182			return $this->setCropPositionX($cropPositionX)->setCropPositionY($cropPositionY);
183			}
184
185			// These need to be set with actual values
186			if ($this->getTargetWidth() === 0 \|\| $this->getTargetHeight() === 0) {
187			throw new InvalidArgumentException('TargetWidth and TargetHeight cannot be 0.');
188			}
189
190			// Do some automatic (lazy) crop calculations
191			switch ($cropMode) {
192			case self::UPPER_LEFT_CROP:
193			$cropPositionX = 0;
194			$cropPositionY = 0;
195			break;
196			case self::UPPER_MIDDLE_CROP:
197			$cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
198			$cropPositionY = 0;
199			break;
200			case self::UPPER_RIGHT_CROP:
201			$cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
202			$cropPositionY = 0;
203			break;
204			case self::MIDDLE_LEFT_CROP:
205			$cropPositionX = 0;
206			$cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
207			break;
208			case self::CENTERED_CROP:
209			$cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
210			$cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
211			break;
212			case self::MIDDLE_RIGHT_CROP:
213			$cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
214			$cropPositionY = ($this->getOriginalHeight() / 2) - ($this->getTargetHeight() / 2);
215			break;
216			case self::BOTTOM_LEFT:
217			$cropPositionX = 0;
218			$cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
219			break;
220			case self::BOTTOM_MIDDLE:
221			$cropPositionX = ($this->getOriginalWidth() / 2) - ($this->getTargetWidth() / 2);
222			$cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
223			break;
224			case self::BOTTOM_RIGHT:
225			$cropPositionX = $this->getOriginalWidth() - $this->getTargetWidth();
226			$cropPositionY = $this->getOriginalHeight() - $this->getTargetHeight();
227			break;
228			}
229
230			// Set the calculated crop positions and return this (fluent interface)
231			return $this->setCropPositionX($cropPositionX)->setCropPositionY($cropPositionY);
232			}
233
234			/**
235			* @return string
236			*/
237			public function getPath(): string
238			{
239			return $this->path;
240			}
241
242			/**
243			* @param string $path
244			*
245			* @return Image
246			*/
247			public function setPath(string $path): Image
248			{
249			$this->path = $path;
250
251			return $this;
252			}
253
254			/**
255			* @return string
256			*/
257			public function getTargetPath(): string
258			{
259			return $this->targetPath;
260			}
261
262			/**
263			* @param string $targetPath
264			* @return Image
265			*/
266			public function setTargetPath(string $targetPath): Image
267			{
268			$this->targetPath = $targetPath;
269			return $this;
270			}
271
272			/**
273			* @return SplFileInfo
274			*/
275			public function getSplFileInfo(): SplFileInfo
276			{
277			return $this->splFileInfo;
278			}
279
280			/**
281			* @param SplFileInfo $splFileInfo
282			*
283			* @return Image
284			*/
285			public function setSplFileInfo(SplFileInfo $splFileInfo): Image
286			{
287			$this->splFileInfo = $splFileInfo;
288
289			return $this;
290			}
291
292			/**
293			* @return int
294			*/
295			public function getTargetWidth(): int
296			{
297			return $this->targetWidth;
298			}
299
300			/**
301			* @param int $targetWidth
302			* @return Image
303			*/
304			public function setTargetWidth(int $targetWidth): Image
305			{
306			$this->targetWidth = $targetWidth;
307			return $this;
308			}
309
310			/**
311			* @return int
312			*/
313			public function getOriginalWidth(): int
314			{
315			return $this->originalWidth;
316			}
317
318			/**
319			* @param int $originalWidth
320			* @return Image
321			*/
322			public function setOriginalWidth(int $originalWidth): Image
323			{
324			$this->originalWidth = $originalWidth;
325			return $this;
326			}
327
328			/**
329			* @return int
330			*/
331			public function getOriginalHeight(): int
332			{
333			return $this->originalHeight;
334			}
335
336			/**
337			* @param int $originalHeight
338			* @return Image
339			*/
340			public function setOriginalHeight(int $originalHeight): Image
341			{
342			$this->originalHeight = $originalHeight;
343			return $this;
344			}
345
346			/**
347			* @return int
348			*/
349			public function getTargetHeight(): int
350			{
351			return $this->targetHeight;
352			}
353
354			/**
355			* @param int $targetHeight
356			* @return Image
357			*/
358			public function setTargetHeight(int $targetHeight): Image
359			{
360			$this->targetHeight = $targetHeight;
361			return $this;
362			}
363
364			/**
365			* @return int
366			*/
367			public function getCropPositionX(): int
368			{
369			return $this->cropPositionX;
370			}
371
372			/**
373			* @param int $cropPositionX
374			* @return Image
375			*/
376			public function setCropPositionX(int $cropPositionX): Image
377			{
378			$this->cropPositionX = $cropPositionX;
379			return $this;
380			}
381
382			/**
383			* @return int
384			*/
385			public function getCropPositionY(): int
386			{
387			return $this->cropPositionY;
388			}
389
390			/**
391			* @param int $cropPositionY
392			* @return Image
393			*/
394			public function setCropPositionY(int $cropPositionY): Image
395			{
396			$this->cropPositionY = $cropPositionY;
397			return $this;
398			}
399			}

rvdlee / zf-image-resizer

Image::setPath() A last analyzed 2020-09-25 06:56 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Image::setPath() A
last analyzed 2020-09-25 06:56 UTC