Template::setPublicZone() - Code Metrics - Inspection of "Passed again unit tests" - psfs/core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( ed25dd...eced50 )

by Fran

created 2018-09-14 00:52 UTC

Template::setPublicZone() A

↳ Parent: Template

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php
namespace PSFS\base;

use PSFS\base\config\Config;
use PSFS\base\extension\AssetsTokenParser;
use PSFS\base\extension\CustomTranslateExtension;
use PSFS\base\extension\TemplateFunctions;
use PSFS\base\types\helpers\GeneratorHelper;
use PSFS\base\types\helpers\ResponseHelper;
use PSFS\base\types\traits\OutputTrait;
use PSFS\base\types\traits\RouteTrait;
use PSFS\base\types\traits\SingletonTrait;

/**
 * Class Template
 * @package PSFS\base
 */
class Template
{
    use SingletonTrait;
    use OutputTrait;
    use RouteTrait;
    const STATUS_OK = 'HTTP/1.0 200 OK';
    /**
     * @var \Twig_Environment tpl
     */
    protected $tpl;
    protected $filters = array();

    /**
     * Constructor por defecto
     */
    public function __construct()
    {
        $this->setup();
        $this->addTemplateFunctions();
        $this->addTemplateTokens();
        $this->optimizeTemplates();
    }

    /**
     * Método que devuelve el loader del Template
     * @return \Twig_LoaderInterface
     */
    public function getLoader()
    {
        return $this->tpl->getLoader();
    }

    /**
     * Método que activa la zona pública
     * @param bool $public
     *
     * @return Template
     */
    public function setPublicZone($public = true)
    {
        $this->public_zone = $public;
        return $this;
    }

    /**
     * @return bool
     */
    public function isPublicZone() {
        return $this->public_zone;
    }

    /**
     * Método que procesa la plantilla
     *
     * @param string $tpl
     * @param array $vars
     * @param array $cookies
     *
     * @return string HTML
     */
    public function render($tpl, array $vars = array(), array $cookies = array())
    {
        Logger::log('Start render response');
        $vars = ResponseHelper::setDebugHeaders($vars);
        $output = $this->dump($tpl, $vars);

        return $this->output($output, 'text/html', $cookies);
    }

    /**
     * Método que añade una nueva ruta al path de Twig
     * @param $path
     * @param $domain
     *
     * @return Template
     */
    public function addPath($path, $domain = '')
    {
        $this->tpl->getLoader()->addPath($path, $domain);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }

    /**
     * Método que devuelve el contenido de una plantilla
     * @param string $tpl
     * @param array $vars
     * @return string
     */
    public function dump($tpl, array $vars = array())
    {
        $vars["__user__"] = Security::getInstance()->getUser();
        $vars["__admin__"] = Security::getInstance()->getAdmin();
        $vars["__profiles__"] = Security::getCleanProfiles();
        $vars["__flash__"] = Security::getInstance()->getFlashes();
        $vars["__get__"] = Request::getInstance()->getQueryParams();
        $vars["__post__"] = Request::getInstance()->getData();
        $dump = '';
        try {
            $dump = $this->tpl->render($tpl, $vars);
        } catch (\Exception $e) {
            Logger::log($e->getMessage(), LOG_ERR);
        }
        return $dump;
    }

    /**
     * Método que añade una función al motor de plantillas
     * @param string $templateFunction
     * @param $functionName
     *
     * @return Template
     */
    protected function addTemplateFunction($templateFunction, $functionName)
    {
        $function = new \Twig_SimpleFunction($templateFunction, $functionName);
        $this->tpl->addFunction($function);
        return $this;
    }

    /**
     * Servicio que regenera todas las plantillas
     * @return array
     */
    public function regenerateTemplates()
    {
        $this->generateTemplatesCache();
        $domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . "domains.json", Cache::JSON, true);
        $translations = [];
        if (is_array($domains)) {
            $translations = $this->parsePathTranslations($domains);
        }
        $translations[] = _("Plantillas regeneradas correctamente");
        return $translations;
    }

    /**
     * @param $tplDir
     * @param string $domain
     *
     * @return mixed
     */
    protected function generateTemplate($tplDir, $domain = '')
    {
        $templatesDir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($tplDir), \RecursiveIteratorIterator::LEAVES_ONLY);
        foreach ($templatesDir as $file) {
            // force compilation
            if ($file->isFile()) {
                try {
                    $this->tpl->load(str_replace($tplDir . '/', '', $file));
                } catch (\Exception $e) {
                    Logger::log($e->getMessage(), LOG_ERR, ['file' => $e->getFile(), 'line' => $e->getLine()]);
                }
            }
        }
        return str_replace("%d", $domain, str_replace("%s", $tplDir, _("Generando plantillas en path '%s' para el dominio '%d'")));
    }

    /**
     * Método que extrae el path de un string
     * @param $path
     *
     * @return string
     */
    public static function extractPath($path)
    {
        $explodePath = explode(DIRECTORY_SEPARATOR, $path);
        $realPath = array();
        for ($i = 0, $parts = count($explodePath) - 1; $i < $parts; $i++) {
            $realPath[] = $explodePath[$i];
        }
        return implode(DIRECTORY_SEPARATOR, $realPath);
    }

    /**
     * Método que devuelve los dominios de una plataforma
     * @param bool $append
     * @return array
     */
    static public function getDomains($append = false)
    {
        $domains = Router::getInstance()->getDomains();
        if ($append) {
            foreach ($domains as &$domain) {
                foreach ($domain as &$path) {
                    $path .= DIRECTORY_SEPARATOR;
                }
            }
        }
        return $domains;
    }

    /**
     * Método que añade todas las funciones de las plantillas
     */
    private function addTemplateFunctions()
    {
        //Asignamos las funciones especiales
        $functions = [
            'asset' => TemplateFunctions::ASSETS_FUNCTION,
            'form' => TemplateFunctions::FORM_FUNCTION,
            'form_widget' => TemplateFunctions::WIDGET_FUNCTION,
            'form_button' => TemplateFunctions::BUTTON_FUNCTION,
            'get_config' => TemplateFunctions::CONFIG_FUNCTION,
            'path' => TemplateFunctions::ROUTE_FUNCTION,
            'resource' => TemplateFunctions::RESOURCE_FUNCTION,
            'session' => TemplateFunctions::SESSION_FUNCTION,
            'existsFlash' => TemplateFunctions::EXISTS_FLASH_FUNCTION,
            'getFlash' => TemplateFunctions::GET_FLASH_FUNCTION,
            'getQuery' => TemplateFunctions::GET_QUERY_FUNCTION,
        ];
        foreach($functions as $name => $function) {
            $this->addTemplateFunction($name, $function);
        }
    }

    /**
     * Método que devuelve el motod de plantillas
     * @return \Twig_Environment
     */
    public function getTemplateEngine()
    {
        return $this->tpl;
    }

    /**
     * Method that extract all domains for using them with the templates
     */
    private function loadDomains()
    {
        $domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json', Cache::JSON, true);
        if (null !== $domains) {
            foreach ($domains as $domain => $paths) {
                $this->addPath($paths['template'], preg_replace('/(@|\/)/', '', $domain));
            }
        }
    }

    /**
     * Método que inicializa el motor de plantillas
     */
    private function setup()
    {
        $loader = new \Twig_Loader_Filesystem(GeneratorHelper::getTemplatePath());
        $this->tpl = new \Twig_Environment($loader, array(
            'cache' => CACHE_DIR . DIRECTORY_SEPARATOR . 'twig',
            'debug' => (bool)$this->debug,
            'auto_reload' => Config::getParam('twig.autoreload', TRUE),
        ));
        $this->loadDomains();
    }

    /**
     * Método que inyecta los parseadores
     */
    private function addTemplateTokens()
    {
        //Añadimos las extensiones de los tags
        $this->tpl->addTokenParser(new AssetsTokenParser("css"));
        $this->tpl->addTokenParser(new AssetsTokenParser("js"));
    }

    /**
     * Método que inyecta las optimizaciones al motor de la plantilla
     */
    private function optimizeTemplates()
    {
        //Optimizamos
        $this->tpl->addExtension(new CustomTranslateExtension());
    }

    /**
     * Method that extract all path tag for extracting translations
     * @param array $domains
     *
     * @return array
     */
    private function parsePathTranslations($domains)
    {
        $translations = array();
        if (!empty($domains)) {
            foreach ($domains as $domain => $paths) {
                if (strlen($domain) && array_key_exists("template", $paths)) {
                    $this->addPath($paths["template"], $domain);
                    $translations[] = $this->generateTemplate($paths["template"], $domain);
                }
            }
        }

        return $translations;
    }

    /**
     * Method that generate all template caches
     */
    private function generateTemplatesCache()
    {
        /** @var \Twig_Loader_Filesystem $loader */
        $loader = $this->tpl->getLoader();
        $availablePaths = $loader->getPaths();
        if (!empty($availablePaths)) {
            foreach ($availablePaths as $path) {
                $this->generateTemplate($path);
            }
        }
    }
}


1		<?php
2		namespace PSFS\base;
3
4		use PSFS\base\config\Config;
5		use PSFS\base\extension\AssetsTokenParser;
6		use PSFS\base\extension\CustomTranslateExtension;
7		use PSFS\base\extension\TemplateFunctions;
8		use PSFS\base\types\helpers\GeneratorHelper;
9		use PSFS\base\types\helpers\ResponseHelper;
10		use PSFS\base\types\traits\OutputTrait;
11		use PSFS\base\types\traits\RouteTrait;
12		use PSFS\base\types\traits\SingletonTrait;
13
14		/**
15		* Class Template
16		* @package PSFS\base
17		*/
18		class Template
19		{
20		use SingletonTrait;
21		use OutputTrait;
22		use RouteTrait;
23		const STATUS_OK = 'HTTP/1.0 200 OK';
24		/**
25		* @var \Twig_Environment tpl
26		*/
27		protected $tpl;
28		protected $filters = array();
29
30		/**
31		* Constructor por defecto
32		*/
33	1	public function __construct()
34		{
35	1	$this->setup();
36	1	$this->addTemplateFunctions();
37	1	$this->addTemplateTokens();
38	1	$this->optimizeTemplates();
39	1	}
40
41		/**
42		* Método que devuelve el loader del Template
43		* @return \Twig_LoaderInterface
44		*/
45	1	public function getLoader()
46		{
47	1	return $this->tpl->getLoader();
48		}
49
50		/**
51		* Método que activa la zona pública
52		* @param bool $public
53		*
54		* @return Template
55		*/
56	1	public function setPublicZone($public = true)
57		{
58	1	$this->public_zone = $public;
59	1	return $this;
60		}
61
62		/**
63		* @return bool
64		*/
65	1	public function isPublicZone() {
66	1	return $this->public_zone;
67		}
68
69		/**
70		* Método que procesa la plantilla
71		*
72		* @param string $tpl
73		* @param array $vars
74		* @param array $cookies
75		*
76		* @return string HTML
77		*/
78	1	public function render($tpl, array $vars = array(), array $cookies = array())
79		{
80	1	Logger::log('Start render response');
81	1	$vars = ResponseHelper::setDebugHeaders($vars);
82		$output = $this->dump($tpl, $vars);
83
84		return $this->output($output, 'text/html', $cookies);
85		}
86
87		/**
88		* Método que añade una nueva ruta al path de Twig
89		* @param $path
90		* @param $domain
91		*
92		* @return Template
93		*/
94	2	public function addPath($path, $domain = '')
95		{
96	2	$this->tpl->getLoader()->addPath($path, $domain);
		0 ignored issues – show Bug introduced 2017-05-30 22:50 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twig_LoaderInterface` as the method `addPath()` does only exist in the following implementations of said interface: `Twig\Loader\FilesystemLoader`, `Twig_Loader_Filesystem`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
97	2	return $this;
98		}
99
100		/**
101		* Método que devuelve el contenido de una plantilla
102		* @param string $tpl
103		* @param array $vars
104		* @return string
105		*/
106	1	public function dump($tpl, array $vars = array())
107		{
108	1	$vars["__user__"] = Security::getInstance()->getUser();
109	1	$vars["__admin__"] = Security::getInstance()->getAdmin();
110	1	$vars["__profiles__"] = Security::getCleanProfiles();
111	1	$vars["__flash__"] = Security::getInstance()->getFlashes();
112	1	$vars["__get__"] = Request::getInstance()->getQueryParams();
113	1	$vars["__post__"] = Request::getInstance()->getData();
114	1	$dump = '';
115		try {
116	1	$dump = $this->tpl->render($tpl, $vars);
117		} catch (\Exception $e) {
118		Logger::log($e->getMessage(), LOG_ERR);
119		}
120	1	return $dump;
121		}
122
123		/**
124		* Método que añade una función al motor de plantillas
125		* @param string $templateFunction
126		* @param $functionName
127		*
128		* @return Template
129		*/
130	1	protected function addTemplateFunction($templateFunction, $functionName)
131		{
132	1	$function = new \Twig_SimpleFunction($templateFunction, $functionName);
133	1	$this->tpl->addFunction($function);
134	1	return $this;
135		}
136
137		/**
138		* Servicio que regenera todas las plantillas
139		* @return array
140		*/
141	1	public function regenerateTemplates()
142		{
143	1	$this->generateTemplatesCache();
144	1	$domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . "domains.json", Cache::JSON, true);
145	1	$translations = [];
146	1	if (is_array($domains)) {
147	1	$translations = $this->parsePathTranslations($domains);
148		}
149	1	$translations[] = _("Plantillas regeneradas correctamente");
150	1	return $translations;
151		}
152
153		/**
154		* @param $tplDir
155		* @param string $domain
156		*
157		* @return mixed
158		*/
159	1	protected function generateTemplate($tplDir, $domain = '')
160		{
161	1	$templatesDir = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($tplDir), \RecursiveIteratorIterator::LEAVES_ONLY);
162	1	foreach ($templatesDir as $file) {
163		// force compilation
164	1	if ($file->isFile()) {
165		try {
166	1	$this->tpl->load(str_replace($tplDir . '/', '', $file));
167	1	} catch (\Exception $e) {
168	1	Logger::log($e->getMessage(), LOG_ERR, ['file' => $e->getFile(), 'line' => $e->getLine()]);
169		}
170		}
171		}
172	1	return str_replace("%d", $domain, str_replace("%s", $tplDir, _("Generando plantillas en path '%s' para el dominio '%d'")));
173		}
174
175		/**
176		* Método que extrae el path de un string
177		* @param $path
178		*
179		* @return string
180		*/
181	1	public static function extractPath($path)
182		{
183	1	$explodePath = explode(DIRECTORY_SEPARATOR, $path);
184	1	$realPath = array();
185	1	for ($i = 0, $parts = count($explodePath) - 1; $i < $parts; $i++) {
186	1	$realPath[] = $explodePath[$i];
187		}
188	1	return implode(DIRECTORY_SEPARATOR, $realPath);
189		}
190
191		/**
192		* Método que devuelve los dominios de una plataforma
193		* @param bool $append
194		* @return array
195		*/
196	1	static public function getDomains($append = false)
197		{
198	1	$domains = Router::getInstance()->getDomains();
199	1	if ($append) {
200	1	foreach ($domains as &$domain) {
201	1	foreach ($domain as &$path) {
202	1	$path .= DIRECTORY_SEPARATOR;
203		}
204		}
205		}
206	1	return $domains;
207		}
208
209		/**
210		* Método que añade todas las funciones de las plantillas
211		*/
212	1	private function addTemplateFunctions()
213		{
214		//Asignamos las funciones especiales
215		$functions = [
216	1	'asset' => TemplateFunctions::ASSETS_FUNCTION,
217	1	'form' => TemplateFunctions::FORM_FUNCTION,
218	1	'form_widget' => TemplateFunctions::WIDGET_FUNCTION,
219	1	'form_button' => TemplateFunctions::BUTTON_FUNCTION,
220	1	'get_config' => TemplateFunctions::CONFIG_FUNCTION,
221	1	'path' => TemplateFunctions::ROUTE_FUNCTION,
222	1	'resource' => TemplateFunctions::RESOURCE_FUNCTION,
223	1	'session' => TemplateFunctions::SESSION_FUNCTION,
224	1	'existsFlash' => TemplateFunctions::EXISTS_FLASH_FUNCTION,
225	1	'getFlash' => TemplateFunctions::GET_FLASH_FUNCTION,
226	1	'getQuery' => TemplateFunctions::GET_QUERY_FUNCTION,
227		];
228	1	foreach($functions as $name => $function) {
229	1	$this->addTemplateFunction($name, $function);
230		}
231	1	}
232
233		/**
234		* Método que devuelve el motod de plantillas
235		* @return \Twig_Environment
236		*/
237	1	public function getTemplateEngine()
238		{
239	1	return $this->tpl;
240		}
241
242		/**
243		* Method that extract all domains for using them with the templates
244		*/
245	1	private function loadDomains()
246		{
247	1	$domains = Cache::getInstance()->getDataFromFile(CONFIG_DIR . DIRECTORY_SEPARATOR . 'domains.json', Cache::JSON, true);
248	1	if (null !== $domains) {
249	1	foreach ($domains as $domain => $paths) {
250	1	$this->addPath($paths['template'], preg_replace('/(@\|\/)/', '', $domain));
251		}
252		}
253	1	}
254
255		/**
256		* Método que inicializa el motor de plantillas
257		*/
258	1	private function setup()
259		{
260	1	$loader = new \Twig_Loader_Filesystem(GeneratorHelper::getTemplatePath());
261	1	$this->tpl = new \Twig_Environment($loader, array(
262	1	'cache' => CACHE_DIR . DIRECTORY_SEPARATOR . 'twig',
263	1	'debug' => (bool)$this->debug,
264	1	'auto_reload' => Config::getParam('twig.autoreload', TRUE),
265		));
266	1	$this->loadDomains();
267	1	}
268
269		/**
270		* Método que inyecta los parseadores
271		*/
272	1	private function addTemplateTokens()
273		{
274		//Añadimos las extensiones de los tags
275	1	$this->tpl->addTokenParser(new AssetsTokenParser("css"));
276	1	$this->tpl->addTokenParser(new AssetsTokenParser("js"));
277	1	}
278
279		/**
280		* Método que inyecta las optimizaciones al motor de la plantilla
281		*/
282	1	private function optimizeTemplates()
283		{
284		//Optimizamos
285	1	$this->tpl->addExtension(new CustomTranslateExtension());
286	1	}
287
288		/**
289		* Method that extract all path tag for extracting translations
290		* @param array $domains
291		*
292		* @return array
293		*/
294	1	private function parsePathTranslations($domains)
295		{
296	1	$translations = array();
297	1	if (!empty($domains)) {
298	1	foreach ($domains as $domain => $paths) {
299	1	if (strlen($domain) && array_key_exists("template", $paths)) {
300	1	$this->addPath($paths["template"], $domain);
301	1	$translations[] = $this->generateTemplate($paths["template"], $domain);
302		}
303		}
304		}
305
306	1	return $translations;
307		}
308
309		/**
310		* Method that generate all template caches
311		*/
312	1	private function generateTemplatesCache()
313		{
314		/** @var \Twig_Loader_Filesystem $loader */
315	1	$loader = $this->tpl->getLoader();
316	1	$availablePaths = $loader->getPaths();
317	1	if (!empty($availablePaths)) {
318	1	foreach ($availablePaths as $path) {
319	1	$this->generateTemplate($path);
320		}
321		}
322	1	}
323		}
324

psfs / core

Push — master ( ed25dd...eced50 )

Template::setPublicZone() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like