TemplateFunctions::session() - Code Metrics - Inspection of "Added angular srv for requests." - psfs/core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b1c7c3...216fd2 )

by Fran

created 2017-03-20 19:56 UTC

TemplateFunctions::session() A

↳ Parent: TemplateFunctions

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php
namespace PSFS\base\extension;

use PSFS\base\config\Config;
use PSFS\base\exception\ConfigException;
use PSFS\base\Request;
use PSFS\base\Router;
use PSFS\base\Security;
use PSFS\base\Template;
use PSFS\base\types\Form;
use PSFS\base\types\helpers\GeneratorHelper;
use PSFS\Services\GeneratorService;
use Symfony\Component\Translation\Tests\StringClass;

class TemplateFunctions
{

    const ASSETS_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::asset";
    const ROUTE_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::route";
    const CONFIG_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::config";
    const BUTTON_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::button";
    const WIDGET_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::widget";
    const FORM_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::form";
    const RESOURCE_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::resource";
    const SESSION_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::session";
    const EXISTS_FLASH_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::existsFlash";
    const GET_FLASH_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::getFlash";

    /**
     * Función que copia los recursos de las carpetas Public al DocumentRoot
     * @param $string
     * @param null $name
     * @param bool|TRUE $return
     *
     * @return string
     */
    public static function asset($string, $name = null, $return = true)
    {

        $file_path = "";
        if (!file_exists($file_path)) {
            $file_path = BASE_DIR . $string;
        }
        $filename_path = AssetsParser::findDomainPath($string, $file_path);

        $file_path = self::processAsset($string, $name, $return, $filename_path);
        $return_path = (empty($name)) ? Request::getInstance()->getRootUrl() . '/' . $file_path : $name;
        return ($return) ? $return_path : '';
    }

    /**
     * Función que devuelve una url correspondiente a una ruta
     * @param string $path
     * @param bool|FALSE $absolute
     * @param array $params

     *
     * @return string|null
     */
    public static function route($path = '', $absolute = false, array $params = null)
    {
        $router = Router::getInstance();
        try {
            return $router->getRoute($path, $absolute, $params);
        } catch (\Exception $e) {
            return $router->getRoute('', $absolute, $params);
        }
    }

    /**
     * Función que devuelve un parámetro de la configuración
     * @param $param
     * @param string $default
     *
     * @return string
     */
    public static function config($param, $default = '')
    {
        return Config::getInstance()->get($param) ?: $default;
    }

    /**
     * Método que devuelve un botón en html para la plantilla de formularios
     * @param array $button
     */
    public static function button(array $button)
    {
        Template::getInstance()->getTemplateEngine()->display('forms/button.html.twig', array(
            'button' => $button,
        ));
    }

    /**
     * Función que pinta parte de un formulario
     * @param array $field
     * @param StringClass $label
     */
    public static function widget(array $field, StringClass $label = null)
    {
        if (!empty($label)) {
            $field["label"] = $label;
        }
        //Limpiamos los campos obligatorios
        if (!isset($field["required"])) {
            $field["required"] = true;
        } elseif (isset($field["required"]) && (bool)$field["required"] === false) {
            unset($field["required"]);
        }
        Template::getInstance()->getTemplateEngine()->display('forms/field.html.twig', array(
            'field' => $field,
        ));
    }

    /**
     * Función que deveulve un formulario en html
     * @param Form $form
     */
    public static function form(Form $form)
    {
        Template::getInstance()->getTemplateEngine()->display('forms/base.html.twig', array(
            'form' => $form,
        ));
    }

    /**
     * Función que copia un recurso directamente en el DocumentRoot
     * @param string $path
     * @param string $dest
     * @param bool|FALSE $force
     *
     * @return string
     * @throws ConfigException
     */
    public static function resource($path, $dest, $force = false)
    {
        $debug = Config::getInstance()->getDebugMode();
        $domains = Template::getDomains(true);
        $filename_path = self::extractPathname($path, $domains);
        GeneratorService::copyResources($dest, $force, $filename_path, $debug);
        return '';
    }

    /**
     * Método que extrae el pathname para un dominio
     * @param string $path
     * @param $domains
     *
     * @return mixed

     */
    private static function extractPathname($path, $domains)
    {
        $filename_path = $path;
        if (!file_exists($path) && !empty($domains)) {
            foreach ($domains as $domain => $paths) {
                $domain_filename = str_replace($domain, $paths["public"], $path);
                if (file_exists($domain_filename)) {
                    $filename_path = $domain_filename;
                    continue;
                }
            }

        }

        return $filename_path;
    }

    /**
     * @param string $filename_path
     */
    private static function processCssLines($filename_path)
    {
        $handle = @fopen($filename_path, 'r');
        if ($handle) {
            while (!feof($handle)) {
                AssetsParser::extractCssLineResource($handle, $filename_path);
            }
            fclose($handle);
        }
    }

    /**
     * Método que copia el contenido de un recurso en su destino correspondiente
     * @param string $name
     * @param string $filename_path
     * @param string $base
     * @param string $file_path
     */
    private static function putResourceContent($name, $filename_path, $base, $file_path)
    {
        $data = file_get_contents($filename_path);
        if (!empty($name)) file_put_contents(WEB_DIR . DIRECTORY_SEPARATOR . $name, $data);
        else file_put_contents($base . $file_path, $data);
    }

    /**
     * Método que procesa un recurso para su copia en el DocumentRoot
     * @param string $string
     * @param string $name
     * @param boolean $return
     * @param string $filename_path
     *
     * @return string
     */
    private static function processAsset($string, $name, $return, $filename_path)
    {
        $file_path = $filename_path;
        if (file_exists($filename_path)) {
            list($base, $html_base, $file_path) = AssetsParser::calculateAssetPath($string, $name, $return, $filename_path);

            //Creamos el directorio si no existe
            GeneratorHelper::createDir($base . $html_base);
            //Si se ha modificado
            if (!file_exists($base . $file_path) || filemtime($base . $file_path) < filemtime($filename_path)) {
                if ($html_base == 'css') {
                    self::processCssLines($filename_path);
                }
                self::putResourceContent($name, $filename_path, $base, $file_path);
            }
        }

        return $file_path;
    }

    /**
     * Template function for get a session var
     * @param string $key
     * @return mixed
     */
    public static function session($key)
    {
        return Security::getInstance()->getSessionKey($key);
    }

    /**
     * Template function that check if exists any flash session var
     * @param string $key
     * @return bool
     */
    public static function existsFlash($key = '')
    {
        return null !== Security::getInstance()->getFlash($key);
    }

    /**
     * Template function that get a flash session var
     * @param string $key
     * @return mixed
     */
    public static function getFlash($key)
    {
        $var = Security::getInstance()->getFlash($key);
        Security::getInstance()->setFlash($key, null);
        return $var;
    }
}

1			<?php
2			namespace PSFS\base\extension;
3
4			use PSFS\base\config\Config;
5			use PSFS\base\exception\ConfigException;
6			use PSFS\base\Request;
7			use PSFS\base\Router;
8			use PSFS\base\Security;
9			use PSFS\base\Template;
10			use PSFS\base\types\Form;
11			use PSFS\base\types\helpers\GeneratorHelper;
12			use PSFS\Services\GeneratorService;
13			use Symfony\Component\Translation\Tests\StringClass;
14
15			class TemplateFunctions
16			{
17
18			const ASSETS_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::asset";
19			const ROUTE_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::route";
20			const CONFIG_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::config";
21			const BUTTON_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::button";
22			const WIDGET_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::widget";
23			const FORM_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::form";
24			const RESOURCE_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::resource";
25			const SESSION_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::session";
26			const EXISTS_FLASH_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::existsFlash";
27			const GET_FLASH_FUNCTION = "\\PSFS\\base\\extension\\TemplateFunctions::getFlash";
28
29			/**
30			* Función que copia los recursos de las carpetas Public al DocumentRoot
31			* @param $string
32			* @param null $name
33			* @param bool\|TRUE $return
34			*
35			* @return string
36			*/
37			public static function asset($string, $name = null, $return = true)
38			{
39
40			$file_path = "";
41			if (!file_exists($file_path)) {
42			$file_path = BASE_DIR . $string;
43			}
44			$filename_path = AssetsParser::findDomainPath($string, $file_path);
45
46			$file_path = self::processAsset($string, $name, $return, $filename_path);
47			$return_path = (empty($name)) ? Request::getInstance()->getRootUrl() . '/' . $file_path : $name;
48			return ($return) ? $return_path : '';
49			}
50
51			/**
52			* Función que devuelve una url correspondiente a una ruta
53			* @param string $path
54			* @param bool\|FALSE $absolute
55			* @param array $params
			0 ignored issues – show Documentation introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report Should the type for parameter `$params` not be `null\|array`? Also, consider making the array more specific, something like `array<String>`, or `String[]`. This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. In addition it looks for parameters that have the generic type `array` and suggests a stricter type like `array<String>`. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
56			*
57			* @return string\|null
58			*/
59	1		public static function route($path = '', $absolute = false, array $params = null)
60			{
61	1		$router = Router::getInstance();
62			try {
63	1		return $router->getRoute($path, $absolute, $params);
64			} catch (\Exception $e) {
65			return $router->getRoute('', $absolute, $params);
66			}
67			}
68
69			/**
70			* Función que devuelve un parámetro de la configuración
71			* @param $param
72			* @param string $default
73			*
74			* @return string
75			*/
76	1		public static function config($param, $default = '')
77			{
78	1		return Config::getInstance()->get($param) ?: $default;
79			}
80
81			/**
82			* Método que devuelve un botón en html para la plantilla de formularios
83			* @param array $button
84			*/
85			public static function button(array $button)
86			{
87			Template::getInstance()->getTemplateEngine()->display('forms/button.html.twig', array(
88			'button' => $button,
89			));
90			}
91
92			/**
93			* Función que pinta parte de un formulario
94			* @param array $field
95			* @param StringClass $label
96			*/
97			public static function widget(array $field, StringClass $label = null)
98			{
99			if (!empty($label)) {
100			$field["label"] = $label;
101			}
102			//Limpiamos los campos obligatorios
103			if (!isset($field["required"])) {
104			$field["required"] = true;
105			} elseif (isset($field["required"]) && (bool)$field["required"] === false) {
106			unset($field["required"]);
107			}
108			Template::getInstance()->getTemplateEngine()->display('forms/field.html.twig', array(
109			'field' => $field,
110			));
111			}
112
113			/**
114			* Función que deveulve un formulario en html
115			* @param Form $form
116			*/
117			public static function form(Form $form)
118			{
119			Template::getInstance()->getTemplateEngine()->display('forms/base.html.twig', array(
120			'form' => $form,
121			));
122			}
123
124			/**
125			* Función que copia un recurso directamente en el DocumentRoot
126			* @param string $path
127			* @param string $dest
128			* @param bool\|FALSE $force
129			*
130			* @return string
131			* @throws ConfigException
132			*/
133			public static function resource($path, $dest, $force = false)
134			{
135			$debug = Config::getInstance()->getDebugMode();
136			$domains = Template::getDomains(true);
137			$filename_path = self::extractPathname($path, $domains);
138			GeneratorService::copyResources($dest, $force, $filename_path, $debug);
139			return '';
140			}
141
142			/**
143			* Método que extrae el pathname para un dominio
144			* @param string $path
145			* @param $domains
146			*
147			* @return mixed
			0 ignored issues – show Documentation introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `string`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
148			*/
149			private static function extractPathname($path, $domains)
150			{
151			$filename_path = $path;
152		View Code Duplication	if (!file_exists($path) && !empty($domains)) {
153			foreach ($domains as $domain => $paths) {
154			$domain_filename = str_replace($domain, $paths["public"], $path);
155			if (file_exists($domain_filename)) {
156			$filename_path = $domain_filename;
157			continue;
158			}
159			}
160
161			}
162
163			return $filename_path;
164			}
165
166			/**
167			* @param string $filename_path
168			*/
169			private static function processCssLines($filename_path)
170			{
171			$handle = @fopen($filename_path, 'r');
172			if ($handle) {
173			while (!feof($handle)) {
174			AssetsParser::extractCssLineResource($handle, $filename_path);
175			}
176			fclose($handle);
177			}
178			}
179
180			/**
181			* Método que copia el contenido de un recurso en su destino correspondiente
182			* @param string $name
183			* @param string $filename_path
184			* @param string $base
185			* @param string $file_path
186			*/
187			private static function putResourceContent($name, $filename_path, $base, $file_path)
188			{
189			$data = file_get_contents($filename_path);
190			if (!empty($name)) file_put_contents(WEB_DIR . DIRECTORY_SEPARATOR . $name, $data);
191			else file_put_contents($base . $file_path, $data);
192			}
193
194			/**
195			* Método que procesa un recurso para su copia en el DocumentRoot
196			* @param string $string
197			* @param string $name
198			* @param boolean $return
199			* @param string $filename_path
200			*
201			* @return string
202			*/
203			private static function processAsset($string, $name, $return, $filename_path)
204			{
205			$file_path = $filename_path;
206			if (file_exists($filename_path)) {
207			list($base, $html_base, $file_path) = AssetsParser::calculateAssetPath($string, $name, $return, $filename_path);
			0 ignored issues – show Coding Style introduced 2016-05-07 10:58 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 124 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
208			//Creamos el directorio si no existe
209			GeneratorHelper::createDir($base . $html_base);
210			//Si se ha modificado
211			if (!file_exists($base . $file_path) \|\| filemtime($base . $file_path) < filemtime($filename_path)) {
212			if ($html_base == 'css') {
213			self::processCssLines($filename_path);
214			}
215			self::putResourceContent($name, $filename_path, $base, $file_path);
216			}
217			}
218
219			return $file_path;
220			}
221
222			/**
223			* Template function for get a session var
224			* @param string $key
225			* @return mixed
226			*/
227			public static function session($key)
228			{
229			return Security::getInstance()->getSessionKey($key);
230			}
231
232			/**
233			* Template function that check if exists any flash session var
234			* @param string $key
235			* @return bool
236			*/
237	1		public static function existsFlash($key = '')
238			{
239	1		return null !== Security::getInstance()->getFlash($key);
240			}
241
242			/**
243			* Template function that get a flash session var
244			* @param string $key
245			* @return mixed
246			*/
247			public static function getFlash($key)
248			{
249			$var = Security::getInstance()->getFlash($key);
250			Security::getInstance()->setFlash($key, null);
251			return $var;
252			}
253			}

psfs / core

Push — master ( b1c7c3...216fd2 )

TemplateFunctions::session() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like