Engine::__construct() - Code Metrics - Inspection of "Hash last updated timestamp value for Assets" - thephpleague/plates - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#153)

by Harry

created 2017-09-25 06:17 UTC

Engine::__construct() A

↳ Parent: Engine

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1.0019

Importance

Changes

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

<?php

namespace League\Plates;

use League\Plates\Extension\ExtensionInterface;
use League\Plates\Template\Data;
use League\Plates\Template\Directory;
use League\Plates\Template\FileExtension;
use League\Plates\Template\Folders;
use League\Plates\Template\Func;
use League\Plates\Template\Functions;
use League\Plates\Template\Name;
use League\Plates\Template\Template;

/**
 * Template API and environment settings storage.
 */
class Engine
{
    /**
     * Default template directory.
     * @var Directory
     */
    protected $directory;

    /**
     * Template file extension.
     * @var FileExtension
     */
    protected $fileExtension;

    /**
     * Collection of template folders.
     * @var Folders
     */
    protected $folders;

    /**
     * Collection of template functions.
     * @var Functions
     */
    protected $functions;

    /**
     * Collection of preassigned template data.
     * @var Data
     */
    protected $data;

    /**
     * Create new Engine instance.
     * @param string $directory
     * @param string $fileExtension
     */
    public function __construct($directory = null, $fileExtension = 'php')
    {
        $this->directory = new Directory($directory);
        $this->fileExtension = new FileExtension($fileExtension);
        $this->folders = new Folders();
        $this->functions = new Functions();
        $this->data = new Data();
    }

    /**
     * Set path to templates directory.
     * @param  string|null $directory Pass null to disable the default directory.
     * @return Engine
     */
    public function setDirectory($directory)
    {
        $this->directory->set($directory);

        return $this;
    }

    /**
     * Get path to templates directory.
     * @return string
     */
    public function getDirectory()
    {
        return $this->directory->get();
    }

    /**
     * Set the template file extension.
     * @param  string|null $fileExtension Pass null to manually set it.
     * @return Engine
     */
    public function setFileExtension($fileExtension)
    {
        $this->fileExtension->set($fileExtension);

        return $this;
    }

    /**
     * Get the template file extension.
     * @return string
     */
    public function getFileExtension()
    {
        return $this->fileExtension->get();
    }

    /**
     * Add a new template folder for grouping templates under different namespaces.
     * @param  string  $name
     * @param  string  $directory
     * @param  boolean $fallback
     * @return Engine
     */
    public function addFolder($name, $directory, $fallback = false)
    {
        $this->folders->add($name, $directory, $fallback);

        return $this;
    }

    /**
     * Remove a template folder.
     * @param  string $name
     * @return Engine
     */
    public function removeFolder($name)
    {
        $this->folders->remove($name);

        return $this;
    }

    /**
     * Get collection of all template folders.
     * @return Folders
     */
    public function getFolders()
    {
        return $this->folders;
    }

    /**
     * Add preassigned template data.
     * @param  array             $data;
     * @param  null|string|array $templates;
     * @return Engine
     */
    public function addData(array $data, $templates = null)
    {
        $this->data->add($data, $templates);

        return $this;
    }

    /**
     * Get all preassigned template data.
     * @param  null|string $template;
     * @return array
     */
    public function getData($template = null)
    {
        return $this->data->get($template);
    }

    /**
     * Register a new template function.
     * @param  string   $name;
     * @param  callback $callback;
     * @return Engine
     */
    public function registerFunction($name, $callback)
    {
        $this->functions->add($name, $callback);

        return $this;
    }

    /**
     * Remove a template function.
     * @param  string $name;
     * @return Engine
     */
    public function dropFunction($name)
    {
        $this->functions->remove($name);

        return $this;
    }

    /**
     * Get a template function.
     * @param  string $name
     * @return Func
     */
    public function getFunction($name)
    {
        return $this->functions->get($name);
    }

    /**
     * Check if a template function exists.
     * @param  string  $name
     * @return boolean
     */
    public function doesFunctionExist($name)
    {
        return $this->functions->exists($name);
    }

    /**
     * Load an extension.
     * @param  ExtensionInterface $extension
     * @return Engine
     */
    public function loadExtension(ExtensionInterface $extension)
    {
        $extension->register($this);

        return $this;
    }

    /**
     * Load multiple extensions.
     * @param  array  $extensions
     * @return Engine
     */
    public function loadExtensions(array $extensions = array())
    {
        foreach ($extensions as $extension) {
            $this->loadExtension($extension);
        }

        return $this;
    }

    /**
     * Get a template path.
     * @param  string $name
     * @return string
     */
    public function path($name)
    {
        $name = new Name($this, $name);

        return $name->getPath();
    }

    /**
     * Check if a template exists.
     * @param  string  $name
     * @return boolean
     */
    public function exists($name)
    {
        $name = new Name($this, $name);

        return $name->doesPathExist();
    }

    /**
     * Create a new template.
     * @param  string   $name
     * @return Template
     */
    public function make($name)
    {
        return new Template($this, $name);
    }

    /**
     * Create a new template and render it.
     * @param  string $name
     * @param  array  $data
     * @return string
     */
    public function render($name, array $data = array())
    {
        return $this->make($name)->render($data);
    }
}


1		<?php
2
3		namespace League\Plates;
4
5		use League\Plates\Extension\ExtensionInterface;
6		use League\Plates\Template\Data;
7		use League\Plates\Template\Directory;
8		use League\Plates\Template\FileExtension;
9		use League\Plates\Template\Folders;
10		use League\Plates\Template\Func;
11		use League\Plates\Template\Functions;
12		use League\Plates\Template\Name;
13		use League\Plates\Template\Template;
14
15		/**
16		* Template API and environment settings storage.
17		*/
18		class Engine
19		{
20		/**
21		* Default template directory.
22		* @var Directory
23		*/
24		protected $directory;
25
26		/**
27		* Template file extension.
28		* @var FileExtension
29		*/
30		protected $fileExtension;
31
32		/**
33		* Collection of template folders.
34		* @var Folders
35		*/
36		protected $folders;
37
38		/**
39		* Collection of template functions.
40		* @var Functions
41		*/
42		protected $functions;
43
44		/**
45		* Collection of preassigned template data.
46		* @var Data
47		*/
48		protected $data;
49
50		/**
51		* Create new Engine instance.
52		* @param string $directory
53		* @param string $fileExtension
54		*/
55	158	public function __construct($directory = null, $fileExtension = 'php')
56		{
57	158	$this->directory = new Directory($directory);
58	158	$this->fileExtension = new FileExtension($fileExtension);
59	158	$this->folders = new Folders();
60	158	$this->functions = new Functions();
61	158	$this->data = new Data();
62	158	}
63
64		/**
65		* Set path to templates directory.
66		* @param string\|null $directory Pass null to disable the default directory.
67		* @return Engine
68		*/
69	8	public function setDirectory($directory)
70		{
71	8	$this->directory->set($directory);
72
73	6	return $this;
74		}
75
76		/**
77		* Get path to templates directory.
78		* @return string
79		*/
80	76	public function getDirectory()
81		{
82	76	return $this->directory->get();
83		}
84
85		/**
86		* Set the template file extension.
87		* @param string\|null $fileExtension Pass null to manually set it.
88		* @return Engine
89		*/
90	6	public function setFileExtension($fileExtension)
91		{
92	6	$this->fileExtension->set($fileExtension);
93
94	6	return $this;
95		}
96
97		/**
98		* Get the template file extension.
99		* @return string
100		*/
101	100	public function getFileExtension()
102		{
103	100	return $this->fileExtension->get();
104		}
105
106		/**
107		* Add a new template folder for grouping templates under different namespaces.
108		* @param string $name
109		* @param string $directory
110		* @param boolean $fallback
111		* @return Engine
112		*/
113	42	public function addFolder($name, $directory, $fallback = false)
114		{
115	42	$this->folders->add($name, $directory, $fallback);
116
117	40	return $this;
118		}
119
120		/**
121		* Remove a template folder.
122		* @param string $name
123		* @return Engine
124		*/
125	2	public function removeFolder($name)
126		{
127	2	$this->folders->remove($name);
128
129	2	return $this;
130		}
131
132		/**
133		* Get collection of all template folders.
134		* @return Folders
135		*/
136	16	public function getFolders()
137		{
138	16	return $this->folders;
139		}
140
141		/**
142		* Add preassigned template data.
143		* @param array $data;
144		* @param null\|string\|array $templates;
145		* @return Engine
146		*/
147	6	public function addData(array $data, $templates = null)
148		{
149	6	$this->data->add($data, $templates);
150
151	6	return $this;
152		}
153
154		/**
155		* Get all preassigned template data.
156		* @param null\|string $template;
157		* @return array
158		*/
159	68	public function getData($template = null)
160		{
161	68	return $this->data->get($template);
162		}
163
164		/**
165		* Register a new template function.
166		* @param string $name;
167		* @param callback $callback;
168		* @return Engine
169		*/
170	78	public function registerFunction($name, $callback)
171		{
172	78	$this->functions->add($name, $callback);
173
174	78	return $this;
175		}
176
177		/**
178		* Remove a template function.
179		* @param string $name;
180		* @return Engine
181		*/
182	4	public function dropFunction($name)
183		{
184	4	$this->functions->remove($name);
185
186	2	return $this;
187		}
188
189		/**
190		* Get a template function.
191		* @param string $name
192		* @return Func
193		*/
194	10	public function getFunction($name)
195		{
196	10	return $this->functions->get($name);
197		}
198
199		/**
200		* Check if a template function exists.
201		* @param string $name
202		* @return boolean
203		*/
204	20	public function doesFunctionExist($name)
205		{
206	20	return $this->functions->exists($name);
207		}
208
209		/**
210		* Load an extension.
211		* @param ExtensionInterface $extension
212		* @return Engine
213		*/
214	4	public function loadExtension(ExtensionInterface $extension)
215		{
216	4	$extension->register($this);
217
218	4	return $this;
219		}
220
221		/**
222		* Load multiple extensions.
223		* @param array $extensions
224		* @return Engine
225		*/
226	2	public function loadExtensions(array $extensions = array())
227		{
228	2	foreach ($extensions as $extension) {
229	2	$this->loadExtension($extension);
230	2	}
231
232	2	return $this;
233		}
234
235		/**
236		* Get a template path.
237		* @param string $name
238		* @return string
239		*/
240	2	public function path($name)
241		{
242	2	$name = new Name($this, $name);
243
244	2	return $name->getPath();
245		}
246
247		/**
248		* Check if a template exists.
249		* @param string $name
250		* @return boolean
251		*/
252	2	public function exists($name)
253		{
254	2	$name = new Name($this, $name);
255
256	2	return $name->doesPathExist();
257		}
258
259		/**
260		* Create a new template.
261		* @param string $name
262		* @return Template
263		*/
264	20	public function make($name)
265		{
266	20	return new Template($this, $name);
267		}
268
269		/**
270		* Create a new template and render it.
271		* @param string $name
272		* @param array $data
273		* @return string
274		*/
275	6	public function render($name, array $data = array())
276		{
277	6	return $this->make($name)->render($data);
278		}
279		}
280

thephpleague / plates

Pull Request — master (#153)

Engine::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like