BladeProvider - Code Metrics - Inspection of "bxComponent and small improvements" - arrilot/bitrix-blade - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d916f4...696ec4 )

by Nekrasov

created 2017-01-17 22:23 UTC

BladeProvider A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
dl	0
loc	148
rs	10
c	3
b	0
f	0
wmc	10
lcom	1
cbo	4

8 Methods

Rating	Name	Size	Complexity
A	register()	15	1
A	getViewFactory()	4	1
A	getCompiler()	4	1
A	updateViewPaths()	10	1
A	instantiateServiceContainer()	11	2
A	instantiateViewFactory()	15	1
A	createDirIfNotExist()	8	2
A	registerBitrixDirectives()	10	1

<?php

namespace Arrilot\BitrixBlade;

use Illuminate\Container\Container;
use Illuminate\Contracts\View\Factory;

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.
     *
     * @param string $baseViewPath
     * @param string $cachePath
     */
    public static function register($baseViewPath = 'local/views', $cachePath = 'bitrix/cache/blade')
// 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);
    }
}
    {
        static::$baseViewPath = $_SERVER['DOCUMENT_ROOT'].'/'.$baseViewPath;
        static::$cachePath = $_SERVER['DOCUMENT_ROOT'].'/'.$cachePath;

        static::instantiateServiceContainer();
        static::instantiateViewFactory();
        static::registerBitrixDirectives();

        global $arCustomTemplateEngines;
function myFunction($a, $b) {
    // Do something
}
        $arCustomTemplateEngines['blade'] = [
            'templateExt' => ['blade'],
            'function'    => 'renderBladeTemplate',
        ];
    }

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

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

    /**
     * Update paths where blade tries to find additional views.
     *
     * @param string $templateDir
     */
    public static function updateViewPaths($templateDir)
// 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);
    }
}
    {
        $newPaths = [
            $_SERVER['DOCUMENT_ROOT'].$templateDir,
            static::$baseViewPath,
        ];

        $finder = Container::getInstance()->make('view.finder');
        $finder->setPaths($newPaths);
    }

    /**
     * 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();
        $compiler->directive('bxComponent', function ($expression) {
            $expression = rtrim($expression, ')');
            $expression = ltrim($expression, '(');

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


1			<?php
2
3			namespace Arrilot\BitrixBlade;
4
5			use Illuminate\Container\Container;
6			use Illuminate\Contracts\View\Factory;
7
8			class BladeProvider
9			{
10			/**
11			* Path to a folder view common view can be stored.
12			*
13			* @var string
14			*/
15			protected static $baseViewPath;
16
17			/**
18			* Local path to blade cache storage.
19			*
20			* @var string
21			*/
22			protected static $cachePath;
23
24			/**
25			* View factory.
26			*
27			* @var Factory
28			*/
29			protected static $viewFactory;
30
31			/**
32			* Service container factory.
33			*
34			* @var Container
35			*/
36			protected static $container;
37
38			/**
39			* Register blade engine in Bitrix.
40			*
41			* @param string $baseViewPath
42			* @param string $cachePath
43			*/
44			public static function register($baseViewPath = 'local/views', $cachePath = 'bitrix/cache/blade')
			0 ignored issues – show Coding Style introduced 2016-02-15 20:00 UTC by Report Bug Copy Issue Report `register` uses the super-global variable `$_SERVER` 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...
45			{
46			static::$baseViewPath = $_SERVER['DOCUMENT_ROOT'].'/'.$baseViewPath;
47			static::$cachePath = $_SERVER['DOCUMENT_ROOT'].'/'.$cachePath;
48
49			static::instantiateServiceContainer();
50			static::instantiateViewFactory();
51			static::registerBitrixDirectives();
52
53			global $arCustomTemplateEngines;
			0 ignored issues – show Compatibility Best Practice introduced 2016-02-15 20:00 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
54			$arCustomTemplateEngines['blade'] = [
55			'templateExt' => ['blade'],
56			'function' => 'renderBladeTemplate',
57			];
58			}
59
60			/**
61			* Get view factory.
62			*
63			* @return Factory
64			*/
65			public static function getViewFactory()
66			{
67			return static::$viewFactory;
68			}
69
70			/**
71			* @return BladeCompiler
72			*/
73			public function getCompiler()
74			{
75			return static::$container['blade.compiler'];
76			}
77
78			/**
79			* Update paths where blade tries to find additional views.
80			*
81			* @param string $templateDir
82			*/
83			public static function updateViewPaths($templateDir)
			0 ignored issues – show Coding Style introduced 2016-02-15 20:00 UTC by Report Bug Copy Issue Report `updateViewPaths` uses the super-global variable `$_SERVER` 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...
84			{
85			$newPaths = [
86			$_SERVER['DOCUMENT_ROOT'].$templateDir,
87			static::$baseViewPath,
88			];
89
90			$finder = Container::getInstance()->make('view.finder');
91			$finder->setPaths($newPaths);
92			}
93
94			/**
95			* Instantiate service container if it's not instantiated yet.
96			*/
97			protected static function instantiateServiceContainer()
98			{
99			$container = Container::getInstance();
100
101			if (!$container) {
102			$container = new Container();
103			Container::setInstance($container);
104			}
105
106			static::$container = $container;
107			}
108
109			/**
110			* Instantiate view factory.
111			*/
112			protected static function instantiateViewFactory()
113			{
114			static::createDirIfNotExist(static::$baseViewPath);
115			static::createDirIfNotExist(static::$cachePath);
116
117			$viewPaths = [
118			static::$baseViewPath,
119			];
120			$cache = static::$cachePath;
121
122			$blade = new Blade($viewPaths, $cache, static::$container);
123
124			static::$viewFactory = $blade->view();
125			static::$viewFactory->addExtension('blade', 'blade');
126			}
127
128			/**
129			* Create dir if it does not exist.
130			*
131			* @param string $path
132			*/
133			protected static function createDirIfNotExist($path)
134			{
135			if (!file_exists($path)) {
136			$mask = umask(0);
137			mkdir($path, 0777, true);
138			umask($mask);
139			}
140			}
141
142			/**
143			* Register bitrix directives.
144			*/
145			protected static function registerBitrixDirectives()
146			{
147			$compiler = static::getCompiler();
148			$compiler->directive('bxComponent', function ($expression) {
149			$expression = rtrim($expression, ')');
150			$expression = ltrim($expression, '(');
151
152			return '<?php $APPLICATION->IncludeComponent('.$expression.'); ?>';
153			});
154			}
155			}
156

arrilot / bitrix-blade

Push — master ( d916f4...696ec4 )

BladeProvider A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

8 Methods

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like