Loader::getFilename() - Code Metrics - Inspection of "TwigView 5.0 / Twig ^2.0 / PHP >=7.0" - WyriHaximus/TwigView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#58)

unknown

created 2017-09-11 22:07 UTC

Loader::getFilename() B

↳ Parent: Loader

Complexity

Conditions	6
Paths	6

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	6

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	24
ccs	14
cts	14
cp	1
rs	8.5125
cc	6
eloc	14
nc	6
nop	1
crap	6

<?php declare(strict_types=1);
/**
 * 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\Lib\Twig;

use Cake\Core\App;
use Cake\Core\Plugin;
use Twig\Error\LoaderError;
use Twig\Loader\LoaderInterface;
use Twig\Loader\SourceContextLoaderInterface;
use Twig\Source;
use WyriHaximus\TwigView\View\TwigView;

/**
 * Class Loader.
 * @package WyriHaximus\TwigView\Lib\Twig
 */
class Loader implements LoaderInterface, SourceContextLoaderInterface
{
    /**
     * Get the file contents of a template.
     *
     * @param string $name Template.
     *
     * @return string
     */
    public function getSource($name): string
    {
        $name = $this->resolveFileName($name);

        return file_get_contents($name);
    }

    /**
     * Returns the source context for a given template logical name.
     *
     * @param string $name The template logical name.
     *
     * @throws Twig\Error\Loader When $name is not found
     * @return Twig\Source
     *
     */
    public function getSourceContext($name): Source
    {
        $code = $this->getSource($name);
        $path = $this->getFilename($name);

        return new Source($code, $name, $path);
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
    }

    /**
     * Get cache key for template.
     *
     * @param string $name Template.
     *
     * @return string
     */
    public function getCacheKey($name): string
    {
        return $this->resolveFileName($name);
    }

    /**
     * Check if template is still fresh.
     *
     * @param string $name Template.
     * @param int    $time Timestamp.
     *
     * @return bool
     */
    public function isFresh($name, $time): bool
    {
        $name = $this->resolveFileName($name);

        return filemtime($name) < $time;
    }

    /**
     * Check if we have the source code of a template, given its name.
     *
     * @param string $name The name of the template to check if we can load.
     *
     * @return bool If the template source code is handled by this loader or not.
     */
    public function exists($name): bool
    {
        $filename = $this->getFilename($name);
        if ($filename === false) {
            return false;
        }

        return true;
    }

    /**
     * Resolve template name to filename.
     *
     * @param string $name Template.
     *
     * @throws \Twig\Error\LoaderError Thrown when template file isn't found.
     * @return string
     *
     */
    protected function resolveFileName($name): string
    {
        $filename = $this->getFilename($name);
        if ($filename === false) {
            throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
        }

        return $filename;
    }

    /**
     * Get template filename.
     *
     * @param string $name Template.
     *
     * @return string|false
     *
     */
    protected function getFilename($name)
    {
        if (file_exists($name)) {
            return $name;
        }

        list($plugin, $file) = pluginSplit($name);
        foreach ([null, $plugin] as $scope) {
            $paths = $this->getPaths($scope);
            foreach ($paths as $path) {
                $filePath = $path . $file;
                if (file_exists($filePath)) {
                    return $filePath;
                }

                $filePath = $path . $file . TwigView::EXT;
                if (file_exists($filePath)) {
                    return $filePath;
                }
            }
        }

        return false;
    }

    /**
     * Check if $plugin is active and return it's template paths or return the aps template paths.
     *
     * @param string|null $plugin The plugin in question.
     *
     * @return array
     */
    protected function getPaths($plugin): array
    {
        if ($plugin === null || !Plugin::loaded($plugin)) {
            return App::path('Template');
        }

        return App::path('Template', $plugin);
    }
}


1		<?php declare(strict_types=1);
2		/**
3		* This file is part of TwigView.
4		*
5		** (c) 2014 Cees-Jan Kiewiet
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*/
10
11		namespace WyriHaximus\TwigView\Lib\Twig;
12
13		use Cake\Core\App;
14		use Cake\Core\Plugin;
15		use Twig\Error\LoaderError;
16		use Twig\Loader\LoaderInterface;
17		use Twig\Loader\SourceContextLoaderInterface;
18		use Twig\Source;
19		use WyriHaximus\TwigView\View\TwigView;
20
21		/**
22		* Class Loader.
23		* @package WyriHaximus\TwigView\Lib\Twig
24		*/
25		class Loader implements LoaderInterface, SourceContextLoaderInterface
26		{
27		/**
28		* Get the file contents of a template.
29		*
30		* @param string $name Template.
31		*
32		* @return string
33		*/
34	4	public function getSource($name): string
35		{
36	4	$name = $this->resolveFileName($name);
37
38	3	return file_get_contents($name);
39		}
40
41		/**
42		* Returns the source context for a given template logical name.
43		*
44		* @param string $name The template logical name.
45		*
46		* @throws Twig\Error\Loader When $name is not found
47		* @return Twig\Source
48		*
49		*/
50	2	public function getSourceContext($name): Source
51		{
52	2	$code = $this->getSource($name);
53	2	$path = $this->getFilename($name);
54
55	2	return new Source($code, $name, $path);
		0 ignored issues – show Security Bug introduced 2017-09-04 18:21 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->getFilename($name)` on line `53` can also be of type `false`; however, `Twig_Source::__construct()` does only seem to accept `string`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
56		}
57
58		/**
59		* Get cache key for template.
60		*
61		* @param string $name Template.
62		*
63		* @return string
64		*/
65	5	public function getCacheKey($name): string
66		{
67	5	return $this->resolveFileName($name);
68		}
69
70		/**
71		* Check if template is still fresh.
72		*
73		* @param string $name Template.
74		* @param int $time Timestamp.
75		*
76		* @return bool
77		*/
78	2	public function isFresh($name, $time): bool
79		{
80	2	$name = $this->resolveFileName($name);
81
82	1	return filemtime($name) < $time;
83		}
84
85		/**
86		* Check if we have the source code of a template, given its name.
87		*
88		* @param string $name The name of the template to check if we can load.
89		*
90		* @return bool If the template source code is handled by this loader or not.
91		*/
92		public function exists($name): bool
93		{
94		$filename = $this->getFilename($name);
95		if ($filename === false) {
96		return false;
97		}
98
99		return true;
100		}
101
102		/**
103		* Resolve template name to filename.
104		*
105		* @param string $name Template.
106		*
107		* @throws \Twig\Error\LoaderError Thrown when template file isn't found.
108		* @return string
109		*
110		*/
111	9	protected function resolveFileName($name): string
112		{
113	9	$filename = $this->getFilename($name);
114	9	if ($filename === false) {
115	3	throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
116		}
117
118	6	return $filename;
119		}
120
121		/**
122		* Get template filename.
123		*
124		* @param string $name Template.
125		*
126		* @return string\|false
127		*
128		*/
129	9	protected function getFilename($name)
130		{
131	9	if (file_exists($name)) {
132	3	return $name;
133		}
134
135	6	list($plugin, $file) = pluginSplit($name);
136	6	foreach ([null, $plugin] as $scope) {
137	6	$paths = $this->getPaths($scope);
138	6	foreach ($paths as $path) {
139	6	$filePath = $path . $file;
140	6	if (file_exists($filePath)) {
141	2	return $filePath;
142		}
143
144	6	$filePath = $path . $file . TwigView::EXT;
145	6	if (file_exists($filePath)) {
146	6	return $filePath;
147		}
148		}
149		}
150
151	3	return false;
152		}
153
154		/**
155		* Check if $plugin is active and return it's template paths or return the aps template paths.
156		*
157		* @param string\|null $plugin The plugin in question.
158		*
159		* @return array
160		*/
161	6	protected function getPaths($plugin): array
162		{
163	6	if ($plugin === null \|\| !Plugin::loaded($plugin)) {
164	6	return App::path('Template');
165		}
166
167	4	return App::path('Template', $plugin);
168		}
169		}
170

WyriHaximus / TwigView

Pull Request — master (#58)

Loader::getFilename() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like