UploadImageBehavior::getPlaceholderUrl() - Code Metrics - mohorev/yii2-upload-behavior - Measure and Improve Code Quality continuously with Scrutinizer

UploadImageBehavior::getPlaceholderUrl() A
last analyzed 2018-08-10 08:00 UTC

↳ Parent: UploadImageBehavior

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace mohorev\file;

use Imagine\Image\ManipulatorInterface;
use Yii;
use yii\base\InvalidArgumentException;
use yii\base\InvalidConfigException;
use yii\base\NotSupportedException;
use yii\db\BaseActiveRecord;
use yii\helpers\ArrayHelper;
use yii\helpers\FileHelper;
use yii\imagine\Image;

/**
 * UploadImageBehavior automatically uploads image, creates thumbnails and fills
 * the specified attribute with a value of the name of the uploaded image.
 *
 * To use UploadImageBehavior, insert the following code to your ActiveRecord class:
 *
 * ```php
 * use mohorev\file\UploadImageBehavior;
 *
 * function behaviors()
 * {
 *     return [
 *         [
 *             'class' => UploadImageBehavior::class,
 *             'attribute' => 'file',
 *             'scenarios' => ['insert', 'update'],
 *             'placeholder' => '@app/modules/user/assets/images/userpic.jpg',
 *             'path' => '@webroot/upload/{id}/images',
 *             'url' => '@web/upload/{id}/images',
 *             'thumbPath' => '@webroot/upload/{id}/images/thumb',
 *             'thumbUrl' => '@web/upload/{id}/images/thumb',
 *             'thumbs' => [
 *                   'thumb' => ['width' => 400, 'quality' => 90],
 *                   'preview' => ['width' => 200, 'height' => 200],
 *              ],
 *         ],
 *     ];
 * }
 * ```
 *
 * @author Alexander Mohorev <[email protected]>
 * @author Alexey Samoylov <[email protected]>
 */
class UploadImageBehavior extends UploadBehavior
{
    /**
     * @var string
     */
    public $placeholder;
    /**
     * @var boolean
     */
    public $createThumbsOnSave = true;
    /**
     * @var boolean
     */
    public $createThumbsOnRequest = false;
    /**
     * Whether delete original uploaded image after thumbs generating.
     * Defaults to FALSE
     * @var boolean
     */
    public $deleteOriginalFile = false;
    /**
     * @var array the thumbnail profiles
     * - `width`
     * - `height`
     * - `quality`
     */
    public $thumbs = [
        'thumb' => ['width' => 200, 'height' => 200, 'quality' => 90],
    ];
    /**
     * @var string|null
     */
    public $thumbPath;
    /**
     * @var string|null
     */
    public $thumbUrl;


    /**
     * @inheritdoc
     */
    public function init()
    {
        if (!class_exists(Image::class)) {
            throw new NotSupportedException("Yii2-imagine extension is required to use the UploadImageBehavior");
        }

        parent::init();

        if ($this->createThumbsOnSave || $this->createThumbsOnRequest) {
            if ($this->thumbPath === null) {
                $this->thumbPath = $this->path;
            }
            if ($this->thumbUrl === null) {
                $this->thumbUrl = $this->url;
            }

            foreach ($this->thumbs as $config) {
                $width = ArrayHelper::getValue($config, 'width');
                $height = ArrayHelper::getValue($config, 'height');
                if ($height < 1 && $width < 1) {
                    throw new InvalidConfigException(sprintf(
                        'Length of either side of thumb cannot be 0 or negative, current size ' .
                        'is %sx%s', $width, $height
                    ));
                }
            }
        }
    }

    /**
     * @inheritdoc
     */
    protected function afterUpload()
    {
        parent::afterUpload();
        if ($this->createThumbsOnSave) {
            $this->createThumbs();
        }
    }

    /**
     * @throws \yii\base\InvalidArgumentException
     */
    protected function createThumbs()
    {
        $path = $this->getUploadPath($this->attribute);
        if (!is_file($path)) {
            return;
        }
        
        foreach ($this->thumbs as $profile => $config) {
            $thumbPath = $this->getThumbUploadPath($this->attribute, $profile);
            if ($thumbPath !== null) {
                if (!FileHelper::createDirectory(dirname($thumbPath))) {
                    throw new InvalidArgumentException(
                        "Directory specified in 'thumbPath' attribute doesn't exist or cannot be created."
                    );
                }
                if (!is_file($thumbPath)) {
                    $this->generateImageThumb($config, $path, $thumbPath);
                }
            }
        }
        
        if ($this->deleteOriginalFile) {
            parent::delete($this->attribute);
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
        }
    }

    /**
     * @param string $attribute
     * @param string $profile
     * @param boolean $old
     * @return string
     */
    public function getThumbUploadPath($attribute, $profile = 'thumb', $old = false)
    {
        /** @var BaseActiveRecord $model */
        $model = $this->owner;
        $path = $this->resolvePath($this->thumbPath);
        $attribute = ($old === true) ? $model->getOldAttribute($attribute) : $model->$attribute;
        $filename = $this->getThumbFileName($attribute, $profile);
        
        return $filename ? Yii::getAlias($path . '/' . $filename) : null;
    }

    /**
     * @param string $attribute
     * @param string $profile
     * @return string|null
     */
    public function getThumbUploadUrl($attribute, $profile = 'thumb')
    {
        /** @var BaseActiveRecord $model */
        $model = $this->owner;
        
        if ($this->createThumbsOnRequest) {
            $this->createThumbs();
        }
        
        if (is_file($this->getThumbUploadPath($attribute, $profile))) {
            $url = $this->resolvePath($this->thumbUrl);
            $fileName = $model->getOldAttribute($attribute);
            $thumbName = $this->getThumbFileName($fileName, $profile);

            return Yii::getAlias($url . '/' . $thumbName);
        } elseif ($this->placeholder) {
            return $this->getPlaceholderUrl($profile);
        } else {
            return null;
        }
    }

    /**
     * @param $profile
     * @return string
     */
    protected function getPlaceholderUrl($profile)
    {
        list ($path, $url) = Yii::$app->assetManager->publish($this->placeholder);
        $filename = basename($path);
        $thumb = $this->getThumbFileName($filename, $profile);
        $thumbPath = dirname($path) . DIRECTORY_SEPARATOR . $thumb;
        $thumbUrl = dirname($url) . '/' . $thumb;

        if (!is_file($thumbPath)) {
            $this->generateImageThumb($this->thumbs[$profile], $path, $thumbPath);
        }

        return $thumbUrl;
    }

    /**
     * @inheritdoc
     */
    protected function delete($attribute, $old = false)
    {
        parent::delete($attribute, $old);

        $profiles = array_keys($this->thumbs);
        foreach ($profiles as $profile) {
            $path = $this->getThumbUploadPath($attribute, $profile, $old);
            if (is_file($path)) {
                unlink($path);
            }
        }
    }

    /**
     * @param $filename
     * @param string $profile
     * @return string
     */
    protected function getThumbFileName($filename, $profile = 'thumb')
    {
        return $profile . '-' . $filename;
    }

    /**
     * @param $config
     * @param $path
     * @param $thumbPath
     */
    protected function generateImageThumb($config, $path, $thumbPath)
    {
        $width = ArrayHelper::getValue($config, 'width');
        $height = ArrayHelper::getValue($config, 'height');
        $quality = ArrayHelper::getValue($config, 'quality', 100);
        $mode = ArrayHelper::getValue($config, 'mode', ManipulatorInterface::THUMBNAIL_INSET);
        $bg_color = ArrayHelper::getValue($config, 'bg_color', 'FFF');

        if (!$width || !$height) {
            $image = Image::getImagine()->open($path);
            $ratio = $image->getSize()->getWidth() / $image->getSize()->getHeight();
            if ($width) {
                $height = ceil($width / $ratio);
            } else {
                $width = ceil($height * $ratio);
            }
        }

        // Fix error "PHP GD Allowed memory size exhausted".
        ini_set('memory_limit', '512M');
        Image::$thumbnailBackgroundColor = $bg_color;
        Image::thumbnail($path, $width, $height, $mode)->save($thumbPath, ['quality' => $quality]);
    }
}


1			<?php
2
3			namespace mohorev\file;
4
5			use Imagine\Image\ManipulatorInterface;
6			use Yii;
7			use yii\base\InvalidArgumentException;
8			use yii\base\InvalidConfigException;
9			use yii\base\NotSupportedException;
10			use yii\db\BaseActiveRecord;
11			use yii\helpers\ArrayHelper;
12			use yii\helpers\FileHelper;
13			use yii\imagine\Image;
14
15			/**
16			* UploadImageBehavior automatically uploads image, creates thumbnails and fills
17			* the specified attribute with a value of the name of the uploaded image.
18			*
19			* To use UploadImageBehavior, insert the following code to your ActiveRecord class:
20			*
21			* ```php
22			* use mohorev\file\UploadImageBehavior;
23			*
24			* function behaviors()
25			* {
26			* return [
27			* [
28			* 'class' => UploadImageBehavior::class,
29			* 'attribute' => 'file',
30			* 'scenarios' => ['insert', 'update'],
31			* 'placeholder' => '@app/modules/user/assets/images/userpic.jpg',
32			* 'path' => '@webroot/upload/{id}/images',
33			* 'url' => '@web/upload/{id}/images',
34			* 'thumbPath' => '@webroot/upload/{id}/images/thumb',
35			* 'thumbUrl' => '@web/upload/{id}/images/thumb',
36			* 'thumbs' => [
37			* 'thumb' => ['width' => 400, 'quality' => 90],
38			* 'preview' => ['width' => 200, 'height' => 200],
39			* ],
40			* ],
41			* ];
42			* }
43			* ```
44			*
45			* @author Alexander Mohorev <[email protected]>
46			* @author Alexey Samoylov <[email protected]>
47			*/
48			class UploadImageBehavior extends UploadBehavior
49			{
50			/**
51			* @var string
52			*/
53			public $placeholder;
54			/**
55			* @var boolean
56			*/
57			public $createThumbsOnSave = true;
58			/**
59			* @var boolean
60			*/
61			public $createThumbsOnRequest = false;
62			/**
63			* Whether delete original uploaded image after thumbs generating.
64			* Defaults to FALSE
65			* @var boolean
66			*/
67			public $deleteOriginalFile = false;
68			/**
69			* @var array the thumbnail profiles
70			* - `width`
71			* - `height`
72			* - `quality`
73			*/
74			public $thumbs = [
75			'thumb' => ['width' => 200, 'height' => 200, 'quality' => 90],
76			];
77			/**
78			* @var string\|null
79			*/
80			public $thumbPath;
81			/**
82			* @var string\|null
83			*/
84			public $thumbUrl;
85
86
87			/**
88			* @inheritdoc
89			*/
90			public function init()
91			{
92			if (!class_exists(Image::class)) {
93			throw new NotSupportedException("Yii2-imagine extension is required to use the UploadImageBehavior");
94			}
95
96			parent::init();
97
98			if ($this->createThumbsOnSave \|\| $this->createThumbsOnRequest) {
99			if ($this->thumbPath === null) {
100			$this->thumbPath = $this->path;
101			}
102			if ($this->thumbUrl === null) {
103			$this->thumbUrl = $this->url;
104			}
105
106			foreach ($this->thumbs as $config) {
107			$width = ArrayHelper::getValue($config, 'width');
108			$height = ArrayHelper::getValue($config, 'height');
109			if ($height < 1 && $width < 1) {
110			throw new InvalidConfigException(sprintf(
111			'Length of either side of thumb cannot be 0 or negative, current size ' .
112			'is %sx%s', $width, $height
113			));
114			}
115			}
116			}
117			}
118
119			/**
120			* @inheritdoc
121			*/
122			protected function afterUpload()
123			{
124			parent::afterUpload();
125			if ($this->createThumbsOnSave) {
126			$this->createThumbs();
127			}
128			}
129
130			/**
131			* @throws \yii\base\InvalidArgumentException
132			*/
133			protected function createThumbs()
134			{
135			$path = $this->getUploadPath($this->attribute);
136			if (!is_file($path)) {
137			return;
138			}
139
140			foreach ($this->thumbs as $profile => $config) {
141			$thumbPath = $this->getThumbUploadPath($this->attribute, $profile);
142			if ($thumbPath !== null) {
143			if (!FileHelper::createDirectory(dirname($thumbPath))) {
144			throw new InvalidArgumentException(
145			"Directory specified in 'thumbPath' attribute doesn't exist or cannot be created."
146			);
147			}
148			if (!is_file($thumbPath)) {
149			$this->generateImageThumb($config, $path, $thumbPath);
150			}
151			}
152			}
153
154			if ($this->deleteOriginalFile) {
155			parent::delete($this->attribute);
			0 ignored issues – show Comprehensibility Bug introduced 2018-08-08 18:03 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`delete()` instead of `createThumbs()`). Are you sure this is correct? If so, you might want to change this to `$this->delete()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
156			}
157			}
158
159			/**
160			* @param string $attribute
161			* @param string $profile
162			* @param boolean $old
163			* @return string
164			*/
165			public function getThumbUploadPath($attribute, $profile = 'thumb', $old = false)
166			{
167			/** @var BaseActiveRecord $model */
168			$model = $this->owner;
169			$path = $this->resolvePath($this->thumbPath);
170			$attribute = ($old === true) ? $model->getOldAttribute($attribute) : $model->$attribute;
171			$filename = $this->getThumbFileName($attribute, $profile);
172
173			return $filename ? Yii::getAlias($path . '/' . $filename) : null;
174			}
175
176			/**
177			* @param string $attribute
178			* @param string $profile
179			* @return string\|null
180			*/
181			public function getThumbUploadUrl($attribute, $profile = 'thumb')
182			{
183			/** @var BaseActiveRecord $model */
184			$model = $this->owner;
185
186			if ($this->createThumbsOnRequest) {
187			$this->createThumbs();
188			}
189
190			if (is_file($this->getThumbUploadPath($attribute, $profile))) {
191			$url = $this->resolvePath($this->thumbUrl);
192			$fileName = $model->getOldAttribute($attribute);
193			$thumbName = $this->getThumbFileName($fileName, $profile);
194
195			return Yii::getAlias($url . '/' . $thumbName);
196			} elseif ($this->placeholder) {
197			return $this->getPlaceholderUrl($profile);
198			} else {
199			return null;
200			}
201			}
202
203			/**
204			* @param $profile
205			* @return string
206			*/
207			protected function getPlaceholderUrl($profile)
208			{
209			list ($path, $url) = Yii::$app->assetManager->publish($this->placeholder);
210			$filename = basename($path);
211			$thumb = $this->getThumbFileName($filename, $profile);
212			$thumbPath = dirname($path) . DIRECTORY_SEPARATOR . $thumb;
213			$thumbUrl = dirname($url) . '/' . $thumb;
214
215			if (!is_file($thumbPath)) {
216			$this->generateImageThumb($this->thumbs[$profile], $path, $thumbPath);
217			}
218
219			return $thumbUrl;
220			}
221
222			/**
223			* @inheritdoc
224			*/
225			protected function delete($attribute, $old = false)
226			{
227			parent::delete($attribute, $old);
228
229			$profiles = array_keys($this->thumbs);
230			foreach ($profiles as $profile) {
231			$path = $this->getThumbUploadPath($attribute, $profile, $old);
232			if (is_file($path)) {
233			unlink($path);
234			}
235			}
236			}
237
238			/**
239			* @param $filename
240			* @param string $profile
241			* @return string
242			*/
243			protected function getThumbFileName($filename, $profile = 'thumb')
244			{
245			return $profile . '-' . $filename;
246			}
247
248			/**
249			* @param $config
250			* @param $path
251			* @param $thumbPath
252			*/
253			protected function generateImageThumb($config, $path, $thumbPath)
254			{
255			$width = ArrayHelper::getValue($config, 'width');
256			$height = ArrayHelper::getValue($config, 'height');
257			$quality = ArrayHelper::getValue($config, 'quality', 100);
258			$mode = ArrayHelper::getValue($config, 'mode', ManipulatorInterface::THUMBNAIL_INSET);
259			$bg_color = ArrayHelper::getValue($config, 'bg_color', 'FFF');
260
261			if (!$width \|\| !$height) {
262			$image = Image::getImagine()->open($path);
263			$ratio = $image->getSize()->getWidth() / $image->getSize()->getHeight();
264			if ($width) {
265			$height = ceil($width / $ratio);
266			} else {
267			$width = ceil($height * $ratio);
268			}
269			}
270
271			// Fix error "PHP GD Allowed memory size exhausted".
272			ini_set('memory_limit', '512M');
273			Image::$thumbnailBackgroundColor = $bg_color;
274			Image::thumbnail($path, $width, $height, $mode)->save($thumbPath, ['quality' => $quality]);
275			}
276			}
277

mohorev / yii2-upload-behavior

GitHub Access Token became invalid

UploadImageBehavior::getPlaceholderUrl() A last analyzed 2018-08-10 08:00 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

UploadImageBehavior::getPlaceholderUrl() A
last analyzed 2018-08-10 08:00 UTC