ImageWrapper::watermark() - Code Metrics - Inspection of "Update scrutinizer config" - rmrevin/yii2-file - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 37e935...df2e82 )

by Revin

created 2016-04-28 13:41 UTC

ImageWrapper::watermark() A

↳ Parent: ImageWrapper

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
cc	1
eloc	6
nc	1
nop	2
crap	1

<?php
/**
 * ImageWrapper.php
 * @author Revin Roman http://phptime.ru
 */

namespace rmrevin\yii\module\File;

use Imagine\Image\ImageInterface;
use Imagine\Image\ManipulatorInterface;
use rmrevin\yii\module\File\component\Image;
use rmrevin\yii\module\File\models\File;
use yii\helpers\FileHelper;
use yii\helpers\Json;
use yii\helpers\StringHelper;

/**
 * Class ImageWrapper
 * @package rmrevin\yii\module\File
 */
class ImageWrapper extends \yii\base\Object
{

    /** @var \rmrevin\yii\module\File\models\File */
    public $File = null;

    /** @var array */
    public $result = [null, null];

    /** @var array */
    private $mark = [];

    /**
     * @param \rmrevin\yii\module\File\models\File $File
     * @return self
     */
    public static function load(File $File)
    {
        return new self(['File' => $File]);
    }

    /**
     * @return string
     */
    public function __toString()
    {
        return (string)$this->result[1];
    }

    /**
     * @param callable $handler
     */
    public function save($handler)
    {
        $mark = $this->calculateMark();

        $this->result = $this->getMarkedFilePath($mark);

        if (!file_exists($this->result[0])) {
            \Yii::trace('create new file cache:' . $this->File->id, __METHOD__);
            $this->createMarkedFile($handler(), $mark);
        } else {
            \Yii::trace('file already cached:' . $this->File->id . ' (' . Json::encode($this->mark) . ')', __METHOD__);
        }

        \Yii::endProfile('manipulating with file `' . $this->File->id . '`', 'services\File\models\File');
    }

    /**
     * @param integer $width
     * @param integer $height
     * @param string $filter
     * @return self
     */
    public function resize($width, $height, $filter = ImageInterface::FILTER_UNDEFINED)

    {
        \Yii::trace('resize file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($width, $height, $filter) {
            return Image::resize($this->File->getAbsolutePath(), $width, $height, $filter);
        });

        return $this;
    }

    /**
     * @param integer $width
     * @param string $filter
     * @return self
     */
    public function resizeByWidth($width, $filter = ImageInterface::FILTER_UNDEFINED)

    {
        \Yii::trace('resizeByWidth file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($width, $filter) {
            return Image::resizeByWidth($this->File->getAbsolutePath(), $width, $filter);
        });

        return $this;

    }

    /**
     * @param integer $height
     * @param string $filter
     * @return self
     */
    public function resizeByHeight($height, $filter = ImageInterface::FILTER_UNDEFINED)

    {
        \Yii::trace('resizeByHeight file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($height, $filter) {
            return Image::resizeByHeight($this->File->getAbsolutePath(), $height, $filter);
        });

        return $this;
    }

    /**
     * @param integer $width
     * @param integer $height
     * @param array $start
     * @return self
     */
    public function crop($width, $height, array $start = [0, 0])

    {
        \Yii::trace('crop file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($width, $height, $start) {
            return Image::crop($this->File->getAbsolutePath(), $width, $height, $start);
        });

        return $this;
    }

    /**
     * @param integer $width
     * @param integer $height
     * @param string $mode
     * @return self
     */
    public function thumbnail($width, $height, $mode = ManipulatorInterface::THUMBNAIL_OUTBOUND)

    {
        \Yii::trace('thumbnail file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($width, $height, $mode) {
            return Image::thumbnail($this->File->getAbsolutePath(), $width, $height, $mode);
        });

        return $this;
    }

    /**
     * @param string $watermarkFilename
     * @param array $start
     * @return self
     */
    public function watermark($watermarkFilename, array $start = [0, 0])
    {
        \Yii::trace('watermark file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($watermarkFilename, $start) {
            return Image::watermark($this->File->getAbsolutePath(), $watermarkFilename, $start);
        });

        return $this;
    }

    /**
     * @param string $text
     * @param string $fontFile
     * @param array $start
     * @param array $fontOptions
     * @return self
     */
    public function text($text, $fontFile, array $start = [0, 0], array $fontOptions = [])

    {
        \Yii::trace('text file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($text, $fontFile, $start, $fontOptions) {
            return Image::text($this->File->getAbsolutePath(), $text, $fontFile, $start, $fontOptions);
        });

        return $this;
    }

    /**
     * @param int $margin
     * @param string $color
     * @param int $alpha
     * @return self
     */
    public function frame($margin = 20, $color = '666', $alpha = 100)
    {
        \Yii::trace('frame file', __METHOD__);

        $this->mark(__METHOD__, func_get_args());
        $this->save(function () use ($margin, $color, $alpha) {
            return Image::frame($this->File->getAbsolutePath(), $margin, $color, $alpha);
        });

        return $this;
    }

    /**
     * @return string[]
     */
    private function getPath()
    {
        $filename = basename($this->File->name);
        $p1 = StringHelper::byteSubstr($filename, 0, 2);
        $p2 = StringHelper::byteSubstr($filename, 2, 2);
        $p = DIRECTORY_SEPARATOR . $p1 . DIRECTORY_SEPARATOR . $p2;

        return [
            Module::module()->storage_path . $p,
            Module::module()->storage_web_path . $p
        ];
    }

    /**
     * @param string $mark
     * @return string[]
     */
    private function getMarkedFilePath($mark)
    {
        \Yii::trace('calculate mark file path', __METHOD__);

        $ext = pathinfo($this->File->name, PATHINFO_EXTENSION);

        list($path, $web_path) = $this->getPath();
        $mark_file_path = $path . DIRECTORY_SEPARATOR . $mark . '.' . $ext;
        $mark_file_web_path = $web_path . '/' . $mark . '.' . $ext;

        return [$mark_file_path, $mark_file_web_path];
    }

    /**
     * @param \Imagine\Image\ImageInterface $Image
     * @param string $mark
     */
    private function createMarkedFile(ImageInterface $Image, $mark)
    {
        \Yii::beginProfile('create cache file:' . $this->File->id, __METHOD__);

        list($mark_file_path, $mark_file_web_path) = $this->getMarkedFilePath($mark);
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

        $mark_dir_path = dirname($mark_file_path);
        if (!file_exists($mark_dir_path) || !is_dir($mark_dir_path)) {
            FileHelper::createDirectory($mark_dir_path);
        }

        $Image->save($mark_file_path, ['quality' => 90]);
        @chmod($mark_file_path, 0664);
// For example instead of
@mkdir($dir);

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

        \Yii::endProfile('create cache file:' . $this->File->id, __METHOD__);
    }


    /**
     * @param string $method
     * @param array $data
     */
    private function mark($method, array $data)

    {
        $this->mark = func_get_args();
    }

    /**
     * @return string
     */
    private function calculateMark()
    {
        return sha1(Json::encode($this->mark));
    }
}

1			<?php
2			/**
3			* ImageWrapper.php
4			* @author Revin Roman http://phptime.ru
5			*/
6
7			namespace rmrevin\yii\module\File;
8
9			use Imagine\Image\ImageInterface;
10			use Imagine\Image\ManipulatorInterface;
11			use rmrevin\yii\module\File\component\Image;
12			use rmrevin\yii\module\File\models\File;
13			use yii\helpers\FileHelper;
14			use yii\helpers\Json;
15			use yii\helpers\StringHelper;
16
17			/**
18			* Class ImageWrapper
19			* @package rmrevin\yii\module\File
20			*/
21			class ImageWrapper extends \yii\base\Object
22			{
23
24			/** @var \rmrevin\yii\module\File\models\File */
25			public $File = null;
26
27			/** @var array */
28			public $result = [null, null];
29
30			/** @var array */
31			private $mark = [];
32
33			/**
34			* @param \rmrevin\yii\module\File\models\File $File
35			* @return self
36			*/
37	4		public static function load(File $File)
38			{
39	4		return new self(['File' => $File]);
40			}
41
42			/**
43			* @return string
44			*/
45	1		public function __toString()
46			{
47	1		return (string)$this->result[1];
48			}
49
50			/**
51			* @param callable $handler
52			*/
53	1		public function save($handler)
54			{
55	1		$mark = $this->calculateMark();
56
57	1		$this->result = $this->getMarkedFilePath($mark);
58
59	1		if (!file_exists($this->result[0])) {
60	1		\Yii::trace('create new file cache:' . $this->File->id, __METHOD__);
61	1		$this->createMarkedFile($handler(), $mark);
62	1		} else {
63	1		\Yii::trace('file already cached:' . $this->File->id . ' (' . Json::encode($this->mark) . ')', __METHOD__);
64			}
65
66	1		\Yii::endProfile('manipulating with file `' . $this->File->id . '`', 'services\File\models\File');
67	1		}
68
69			/**
70			* @param integer $width
71			* @param integer $height
72			* @param string $filter
73			* @return self
74			*/
75	1	View Code Duplication	public function resize($width, $height, $filter = ImageInterface::FILTER_UNDEFINED)
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
76			{
77	1		\Yii::trace('resize file', __METHOD__);
78
79	1		$this->mark(__METHOD__, func_get_args());
80			$this->save(function () use ($width, $height, $filter) {
81	1		return Image::resize($this->File->getAbsolutePath(), $width, $height, $filter);
82	1		});
83
84	1		return $this;
85			}
86
87			/**
88			* @param integer $width
89			* @param string $filter
90			* @return self
91			*/
92	1	View Code Duplication	public function resizeByWidth($width, $filter = ImageInterface::FILTER_UNDEFINED)
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
93			{
94	1		\Yii::trace('resizeByWidth file', __METHOD__);
95
96	1		$this->mark(__METHOD__, func_get_args());
97			$this->save(function () use ($width, $filter) {
98	1		return Image::resizeByWidth($this->File->getAbsolutePath(), $width, $filter);
99	1		});
100
101	1		return $this;
102
103	1		}
104
105			/**
106			* @param integer $height
107			* @param string $filter
108			* @return self
109			*/
110	1	View Code Duplication	public function resizeByHeight($height, $filter = ImageInterface::FILTER_UNDEFINED)
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
111			{
112	1		\Yii::trace('resizeByHeight file', __METHOD__);
113
114	1		$this->mark(__METHOD__, func_get_args());
115			$this->save(function () use ($height, $filter) {
116	1		return Image::resizeByHeight($this->File->getAbsolutePath(), $height, $filter);
117	1		});
118
119	1		return $this;
120			}
121
122			/**
123			* @param integer $width
124			* @param integer $height
125			* @param array $start
126			* @return self
127			*/
128	1	View Code Duplication	public function crop($width, $height, array $start = [0, 0])
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
129			{
130	1		\Yii::trace('crop file', __METHOD__);
131
132	1		$this->mark(__METHOD__, func_get_args());
133			$this->save(function () use ($width, $height, $start) {
134	1		return Image::crop($this->File->getAbsolutePath(), $width, $height, $start);
135	1		});
136
137	1		return $this;
138			}
139
140			/**
141			* @param integer $width
142			* @param integer $height
143			* @param string $mode
144			* @return self
145			*/
146	1	View Code Duplication	public function thumbnail($width, $height, $mode = ManipulatorInterface::THUMBNAIL_OUTBOUND)
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
147			{
148	1		\Yii::trace('thumbnail file', __METHOD__);
149
150	1		$this->mark(__METHOD__, func_get_args());
151			$this->save(function () use ($width, $height, $mode) {
152	1		return Image::thumbnail($this->File->getAbsolutePath(), $width, $height, $mode);
153	1		});
154
155	1		return $this;
156			}
157
158			/**
159			* @param string $watermarkFilename
160			* @param array $start
161			* @return self
162			*/
163	1		public function watermark($watermarkFilename, array $start = [0, 0])
164			{
165	1		\Yii::trace('watermark file', __METHOD__);
166
167	1		$this->mark(__METHOD__, func_get_args());
168			$this->save(function () use ($watermarkFilename, $start) {
169	1		return Image::watermark($this->File->getAbsolutePath(), $watermarkFilename, $start);
170	1		});
171
172	1		return $this;
173			}
174
175			/**
176			* @param string $text
177			* @param string $fontFile
178			* @param array $start
179			* @param array $fontOptions
180			* @return self
181			*/
182	1	View Code Duplication	public function text($text, $fontFile, array $start = [0, 0], array $fontOptions = [])
			0 ignored issues – show Duplication introduced 2016-04-28 13:39 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...
183			{
184	1		\Yii::trace('text file', __METHOD__);
185
186	1		$this->mark(__METHOD__, func_get_args());
187			$this->save(function () use ($text, $fontFile, $start, $fontOptions) {
188	1		return Image::text($this->File->getAbsolutePath(), $text, $fontFile, $start, $fontOptions);
189	1		});
190
191	1		return $this;
192			}
193
194			/**
195			* @param int $margin
196			* @param string $color
197			* @param int $alpha
198			* @return self
199			*/
200	1		public function frame($margin = 20, $color = '666', $alpha = 100)
201			{
202	1		\Yii::trace('frame file', __METHOD__);
203
204	1		$this->mark(__METHOD__, func_get_args());
205	1		$this->save(function () use ($margin, $color, $alpha) {
206	1		return Image::frame($this->File->getAbsolutePath(), $margin, $color, $alpha);
207	1		});
208
209	1		return $this;
210			}
211
212			/**
213			* @return string[]
214			*/
215	1		private function getPath()
216			{
217	1		$filename = basename($this->File->name);
218	1		$p1 = StringHelper::byteSubstr($filename, 0, 2);
219	1		$p2 = StringHelper::byteSubstr($filename, 2, 2);
220	1		$p = DIRECTORY_SEPARATOR . $p1 . DIRECTORY_SEPARATOR . $p2;
221
222			return [
223	1		Module::module()->storage_path . $p,
224	1		Module::module()->storage_web_path . $p
225	1		];
226			}
227
228			/**
229			* @param string $mark
230			* @return string[]
231			*/
232	1		private function getMarkedFilePath($mark)
233			{
234	1		\Yii::trace('calculate mark file path', __METHOD__);
235
236	1		$ext = pathinfo($this->File->name, PATHINFO_EXTENSION);
237
238	1		list($path, $web_path) = $this->getPath();
239	1		$mark_file_path = $path . DIRECTORY_SEPARATOR . $mark . '.' . $ext;
240	1		$mark_file_web_path = $web_path . '/' . $mark . '.' . $ext;
241
242	1		return [$mark_file_path, $mark_file_web_path];
243			}
244
245			/**
246			* @param \Imagine\Image\ImageInterface $Image
247			* @param string $mark
248			*/
249	1		private function createMarkedFile(ImageInterface $Image, $mark)
250			{
251	1		\Yii::beginProfile('create cache file:' . $this->File->id, __METHOD__);
252
253	1		list($mark_file_path, $mark_file_web_path) = $this->getMarkedFilePath($mark);
			0 ignored issues – show Unused Code introduced 2016-04-28 13:39 UTC by Report Bug Copy Issue Report The assignment to `$mark_file_web_path` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
254
255	1		$mark_dir_path = dirname($mark_file_path);
256	1		if (!file_exists($mark_dir_path) \|\| !is_dir($mark_dir_path)) {
257	1		FileHelper::createDirectory($mark_dir_path);
258	1		}
259
260	1		$Image->save($mark_file_path, ['quality' => 90]);
261	1		@chmod($mark_file_path, 0664);
			0 ignored issues – show Security Best Practice introduced 2016-04-28 13:39 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...
262
263	1		\Yii::endProfile('create cache file:' . $this->File->id, __METHOD__);
264	1		}
265
266
267			/**
268			* @param string $method
269			* @param array $data
270			*/
271	1		private function mark($method, array $data)
			0 ignored issues – show Unused Code introduced 2016-04-28 13:39 UTC by Report Bug Copy Issue Report The parameter `$method` 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... Unused Code introduced 2016-04-28 13:39 UTC by Report Bug Copy Issue Report The parameter `$data` 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...
272			{
273	1		$this->mark = func_get_args();
274	1		}
275
276			/**
277			* @return string
278			*/
279	1		private function calculateMark()
280			{
281	1		return sha1(Json::encode($this->mark));
282			}
283			}

rmrevin / yii2-file

Push — master ( 37e935...df2e82 )

ImageWrapper::watermark() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like