Imagick2 - Code Metrics - Inspection of "Imagick ready" - Compolomus/Compomage - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — next (11674b)

by compolom

created 2020-01-07 21:17 UTC

Imagick2 A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	301
Duplicated Lines	8.97 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

42.48%

Importance

Changes

Metric	Value
wmc	29
lcom	1
cbo	2
dl	27
loc	301
ccs	48
cts	113
cp	0.4248
rs	10
c	0
b	0
f	0

23 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	resize()	0	7	1
A	setSizes()	0	7	1
A	rotate()	0	7	1
A	flip()	0	6	1
A	flop()	0	6	1
A	grayscale()	0	9	1
A	copyright()	0	21	3
A	getFontsList()	0	4	1
A	prepareImage()	0	22	1
A	crop()	0	7	1
A	save()	0	7	1
A	__toString()	0	4	1
A	prepareThumbnail()	0	6	1
A	tmp()	0	16	3
A	newImage()	0	8	1
A	prepareWatermark()	0	8	1
A	resizeByTransparentBackground()	0	7	1
A	resizeByBlurBackground()	7	7	1
A	brightness()	10	10	2
A	contrast()	10	10	2
A	negate()	0	6	1
A	blur()	0	6	1

How to fix Duplicated Code

<?php declare(strict_types=1);

namespace Compolomus\Compomage;

use Compolomus\Compomage\Interfaces\ImageInterface;
use Exception;
use imagick;
use ImagickDraw;
use ImagickException;
use ImagickPixel;
use InvalidArgumentException;

class Imagick2 extends AbstractImage
{
    /**
     * Imagick constructor.
     * @param string $image
     * @throws Exception
     */
    public function __construct(string $image)
    {
        $this->init($image);
    }

    /**
     * @param int $width
     * @param int $height
     * @return ImageInterface
     * @throws ImagickException
     */
    public function resize(int $width, int $height): ImageInterface
    {
        $this->getImage()->scaleImage($width, $height, false);
        $this->setSizes();

        return $this;
    }

    protected function setSizes(): void
    {
        $args = $this->getImage()->getImageGeometry();
        $this->setWidth($args['width']);
        $this->setHeight($args['height']);
        $this->setOrientation();
    }

    /**
     * @param int $angle
     * @return ImageInterface
     */
    public function rotate(int $angle = 90): ImageInterface
    {
        $this->getImage()->rotateImage(new ImagickPixel('transparent'), $angle);
        $this->setSizes();

        return $this;
    }

    /**
     * @return ImageInterface
     */
    public function flip(): ImageInterface
    {
        $this->getImage()->flipImage();

        return $this;
    }

    /**
     * @return ImageInterface
     */
    public function flop(): ImageInterface
    {
        $this->getImage()->flopImage();

        return $this;
    }

    public function grayscale(): ImageInterface
    {
        $this->getImage()->transformimagecolorspace(Imagick::COLORSPACE_GRAY);
        $this->getImage()->separateImageChannel(1);

        // modulateImage(100, 0, 100);

        return $this;
    }

    /**
     * @param string $text
     * @param string $position
     * @param string $font
     * @return ImageInterface
     * @throws InvalidArgumentException
     * @throws ImagickException
     */
    public function copyright(string $text, string $font = 'Courier', string $position = 'SouthWest'): ImageInterface
    {
        $positions = [
            'NORTHWEST' => Imagick::GRAVITY_NORTHWEST,
            'NORTH' => Imagick::GRAVITY_NORTH,
            'NORTHEAST' => Imagick::GRAVITY_NORTHEAST,
            'WEST' => Imagick::GRAVITY_WEST,
            'CENTER' => Imagick::GRAVITY_CENTER,
            'SOUTHWEST' => Imagick::GRAVITY_SOUTHWEST,
            'SOUTH' => Imagick::GRAVITY_SOUTH,
            'SOUTHEAST' => Imagick::GRAVITY_SOUTHEAST,
            'EAST' => Imagick::GRAVITY_EAST
        ];
        if (!array_key_exists(strtoupper($position), $positions) || !in_array($font, $this->getFontsList(), true)) {
            throw new InvalidArgumentException('Does not support font or wrong position');
        }
        $this->getImage()->compositeImage($this->prepareImage($text, $positions[strtoupper($position)], $font),
            Imagick::COMPOSITE_DISSOLVE, 0, 0);

        return $this;
    }

    public function getFontsList(): array
    {
        return $this->getImage()->queryFonts();
    }

    /**
     * @param string $text
     * @param int $position
     * @param string $font
     * @return Imagick
     * @throws ImagickException
     */
    private function prepareImage(string $text, int $position, string $font): Imagick
    {
        $image = new Imagick();
        $mask = new Imagick();
        $draw = new ImagickDraw();
        $image->newImage($this->getWidth(), $this->getHeight(), new ImagickPixel('grey30'));
        $mask->newImage($this->getWidth(), $this->getHeight(), new ImagickPixel('black'));
        $draw->setFont($font);
        $draw->setFontSize(20);
        $draw->setFillColor(new ImagickPixel('grey70'));
        $draw->setGravity($position);
        $image->annotateImage($draw, 10, 12, 0, $text);
        $draw->setFillColor(new ImagickPixel('white'));
        $mask->annotateImage($draw, 11, 13, 0, $text);
        $mask->annotateImage($draw, 10, 12, 0, $text);
        $draw->setFillColor(new ImagickPixel('black'));
        $mask->annotateImage($draw, 9, 11, 0, $text);
        $mask->setImageMatte(false);
        $image->compositeImage($mask, Imagick::COMPOSITE_COPYOPACITY, 0, 0);

        return $image;
    }

    /**
     * @param int $width
     * @param int $height
     * @param int $startX
     * @param int $startY
     * @return ImageInterface
     */
    public function crop(int $width, int $height, int $startX, int $startY): ImageInterface
    {
        $this->getImage()->cropImage($width, $height, $startX, $startY);
        $this->setSizes();

        return $this;
    }

    public function save(string $filename, $quality = 100): bool
    {
        $this->getImage()->setImageCompressionQuality($quality);
        $this->getImage()->writeImage($filename . '.png');

        return true;
    }

    public function __toString(): string
    {
        return trim($this->getImage()->getImageBlob());
    }

    /**
     * @param int $width
     * @param int $height
     * @return ImageInterface
     * @throws ImagickException
     */
    protected function prepareThumbnail(int $width, int $height): ImageInterface
    {
        $this->getImage()->cropThumbnailImage($width, $height);

        return $this;
    }

    /**
     * @param string $source
     * @return ImageInterface
     * @throws ImagickException
     */
    protected function tmp(string $source): ImageInterface
    {
        $image = new Imagick;
        if ($image->readImageBlob($source)) {
            if ($image->getImageAlphaChannel() !== Imagick::ALPHACHANNEL_ACTIVATE) {
                $image->setImageAlphaChannel(Imagick::ALPHACHANNEL_SET);
            }
        }
        $background = $this->newImage($image->getImageWidth(), $image->getImageHeight());
        $image->compositeImage($background, Imagick::COMPOSITE_OVER, 0, 0); //Imagick::COMPOSITE_DISSOLVE
        $this->setImage($image);
        $this->getImage()->setFormat('png'); // save transparent
        $this->setSizes();

        return $this;
    }

    /**
     * @param int $width
     * @param int $height
     * @return Imagick
     * @throws ImagickException
     */
    protected function newImage(int $width, int $height): Imagick
    {
        $background = new Imagick;
        $background->newImage($width, $height, new ImagickPixel('transparent'));
        $background->setImageBackgroundColor(new ImagickPixel('transparent'));

        return $background;
    }

    /**
     * @param Image $watermark
     * @param int $x
     * @param int $y
     * @return ImageInterface
     * @throws Exception
     */
    protected function prepareWatermark($watermark, int $x, int $y): ImageInterface
    {
        $watermark = $watermark->getImage();
        $watermark->evaluateImage(Imagick::EVALUATE_MULTIPLY, 1, Imagick::CHANNEL_ALPHA);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        $this->getImage()->compositeImage($watermark, Imagick::COMPOSITE_DISSOLVE, $x, $y);

        return $this;
    }

    public function resizeByTransparentBackground(int $width, int $height): ImageInterface
    {
        $background = $this->newImage($width, $height);
        $background->setImageFormat('png');

        return $this->setBackground($width, $height, new Image(base64_encode((string) $background), Image::IMAGICK));
    }

    public function resizeByBlurBackground(int $width, int $height): ImageInterface

    {
        $background = new Image(base64_encode((string) $this));
        $background->resize($width, $height)->blur();

        return $this->setBackground($width, $height, $background);
    }

    /**
     * @param int $level
     * @return ImageInterface
     */
    public function brightness(int $level): ImageInterface

    {
        if (!$this->compareRangeValue($level, 200))
        {
            throw new InvalidArgumentException('Wrong brightness level, range 0 - 200, ' . $level . ' given');
        }
        $this->getImage()->modulateImage(abs($level), 100, 100);

        return $this;
    }

    /**
     * @param int $level
     * @return ImageInterface
     */
    public function contrast(int $level): ImageInterface

    {
        if (!$this->compareRangeValue($level, 100))
        {
            throw new InvalidArgumentException('Wrong contrast level, range 0 - 100, ' . $level . ' given');
        }
        $this->getImage()->brightnessContrastImage(0, abs($level));


        return $this;
    }

    /**
     * @return ImageInterface
     */
    public function negate(): ImageInterface
    {
        $this->getImage()->negateImage(false);

        return $this;
    }

    /**
     * @return ImageInterface
     */
    public function blur(): ImageInterface
    {
        $this->getImage()->blurImage(7,5);

        return $this;
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Compolomus\Compomage;
4
5			use Compolomus\Compomage\Interfaces\ImageInterface;
6			use Exception;
7			use imagick;
8			use ImagickDraw;
9			use ImagickException;
10			use ImagickPixel;
11			use InvalidArgumentException;
12
13			class Imagick2 extends AbstractImage
14			{
15			/**
16			* Imagick constructor.
17			* @param string $image
18			* @throws Exception
19			*/
20	9		public function __construct(string $image)
21			{
22	9		$this->init($image);
23	9		}
24
25			/**
26			* @param int $width
27			* @param int $height
28			* @return ImageInterface
29			* @throws ImagickException
30			*/
31	1		public function resize(int $width, int $height): ImageInterface
32			{
33	1		$this->getImage()->scaleImage($width, $height, false);
34	1		$this->setSizes();
35
36	1		return $this;
37			}
38
39	9		protected function setSizes(): void
40			{
41	9		$args = $this->getImage()->getImageGeometry();
42	9		$this->setWidth($args['width']);
43	9		$this->setHeight($args['height']);
44	9		$this->setOrientation();
45	9		}
46
47			/**
48			* @param int $angle
49			* @return ImageInterface
50			*/
51	1		public function rotate(int $angle = 90): ImageInterface
52			{
53	1		$this->getImage()->rotateImage(new ImagickPixel('transparent'), $angle);
54	1		$this->setSizes();
55
56	1		return $this;
57			}
58
59			/**
60			* @return ImageInterface
61			*/
62			public function flip(): ImageInterface
63			{
64			$this->getImage()->flipImage();
65
66			return $this;
67			}
68
69			/**
70			* @return ImageInterface
71			*/
72			public function flop(): ImageInterface
73			{
74			$this->getImage()->flopImage();
75
76			return $this;
77			}
78
79			public function grayscale(): ImageInterface
80			{
81			$this->getImage()->transformimagecolorspace(Imagick::COLORSPACE_GRAY);
82			$this->getImage()->separateImageChannel(1);
83
84			// modulateImage(100, 0, 100);
85
86			return $this;
87			}
88
89			/**
90			* @param string $text
91			* @param string $position
92			* @param string $font
93			* @return ImageInterface
94			* @throws InvalidArgumentException
95			* @throws ImagickException
96			*/
97	1		public function copyright(string $text, string $font = 'Courier', string $position = 'SouthWest'): ImageInterface
98			{
99			$positions = [
100	1		'NORTHWEST' => Imagick::GRAVITY_NORTHWEST,
101			'NORTH' => Imagick::GRAVITY_NORTH,
102			'NORTHEAST' => Imagick::GRAVITY_NORTHEAST,
103			'WEST' => Imagick::GRAVITY_WEST,
104			'CENTER' => Imagick::GRAVITY_CENTER,
105			'SOUTHWEST' => Imagick::GRAVITY_SOUTHWEST,
106			'SOUTH' => Imagick::GRAVITY_SOUTH,
107			'SOUTHEAST' => Imagick::GRAVITY_SOUTHEAST,
108			'EAST' => Imagick::GRAVITY_EAST
109			];
110	1		if (!array_key_exists(strtoupper($position), $positions) \|\| !in_array($font, $this->getFontsList(), true)) {
111	1		throw new InvalidArgumentException('Does not support font or wrong position');
112			}
113			$this->getImage()->compositeImage($this->prepareImage($text, $positions[strtoupper($position)], $font),
114			Imagick::COMPOSITE_DISSOLVE, 0, 0);
115
116			return $this;
117			}
118
119	1		public function getFontsList(): array
120			{
121	1		return $this->getImage()->queryFonts();
122			}
123
124			/**
125			* @param string $text
126			* @param int $position
127			* @param string $font
128			* @return Imagick
129			* @throws ImagickException
130			*/
131			private function prepareImage(string $text, int $position, string $font): Imagick
132			{
133			$image = new Imagick();
134			$mask = new Imagick();
135			$draw = new ImagickDraw();
136			$image->newImage($this->getWidth(), $this->getHeight(), new ImagickPixel('grey30'));
137			$mask->newImage($this->getWidth(), $this->getHeight(), new ImagickPixel('black'));
138			$draw->setFont($font);
139			$draw->setFontSize(20);
140			$draw->setFillColor(new ImagickPixel('grey70'));
141			$draw->setGravity($position);
142			$image->annotateImage($draw, 10, 12, 0, $text);
143			$draw->setFillColor(new ImagickPixel('white'));
144			$mask->annotateImage($draw, 11, 13, 0, $text);
145			$mask->annotateImage($draw, 10, 12, 0, $text);
146			$draw->setFillColor(new ImagickPixel('black'));
147			$mask->annotateImage($draw, 9, 11, 0, $text);
148			$mask->setImageMatte(false);
149			$image->compositeImage($mask, Imagick::COMPOSITE_COPYOPACITY, 0, 0);
150
151			return $image;
152			}
153
154			/**
155			* @param int $width
156			* @param int $height
157			* @param int $startX
158			* @param int $startY
159			* @return ImageInterface
160			*/
161			public function crop(int $width, int $height, int $startX, int $startY): ImageInterface
162			{
163			$this->getImage()->cropImage($width, $height, $startX, $startY);
164			$this->setSizes();
165
166			return $this;
167			}
168
169	1		public function save(string $filename, $quality = 100): bool
170			{
171	1		$this->getImage()->setImageCompressionQuality($quality);
172	1		$this->getImage()->writeImage($filename . '.png');
173
174	1		return true;
175			}
176
177	1		public function __toString(): string
178			{
179	1		return trim($this->getImage()->getImageBlob());
180			}
181
182			/**
183			* @param int $width
184			* @param int $height
185			* @return ImageInterface
186			* @throws ImagickException
187			*/
188	1		protected function prepareThumbnail(int $width, int $height): ImageInterface
189			{
190	1		$this->getImage()->cropThumbnailImage($width, $height);
191
192	1		return $this;
193			}
194
195			/**
196			* @param string $source
197			* @return ImageInterface
198			* @throws ImagickException
199			*/
200	9		protected function tmp(string $source): ImageInterface
201			{
202	9		$image = new Imagick;
203	9		if ($image->readImageBlob($source)) {
204	9		if ($image->getImageAlphaChannel() !== Imagick::ALPHACHANNEL_ACTIVATE) {
205	8		$image->setImageAlphaChannel(Imagick::ALPHACHANNEL_SET);
206			}
207			}
208	9		$background = $this->newImage($image->getImageWidth(), $image->getImageHeight());
209	9		$image->compositeImage($background, Imagick::COMPOSITE_OVER, 0, 0); //Imagick::COMPOSITE_DISSOLVE
210	9		$this->setImage($image);
211	9		$this->getImage()->setFormat('png'); // save transparent
212	9		$this->setSizes();
213
214	9		return $this;
215			}
216
217			/**
218			* @param int $width
219			* @param int $height
220			* @return Imagick
221			* @throws ImagickException
222			*/
223	9		protected function newImage(int $width, int $height): Imagick
224			{
225	9		$background = new Imagick;
226	9		$background->newImage($width, $height, new ImagickPixel('transparent'));
227	9		$background->setImageBackgroundColor(new ImagickPixel('transparent'));
228
229	9		return $background;
230			}
231
232			/**
233			* @param Image $watermark
234			* @param int $x
235			* @param int $y
236			* @return ImageInterface
237			* @throws Exception
238			*/
239			protected function prepareWatermark($watermark, int $x, int $y): ImageInterface
240			{
241			$watermark = $watermark->getImage();
242			$watermark->evaluateImage(Imagick::EVALUATE_MULTIPLY, 1, Imagick::CHANNEL_ALPHA);
			0 ignored issues – show Documentation Bug introduced 2020-01-07 21:21 UTC by Report Bug Copy Issue Report The method `evaluateImage` does not exist on `object<Compolomus\Compomage\Image>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
243			$this->getImage()->compositeImage($watermark, Imagick::COMPOSITE_DISSOLVE, $x, $y);
244
245			return $this;
246			}
247
248			public function resizeByTransparentBackground(int $width, int $height): ImageInterface
249			{
250			$background = $this->newImage($width, $height);
251			$background->setImageFormat('png');
252
253			return $this->setBackground($width, $height, new Image(base64_encode((string) $background), Image::IMAGICK));
254			}
255
256		View Code Duplication	public function resizeByBlurBackground(int $width, int $height): ImageInterface
			0 ignored issues – show Duplication introduced 2020-01-07 21:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
257			{
258			$background = new Image(base64_encode((string) $this));
259			$background->resize($width, $height)->blur();
260
261			return $this->setBackground($width, $height, $background);
262			}
263
264			/**
265			* @param int $level
266			* @return ImageInterface
267			*/
268		View Code Duplication	public function brightness(int $level): ImageInterface
			0 ignored issues – show Duplication introduced 2020-01-07 21:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
269			{
270			if (!$this->compareRangeValue($level, 200))
271			{
272			throw new InvalidArgumentException('Wrong brightness level, range 0 - 200, ' . $level . ' given');
273			}
274			$this->getImage()->modulateImage(abs($level), 100, 100);
275
276			return $this;
277			}
278
279			/**
280			* @param int $level
281			* @return ImageInterface
282			*/
283		View Code Duplication	public function contrast(int $level): ImageInterface
			0 ignored issues – show Duplication introduced 2020-01-07 21:21 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
284			{
285			if (!$this->compareRangeValue($level, 100))
286			{
287			throw new InvalidArgumentException('Wrong contrast level, range 0 - 100, ' . $level . ' given');
288			}
289			$this->getImage()->brightnessContrastImage(0, abs($level));
			0 ignored issues – show Bug introduced 2020-01-07 21:21 UTC by Report Bug Copy Issue Report The method `brightnessContrastImage()` does not exist on `Imagick`. Did you maybe mean `contrastimage()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
290
291			return $this;
292			}
293
294			/**
295			* @return ImageInterface
296			*/
297			public function negate(): ImageInterface
298			{
299			$this->getImage()->negateImage(false);
300
301			return $this;
302			}
303
304			/**
305			* @return ImageInterface
306			*/
307			public function blur(): ImageInterface
308			{
309			$this->getImage()->blurImage(7,5);
310
311			return $this;
312			}
313			}
314

Compolomus / Compomage

Branch — next (11674b)

Imagick2 A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

23 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like