ViewHelperFunctions.php ➔ e() - Code Metrics - Inspection of "Added view helper e() as alias for htmlentities." - canax/view - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0327ee...7d0974 )

by Mikael

created 2018-08-30 20:32 UTC

ViewHelperFunctions.php ➔ e() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Anax\View;

/**
 * Define helper functions to include before processing the view template.
 * The functions here are exposed to the view and can be used in the view.
 */

/**
 * Shortcut to create an url for a static asset.
 *
 * @param string $url url to use when creating the url.
 *
 * @return string as resulting url.
 */
function asset($url = "")
{
    global $di;
    return $di->get("url")->asset($url);
}



/**
 * Shortcut to create an url for routing in the framework.
 *
 * @param null|string $url url to use when creating the url.
 *
 * @return string as resulting url.
 */
function url($url = "")
{
    global $di;
    return $di->get("url")->create($url);
}



/**
 * Render a view with an optional data set of variables.
 *
 * @param string $template the template file, or array
 * @param array  $data     variables to make available to the
 *                         view, default is empty
 *
 * @return void
 */
function renderView($template, $data = [])
{
    global $di;
    $view = new View();
    $template = $di->get("view")->getTemplateFile($template);
    $view->set($template, $data);
    $view->render($di);
}



/**
 * Check if the region in the view container has views to render.
 *
 * @param string $region to check
 *
 * @return boolean true or false
 */
function regionHasContent($region)
{
    global $di;
    return $di->get("view")->hasContent($region);
}



/**
 * Render views, from the view container, in the region.
 *
 * @param string $region to render in
 *
 * @return boolean true or false
 */
function renderRegion($region)
{
    global $di;
    return $di->get("view")->render($region);
}



/**
 * Create a class attribute from a string or array.
 *
 * @param string|array $args variable amount of classlists.
 *
 * @return string as complete class attribute
 */
function classList(...$args)
{
    $classes = [];

    foreach ($args as $arg) {
        if (empty($arg)) {
            continue;
        } elseif (is_string($arg)) {
            $arg = explode(" ", $arg);
        }
        $classes = array_merge($classes, $arg);
    }

    return "class=\"" . implode(" ", $classes) . "\"";
}



/**
 * Get current url, without querystring.
 *
 * @return string as resulting url.
 */
function currentUrl()
{
    global $di;
    return $di->get("request")->getCurrentUrl(false);
}



/**
 * Get current route.
 *
 * @return string as resulting route.
 */
function currentRoute()
{
    global $di;
    return $di->get("request")->getRoute();
}



/**
 * Escape HTML entities.
 *
 * @param string $string to be escaped.
 *
 * @return string as resulting route.
 */
function e($string) : string
{
    return htmlentities($string);
}



/**
 * Show variables/functions that are currently defined and can
 * be used within the view. Call the function with get_defined_vars()
 * as the parameter.
 *
 * @param array $variables should be the returned value from
 *                         get_defined_vars()
 * @param array $functions should be the returned value from
 *                         get_defined_functions()
 *
 * @return string showing variables and functions.
 */
function showEnvironment($variables, $functions)
{
    $all = array_keys($variables);
    sort($all);
    $res = "<pre>\n"
        . "VIEW DEVELOPMENT INFORMATION\n"
        . "----------------------------\n"
        . "Variables available:\n"
        . " (var_dump each for more information):\n";
    foreach ($all as $var) {
        $variable = $variables[$var];
        $res .= "* $var (" . gettype($variable) . ")";
        if (is_integer($variable) || is_double($variable)) {
            $res .= ": $variable";
        } elseif (is_string($variable)) {
            $res .= ": \"$variable\"";
        } elseif (is_bool($variable)) {
            $res .= ": " . ( $variable ? "true" : "false" );
        }
        $res .= "\n";
    }

    $res .= "\nView helper functions available:\n (see " . __FILE__ . ")\n";
    $namespace = strtolower(__NAMESPACE__);
    $matches = array_filter(
        $functions["user"],
        function ($function) use ($namespace) {
            return substr($function, 0, strlen($namespace)) === $namespace;
        }
    );
    sort($matches);
    $res .= "* " . implode(",\n* ", $matches);
    $res .= "</pre>";

    return $res;
}



/* OLDER VERSIONS MIGHT NEED IMPLEMENTING */

/**
 * Load content from a route and return details to view.
 *
 * @param string $route to load content from.
 *
 * @return array with values to extract in view.
 */
// public function getContentForRoute($route)
// {
//     $content = $this->di->get("content")->contentForInternalRoute($route);
//     return $content->views["main"]["data"];
// }



/**
 * Wrap a HTML element with start and end.
 *
 * @param string  $text  with content
 * @param string  $tag   HTML tag to search for
 * @param string  $start wrap start part
 * @param string  $end   wrap end part
 * @param number  $count hits to search for
 *
 * @return array with values to extract in view.
 */
// public function wrapElementWithStartEnd($text, $tag, $start, $end, $count)
// {
//     return $this->di->get("textFilter")->wrapElementWithStartEnd($text, $tag, $start, $end, $count);
// }



/**
 * Wrap content of a HTML element with start and end.
 *
 * @param string  $text  with content
 * @param string  $tag   HTML tag to search for
 * @param string  $start wrap start part
 * @param string  $end   wrap end part
 * @param number  $count hits to search for
 *
 * @return array with values to extract in view.
 */
// public function wrapElementContentWithStartEnd($text, $tag, $start, $end, $count)
// {
//     return $this->di->get("textFilter")->wrapElementContentWithStartEnd($text, $tag, $start, $end, $count);
// }



/**
 * Extrat the publish or update date for the article.
 *
 * @param array $dates a collection of possible date values.
 *
 * @return array with values for showing the date.
 */
// public function getPublishedDate($dates)
// {
//     $defaults = [
//         "revision" => [],
//         "published" => null,
//         "updated" => null,
//         "created" => null,
//     ];
//     $dates = array_merge($defaults, $dates);
//
//     if ($dates["revision"]) {
//         return [t("Latest revision"), key($dates["revision"])];
//     } elseif ($dates["published"]) {
//         return [t("Published"), $dates["published"]];
//     } elseif ($dates["updated"]) {
//         return [t("Updated"), $dates["updated"]];
//     } elseif ($dates["created"]) {
//         return [t("Created"), $dates["created"]];
//     }
//
//     return [t("Missing pubdate."), null];
// }


1		<?php
2
3		namespace Anax\View;
4
5		/**
6		* Define helper functions to include before processing the view template.
7		* The functions here are exposed to the view and can be used in the view.
8		*/
9
10		/**
11		* Shortcut to create an url for a static asset.
12		*
13		* @param string $url url to use when creating the url.
14		*
15		* @return string as resulting url.
16		*/
17		function asset($url = "")
18		{
19		global $di;
20		return $di->get("url")->asset($url);
21		}
22
23
24
25		/**
26		* Shortcut to create an url for routing in the framework.
27		*
28		* @param null\|string $url url to use when creating the url.
29		*
30		* @return string as resulting url.
31		*/
32		function url($url = "")
33		{
34		global $di;
35		return $di->get("url")->create($url);
36		}
37
38
39
40		/**
41		* Render a view with an optional data set of variables.
42		*
43		* @param string $template the template file, or array
44		* @param array $data variables to make available to the
45		* view, default is empty
46		*
47		* @return void
48		*/
49		function renderView($template, $data = [])
50		{
51		global $di;
52		$view = new View();
53		$template = $di->get("view")->getTemplateFile($template);
54		$view->set($template, $data);
55		$view->render($di);
56		}
57
58
59
60		/**
61		* Check if the region in the view container has views to render.
62		*
63		* @param string $region to check
64		*
65		* @return boolean true or false
66		*/
67		function regionHasContent($region)
68		{
69		global $di;
70		return $di->get("view")->hasContent($region);
71		}
72
73
74
75		/**
76		* Render views, from the view container, in the region.
77		*
78		* @param string $region to render in
79		*
80		* @return boolean true or false
81		*/
82		function renderRegion($region)
83		{
84		global $di;
85		return $di->get("view")->render($region);
86		}
87
88
89
90		/**
91		* Create a class attribute from a string or array.
92		*
93		* @param string\|array $args variable amount of classlists.
94		*
95		* @return string as complete class attribute
96		*/
97		function classList(...$args)
98		{
99	5	$classes = [];
100
101	5	foreach ($args as $arg) {
102	5	if (empty($arg)) {
103	2	continue;
104	4	} elseif (is_string($arg)) {
105	4	$arg = explode(" ", $arg);
106		}
107	4	$classes = array_merge($classes, $arg);
108		}
109
110	5	return "class=\"" . implode(" ", $classes) . "\"";
111		}
112
113
114
115		/**
116		* Get current url, without querystring.
117		*
118		* @return string as resulting url.
119		*/
120		function currentUrl()
121		{
122		global $di;
123		return $di->get("request")->getCurrentUrl(false);
124		}
125
126
127
128		/**
129		* Get current route.
130		*
131		* @return string as resulting route.
132		*/
133		function currentRoute()
134		{
135		global $di;
136		return $di->get("request")->getRoute();
137		}
138
139
140
141		/**
142		* Escape HTML entities.
143		*
144		* @param string $string to be escaped.
145		*
146		* @return string as resulting route.
147		*/
148		function e($string) : string
149		{
150		return htmlentities($string);
151		}
152
153
154
155		/**
156		* Show variables/functions that are currently defined and can
157		* be used within the view. Call the function with get_defined_vars()
158		* as the parameter.
159		*
160		* @param array $variables should be the returned value from
161		* get_defined_vars()
162		* @param array $functions should be the returned value from
163		* get_defined_functions()
164		*
165		* @return string showing variables and functions.
166		*/
167		function showEnvironment($variables, $functions)
168		{
169		$all = array_keys($variables);
170		sort($all);
171		$res = "<pre>\n"
172		. "VIEW DEVELOPMENT INFORMATION\n"
173		. "----------------------------\n"
174		. "Variables available:\n"
175		. " (var_dump each for more information):\n";
176		foreach ($all as $var) {
177		$variable = $variables[$var];
178		$res .= "* $var (" . gettype($variable) . ")";
179		if (is_integer($variable) \|\| is_double($variable)) {
180		$res .= ": $variable";
181		} elseif (is_string($variable)) {
182		$res .= ": \"$variable\"";
183		} elseif (is_bool($variable)) {
184		$res .= ": " . ( $variable ? "true" : "false" );
185		}
186		$res .= "\n";
187		}
188
189		$res .= "\nView helper functions available:\n (see " . __FILE__ . ")\n";
190		$namespace = strtolower(__NAMESPACE__);
191		$matches = array_filter(
192		$functions["user"],
193		function ($function) use ($namespace) {
194		return substr($function, 0, strlen($namespace)) === $namespace;
195		}
196		);
197		sort($matches);
198		$res .= "* " . implode(",\n* ", $matches);
199		$res .= "</pre>";
200
201		return $res;
202		}
203
204
205
206		/* OLDER VERSIONS MIGHT NEED IMPLEMENTING */
207
208		/**
209		* Load content from a route and return details to view.
210		*
211		* @param string $route to load content from.
212		*
213		* @return array with values to extract in view.
214		*/
215		// public function getContentForRoute($route)
216		// {
217		// $content = $this->di->get("content")->contentForInternalRoute($route);
218		// return $content->views["main"]["data"];
219		// }
220
221
222
223		/**
224		* Wrap a HTML element with start and end.
225		*
226		* @param string $text with content
227		* @param string $tag HTML tag to search for
228		* @param string $start wrap start part
229		* @param string $end wrap end part
230		* @param number $count hits to search for
231		*
232		* @return array with values to extract in view.
233		*/
234		// public function wrapElementWithStartEnd($text, $tag, $start, $end, $count)
235		// {
236		// return $this->di->get("textFilter")->wrapElementWithStartEnd($text, $tag, $start, $end, $count);
237		// }
238
239
240
241		/**
242		* Wrap content of a HTML element with start and end.
243		*
244		* @param string $text with content
245		* @param string $tag HTML tag to search for
246		* @param string $start wrap start part
247		* @param string $end wrap end part
248		* @param number $count hits to search for
249		*
250		* @return array with values to extract in view.
251		*/
252		// public function wrapElementContentWithStartEnd($text, $tag, $start, $end, $count)
253		// {
254		// return $this->di->get("textFilter")->wrapElementContentWithStartEnd($text, $tag, $start, $end, $count);
255		// }
256
257
258
259		/**
260		* Extrat the publish or update date for the article.
261		*
262		* @param array $dates a collection of possible date values.
263		*
264		* @return array with values for showing the date.
265		*/
266		// public function getPublishedDate($dates)
267		// {
268		// $defaults = [
269		// "revision" => [],
270		// "published" => null,
271		// "updated" => null,
272		// "created" => null,
273		// ];
274		// $dates = array_merge($defaults, $dates);
275		//
276		// if ($dates["revision"]) {
277		// return [t("Latest revision"), key($dates["revision"])];
278		// } elseif ($dates["published"]) {
279		// return [t("Published"), $dates["published"]];
280		// } elseif ($dates["updated"]) {
281		// return [t("Updated"), $dates["updated"]];
282		// } elseif ($dates["created"]) {
283		// return [t("Created"), $dates["created"]];
284		// }
285		//
286		// return [t("Missing pubdate."), null];
287		// }
288

canax / view

Push — master ( 0327ee...7d0974 )

ViewHelperFunctions.php ➔ e() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like