Code Coverage - ProcessFast/yii2-minify-view - Measure and Improve Code Quality continuously with Scrutinizer

Code

View.php

< 40 %

40-60 %

> 60 %

<?php
/**
 * View.php
 * @author Revin Roman
 * @link https://processfast.ru
 */

namespace processfast\yii\minify;

use yii\base\Event;
use yii\helpers\FileHelper;
use yii\web\AssetBundle;
use yii\web\Response;



/**
 * Class View
 * @package processfast\yii\minify
 */
class View extends \yii\web\View
{

    /**
     * @var bool
     */
    public $enableMinify = true;

    /**
     * @var string filemtime or sha1
     */
    public $fileCheckAlgorithm = 'sha1';

    /**
     * @var bool
     */
    public $concatCss = true;

    /**
     * @var bool
     */
    public $minifyCss = true;

    /**
     * @var bool
     */
    public $concatJs = true;

    /**
     * @var bool
     */
    public $minifyJs = true;

    /**
     * @var bool
     */
    public $minifyOutput = false;

    /**
     * @var bool
     */
    public $removeComments = true;

    /**
     * @deprecated
     * @var string path alias to web base (in url)
     */
    public $web_path = '@web';

    /**
     * @var string path alias to web base (in url)
     */
    public $webPath;

    /**
     * @deprecated
     * @var string path alias to web base (absolute)
     */
    public $base_path = '@webroot';

    /**
     * @var string path alias to web base (absolute)
     */
    public $basePath;

    /**
     * @deprecated
     * @var string path alias to save minify result
     */
    public $minify_path = '@webroot/minify';

    /**
     * @var string path alias to save minify result
     */
    public $minifyPath;

    /**
     * @deprecated
     * @var array positions of js files to be minified
     */
    public $js_position = [self::POS_END, self::POS_HEAD];

    /**
     * @var array positions of js files to be minified
     */
    public $jsPosition;

    /**
     * @var array options of minified js files
     */
    public $jsOptions = [];

    /**
     * @deprecated
     * @var bool|string charset forcibly assign, otherwise will use all of the files found charset
     */
    public $force_charset = false;

    /**
     * @var bool|string charset forcibly assign, otherwise will use all of the files found charset
     */
    public $forceCharset;

    /**
     * @deprecated
     * @var bool whether to change @import on content
     */
    public $expand_imports = true;

    /**
     * @var bool whether to change @import on content
     */
    public $expandImports;

    /**
     * @deprecated
     * @var int
     */
    public $css_linebreak_pos = 2048;

    /**
     * @var int
     */
    public $cssLinebreakPos;

    /**
     * @deprecated
     * @var int|bool chmod of minified file. If false chmod not set
     */
    public $file_mode = 0664;

    /**
     * @var int|bool chmod of minified file. If false chmod not set
     */
    public $fileMode;

    /**
     * @var array schemes that will be ignored during normalization url
     */
    public $schemas = ['//', 'http://', 'https://', 'ftp://'];

    /**
     * @deprecated
     * @var bool do I need to compress the result html page.
     */
    public $compress_output = false;

    /**
     * @deprecated
     * @var array options for compressing output result
     *   * extra - use more compact algorithm
     *   * no-comments - cut all the html comments
     */
    public $compress_options = ['extra' => true];

    /**
     * @var array options for compressing output result
     *   * extra - use more compact algorithm
     *   * no-comments - cut all the html comments
     */
    public $compressOptions;

    /**
     * @var array
     */
    public $excludeBundles = [];

    /**
     * @var array
     */
    public $excludeFiles = [];

    /**
     * @var boolean
     */
    public $S3Upload = false ;


    /**
     * @var boolean
     */
    public $awsBucket = null ;

    /**
     * @var boolean
     * It is for linking Resource folder to asset files
     * if Resources like images above one folder it should be "../" if two folders above "../../"
     */
    public $assetsFolderPathPatch = null ;


    /*
     * boolean
     * backend checke will help keep assets into root/minify folder instead of root/backend/minifiy for backend
     */
    public $backendCheck = false ;
    /*
     * Folder name where minified files will be kept
     */
    public $folderName = 'minify' ;
    /*
     * will be used at _getSummaryFilesHash will fix path to have same hash value as frontend or backend when files generated from console.
     */
    public $modifyPath = false  ;
    public $modifyPathData = "" ;

    /**
     * This one will be added as JS file prefix while it will be uploaded to S3 bucket
     * @var string
     */
    public $prefixJsFile = "" ;

    /**
     * This one will be added as CSS file prefix while it will be uploaded to S3 bucket
     * @var string
     */
    public $prefixCssFile = "" ;

    /**
     * by the param it will be decided whether to encode content of js files into gzip or not
     * @var bool
     */
    public $gzipEncodeJs = false ;

    /**
     * by the param it will be decided whether to encode content of css files into gzip or not
     * @var bool
     */
    public $gzipEncodeCss = false ;


    /**
     * this will tell the versionNumber of app. It will be included in filename while it will be uploaded to S3 bucket
     * @var string
     */
    public $versionNumber = "";

    /**
     * @throws \processfast\yii\minify\Exception
     */
    public function init()
    {
        parent::init();

        $this->webPath = empty($this->webPath) ? $this->web_path : $this->webPath;
        $this->basePath = empty($this->basePath) ? $this->base_path : $this->basePath;
        $this->minifyPath = empty($this->minifyPath) ? $this->minify_path : $this->minifyPath;
        $this->jsPosition = empty($this->jsPosition) ? $this->js_position : $this->jsPosition;
        $this->forceCharset = empty($this->forceCharset) ? $this->force_charset : $this->forceCharset;
        $this->expandImports = empty($this->expandImports) ? $this->expand_imports : $this->expandImports;
        $this->cssLinebreakPos = empty($this->cssLinebreakPos) ? $this->css_linebreak_pos : $this->cssLinebreakPos;
        $this->fileMode = empty($this->fileMode) ? $this->file_mode : $this->fileMode;
        $this->compressOptions = empty($this->compressOptions) ? $this->compress_options : $this->compressOptions;

        if( $this->backendCheck )
        {
            $appId = \Yii::$app->id ;
            if( $appId == "app-frontend" )
            {
                $this->minifyPath = $this->minifyPath."/".$this->folderName;
            }
            else if( $appId == "app-backend" )
            {
                $this->minifyPath = $this->minifyPath."/../".$this->folderName;
            }
        }

        $excludeBundles = $this->excludeBundles;
        if (!empty($excludeBundles)) {
            foreach ($excludeBundles as $bundle) {
                if (!class_exists($bundle)) {
                    continue;
                }

                /** @var AssetBundle $Bundle */
                $Bundle = new $bundle;

                if (!empty($Bundle->css)) {
                    $this->excludeFiles = array_merge($this->excludeFiles, $Bundle->css);
                }

                if (!empty($Bundle->js)) {
                    $this->excludeFiles = array_merge($this->excludeFiles, $Bundle->js);
                }
            }
        }

        $minify_path = $this->minifyPath = (string)\Yii::getAlias($this->minifyPath);
        if (!file_exists($minify_path)) {
            FileHelper::createDirectory($minify_path);
        }

        if (!is_readable($minify_path)) {
            throw new Exception('Directory for compressed assets is not readable.');
        }

        if (!is_writable($minify_path)) {
            throw new Exception('Directory for compressed assets is not writable.');
        }

        if (true === $this->enableMinify && (true === $this->minifyOutput || true === $this->compress_output)) {
            \Yii::$app->response->on(Response::EVENT_BEFORE_SEND, function (Event $Event) {
                /** @var Response $Response */
                $Response = $Event->sender;

                if ($Response->format === Response::FORMAT_HTML) {
                    if (!empty($Response->data)) {
                        $Response->data = HtmlCompressor::compress($Response->data, $this->compressOptions);
                    }

                    if (!empty($Response->content)) {
                        $Response->content = HtmlCompressor::compress($Response->content, $this->compressOptions);
                    }
                }
            });
        }
    }

    /**
     * @inheritdoc
     */
    public function endBody()
    {
        $this->trigger(self::EVENT_END_BODY);
        echo self::PH_BODY_END;

        foreach (array_keys($this->assetBundles) as $bundle) {
            $this->registerAssetFiles($bundle);
        }

        if (true === $this->enableMinify) {
            (new components\CSS($this))->export();
            (new components\JS($this))->export();
        }
    }
}


1		<?php
2		/**
3		* View.php
4		* @author Revin Roman
5		* @link https://processfast.ru
6		*/
7
8		namespace processfast\yii\minify;
9
10		use yii\base\Event;
11		use yii\helpers\FileHelper;
12		use yii\web\AssetBundle;
13		use yii\web\Response;
14
15
16
17		/**
18		* Class View
19		* @package processfast\yii\minify
20		*/
21		class View extends \yii\web\View
22		{
23
24		/**
25		* @var bool
26		*/
27		public $enableMinify = true;
28
29		/**
30		* @var string filemtime or sha1
31		*/
32		public $fileCheckAlgorithm = 'sha1';
33
34		/**
35		* @var bool
36		*/
37		public $concatCss = true;
38
39		/**
40		* @var bool
41		*/
42		public $minifyCss = true;
43
44		/**
45		* @var bool
46		*/
47		public $concatJs = true;
48
49		/**
50		* @var bool
51		*/
52		public $minifyJs = true;
53
54		/**
55		* @var bool
56		*/
57		public $minifyOutput = false;
58
59		/**
60		* @var bool
61		*/
62		public $removeComments = true;
63
64		/**
65		* @deprecated
66		* @var string path alias to web base (in url)
67		*/
68		public $web_path = '@web';
69
70		/**
71		* @var string path alias to web base (in url)
72		*/
73		public $webPath;
74
75		/**
76		* @deprecated
77		* @var string path alias to web base (absolute)
78		*/
79		public $base_path = '@webroot';
80
81		/**
82		* @var string path alias to web base (absolute)
83		*/
84		public $basePath;
85
86		/**
87		* @deprecated
88		* @var string path alias to save minify result
89		*/
90		public $minify_path = '@webroot/minify';
91
92		/**
93		* @var string path alias to save minify result
94		*/
95		public $minifyPath;
96
97		/**
98		* @deprecated
99		* @var array positions of js files to be minified
100		*/
101		public $js_position = [self::POS_END, self::POS_HEAD];
102
103		/**
104		* @var array positions of js files to be minified
105		*/
106		public $jsPosition;
107
108		/**
109		* @var array options of minified js files
110		*/
111		public $jsOptions = [];
112
113		/**
114		* @deprecated
115		* @var bool\|string charset forcibly assign, otherwise will use all of the files found charset
116		*/
117		public $force_charset = false;
118
119		/**
120		* @var bool\|string charset forcibly assign, otherwise will use all of the files found charset
121		*/
122		public $forceCharset;
123
124		/**
125		* @deprecated
126		* @var bool whether to change @import on content
127		*/
128		public $expand_imports = true;
129
130		/**
131		* @var bool whether to change @import on content
132		*/
133		public $expandImports;
134
135		/**
136		* @deprecated
137		* @var int
138		*/
139		public $css_linebreak_pos = 2048;
140
141		/**
142		* @var int
143		*/
144		public $cssLinebreakPos;
145
146		/**
147		* @deprecated
148		* @var int\|bool chmod of minified file. If false chmod not set
149		*/
150		public $file_mode = 0664;
151
152		/**
153		* @var int\|bool chmod of minified file. If false chmod not set
154		*/
155		public $fileMode;
156
157		/**
158		* @var array schemes that will be ignored during normalization url
159		*/
160		public $schemas = ['//', 'http://', 'https://', 'ftp://'];
161
162		/**
163		* @deprecated
164		* @var bool do I need to compress the result html page.
165		*/
166		public $compress_output = false;
167
168		/**
169		* @deprecated
170		* @var array options for compressing output result
171		* * extra - use more compact algorithm
172		* * no-comments - cut all the html comments
173		*/
174		public $compress_options = ['extra' => true];
175
176		/**
177		* @var array options for compressing output result
178		* * extra - use more compact algorithm
179		* * no-comments - cut all the html comments
180		*/
181		public $compressOptions;
182
183		/**
184		* @var array
185		*/
186		public $excludeBundles = [];
187
188		/**
189		* @var array
190		*/
191		public $excludeFiles = [];
192
193		/**
194		* @var boolean
195		*/
196		public $S3Upload = false ;
197
198
199		/**
200		* @var boolean
201		*/
202		public $awsBucket = null ;
203
204		/**
205		* @var boolean
206		* It is for linking Resource folder to asset files
207		* if Resources like images above one folder it should be "../" if two folders above "../../"
208		*/
209		public $assetsFolderPathPatch = null ;
210
211
212		/*
213		* boolean
214		* backend checke will help keep assets into root/minify folder instead of root/backend/minifiy for backend
215		*/
216		public $backendCheck = false ;
217		/*
218		* Folder name where minified files will be kept
219		*/
220		public $folderName = 'minify' ;
221		/*
222		* will be used at _getSummaryFilesHash will fix path to have same hash value as frontend or backend when files generated from console.
223		*/
224		public $modifyPath = false ;
225		public $modifyPathData = "" ;
226
227		/**
228		* This one will be added as JS file prefix while it will be uploaded to S3 bucket
229		* @var string
230		*/
231		public $prefixJsFile = "" ;
232
233		/**
234		* This one will be added as CSS file prefix while it will be uploaded to S3 bucket
235		* @var string
236		*/
237		public $prefixCssFile = "" ;
238
239		/**
240		* by the param it will be decided whether to encode content of js files into gzip or not
241		* @var bool
242		*/
243		public $gzipEncodeJs = false ;
244
245		/**
246		* by the param it will be decided whether to encode content of css files into gzip or not
247		* @var bool
248		*/
249		public $gzipEncodeCss = false ;
250
251
252		/**
253		* this will tell the versionNumber of app. It will be included in filename while it will be uploaded to S3 bucket
254		* @var string
255		*/
256		public $versionNumber = "";
257
258		/**
259		* @throws \processfast\yii\minify\Exception
260		*/
261	10	public function init()
262		{
263	10	parent::init();
264
265	10	$this->webPath = empty($this->webPath) ? $this->web_path : $this->webPath;
266	10	$this->basePath = empty($this->basePath) ? $this->base_path : $this->basePath;
267	10	$this->minifyPath = empty($this->minifyPath) ? $this->minify_path : $this->minifyPath;
268	10	$this->jsPosition = empty($this->jsPosition) ? $this->js_position : $this->jsPosition;
269	10	$this->forceCharset = empty($this->forceCharset) ? $this->force_charset : $this->forceCharset;
270	10	$this->expandImports = empty($this->expandImports) ? $this->expand_imports : $this->expandImports;
271	10	$this->cssLinebreakPos = empty($this->cssLinebreakPos) ? $this->css_linebreak_pos : $this->cssLinebreakPos;
272	10	$this->fileMode = empty($this->fileMode) ? $this->file_mode : $this->fileMode;
273	10	$this->compressOptions = empty($this->compressOptions) ? $this->compress_options : $this->compressOptions;
274
275	10	if( $this->backendCheck )
276	10	{
277		$appId = \Yii::$app->id ;
278		if( $appId == "app-frontend" )
279		{
280		$this->minifyPath = $this->minifyPath."/".$this->folderName;
281		}
282		else if( $appId == "app-backend" )
283		{
284		$this->minifyPath = $this->minifyPath."/../".$this->folderName;
285		}
286		}
287
288	10	$excludeBundles = $this->excludeBundles;
289	10	if (!empty($excludeBundles)) {
290	1	foreach ($excludeBundles as $bundle) {
291	1	if (!class_exists($bundle)) {
292		continue;
293		}
294
295		/** @var AssetBundle $Bundle */
296	1	$Bundle = new $bundle;
297
298	1	if (!empty($Bundle->css)) {
299	1	$this->excludeFiles = array_merge($this->excludeFiles, $Bundle->css);
300	1	}
301
302	1	if (!empty($Bundle->js)) {
303	1	$this->excludeFiles = array_merge($this->excludeFiles, $Bundle->js);
304	1	}
305	1	}
306	1	}
307
308	10	$minify_path = $this->minifyPath = (string)\Yii::getAlias($this->minifyPath);
309	10	if (!file_exists($minify_path)) {
310	10	FileHelper::createDirectory($minify_path);
311	10	}
312
313	10	if (!is_readable($minify_path)) {
314		throw new Exception('Directory for compressed assets is not readable.');
315		}
316
317	10	if (!is_writable($minify_path)) {
318		throw new Exception('Directory for compressed assets is not writable.');
319		}
320
321	10	if (true === $this->enableMinify && (true === $this->minifyOutput \|\| true === $this->compress_output)) {
322		\Yii::$app->response->on(Response::EVENT_BEFORE_SEND, function (Event $Event) {
323		/** @var Response $Response */
324		$Response = $Event->sender;
325
326		if ($Response->format === Response::FORMAT_HTML) {
327		if (!empty($Response->data)) {
328		$Response->data = HtmlCompressor::compress($Response->data, $this->compressOptions);
329		}
330
331		if (!empty($Response->content)) {
332		$Response->content = HtmlCompressor::compress($Response->content, $this->compressOptions);
333		}
334		}
335		});
336		}
337	10	}
338
339		/**
340		* @inheritdoc
341		*/
342	8	public function endBody()
343		{
344	8	$this->trigger(self::EVENT_END_BODY);
345	8	echo self::PH_BODY_END;
346
347	8	foreach (array_keys($this->assetBundles) as $bundle) {
348	8	$this->registerAssetFiles($bundle);
349	8	}
350
351	8	if (true === $this->enableMinify) {
352	8	(new components\CSS($this))->export();
353	8	(new components\JS($this))->export();
354	8	}
355	8	}
356		}
357

ProcessFast / yii2-minify-view

Code