BladeProvider::clearCache() - Code Metrics - Inspection of "Update README.md" - arrilot/bitrix-blade - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 346a11...166086 )

by Nekrasov

created 2020-09-03 20:06 UTC

BladeProvider::clearCache() A

↳ Parent: BladeProvider

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
nc	5
nop	0
dl	0
loc	21
rs	9.2728
c	0
b	0
f	0

<?php

namespace Arrilot\BitrixBlade;

use Bitrix\Main\Config\Configuration;
use ErrorException;
use Illuminate\Container\Container;
use Illuminate\Contracts\View\Factory;
use RuntimeException;

class BladeProvider
{
    /**
     * Path to a folder view common view can be stored.
     *
     * @var string
     */
    protected static $baseViewPath;

    /**
     * Local path to blade cache storage.
     *
     * @var string
     */
    protected static $cachePath;

    /**
     * View factory.
     *
     * @var Factory
     */
    protected static $viewFactory;

    /**
     * Service container factory.
     *
     * @var Container
     */
    protected static $container;

    /**
     * Register blade engine in Bitrix.
     */
    public static function register()
    {
        $bitrixConfig = Configuration::getValue('bitrix-blade');
        $baseViewPath = isset($bitrixConfig['baseViewPath']) ? $bitrixConfig['baseViewPath'] : 'local/views';
        $cachePath = isset($bitrixConfig['cachePath']) ? $bitrixConfig['cachePath'] : 'local/cache/blade';

        static::$baseViewPath = static::isAbsolutePath($baseViewPath) ? $baseViewPath : $_SERVER['DOCUMENT_ROOT'].'/'.$baseViewPath;
        static::$cachePath = static::isAbsolutePath($cachePath) ? $cachePath : $_SERVER['DOCUMENT_ROOT'].'/'.$cachePath;
        static::instantiateServiceContainer();
        static::instantiateViewFactory();
        static::registerBitrixDirectives();

        global $arCustomTemplateEngines;
        $arCustomTemplateEngines['blade'] = [
            'templateExt' => ['blade'],
            'function'    => 'renderBladeTemplate',
        ];
    }

    protected static function isAbsolutePath($path)
    {
        return $path && ($path[0] === DIRECTORY_SEPARATOR || preg_match('~\A[A-Z]:(?![^/\\\\])~i', $path) > 0);
    }

    /**
     * Get view factory.
     *
     * @return Factory
     */
    public static function getViewFactory()
    {
        return static::$viewFactory;
    }

    /**
     * @return BladeCompiler
     */
    public static function getCompiler()
    {
        return static::$container['blade.compiler'];
    }

    /**
     * Clear all compiled view files.
     */
    public static function clearCache()
    {
        $path = static::$cachePath;

        if (!$path) {
            throw new RuntimeException('Cache path is empty');
        }

        $success = true;
        foreach (glob("{$path}/*") as $view) {
            try {
                if (!@unlink($view)) {
                    $success = false;
                }
            } catch (ErrorException $e) {
                $success = false;
            }
        }

        return $success;
    }

    /**
     * Update paths where blade tries to find additional views.
     *
     * @param string $templateDir
     */
    public static function addTemplateFolderToViewPaths($templateDir)
    {
        $finder = Container::getInstance()->make('view.finder');

        $currentPaths = $finder->getPaths();
        $newPaths = [$_SERVER['DOCUMENT_ROOT'].$templateDir];

        // Полностью перезаписывать пути нельзя, иначе вложенные компоненты + include перестанут работать.
        $newPaths = array_values(array_unique(array_merge($newPaths, $currentPaths)));
        if (!in_array(static::$baseViewPath, $newPaths)) {
            $newPaths[] = static::$baseViewPath;
        }

        // Необходимо очистить внутренний кэш ViewFinder-а
        // Потому что иначе если в родительском компоненте есть @include('foo'), то при вызове @include('foo') из дочернего,
        // он не будет искать foo в дочернем, а сразу подключит foo из родительского компонента
        $finder->flush();

        $finder->setPaths($newPaths);
    }

    /**
     * Undo addTemplateFolderToViewPaths
     *
     * @param string $templateDir
     */
    public static function removeTemplateFolderFromViewPaths($templateDir)
    {
        $finder = Container::getInstance()->make('view.finder');
        $currentPaths = $finder->getPaths();
        $finder->setPaths(array_diff($currentPaths, [$_SERVER['DOCUMENT_ROOT'].$templateDir] ));

        // Необходимо очистить внутренний кэш ViewFinder-а
        // Потому что иначе если в дочернем компоненте есть @include('foo'), то при вызове @include('foo') в родительском
        // после подключения дочернего,
        // он не будет искать foo в родительском, а сразу подключит foo из дочернего компонента
        $finder->flush();
    }

    /**
     * Instantiate service container if it's not instantiated yet.
     */
    protected static function instantiateServiceContainer()
    {
        $container = Container::getInstance();

        if (!$container) {
            $container = new Container();
            Container::setInstance($container);
        }

        static::$container = $container;
    }

    /**
     * Instantiate view factory.
     */
    protected static function instantiateViewFactory()
    {
        static::createDirIfNotExist(static::$baseViewPath);
        static::createDirIfNotExist(static::$cachePath);

        $viewPaths = [
            static::$baseViewPath,
        ];
        $cache = static::$cachePath;

        $blade = new Blade($viewPaths, $cache, static::$container);

        static::$viewFactory = $blade->view();
        static::$viewFactory->addExtension('blade', 'blade');
    }

    /**
     * Create dir if it does not exist.
     *
     * @param string $path
     */
    protected static function createDirIfNotExist($path)
    {
        if (!file_exists($path)) {
            $mask = umask(0);
            mkdir($path, 0777, true);
            umask($mask);
        }
    }

    /**
     * Register bitrix directives.
     */
    protected static function registerBitrixDirectives()
    {
        $compiler = static::getCompiler();

        $endIf = function () {
            return '<?php endif; ?>';
        };

        $compiler->directive('component', function ($expression) {
            $expression = rtrim($expression, ')');
            $expression = ltrim($expression, '(');

            return '<?php $APPLICATION->IncludeComponent('.$expression.'); ?>';
        });

        $compiler->directive('bxComponent', function ($expression) {
            $expression = rtrim($expression, ')');
            $expression = ltrim($expression, '(');

            return '<?php $APPLICATION->IncludeComponent('.$expression.'); ?>';
        });

        $compiler->directive('block', function ($expression) {
            $expression = rtrim($expression, ')');
            $expression = ltrim($expression, '(');

            return '<?php ob_start(); $__bx_block = ' . $expression . '; ?>';
        });

        $compiler->directive('endblock', function () {
            return '<?php $APPLICATION->AddViewContent($__bx_block, ob_get_clean()); ?>';
        });

        $compiler->directive('lang', function ($expression) {
            return '<?= Bitrix\Main\Localization\Loc::getMessage('.$expression.') ?>';
        });

        $compiler->directive('auth', function () {
            return '<?php if($USER->IsAuthorized()): ?>';
        });
        $compiler->directive('guest', function () {
            return '<?php if(!$USER->IsAuthorized()): ?>';
        });
        $compiler->directive('admin', function () {
            return '<?php if($USER->IsAdmin()): ?>';
        });
        $compiler->directive('csrf', function ($name = 'sessid') {
            $name = !empty($name) ? $name : 'sessid';
            $name = trim($name, '"');
            $name = trim($name, "'");
            return '<input type="hidden" name="'.$name.'" value="<?= bitrix_sessid() ?>" />';
        });

        $compiler->directive('endauth', $endIf);
        $compiler->directive('endguest', $endIf);
        $compiler->directive('endadmin', $endIf);

        static::registerHermitageDirectives($compiler);
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
    }

    /**
     * @param BladeCompiler $compiler
     */
    private static function registerHermitageDirectives($compiler)
    {
        $simpleDirectives = [
            'actionAddForIBlock' => 'addForIBlock',
        ];
        foreach ($simpleDirectives as $directive => $action) {

            $compiler->directive($directive, function ($expression) use ($action) {
                $expression = rtrim($expression, ')');
                $expression = ltrim($expression, '(');
                return '<?php \Arrilot\BitrixHermitage\Action::' . $action . '($template, ' . $expression . '); ?>';
            });
        }

        $echoDirectives = [
            'actionEditIBlockElement' => 'editIBlockElement',
            'actionDeleteIBlockElement' => 'deleteIBlockElement',
            'actionEditAndDeleteIBlockElement' => 'editAndDeleteIBlockElement',

            'actionEditIBlockSection' => 'editIBlockSection',
            'actionDeleteIBlockSection' => 'deleteIBlockSection',
            'actionEditAndDeleteIBlockSection' => 'editAndDeleteIBlockSection',

            'actionEditHLBlockElement' => 'editHLBlockElement',
            'actionDeleteHLBlockElement' => 'deleteHLBlockElement',
            'actionEditAndDeleteHLBlockElement' => 'editAndDeleteHLBlockElement',
        ];
        foreach ($echoDirectives as $directive => $action) {

            $compiler->directive($directive, function ($expression) use ($action) {
                $expression = rtrim($expression, ')');
                $expression = ltrim($expression, '(');
                return '<?= \Arrilot\BitrixHermitage\Action::' . $action . '($template, ' . $expression . '); ?>';
            });
        }
    }

    /**
     * @return string|null
     */
    public static function getCachePath()
    {
        return static::$cachePath;
    }
}


1		<?php
2
3		namespace Arrilot\BitrixBlade;
4
5		use Bitrix\Main\Config\Configuration;
6		use ErrorException;
7		use Illuminate\Container\Container;
8		use Illuminate\Contracts\View\Factory;
9		use RuntimeException;
10
11		class BladeProvider
12		{
13		/**
14		* Path to a folder view common view can be stored.
15		*
16		* @var string
17		*/
18		protected static $baseViewPath;
19
20		/**
21		* Local path to blade cache storage.
22		*
23		* @var string
24		*/
25		protected static $cachePath;
26
27		/**
28		* View factory.
29		*
30		* @var Factory
31		*/
32		protected static $viewFactory;
33
34		/**
35		* Service container factory.
36		*
37		* @var Container
38		*/
39		protected static $container;
40
41		/**
42		* Register blade engine in Bitrix.
43		*/
44		public static function register()
45		{
46		$bitrixConfig = Configuration::getValue('bitrix-blade');
47		$baseViewPath = isset($bitrixConfig['baseViewPath']) ? $bitrixConfig['baseViewPath'] : 'local/views';
48		$cachePath = isset($bitrixConfig['cachePath']) ? $bitrixConfig['cachePath'] : 'local/cache/blade';
49
50		static::$baseViewPath = static::isAbsolutePath($baseViewPath) ? $baseViewPath : $_SERVER['DOCUMENT_ROOT'].'/'.$baseViewPath;
51		static::$cachePath = static::isAbsolutePath($cachePath) ? $cachePath : $_SERVER['DOCUMENT_ROOT'].'/'.$cachePath;
52		static::instantiateServiceContainer();
53		static::instantiateViewFactory();
54		static::registerBitrixDirectives();
55
56		global $arCustomTemplateEngines;
57		$arCustomTemplateEngines['blade'] = [
58		'templateExt' => ['blade'],
59		'function' => 'renderBladeTemplate',
60		];
61		}
62
63		protected static function isAbsolutePath($path)
64		{
65		return $path && ($path[0] === DIRECTORY_SEPARATOR \|\| preg_match('~\A[A-Z]:(?![^/\\\\])~i', $path) > 0);
66		}
67
68		/**
69		* Get view factory.
70		*
71		* @return Factory
72		*/
73		public static function getViewFactory()
74		{
75		return static::$viewFactory;
76		}
77
78		/**
79		* @return BladeCompiler
80		*/
81		public static function getCompiler()
82		{
83		return static::$container['blade.compiler'];
84		}
85
86		/**
87		* Clear all compiled view files.
88		*/
89		public static function clearCache()
90		{
91		$path = static::$cachePath;
92
93		if (!$path) {
94		throw new RuntimeException('Cache path is empty');
95		}
96
97		$success = true;
98		foreach (glob("{$path}/*") as $view) {
99		try {
100		if (!@unlink($view)) {
101		$success = false;
102		}
103		} catch (ErrorException $e) {
104		$success = false;
105		}
106		}
107
108		return $success;
109		}
110
111		/**
112		* Update paths where blade tries to find additional views.
113		*
114		* @param string $templateDir
115		*/
116		public static function addTemplateFolderToViewPaths($templateDir)
117		{
118		$finder = Container::getInstance()->make('view.finder');
119
120		$currentPaths = $finder->getPaths();
121		$newPaths = [$_SERVER['DOCUMENT_ROOT'].$templateDir];
122
123		// Полностью перезаписывать пути нельзя, иначе вложенные компоненты + include перестанут работать.
124		$newPaths = array_values(array_unique(array_merge($newPaths, $currentPaths)));
125		if (!in_array(static::$baseViewPath, $newPaths)) {
126		$newPaths[] = static::$baseViewPath;
127		}
128
129		// Необходимо очистить внутренний кэш ViewFinder-а
130		// Потому что иначе если в родительском компоненте есть @include('foo'), то при вызове @include('foo') из дочернего,
131		// он не будет искать foo в дочернем, а сразу подключит foo из родительского компонента
132		$finder->flush();
133
134		$finder->setPaths($newPaths);
135		}
136
137		/**
138		* Undo addTemplateFolderToViewPaths
139		*
140		* @param string $templateDir
141		*/
142		public static function removeTemplateFolderFromViewPaths($templateDir)
143		{
144		$finder = Container::getInstance()->make('view.finder');
145		$currentPaths = $finder->getPaths();
146		$finder->setPaths(array_diff($currentPaths, [$_SERVER['DOCUMENT_ROOT'].$templateDir] ));
147
148		// Необходимо очистить внутренний кэш ViewFinder-а
149		// Потому что иначе если в дочернем компоненте есть @include('foo'), то при вызове @include('foo') в родительском
150		// после подключения дочернего,
151		// он не будет искать foo в родительском, а сразу подключит foo из дочернего компонента
152		$finder->flush();
153		}
154
155		/**
156		* Instantiate service container if it's not instantiated yet.
157		*/
158		protected static function instantiateServiceContainer()
159		{
160		$container = Container::getInstance();
161
162		if (!$container) {
163		$container = new Container();
164		Container::setInstance($container);
165		}
166
167		static::$container = $container;
168		}
169
170		/**
171		* Instantiate view factory.
172		*/
173		protected static function instantiateViewFactory()
174		{
175		static::createDirIfNotExist(static::$baseViewPath);
176		static::createDirIfNotExist(static::$cachePath);
177
178		$viewPaths = [
179		static::$baseViewPath,
180		];
181		$cache = static::$cachePath;
182
183		$blade = new Blade($viewPaths, $cache, static::$container);
184
185		static::$viewFactory = $blade->view();
186		static::$viewFactory->addExtension('blade', 'blade');
187		}
188
189		/**
190		* Create dir if it does not exist.
191		*
192		* @param string $path
193		*/
194		protected static function createDirIfNotExist($path)
195		{
196		if (!file_exists($path)) {
197		$mask = umask(0);
198		mkdir($path, 0777, true);
199		umask($mask);
200		}
201		}
202
203		/**
204		* Register bitrix directives.
205		*/
206		protected static function registerBitrixDirectives()
207		{
208		$compiler = static::getCompiler();
209
210		$endIf = function () {
211		return '<?php endif; ?>';
212		};
213
214		$compiler->directive('component', function ($expression) {
215		$expression = rtrim($expression, ')');
216		$expression = ltrim($expression, '(');
217
218		return '<?php $APPLICATION->IncludeComponent('.$expression.'); ?>';
219		});
220
221		$compiler->directive('bxComponent', function ($expression) {
222		$expression = rtrim($expression, ')');
223		$expression = ltrim($expression, '(');
224
225		return '<?php $APPLICATION->IncludeComponent('.$expression.'); ?>';
226		});
227
228		$compiler->directive('block', function ($expression) {
229		$expression = rtrim($expression, ')');
230		$expression = ltrim($expression, '(');
231
232		return '<?php ob_start(); $__bx_block = ' . $expression . '; ?>';
233		});
234
235		$compiler->directive('endblock', function () {
236		return '<?php $APPLICATION->AddViewContent($__bx_block, ob_get_clean()); ?>';
237		});
238
239		$compiler->directive('lang', function ($expression) {
240		return '<?= Bitrix\Main\Localization\Loc::getMessage('.$expression.') ?>';
241		});
242
243		$compiler->directive('auth', function () {
244		return '<?php if($USER->IsAuthorized()): ?>';
245		});
246		$compiler->directive('guest', function () {
247		return '<?php if(!$USER->IsAuthorized()): ?>';
248		});
249		$compiler->directive('admin', function () {
250		return '<?php if($USER->IsAdmin()): ?>';
251		});
252		$compiler->directive('csrf', function ($name = 'sessid') {
253		$name = !empty($name) ? $name : 'sessid';
254		$name = trim($name, '"');
255		$name = trim($name, "'");
256		return '<input type="hidden" name="'.$name.'" value="<?= bitrix_sessid() ?>" />';
257		});
258
259		$compiler->directive('endauth', $endIf);
260		$compiler->directive('endguest', $endIf);
261		$compiler->directive('endadmin', $endIf);
262
263		static::registerHermitageDirectives($compiler);
		0 ignored issues – show Bug introduced 2017-11-13 22:01 UTC by Report Bug Copy Issue Report Since `registerHermitageDirectives()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `registerHermitageDirectives()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
264		}
265
266		/**
267		* @param BladeCompiler $compiler
268		*/
269		private static function registerHermitageDirectives($compiler)
270		{
271		$simpleDirectives = [
272		'actionAddForIBlock' => 'addForIBlock',
273		];
274	View Code Duplication	foreach ($simpleDirectives as $directive => $action) {
		0 ignored issues – show Duplication introduced 2017-11-13 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
275		$compiler->directive($directive, function ($expression) use ($action) {
276		$expression = rtrim($expression, ')');
277		$expression = ltrim($expression, '(');
278		return '<?php \Arrilot\BitrixHermitage\Action::' . $action . '($template, ' . $expression . '); ?>';
279		});
280		}
281
282		$echoDirectives = [
283		'actionEditIBlockElement' => 'editIBlockElement',
284		'actionDeleteIBlockElement' => 'deleteIBlockElement',
285		'actionEditAndDeleteIBlockElement' => 'editAndDeleteIBlockElement',
286
287		'actionEditIBlockSection' => 'editIBlockSection',
288		'actionDeleteIBlockSection' => 'deleteIBlockSection',
289		'actionEditAndDeleteIBlockSection' => 'editAndDeleteIBlockSection',
290
291		'actionEditHLBlockElement' => 'editHLBlockElement',
292		'actionDeleteHLBlockElement' => 'deleteHLBlockElement',
293		'actionEditAndDeleteHLBlockElement' => 'editAndDeleteHLBlockElement',
294		];
295	View Code Duplication	foreach ($echoDirectives as $directive => $action) {
		0 ignored issues – show Duplication introduced 2017-11-13 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
296		$compiler->directive($directive, function ($expression) use ($action) {
297		$expression = rtrim($expression, ')');
298		$expression = ltrim($expression, '(');
299		return '<?= \Arrilot\BitrixHermitage\Action::' . $action . '($template, ' . $expression . '); ?>';
300		});
301		}
302		}
303
304		/**
305		* @return string\|null
306		*/
307		public static function getCachePath()
308		{
309		return static::$cachePath;
310		}
311		}
312

arrilot / bitrix-blade

Push — master ( 346a11...166086 )

BladeProvider::clearCache() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like