Manipulations::getManipulationSequence() - Code Metrics - Inspection of "commit" - spatie/image - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f9e5d0...b497b7 )

by Freek

created 2017-02-02 09:41 UTC

Manipulations::getManipulationSequence() A

↳ Parent: Manipulations

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Spatie\Image;

class Manipulations
{
    const CROP_TOP_LEFT = 'crop-top-left';
    const CROP_TOP = 'crop-top';
    const CROP_TOP_RIGHT = 'crop-top-right';
    const CROP_LEFT = 'crop-left';
    const CROP_CENTER = 'crop-center';
    const CROP_RIGHT = 'crop-right';
    const CROP_BOTTOM_LEFT = 'crop-bottom-left';
    const CROP_BOTTOM = 'crop-bottom';
    const CROP_BOTTOM_RIGHT = 'crop-bottom-right';

    const ORIENTATION_AUTO = 'auto';
    const ORIENTATION_90 = 90;
    const ORIENTATION_180 = 180;
    const ORIENTATION_270 = 270;

    const FIT_CONTAIN = 'contain';
    const FIT_MAX = 'max';
    const FIT_FILL = 'fill';
    const FIT_STRETCH = 'stretch';
    const FIT_CROP = 'crop';

    const BORDER_OVERLAY = 'overlay';
    const BORDER_SHRINK = 'shrink';
    const BORDER_EXPAND = 'expand';

    const FORMAT_JPG = 'jpg';
    const FORMAT_PJPG = 'pjpg';
    const FORMAT_PNG = 'png';
    const FORMAT_GIF = 'gif';

    /** @var \Spatie\Image\ManipulationSequence */
    protected $manipulationSequence;

    public function __construct(array $manipulations = [])

    {
        $this->manipulationSequence = new ManipulationSequence();
    }

    /**
     * @param string $orientation
     *
     * @return static
     */
    public function orientation(string $orientation)
    {
        return $this->addManipulation($orientation);
    }

    /**
     * @param string $cropMethod
     * @param int $width
     * @param int $height
     *
     * @return static
     */
    public function crop(string $cropMethod, int $width, int $height)
    {
        return $this
            ->addManipulation($cropMethod, 'crop')
            ->addManipulation($width, 'width')
            ->addManipulation($height, 'height');
    }

    /**
     * @param int $width
     *
     * @return $this
     */
    public function width(int $width)
    {
        return $this->addManipulation($width);
    }

    /**
     * @param int $height
     *
     * @return static
     */
    public function height(int $height)
    {
        return $this->addManipulation($height);
    }

    /**
     * @param string $fitMethod
     * @param int $width
     * @param int $height
     *
     * @return static
     */
    public function fit(string $fitMethod, int $width, int $height)
    {
        return $this
            ->addManipulation($fitMethod, 'fit')
            ->addManipulation($width, 'width')
            ->addManipulation($height, 'height');
    }

    /**
     * @param int $ratio
     *
     * @return static
     */
    public function devicePixelRatio(int $ratio)
    {
        return $this->addManipulation($ratio);
    }

    /**
     * @param int $brightness
     *
     * @return static
     */
    public function brightness(int $brightness)
    {
        return $this->addManipulation($brightness);
    }

    /**
     * @param float $gamma
     *
     * @return static
     */
    public function gamma(float $gamma)
    {
        return $this->addManipulation($gamma);
    }

    /**
     * @param int $contrast
     *
     * @return static
     */
    public function contrast(int $contrast)
    {
        return $this->addManipulation($contrast);
    }

    /**
     * @param int $sharpen
     *
     * @return static
     */
    public function sharpen(int $sharpen)
    {
        return $this->addManipulation($sharpen);
    }

    /**
     * @param int $blur
     *
     * @return static
     */
    public function blur(int $blur)
    {
        return $this->addManipulation($blur);
    }

    /**
     * @param int $pixelate
     *
     * @return static
     */
    public function pixelate(int $pixelate)
    {
        return $this->addManipulation($pixelate);
    }

    /**
     * @return static
     */
    public function greyscale()
    {
        return $this->filter('greyscale');
    }

    /**
     * @return static
     */
    public function sepia()
    {
        return $this->filter('sepia');
    }

    /**
     * @param string $colorName
     *
     * @return static
     */
    public function background(string $colorName)
    {
        return $this->addManipulation($colorName);
    }

    /**
     * @param int $width
     * @param string $color
     * @param string $borderType
     *
     * @return static
     */
    public function border(int $width, string $color, string $borderType = 'overlay')
    {
        return $this->addManipulation(["{$width},{$color},{$borderType}"], 'border');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @param int $quality
     *
     * @return static
     */
    public function quality(int $quality)
    {
        return $this->addManipulation($quality);
    }

    /**
     * @param string $format
     *
     * @return static
     */
    public function format(string $format)
    {
        return $this->addManipulation($format);
    }

    /**
     * @param string $filterName
     *
     * @return static
     */
    protected function filter(string $filterName)
    {
        return $this->addManipulation($filterName);
    }

    /**
     * @return static
     */
    public function apply()
    {
        $this->manipulationSequence->startNewGroup();

        return $this;
    }

    public function removeManipulation(string $name)
    {
        $this->manipulationSequence->removeManipulation($name);
    }


    public function hasManipulation(string $manipulationName): bool
    {
        return !is_null($this->getManipulation($manipulationName));

    }

    /**
     * @param string $manipulationName
     * @return string|null
     */
    public function getManipulationArgument(string $manipulationName)
    {
        foreach ($this->manipulationSequence->getGroups() as $manipulationSet) {
            if (array_key_exists($manipulationName, $manipulationSet)) {
                return $manipulationSet[$manipulationName];
            }
        }

        return null;
    }

    protected function addManipulation(string $manipulationArgument, string $manipulationName = null)
    {
        $manipulationName = $manipulationName ?? debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2)[1]['function'];

        $this->manipulationSequence->addManipulation($manipulationName, $manipulationArgument);

        return $this;
    }

    public function mergeManipulations(Manipulations $manipulations)
    {
        $this->manipulationSequence->merge($manipulations->manipulationSequence);

        return $this;
    }

    public function getManipulationSequence(): ManipulationSequence
    {
        return $this->manipulationSequence;
    }
}


1			<?php
2
3			namespace Spatie\Image;
4
5			class Manipulations
6			{
7			const CROP_TOP_LEFT = 'crop-top-left';
8			const CROP_TOP = 'crop-top';
9			const CROP_TOP_RIGHT = 'crop-top-right';
10			const CROP_LEFT = 'crop-left';
11			const CROP_CENTER = 'crop-center';
12			const CROP_RIGHT = 'crop-right';
13			const CROP_BOTTOM_LEFT = 'crop-bottom-left';
14			const CROP_BOTTOM = 'crop-bottom';
15			const CROP_BOTTOM_RIGHT = 'crop-bottom-right';
16
17			const ORIENTATION_AUTO = 'auto';
18			const ORIENTATION_90 = 90;
19			const ORIENTATION_180 = 180;
20			const ORIENTATION_270 = 270;
21
22			const FIT_CONTAIN = 'contain';
23			const FIT_MAX = 'max';
24			const FIT_FILL = 'fill';
25			const FIT_STRETCH = 'stretch';
26			const FIT_CROP = 'crop';
27
28			const BORDER_OVERLAY = 'overlay';
29			const BORDER_SHRINK = 'shrink';
30			const BORDER_EXPAND = 'expand';
31
32			const FORMAT_JPG = 'jpg';
33			const FORMAT_PJPG = 'pjpg';
34			const FORMAT_PNG = 'png';
35			const FORMAT_GIF = 'gif';
36
37			/** @var \Spatie\Image\ManipulationSequence */
38			protected $manipulationSequence;
39
40			public function __construct(array $manipulations = [])
			0 ignored issues – show Unused Code introduced 2017-02-01 14:42 UTC by Report Bug Copy Issue Report The parameter `$manipulations` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
41			{
42			$this->manipulationSequence = new ManipulationSequence();
43			}
44
45			/**
46			* @param string $orientation
47			*
48			* @return static
49			*/
50			public function orientation(string $orientation)
51			{
52			return $this->addManipulation($orientation);
53			}
54
55			/**
56			* @param string $cropMethod
57			* @param int $width
58			* @param int $height
59			*
60			* @return static
61			*/
62			public function crop(string $cropMethod, int $width, int $height)
63			{
64			return $this
65			->addManipulation($cropMethod, 'crop')
66			->addManipulation($width, 'width')
67			->addManipulation($height, 'height');
68			}
69
70			/**
71			* @param int $width
72			*
73			* @return $this
74			*/
75			public function width(int $width)
76			{
77			return $this->addManipulation($width);
78			}
79
80			/**
81			* @param int $height
82			*
83			* @return static
84			*/
85			public function height(int $height)
86			{
87			return $this->addManipulation($height);
88			}
89
90			/**
91			* @param string $fitMethod
92			* @param int $width
93			* @param int $height
94			*
95			* @return static
96			*/
97			public function fit(string $fitMethod, int $width, int $height)
98			{
99			return $this
100			->addManipulation($fitMethod, 'fit')
101			->addManipulation($width, 'width')
102			->addManipulation($height, 'height');
103			}
104
105			/**
106			* @param int $ratio
107			*
108			* @return static
109			*/
110			public function devicePixelRatio(int $ratio)
111			{
112			return $this->addManipulation($ratio);
113			}
114
115			/**
116			* @param int $brightness
117			*
118			* @return static
119			*/
120			public function brightness(int $brightness)
121			{
122			return $this->addManipulation($brightness);
123			}
124
125			/**
126			* @param float $gamma
127			*
128			* @return static
129			*/
130			public function gamma(float $gamma)
131			{
132			return $this->addManipulation($gamma);
133			}
134
135			/**
136			* @param int $contrast
137			*
138			* @return static
139			*/
140			public function contrast(int $contrast)
141			{
142			return $this->addManipulation($contrast);
143			}
144
145			/**
146			* @param int $sharpen
147			*
148			* @return static
149			*/
150			public function sharpen(int $sharpen)
151			{
152			return $this->addManipulation($sharpen);
153			}
154
155			/**
156			* @param int $blur
157			*
158			* @return static
159			*/
160			public function blur(int $blur)
161			{
162			return $this->addManipulation($blur);
163			}
164
165			/**
166			* @param int $pixelate
167			*
168			* @return static
169			*/
170			public function pixelate(int $pixelate)
171			{
172			return $this->addManipulation($pixelate);
173			}
174
175			/**
176			* @return static
177			*/
178			public function greyscale()
179			{
180			return $this->filter('greyscale');
181			}
182
183			/**
184			* @return static
185			*/
186			public function sepia()
187			{
188			return $this->filter('sepia');
189			}
190
191			/**
192			* @param string $colorName
193			*
194			* @return static
195			*/
196			public function background(string $colorName)
197			{
198			return $this->addManipulation($colorName);
199			}
200
201			/**
202			* @param int $width
203			* @param string $color
204			* @param string $borderType
205			*
206			* @return static
207			*/
208			public function border(int $width, string $color, string $borderType = 'overlay')
209			{
210			return $this->addManipulation(["{$width},{$color},{$borderType}"], 'border');
			0 ignored issues – show Documentation introduced 2017-02-01 15:29 UTC by Report Bug Copy Issue Report `array("{$width},{$color},{$borderType}")` is of type `array<integer,?>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
211			}
212
213			/**
214			* @param int $quality
215			*
216			* @return static
217			*/
218			public function quality(int $quality)
219			{
220			return $this->addManipulation($quality);
221			}
222
223			/**
224			* @param string $format
225			*
226			* @return static
227			*/
228			public function format(string $format)
229			{
230			return $this->addManipulation($format);
231			}
232
233			/**
234			* @param string $filterName
235			*
236			* @return static
237			*/
238			protected function filter(string $filterName)
239			{
240			return $this->addManipulation($filterName);
241			}
242
243			/**
244			* @return static
245			*/
246			public function apply()
247			{
248			$this->manipulationSequence->startNewGroup();
249
250			return $this;
251			}
252
253			public function removeManipulation(string $name)
254			{
255			$this->manipulationSequence->removeManipulation($name);
256			}
257
258
259			public function hasManipulation(string $manipulationName): bool
260			{
261			return !is_null($this->getManipulation($manipulationName));
			0 ignored issues – show Bug introduced 2017-02-01 15:56 UTC by Report Bug Copy Issue Report The method `getManipulation()` does not exist on `Spatie\Image\Manipulations`. Did you maybe mean `getManipulationArgument()`? 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...
262			}
263
264			/**
265			* @param string $manipulationName
266			* @return string\|null
267			*/
268			public function getManipulationArgument(string $manipulationName)
269			{
270			foreach ($this->manipulationSequence->getGroups() as $manipulationSet) {
271			if (array_key_exists($manipulationName, $manipulationSet)) {
272			return $manipulationSet[$manipulationName];
273			}
274			}
275
276			return null;
277			}
278
279			protected function addManipulation(string $manipulationArgument, string $manipulationName = null)
280			{
281			$manipulationName = $manipulationName ?? debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2)[1]['function'];
282
283			$this->manipulationSequence->addManipulation($manipulationName, $manipulationArgument);
284
285			return $this;
286			}
287
288			public function mergeManipulations(Manipulations $manipulations)
289			{
290			$this->manipulationSequence->merge($manipulations->manipulationSequence);
291
292			return $this;
293			}
294
295			public function getManipulationSequence(): ManipulationSequence
296			{
297			return $this->manipulationSequence;
298			}
299			}
300

spatie / image

GitHub Access Token became invalid

Push — master ( f9e5d0...b497b7 )

Manipulations::getManipulationSequence() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like