TwigView::_getViewFileName() - Code Metrics - Inspection of "Load jasny/twig-extensions extensions" - WyriHaximus/TwigView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature-extra-extensions ( 2f2a70 )

by Cees-Jan

created 2016-11-05 11:28 UTC

TwigView::_getViewFileName() A

↳ Parent: TwigView

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	9

Duplication

Lines	15
Ratio	100 %

Code Coverage

Tests	5
CRAP Score	3.4746

Importance

Changes

Metric	Value
dl	15
loc	15
ccs	5
cts	8
cp	0.625
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	1
crap	3.4746

<?php

/**
 * This file is part of TwigView.
 *
 ** (c) 2014 Cees-Jan Kiewiet
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace WyriHaximus\TwigView\View;

use Cake\Core\Configure;
use Cake\Event\EventManager;
use Cake\Network\Request;
use Cake\Network\Response;
use Cake\View\View;
use Exception;
use WyriHaximus\TwigView\Event\ConstructEvent;
use WyriHaximus\TwigView\Event\EnvironmentConfigEvent;
use WyriHaximus\TwigView\Event\LoaderEvent;
use WyriHaximus\TwigView\Lib\Twig\Loader;

/**
 * Class TwigView
 * @package WyriHaximus\TwigView\View
 */
// @codingStandardsIgnoreStart
class TwigView extends View
// @codingStandardsIgnoreEnd
{
    const EXT = '.twig';

    const ENV_CONFIG = 'WyriHaximus.TwigView.environment';

    /**
     * Extension to use.
     *
     * @var string
     */
    // @codingStandardsIgnoreStart
    protected $_ext = self::EXT;
    // @codingStandardsIgnoreEnd

    /**
     * @var array
     */
    protected $extensions = [
        self::EXT,
        '.tpl',
        '.ctp',
    ];

    /**
     * Twig instance.
     *
     * @var \Twig_Environment
     */
    protected $twig;

    /**
     * Helpers.
     *
     * @var array
     */
    protected $helperList = [];

    /**
     * Event manager.
     *
     * @var EventManager
     */
    protected $eventManager;

    /**
     * Constructor.
     *
     * @param Request      $request      Request.
     * @param Response     $response     Response.
     * @param EventManager $eventManager EventManager.
     * @param array        $viewOptions  View options.
     */
    public function __construct(
        Request $request = null,
        Response $response = null,
        EventManager $eventManager = null,
        array $viewOptions = []
    ) {
        if ($eventManager === null) {
            $eventManager = EventManager::instance();
        }
        $this->eventManager = $eventManager;

        $this->twig = new \Twig_Environment($this->getLoader(), $this->resolveConfig());

        $this->eventManager->dispatch(ConstructEvent::create($this, $this->twig));

        parent::__construct($request, $response, $eventManager, $viewOptions);
        $this->_ext = self::EXT;

        $this->generateHelperList();
    }

    /**
     * @return array
     */
    protected function resolveConfig()
    {
        $config = [
            'cache' => CACHE . 'twigView' . DS,
            'charset' => strtolower(Configure::read('App.encoding')),
            'auto_reload' => Configure::read('debug'),
            'debug' => Configure::read('debug'),
        ];

        $config = array_replace($config, $this->readConfig());

        $configEvent = EnvironmentConfigEvent::create($config);
        $this->eventManager->dispatch($configEvent);
        return $configEvent->getConfig();
    }

    /**
     * @return array
     */
    protected function readConfig()
    {
        if (!Configure::check(static::ENV_CONFIG)) {
            return [];
        }

        $config = Configure::read(static::ENV_CONFIG);
        if (!is_array($config)) {
            return [];
        }

        return $config;
    }

    /**
     * @param string $extension
     */
    public function unshiftExtension($extension)
    {
        array_unshift($this->extensions, $extension);
    }

    /**
     * Create the template loader.
     *
     * @return \Twig_LoaderInterface
     */
    protected function getLoader()
    {
        $event = LoaderEvent::create(new Loader());
        $this->eventManager->dispatch($event);
        return $event->getResultLoader();
    }

    /**
     * Create a useful helper list.
     *
     * @return void
     */
    protected function generateHelperList()
    {
        $registry = $this->helpers();
        
        $helpersList = array_merge($this->helpers, $registry->loaded());
        $helpers = $registry->normalizeArray($helpersList);
        foreach ($helpers as $properties) {
            list(, $class) = pluginSplit($properties['class']);
            $this->helperList[$class] = $this->{$class};
        }
    }

    /**
     * Render the template.
     *
     * @param string $viewFile Template file.
     * @param array  $data     Data that can be used by the template.
     *
     * @throws \Exception
     * @return string
     */
    // @codingStandardsIgnoreStart
    protected function _render($viewFile, $data = array())
    {
        // @codingStandardsIgnoreEnd
        if (empty($data)) {
            $data = $this->viewVars;
        }

        if (substr($viewFile, -3) === 'ctp') {
            $out = parent::_render($viewFile, $data);
            // @codingStandardsIgnoreStart
        } else {
            // @codingStandardsIgnoreEnd
            $data = array_merge(
                $data,
                $this->helperList,
                [
                    '_view' => $this,
                ]
            );

            // @codingStandardsIgnoreStart
            try {
                $out = $this->getTwig()->loadTemplate($viewFile)->render($data);
            } catch (Exception $e) {
                $previous = $e->getPrevious();

                if ($previous !== null && $previous instanceof Exception) {
                    throw $previous;
                } else {
                    throw $e;
                }
            }
            // @codingStandardsIgnoreEnd
        }

        return $out;
    }

    /**
     * @param string|null $name
     * @return string
     * @throws \Exception
     */
    // @codingStandardsIgnoreStart
    protected function _getViewFileName($name = null)

    {
        // @codingStandardsIgnoreEnd
        $rethrow = new \Exception('You\'re not supposed to get here');
        foreach ($this->extensions as $extension) {
            $this->_ext = $extension;
            try {
                return parent::_getViewFileName($name);
            } catch (\Exception $exception) {
                $rethrow = $exception;
            }
        }

        throw $rethrow;
    }

    /**
     * @param string|null $name
     * @return string
     * @throws \Exception
     */
    // @codingStandardsIgnoreStart
    protected function _getLayoutFileName($name = null)

    {
        // @codingStandardsIgnoreEnd
        $rethrow = new \Exception('You\'re not supposed to get here');
        foreach ($this->extensions as $extension) {
            $this->_ext = $extension;
            try {
                return parent::_getLayoutFileName($name);
            } catch (\Exception $exception) {
                $rethrow = $exception;
            }
        }

        throw $rethrow;
    }

    /**
     * @param string $name
     * @param bool $pluginCheck
     * @return string
     * @throws \Exception
     */
    // @codingStandardsIgnoreStart
    protected function _getElementFileName($name, $pluginCheck = true)
    {
        // @codingStandardsIgnoreEnd
        foreach ($this->extensions as $extension) {
            $this->_ext = $extension;
            $result = parent::_getElementFileName($name, $pluginCheck);

            if ($result !== false) {
                return $result;
            }
        }

        return false;
    }

    /**
     * Get twig environment instance.
     *
     * @return \Twig_Environment
     */
    public function getTwig()
    {
        return $this->twig;
    }
}


1			<?php
2
3			/**
4			* This file is part of TwigView.
5			*
6			** (c) 2014 Cees-Jan Kiewiet
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11			namespace WyriHaximus\TwigView\View;
12
13			use Cake\Core\Configure;
14			use Cake\Event\EventManager;
15			use Cake\Network\Request;
16			use Cake\Network\Response;
17			use Cake\View\View;
18			use Exception;
19			use WyriHaximus\TwigView\Event\ConstructEvent;
20			use WyriHaximus\TwigView\Event\EnvironmentConfigEvent;
21			use WyriHaximus\TwigView\Event\LoaderEvent;
22			use WyriHaximus\TwigView\Lib\Twig\Loader;
23
24			/**
25			* Class TwigView
26			* @package WyriHaximus\TwigView\View
27			*/
28			// @codingStandardsIgnoreStart
29			class TwigView extends View
30			// @codingStandardsIgnoreEnd
31			{
32			const EXT = '.twig';
33
34			const ENV_CONFIG = 'WyriHaximus.TwigView.environment';
35
36			/**
37			* Extension to use.
38			*
39			* @var string
40			*/
41			// @codingStandardsIgnoreStart
42			protected $_ext = self::EXT;
43			// @codingStandardsIgnoreEnd
44
45			/**
46			* @var array
47			*/
48			protected $extensions = [
49			self::EXT,
50			'.tpl',
51			'.ctp',
52			];
53
54			/**
55			* Twig instance.
56			*
57			* @var \Twig_Environment
58			*/
59			protected $twig;
60
61			/**
62			* Helpers.
63			*
64			* @var array
65			*/
66			protected $helperList = [];
67
68			/**
69			* Event manager.
70			*
71			* @var EventManager
72			*/
73			protected $eventManager;
74
75			/**
76			* Constructor.
77			*
78			* @param Request $request Request.
79			* @param Response $response Response.
80			* @param EventManager $eventManager EventManager.
81			* @param array $viewOptions View options.
82			*/
83	10		public function __construct(
84			Request $request = null,
85			Response $response = null,
86			EventManager $eventManager = null,
87			array $viewOptions = []
88			) {
89	10		if ($eventManager === null) {
90	9		$eventManager = EventManager::instance();
91			}
92	10		$this->eventManager = $eventManager;
93
94	10		$this->twig = new \Twig_Environment($this->getLoader(), $this->resolveConfig());
95
96	10		$this->eventManager->dispatch(ConstructEvent::create($this, $this->twig));
97
98	10		parent::__construct($request, $response, $eventManager, $viewOptions);
99	10		$this->_ext = self::EXT;
100
101	10		$this->generateHelperList();
102	10		}
103
104			/**
105			* @return array
106			*/
107	10		protected function resolveConfig()
108			{
109			$config = [
110	10		'cache' => CACHE . 'twigView' . DS,
111	10		'charset' => strtolower(Configure::read('App.encoding')),
112	10		'auto_reload' => Configure::read('debug'),
113	10		'debug' => Configure::read('debug'),
114			];
115
116	10		$config = array_replace($config, $this->readConfig());
117
118	10		$configEvent = EnvironmentConfigEvent::create($config);
119	10		$this->eventManager->dispatch($configEvent);
120	10		return $configEvent->getConfig();
121			}
122
123			/**
124			* @return array
125			*/
126	10		protected function readConfig()
127			{
128	10		if (!Configure::check(static::ENV_CONFIG)) {
129	9		return [];
130			}
131
132	1		$config = Configure::read(static::ENV_CONFIG);
133	1		if (!is_array($config)) {
134			return [];
135			}
136
137	1		return $config;
138			}
139
140			/**
141			* @param string $extension
142			*/
143			public function unshiftExtension($extension)
144			{
145			array_unshift($this->extensions, $extension);
146			}
147
148			/**
149			* Create the template loader.
150			*
151			* @return \Twig_LoaderInterface
152			*/
153	10		protected function getLoader()
154			{
155	10		$event = LoaderEvent::create(new Loader());
156	10		$this->eventManager->dispatch($event);
157	10		return $event->getResultLoader();
158			}
159
160			/**
161			* Create a useful helper list.
162			*
163			* @return void
164			*/
165	10		protected function generateHelperList()
166			{
167	10		$registry = $this->helpers();
168
169	10		$helpersList = array_merge($this->helpers, $registry->loaded());
170	10		$helpers = $registry->normalizeArray($helpersList);
171	10		foreach ($helpers as $properties) {
172	3		list(, $class) = pluginSplit($properties['class']);
173	3		$this->helperList[$class] = $this->{$class};
174			}
175	10		}
176
177			/**
178			* Render the template.
179			*
180			* @param string $viewFile Template file.
181			* @param array $data Data that can be used by the template.
182			*
183			* @throws \Exception
184			* @return string
185			*/
186			// @codingStandardsIgnoreStart
187	4		protected function _render($viewFile, $data = array())
188			{
189			// @codingStandardsIgnoreEnd
190	4		if (empty($data)) {
191	4		$data = $this->viewVars;
192			}
193
194	4		if (substr($viewFile, -3) === 'ctp') {
195	1		$out = parent::_render($viewFile, $data);
196			// @codingStandardsIgnoreStart
197			} else {
198			// @codingStandardsIgnoreEnd
199	3		$data = array_merge(
200			$data,
201	3		$this->helperList,
202			[
203	3		'_view' => $this,
204			]
205			);
206
207			// @codingStandardsIgnoreStart
208			try {
209	3		$out = $this->getTwig()->loadTemplate($viewFile)->render($data);
210	2		} catch (Exception $e) {
211	2		$previous = $e->getPrevious();
212
213	2		if ($previous !== null && $previous instanceof Exception) {
214	1		throw $previous;
215			} else {
216	1		throw $e;
217			}
218			}
219			// @codingStandardsIgnoreEnd
220			}
221
222	2		return $out;
223			}
224
225			/**
226			* @param string\|null $name
227			* @return string
228			* @throws \Exception
229			*/
230			// @codingStandardsIgnoreStart
231	2	View Code Duplication	protected function _getViewFileName($name = null)
			0 ignored issues – show Duplication introduced 2015-12-16 16:24 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...
232			{
233			// @codingStandardsIgnoreEnd
234	2		$rethrow = new \Exception('You\'re not supposed to get here');
235	2		foreach ($this->extensions as $extension) {
236	2		$this->_ext = $extension;
237			try {
238	2		return parent::_getViewFileName($name);
239			} catch (\Exception $exception) {
240			$rethrow = $exception;
241			}
242			}
243
244			throw $rethrow;
245			}
246
247			/**
248			* @param string\|null $name
249			* @return string
250			* @throws \Exception
251			*/
252			// @codingStandardsIgnoreStart
253		View Code Duplication	protected function _getLayoutFileName($name = null)
			0 ignored issues – show Duplication introduced 2015-12-16 16:24 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...
254			{
255			// @codingStandardsIgnoreEnd
256			$rethrow = new \Exception('You\'re not supposed to get here');
257			foreach ($this->extensions as $extension) {
258			$this->_ext = $extension;
259			try {
260			return parent::_getLayoutFileName($name);
261			} catch (\Exception $exception) {
262			$rethrow = $exception;
263			}
264			}
265
266			throw $rethrow;
267			}
268
269			/**
270			* @param string $name
271			* @param bool $pluginCheck
272			* @return string
273			* @throws \Exception
274			*/
275			// @codingStandardsIgnoreStart
276			protected function _getElementFileName($name, $pluginCheck = true)
277			{
278			// @codingStandardsIgnoreEnd
279			foreach ($this->extensions as $extension) {
280			$this->_ext = $extension;
281			$result = parent::_getElementFileName($name, $pluginCheck);
			0 ignored issues – show Unused Code introduced 2016-09-28 17:12 UTC by Report Bug Copy Issue Report The call to `View::_getElementFileName()` has too many arguments starting with `$pluginCheck`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
282			if ($result !== false) {
283			return $result;
284			}
285			}
286
287			return false;
288			}
289
290			/**
291			* Get twig environment instance.
292			*
293			* @return \Twig_Environment
294			*/
295	3		public function getTwig()
296			{
297	3		return $this->twig;
298			}
299			}
300

WyriHaximus / TwigView

Push — feature-extra-extensions ( 2f2a70 )

TwigView::_getViewFileName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like