Loader::isFresh() - Code Metrics - WyriHaximus/TwigView - Measure and Improve Code Quality continuously with Scrutinizer

Loader::isFresh() A
last analyzed 2020-01-26 03:02 UTC

↳ Parent: Loader

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2
crap	1

<?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\Source;
use WyriHaximus\TwigView\View\TwigView;

/**
 * Class Loader.
 * @package WyriHaximus\TwigView\Lib\Twig
 */
final class Loader implements LoaderInterface
{
    /**
     * 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 \WyriHaximus\TwigView\Lib\Twig\Twig\Error\Loader When $name is not found
     * @return \WyriHaximus\TwigView\Lib\Twig\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
     *
     */
    private 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
     *
     */
    private function getFilename($name)
    {
        if (file_exists($name)) {
            return $name;
        }

        [$plugin, $file] = pluginSplit($name);

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

                $filePath = $path . $file . TwigView::EXT;
                if (is_file($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
     */
    private function getPaths($plugin): array
    {
        if ($plugin === null || !Plugin::loaded($plugin)) {

            return App::path('templates');
        }

        return [Plugin::templatePath($plugin)];
    }
}


1		<?php
2		declare(strict_types=1);
3
4		/**
5		* This file is part of TwigView.
6		*
7		** (c) 2014 Cees-Jan Kiewiet
8		*
9		* For the full copyright and license information, please view the LICENSE
10		* file that was distributed with this source code.
11		*/
12
13		namespace WyriHaximus\TwigView\Lib\Twig;
14
15		use Cake\Core\App;
16		use Cake\Core\Plugin;
17		use Twig\Error\LoaderError;
18		use Twig\Loader\LoaderInterface;
19		use Twig\Source;
20		use WyriHaximus\TwigView\View\TwigView;
21
22		/**
23		* Class Loader.
24		* @package WyriHaximus\TwigView\Lib\Twig
25		*/
26		final class Loader implements LoaderInterface
27		{
28		/**
29		* Get the file contents of a template.
30		*
31		* @param string $name Template.
32		*
33		* @return string
34		*/
35	4	public function getSource($name): string
36		{
37	4	$name = $this->resolveFileName($name);
38
39	3	return file_get_contents($name);
40		}
41
42		/**
43		* Returns the source context for a given template logical name.
44		*
45		* @param string $name The template logical name.
46		*
47		* @throws \WyriHaximus\TwigView\Lib\Twig\Twig\Error\Loader When $name is not found
48		* @return \WyriHaximus\TwigView\Lib\Twig\Twig\Source
49		*
50		*/
51	2	public function getSourceContext($name): Source
52		{
53	2	$code = $this->getSource($name);
54	2	$path = $this->getFilename($name);
55
56	2	return new Source($code, $name, $path);
		0 ignored issues – show Security Bug introduced 2019-03-12 13:19 UTC by Report Bug Copy Issue Report It seems like `$path` defined by `$this->getFilename($name)` on line `54` 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...
57		}
58
59		/**
60		* Get cache key for template.
61		*
62		* @param string $name Template.
63		*
64		* @return string
65		*/
66	5	public function getCacheKey($name): string
67		{
68	5	return $this->resolveFileName($name);
69		}
70
71		/**
72		* Check if template is still fresh.
73		*
74		* @param string $name Template.
75		* @param int $time Timestamp.
76		*
77		* @return bool
78		*/
79	2	public function isFresh($name, $time): bool
80		{
81	2	$name = $this->resolveFileName($name);
82
83	1	return filemtime($name) < $time;
84		}
85
86		/**
87		* Check if we have the source code of a template, given its name.
88		*
89		* @param string $name The name of the template to check if we can load.
90		*
91		* @return bool If the template source code is handled by this loader or not.
92		*/
93		public function exists($name): bool
94		{
95		$filename = $this->getFilename($name);
96		if ($filename === false) {
97		return false;
98		}
99
100		return true;
101		}
102
103		/**
104		* Resolve template name to filename.
105		*
106		* @param string $name Template.
107		*
108		* @throws \Twig\Error\LoaderError Thrown when template file isn't found.
109		* @return string
110		*
111		*/
112	9	private function resolveFileName($name): string
113		{
114	9	$filename = $this->getFilename($name);
115	9	if ($filename === false) {
116	3	throw new LoaderError(sprintf('Template "%s" is not defined.', $name));
117		}
118
119	6	return $filename;
120		}
121
122		/**
123		* Get template filename.
124		*
125		* @param string $name Template.
126		*
127		* @return string\|false
128		*
129		*/
130	9	private function getFilename($name)
131		{
132	9	if (file_exists($name)) {
133	3	return $name;
134		}
135
136	6	[$plugin, $file] = pluginSplit($name);
		0 ignored issues – show Bug introduced 2019-03-12 19:28 UTC by Report Bug Copy Issue Report The variable `$plugin` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history... Bug introduced 2019-03-12 19:28 UTC by Report Bug Copy Issue Report The variable `$file` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
137	6	foreach ([null, $plugin] as $scope) {
138	6	$paths = $this->getPaths($scope);
139	6	foreach ($paths as $path) {
140	6	$filePath = $path . $file;
141	6	if (is_file($filePath)) {
142	2	return $filePath;
143		}
144
145	6	$filePath = $path . $file . TwigView::EXT;
146	6	if (is_file($filePath)) {
147	3	return $filePath;
148		}
149		}
150		}
151
152	3	return false;
153		}
154
155		/**
156		* Check if $plugin is active and return it's template paths or return the aps template paths.
157		*
158		* @param string\|null $plugin The plugin in question.
159		*
160		* @return array
161		*/
162	6	private function getPaths($plugin): array
163		{
164	6	if ($plugin === null \|\| !Plugin::loaded($plugin)) {
		0 ignored issues – show Unused Code introduced 2018-09-30 17:20 UTC by Report Bug Copy Issue Report The call to `Plugin::loaded()` has too many arguments starting with `$plugin`. 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...
165	6	return App::path('templates');
166		}
167
168	4	return [Plugin::templatePath($plugin)];
169		}
170		}
171

WyriHaximus / TwigView

Loader::isFresh() A last analyzed 2020-01-26 03:02 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Loader::isFresh() A
last analyzed 2020-01-26 03:02 UTC