ImageBehavior - Code Metrics - Inspection of "Added form widget for uploading file control" - inblank/yii2-image - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b56016...3d433d )

by Pavel

created 2017-04-07 21:44 UTC

ImageBehavior A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	283
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	11

Test Coverage

Coverage

46.55%

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
wmc	34
c	2
b	1
f	0
lcom	1
cbo	11
dl	0
loc	283
ccs	54
cts	116
cp	0.4655
rs	9.2

16 Methods

Rating	Name	Size	Complexity
A	events()	9	1
A	beforeUpdate()	5	1
A	afterSave()	4	1
A	afterDelete()	4	1
A	getImagePath()	7	2
A	getImageDefaultUrl()	4	1
A	getImageAbsolutePath()	12	4
A	hasImage()	5	2
A	imageFileExists()	4	1
A	getImageUrl()	6	2
A	getImageFile()	4	1
A	imageChangeByUpload()	15	3
C	imageChange()	56	10
A	imageReset()	6	1
A	imageRemoveFile()	6	2
A	_imageUrl()	4	1

<?php
/**
 * Image behavior for ActiveRecord
 *
 * @link https://github.com/inblank/yii2-image
 * @copyright Copyright (c) 2016 Pavel Aleksandrov <[email protected]>
 * @license http://opensource.org/licenses/MIT
 */

namespace inblank\image;

use Imagine\Filter\Advanced\Canvas;
use Imagine\Filter\Transformation;
use Imagine\Image\Box;
use Imagine\Image\Color;
use Imagine\Image\ImageInterface;
use Imagine\Image\Point;
use yii;
use yii\base\Behavior;
use yii\db\ActiveRecord;

/**
 * Image Behavior Class
 *
 * @property ActiveRecord $owner
 * @property $imageDefaultUrl URL for default image
 * @property $imageUrl image URL for model. If model not have image, will equal $imageDefaultUrl
 * @property $imagePath path for image relative document root
 * @property $imageAbsolutePath absolute path to image file in filesystem
 * @property $imageFile full, with absolute path, image file name in filesystem
 */
class ImageBehavior extends Behavior
{
    /** Just proportional resize image to fit size */
    const NONE = 0;
    /** Crop image resize strategy */
    const CROP = 1;
    /** Add frame image resize strategy */
    const FRAME = 2;
    /** Transparent color */
    const COLOR_TRANSPARENT = null;
    /**
     * Name of attribute to store the image
     * @var string
     */
    public $imageAttribute = "image";
    /**
     * Default image name
     * @var string
     */
    public $imageDefault = "image.png";
    /**
     * Path to store image files.
     * If empty will be init to /images/<ActiveRecord Class Name>
     * @var string
     */
    public $imagePath;
    /**
     * Size to convert image
     * If array: [width, height].
     * If integer: use value for with and height.
     * If not set: image save as is.
     * @var integer|array
     */
    public $imageSize;
    /**
     * Image resize strategy
     * @var int
     */
    public $imageResizeStrategy = self::NONE;
    /**
     * Image frame color
     * @var
     */
    public $imageFrameColor = "#FFF";
    /**
     * Calculated absolute image path relative to webroot
     * @var
     */
    protected $_imageAbsolutePath;

    /**
     * @inheritdoc
     */
    public function events()
    {
        return [
            ActiveRecord::EVENT_AFTER_INSERT => 'afterSave',
            ActiveRecord::EVENT_AFTER_UPDATE => 'afterSave',
            ActiveRecord::EVENT_AFTER_DELETE => 'afterDelete',
            ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeUpdate',
        ];
    }

    /**
     * Before update action
     */
    public function beforeUpdate()
    {
        // prevent save empty image name value and also for correct remove old image
        $this->owner->setAttribute($this->imageAttribute, $this->owner->getOldAttribute($this->imageAttribute));
    }

    /**
     * After save action
     */
    public function afterSave()
    {
        $this->imageChangeByUpload();
    }

    /**
     * After delete action
     */
    public function afterDelete()
    {
        $this->imageRemoveFile();
    }

    /**
     * Get image path
     * @return string
     */
    public function getImagePath()
    {
        if ($this->imagePath === null) {
            $this->imagePath = '/images/' . strtolower((new \ReflectionClass($this->owner))->getShortName());
        }
        return $this->imagePath;
    }

    /**
     * Get default image URL
     * @return string
     * @throws yii\base\InvalidConfigException
     */
    public function getImageDefaultUrl()
    {
        return $this->_imageUrl($this->imageDefault);
    }

    /**
     * Get absolute team image path in filesystem
     * @return string
     */
    public function getImageAbsolutePath()
    {
        if ($this->_imageAbsolutePath === null) {
            $this->_imageAbsolutePath = Yii::getAlias('@webroot') .
                '/' . (defined('IS_BACKEND') ? '../' : '') .
                ltrim($this->getImagePath(), '/');
            if (!file_exists($this->_imageAbsolutePath)) {
                yii\helpers\FileHelper::createDirectory($this->_imageAbsolutePath);
            }
        }
        return $this->_imageAbsolutePath;
    }

    /**
     * Check team image
     * @return bool
     * @throws yii\base\InvalidConfigException
     */
    public function hasImage()
    {
        $image = $this->owner->getAttribute($this->imageAttribute);
        return !empty($image) && $image != $this->imageDefault;
    }

    /**
     * Check that image file exists
     */
    public function imageFileExists()
    {
        return file_exists($this->getImageFile());
    }

    /**
     * Get team image URL
     * @return string
     * @throws yii\base\InvalidConfigException
     */
    public function getImageUrl()
    {
        return !$this->hasImage() ?
            $this->getImageDefaultUrl() :
            $this->_imageUrl($this->owner->getAttribute($this->imageAttribute));
    }

    /**
     * Return filename in filesystem
     * @return string
     */
    public function getImageFile()
    {
        return $this->getImageAbsolutePath() . '/' . $this->owner->getAttribute($this->imageAttribute);
    }

    /**
     * Change image by uploaded file
     */
    public function imageChangeByUpload()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $formName = $this->owner->formName();
        if ($_POST[$formName][$this->imageAttribute] == 'empty') {
            // reset image
            $this->imageReset();
        } else {
            // upload new
            if (!empty($_FILES[$formName]['tmp_name'][$this->imageAttribute])) {
                $this->imageChange(
                    [$_FILES[$formName]['name'][$this->imageAttribute] => $_FILES[$formName]['tmp_name'][$this->imageAttribute]]
                );
            }
        }
    }

    /**
     * Change image
     * @param string|array $sourceFile source file. if set as array ['fileName' => 'file_in_filesystem']
     * @return bool true, if image was changed and old image file was deleted. false, if image not changed
     * @throws yii\base\InvalidConfigException
     */
    public function imageChange($sourceFile)
    {
        if (is_array($sourceFile)) {
            $fileName = key($sourceFile);
            $sourceFile = current($sourceFile);
        } else {
            $fileName = $sourceFile;
        }
        if (!file_exists($sourceFile)) {
            return false;
        }
        $imageName = $this->imageAttribute . '_' .
            md5(implode('-', (array)$this->owner->getPrimaryKey()) . microtime(true) . rand()) .
            '.' . pathinfo($fileName)['extension'];
        $destinationFile = $this->getImageAbsolutePath() . '/' . $imageName;
        if (!copy($sourceFile, $destinationFile)) {
            return false;
        }
        $this->imageRemoveFile();
        if (!empty($this->imageSize)) {
            $size = $this->imageSize;
            if (!is_array($size)) {
                $size = [$size, $size];
            }
            $newBox = new Box($size[0], $size[1]);
            $image = (new Transformation())->thumbnail(
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                $newBox,
                $this->imageResizeStrategy == self::CROP ?
                    ImageInterface::THUMBNAIL_OUTBOUND : ImageInterface::THUMBNAIL_INSET
            )->apply(yii\imagine\Image::getImagine()->open($destinationFile));
            $currentBox = $image->getSize();
            if ($this->imageResizeStrategy === self::FRAME) {
                if ($this->imageFrameColor === self::COLOR_TRANSPARENT) {
                    $frameColor = '#fff';
                    $alpha = 100;
                } else {
                    $frameColor = $this->imageFrameColor;
                    $alpha = 0;
                }
                $image = (new Transformation())->add(
                    new Canvas(
                        yii\imagine\Image::getImagine(),
                        $newBox,
                        $size[0] == $currentBox->getWidth() ?
                            new Point(0, ($size[1] - $currentBox->getHeight()) / 2) :
                            new Point(($size[0] - $currentBox->getWidth()) / 2, 0),
                        new Color($frameColor, $alpha)
                    )
                )->apply($image);
            }
            $image->save($destinationFile);
        }
        $this->owner->setAttribute($this->imageAttribute, $imageName);
        $this->owner->updateAttributes([$this->imageAttribute]);
        return true;
    }

    /**
     * Reset image to default
     * @throws yii\base\InvalidConfigException
     */
    public function imageReset()
    {
        $this->imageRemoveFile();
        $this->owner->setAttribute($this->imageAttribute, null);
        $this->owner->updateAttributes([$this->imageAttribute]);
    }

    /**
     * Remove current image
     * @throws yii\base\InvalidConfigException
     */
    protected function imageRemoveFile()
    {
        if ($this->hasImage()) {
            @unlink($this->getImageFile());
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
        }
    }

    /**
     * Make image URL
     * @param string $imageFileName image filename
     * @return string
     * @throws yii\base\InvalidConfigException
     */
    protected function _imageUrl($imageFileName)
    {
        return $this->getImagePath() . '/' . $imageFileName;
    }

}


1		<?php
2		/**
3		* Image behavior for ActiveRecord
4		*
5		* @link https://github.com/inblank/yii2-image
6		* @copyright Copyright (c) 2016 Pavel Aleksandrov <[email protected]>
7		* @license http://opensource.org/licenses/MIT
8		*/
9
10		namespace inblank\image;
11
12		use Imagine\Filter\Advanced\Canvas;
13		use Imagine\Filter\Transformation;
14		use Imagine\Image\Box;
15		use Imagine\Image\Color;
16		use Imagine\Image\ImageInterface;
17		use Imagine\Image\Point;
18		use yii;
19		use yii\base\Behavior;
20		use yii\db\ActiveRecord;
21
22		/**
23		* Image Behavior Class
24		*
25		* @property ActiveRecord $owner
26		* @property $imageDefaultUrl URL for default image
27		* @property $imageUrl image URL for model. If model not have image, will equal $imageDefaultUrl
28		* @property $imagePath path for image relative document root
29		* @property $imageAbsolutePath absolute path to image file in filesystem
30		* @property $imageFile full, with absolute path, image file name in filesystem
31		*/
32		class ImageBehavior extends Behavior
33		{
34		/** Just proportional resize image to fit size */
35		const NONE = 0;
36		/** Crop image resize strategy */
37		const CROP = 1;
38		/** Add frame image resize strategy */
39		const FRAME = 2;
40		/** Transparent color */
41		const COLOR_TRANSPARENT = null;
42		/**
43		* Name of attribute to store the image
44		* @var string
45		*/
46		public $imageAttribute = "image";
47		/**
48		* Default image name
49		* @var string
50		*/
51		public $imageDefault = "image.png";
52		/**
53		* Path to store image files.
54		* If empty will be init to /images/<ActiveRecord Class Name>
55		* @var string
56		*/
57		public $imagePath;
58		/**
59		* Size to convert image
60		* If array: [width, height].
61		* If integer: use value for with and height.
62		* If not set: image save as is.
63		* @var integer\|array
64		*/
65		public $imageSize;
66		/**
67		* Image resize strategy
68		* @var int
69		*/
70		public $imageResizeStrategy = self::NONE;
71		/**
72		* Image frame color
73		* @var
74		*/
75		public $imageFrameColor = "#FFF";
76		/**
77		* Calculated absolute image path relative to webroot
78		* @var
79		*/
80		protected $_imageAbsolutePath;
81
82		/**
83		* @inheritdoc
84		*/
85	3	public function events()
86		{
87		return [
88	3	ActiveRecord::EVENT_AFTER_INSERT => 'afterSave',
89	3	ActiveRecord::EVENT_AFTER_UPDATE => 'afterSave',
90	3	ActiveRecord::EVENT_AFTER_DELETE => 'afterDelete',
91	3	ActiveRecord::EVENT_BEFORE_UPDATE => 'beforeUpdate',
92	3	];
93		}
94
95		/**
96		* Before update action
97		*/
98		public function beforeUpdate()
99		{
100		// prevent save empty image name value and also for correct remove old image
101		$this->owner->setAttribute($this->imageAttribute, $this->owner->getOldAttribute($this->imageAttribute));
102		}
103
104		/**
105		* After save action
106		*/
107	2	public function afterSave()
108		{
109	2	$this->imageChangeByUpload();
110		}
111
112		/**
113		* After delete action
114		*/
115		public function afterDelete()
116		{
117		$this->imageRemoveFile();
118		}
119
120		/**
121		* Get image path
122		* @return string
123		*/
124	1	public function getImagePath()
125		{
126	1	if ($this->imagePath === null) {
127	1	$this->imagePath = '/images/' . strtolower((new \ReflectionClass($this->owner))->getShortName());
128	1	}
129	1	return $this->imagePath;
130		}
131
132		/**
133		* Get default image URL
134		* @return string
135		* @throws yii\base\InvalidConfigException
136		*/
137		public function getImageDefaultUrl()
138		{
139		return $this->_imageUrl($this->imageDefault);
140		}
141
142		/**
143		* Get absolute team image path in filesystem
144		* @return string
145		*/
146	1	public function getImageAbsolutePath()
147		{
148	1	if ($this->_imageAbsolutePath === null) {
149	1	$this->_imageAbsolutePath = Yii::getAlias('@webroot') .
150	1	'/' . (defined('IS_BACKEND') ? '../' : '') .
151	1	ltrim($this->getImagePath(), '/');
152	1	if (!file_exists($this->_imageAbsolutePath)) {
153		yii\helpers\FileHelper::createDirectory($this->_imageAbsolutePath);
154		}
155	1	}
156	1	return $this->_imageAbsolutePath;
157		}
158
159		/**
160		* Check team image
161		* @return bool
162		* @throws yii\base\InvalidConfigException
163		*/
164	1	public function hasImage()
165		{
166	1	$image = $this->owner->getAttribute($this->imageAttribute);
167	1	return !empty($image) && $image != $this->imageDefault;
168		}
169
170		/**
171		* Check that image file exists
172		*/
173		public function imageFileExists()
174		{
175		return file_exists($this->getImageFile());
176		}
177
178		/**
179		* Get team image URL
180		* @return string
181		* @throws yii\base\InvalidConfigException
182		*/
183		public function getImageUrl()
184		{
185		return !$this->hasImage() ?
186		$this->getImageDefaultUrl() :
187		$this->_imageUrl($this->owner->getAttribute($this->imageAttribute));
188		}
189
190		/**
191		* Return filename in filesystem
192		* @return string
193		*/
194	1	public function getImageFile()
195		{
196	1	return $this->getImageAbsolutePath() . '/' . $this->owner->getAttribute($this->imageAttribute);
197		}
198
199		/**
200		* Change image by uploaded file
201		*/
202	2	public function imageChangeByUpload()
		0 ignored issues – show Coding Style introduced 2016-06-21 11:12 UTC by Report Bug Copy Issue Report `imageChangeByUpload` uses the super-global variable `$_FILES` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2017-04-07 21:48 UTC by Report Bug Copy Issue Report `imageChangeByUpload` uses the super-global variable `$_POST` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
203		{
204	2	$formName = $this->owner->formName();
205	2	if ($_POST[$formName][$this->imageAttribute] == 'empty') {
206		// reset image
207		$this->imageReset();
208		} else {
209		// upload new
210		if (!empty($_FILES[$formName]['tmp_name'][$this->imageAttribute])) {
211		$this->imageChange(
212		[$_FILES[$formName]['name'][$this->imageAttribute] => $_FILES[$formName]['tmp_name'][$this->imageAttribute]]
213		);
214		}
215		}
216		}
217
218		/**
219		* Change image
220		* @param string\|array $sourceFile source file. if set as array ['fileName' => 'file_in_filesystem']
221		* @return bool true, if image was changed and old image file was deleted. false, if image not changed
222		* @throws yii\base\InvalidConfigException
223		*/
224	1	public function imageChange($sourceFile)
225		{
226	1	if (is_array($sourceFile)) {
227		$fileName = key($sourceFile);
228		$sourceFile = current($sourceFile);
229		} else {
230	1	$fileName = $sourceFile;
231		}
232	1	if (!file_exists($sourceFile)) {
233	1	return false;
234		}
235	1	$imageName = $this->imageAttribute . '_' .
236	1	md5(implode('-', (array)$this->owner->getPrimaryKey()) . microtime(true) . rand()) .
237	1	'.' . pathinfo($fileName)['extension'];
238	1	$destinationFile = $this->getImageAbsolutePath() . '/' . $imageName;
239	1	if (!copy($sourceFile, $destinationFile)) {
240		return false;
241		}
242	1	$this->imageRemoveFile();
243	1	if (!empty($this->imageSize)) {
244		$size = $this->imageSize;
245		if (!is_array($size)) {
246		$size = [$size, $size];
247		}
248		$newBox = new Box($size[0], $size[1]);
249		$image = (new Transformation())->thumbnail(
		0 ignored issues – show Bug introduced 2017-03-01 09:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Imagine\Image\ManipulatorInterface` as the method `apply()` does only exist in the following implementations of said interface: `Imagine\Filter\Transformation`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
250		$newBox,
251		$this->imageResizeStrategy == self::CROP ?
252		ImageInterface::THUMBNAIL_OUTBOUND : ImageInterface::THUMBNAIL_INSET
253		)->apply(yii\imagine\Image::getImagine()->open($destinationFile));
254		$currentBox = $image->getSize();
255		if ($this->imageResizeStrategy === self::FRAME) {
256		if ($this->imageFrameColor === self::COLOR_TRANSPARENT) {
257		$frameColor = '#fff';
258		$alpha = 100;
259		} else {
260		$frameColor = $this->imageFrameColor;
261		$alpha = 0;
262		}
263		$image = (new Transformation())->add(
264		new Canvas(
265		yii\imagine\Image::getImagine(),
266		$newBox,
267		$size[0] == $currentBox->getWidth() ?
268		new Point(0, ($size[1] - $currentBox->getHeight()) / 2) :
269		new Point(($size[0] - $currentBox->getWidth()) / 2, 0),
270		new Color($frameColor, $alpha)
271		)
272		)->apply($image);
273		}
274		$image->save($destinationFile);
275		}
276	1	$this->owner->setAttribute($this->imageAttribute, $imageName);
277	1	$this->owner->updateAttributes([$this->imageAttribute]);
278	1	return true;
279		}
280
281		/**
282		* Reset image to default
283		* @throws yii\base\InvalidConfigException
284		*/
285	1	public function imageReset()
286		{
287	1	$this->imageRemoveFile();
288	1	$this->owner->setAttribute($this->imageAttribute, null);
289	1	$this->owner->updateAttributes([$this->imageAttribute]);
290	1	}
291
292		/**
293		* Remove current image
294		* @throws yii\base\InvalidConfigException
295		*/
296	1	protected function imageRemoveFile()
297		{
298	1	if ($this->hasImage()) {
299	1	@unlink($this->getImageFile());
		0 ignored issues – show Security Best Practice introduced 2016-06-21 11:12 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
300	1	}
301	1	}
302
303		/**
304		* Make image URL
305		* @param string $imageFileName image filename
306		* @return string
307		* @throws yii\base\InvalidConfigException
308		*/
309		protected function _imageUrl($imageFileName)
310		{
311		return $this->getImagePath() . '/' . $imageFileName;
312		}
313
314		}
315

inblank / yii2-image

Push — master ( b56016...3d433d )

ImageBehavior A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

16 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like