TwitalLoader::getSourceContext() - Code Metrics - Inspection of "added support for twig 2.0" - goetas/twital - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — twig-2 ( a5bda0 )

by Asmir

created 2017-01-06 12:54 UTC

TwitalLoader::getSourceContext() A

↳ Parent: TwitalLoader

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	8
c	0
b	0
f	0
ccs	0
cts	4
cp	0
rs	9.4285
cc	1
eloc	4
nc	1
nop	1
crap	2

<?php
namespace Goetas\Twital;

use Goetas\Twital\SourceAdapter\HTML5Adapter;
use Goetas\Twital\SourceAdapter\XMLAdapter;
use Goetas\Twital\SourceAdapter\XHTMLAdapter;

/**
 * This is a Twital Loader.
 * Compiles a Twital template into a Twig template.
 *
 * @author Asmir Mustafic <[email protected]>
 */
class TwitalLoader implements \Twig_LoaderInterface, \Twig_ExistsLoaderInterface
{
    /**
     * Array of patterns used to decide if a template is twital-compilable or not.
     * Items are strings or callbacks
     *
     * @var array
     */
    protected $sourceAdapters = array();

    /**
     * The wrapped Twig loader
     *
     * @var \Twig_LoaderInterface
     */
    protected $loader;

    /**
     * The internal Twital compiler
     *
     * @var Twital
     */
    protected $twital;

    /**
     * Creates a new Twital loader.
     * @param \Twig_LoaderInterface $loader
     * @param Twital $twital
     * @param bool $addDefaults If NULL, some standard rules will be used (`*.twital.*` and `*.twital`).
     */
    public function __construct(\Twig_LoaderInterface $loader = null, Twital $twital = null, $addDefaults = true)
    {
        $this->loader = $loader;
        $this->twital = $twital;

        if ($addDefaults === true || (is_array($addDefaults) && in_array('html', $addDefaults))) {
            $this->addSourceAdapter('/\.twital\.html$/i', new HTML5Adapter());
        }
        if ($addDefaults === true || (is_array($addDefaults) && in_array('xml', $addDefaults))) {
            $this->addSourceAdapter('/\.twital\.xml$/i', new XMLAdapter());
        }
        if ($addDefaults === true || (is_array($addDefaults) && in_array('xhtml', $addDefaults))) {
            $this->addSourceAdapter('/\.twital\.xhtml$/i', new XHTMLAdapter());
        }
    }

    public function getSourceContext($name)
    {
        $originalContext = $this->loader->getSourceContext($name);

        $source = $this->getSource($name);

        return new \Twig_Source($source, $name, $originalContext->getPath());
    }

    /**
     * Add a new pattern that can decide if a template is twital-compilable or not.
     * If $pattern is a string, then must be a valid regex that matches the template filename.
     * If $pattern is a callback, then must return true if the template is compilable, false otherwise.
     *
     * @param string|callback $pattern
     * @param SourceAdapter $adapter
     * @return TwitalLoader
     */
    public function addSourceAdapter($pattern, SourceAdapter $adapter)
    {
        $this->sourceAdapters[$pattern] = $adapter;

        return $this;
    }

    /**
     * Get all patterns used to choose if a template is twital-compilable or not
     *
     * @return array:
     */
    public function getSourceAdapters()
    {
        return $this->sourceAdapters;
    }

    /**
     * Decide if a template is twital-compilable or not.
     *
     * @param string $name
     * @return SourceAdapter
     */
    public function getSourceAdapter($name)
    {
        foreach (array_reverse($this->sourceAdapters) as $pattern => $adapter) {
            if (preg_match($pattern, $name)) {
                return $adapter;
            }
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function getSource($name)
    {
        $source = $this->loader->getSource($name);


        if ($adapter = $this->getSourceAdapter($name)) {
            $source = $this->getTwital()->compile($adapter, $source);
        }

        return $source;
    }

    /**
     * {@inheritdoc}
     */
    public function getCacheKey($name)
    {
        return $this->loader->getCacheKey($name);
    }

    /**
     * {@inheritdoc}
     */
    public function isFresh($name, $time)
    {
        return $this->loader->isFresh($name, $time);
    }

    /**
     * {@inheritdoc}
     */
    public function exists($name)
    {
        if (\Twig_Environment::MAJOR_VERSION == 2 || ($this->loader instanceof \Twig_ExistsLoaderInterface)) {
            return $this->loader->exists($name);
        } else {
            try {
                $this->loader->getSource($name);


                return true;
            } catch (\Twig_Error_Loader $e) {
                return false;
            }
        }
    }

    /**
     * Get the wrapped Twig loader
     *
     * @return \Twig_LoaderInterface
     */
    public function getLoader()
    {
        return $this->loader;
    }

    /**
     * Set the wrapped Twig loader
     *
     * @param \Twig_LoaderInterface $loader
     * @return TwitalLoader
     */
    public function setLoader(\Twig_LoaderInterface $loader)
    {
        $this->loader = $loader;

        return $this;
    }

    /**
     * @return Twital
     */
    public function getTwital()
    {
        if ($this->twital===null) {
            $this->twital = new Twital();
        }

        return $this->twital;
    }

}


1		<?php
2		namespace Goetas\Twital;
3
4		use Goetas\Twital\SourceAdapter\HTML5Adapter;
5		use Goetas\Twital\SourceAdapter\XMLAdapter;
6		use Goetas\Twital\SourceAdapter\XHTMLAdapter;
7
8		/**
9		* This is a Twital Loader.
10		* Compiles a Twital template into a Twig template.
11		*
12		* @author Asmir Mustafic <[email protected]>
13		*/
14		class TwitalLoader implements \Twig_LoaderInterface, \Twig_ExistsLoaderInterface
15		{
16		/**
17		* Array of patterns used to decide if a template is twital-compilable or not.
18		* Items are strings or callbacks
19		*
20		* @var array
21		*/
22		protected $sourceAdapters = array();
23
24		/**
25		* The wrapped Twig loader
26		*
27		* @var \Twig_LoaderInterface
28		*/
29		protected $loader;
30
31		/**
32		* The internal Twital compiler
33		*
34		* @var Twital
35		*/
36		protected $twital;
37
38		/**
39		* Creates a new Twital loader.
40		* @param \Twig_LoaderInterface $loader
41		* @param Twital $twital
42		* @param bool $addDefaults If NULL, some standard rules will be used (`.twital.` and `*.twital`).
43		*/
44	32	public function __construct(\Twig_LoaderInterface $loader = null, Twital $twital = null, $addDefaults = true)
45		{
46	32	$this->loader = $loader;
47	32	$this->twital = $twital;
48
49	32	if ($addDefaults === true \|\| (is_array($addDefaults) && in_array('html', $addDefaults))) {
50	6	$this->addSourceAdapter('/\.twital\.html$/i', new HTML5Adapter());
51	6	}
52	32	if ($addDefaults === true \|\| (is_array($addDefaults) && in_array('xml', $addDefaults))) {
53	6	$this->addSourceAdapter('/\.twital\.xml$/i', new XMLAdapter());
54	6	}
55	32	if ($addDefaults === true \|\| (is_array($addDefaults) && in_array('xhtml', $addDefaults))) {
56	6	$this->addSourceAdapter('/\.twital\.xhtml$/i', new XHTMLAdapter());
57	6	}
58	32	}
59
60		public function getSourceContext($name)
61		{
62		$originalContext = $this->loader->getSourceContext($name);
63
64		$source = $this->getSource($name);
65
66		return new \Twig_Source($source, $name, $originalContext->getPath());
67		}
68
69		/**
70		* Add a new pattern that can decide if a template is twital-compilable or not.
71		* If $pattern is a string, then must be a valid regex that matches the template filename.
72		* If $pattern is a callback, then must return true if the template is compilable, false otherwise.
73		*
74		* @param string\|callback $pattern
75		* @param SourceAdapter $adapter
76		* @return TwitalLoader
77		*/
78	30	public function addSourceAdapter($pattern, SourceAdapter $adapter)
79		{
80	30	$this->sourceAdapters[$pattern] = $adapter;
81
82	30	return $this;
83		}
84
85		/**
86		* Get all patterns used to choose if a template is twital-compilable or not
87		*
88		* @return array:
89		*/
90	1	public function getSourceAdapters()
91		{
92	1	return $this->sourceAdapters;
93		}
94
95		/**
96		* Decide if a template is twital-compilable or not.
97		*
98		* @param string $name
99		* @return SourceAdapter
100		*/
101	25	public function getSourceAdapter($name)
102		{
103	25	foreach (array_reverse($this->sourceAdapters) as $pattern => $adapter) {
104	25	if (preg_match($pattern, $name)) {
105	23	return $adapter;
106		}
107	4	}
108
109	2	return null;
110		}
111
112		/**
113		* {@inheritdoc}
114		*/
115	21	public function getSource($name)
116		{
117	21	$source = $this->loader->getSource($name);
		0 ignored issues – show Bug introduced 2017-01-06 12:57 UTC by Report Bug Copy Issue Report The method `getSource()` does not exist on `Twig_LoaderInterface`. Did you maybe mean `getSourceContext()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
118
119	21	if ($adapter = $this->getSourceAdapter($name)) {
120	20	$source = $this->getTwital()->compile($adapter, $source);
121	18	}
122
123	19	return $source;
124		}
125
126		/**
127		* {@inheritdoc}
128		*/
129	22	public function getCacheKey($name)
130		{
131	22	return $this->loader->getCacheKey($name);
132		}
133
134		/**
135		* {@inheritdoc}
136		*/
137		public function isFresh($name, $time)
138		{
139		return $this->loader->isFresh($name, $time);
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145	2	public function exists($name)
146		{
147	2	if (\Twig_Environment::MAJOR_VERSION == 2 \|\| ($this->loader instanceof \Twig_ExistsLoaderInterface)) {
148		return $this->loader->exists($name);
149		} else {
150		try {
151	2	$this->loader->getSource($name);
		0 ignored issues – show Bug introduced 2017-01-06 12:57 UTC by Report Bug Copy Issue Report The method `getSource()` does not exist on `Twig_LoaderInterface`. Did you maybe mean `getSourceContext()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
152
153	1	return true;
154	1	} catch (\Twig_Error_Loader $e) {
155	1	return false;
156		}
157		}
158		}
159
160		/**
161		* Get the wrapped Twig loader
162		*
163		* @return \Twig_LoaderInterface
164		*/
165	1	public function getLoader()
166		{
167	1	return $this->loader;
168		}
169
170		/**
171		* Set the wrapped Twig loader
172		*
173		* @param \Twig_LoaderInterface $loader
174		* @return TwitalLoader
175		*/
176	1	public function setLoader(\Twig_LoaderInterface $loader)
177		{
178	1	$this->loader = $loader;
179
180	1	return $this;
181		}
182
183		/**
184		* @return Twital
185		*/
186	20	public function getTwital()
187		{
188	20	if ($this->twital===null) {
189	19	$this->twital = new Twital();
190	19	}
191
192	20	return $this->twital;
193		}
194
195		}
196

goetas / twital

Push — twig-2 ( a5bda0 )

TwitalLoader::getSourceContext() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like