Partial::resolve() - Code Metrics - Inspection of "refine doc" - zordius/lightncandy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 905076...6870d0 )

by Zordius

created 2016-01-08 03:45 UTC

Partial::resolve() A

↳ Parent: Partial

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

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

<?php
/*

Copyrights for code authored by Yahoo! Inc. is licensed under the following terms:
MIT License
Copyright (c) 2013-2015 Yahoo! Inc. All Rights Reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Origin: https://github.com/zordius/lightncandy
*/

/**
 * file to keep LightnCandy partial methods
 *
 * @package    LightnCandy
 * @author     Zordius <[email protected]>
 */

namespace LightnCandy;

use \LightnCandy\Compiler;
use \LightnCandy\SafeString;
use \LightnCandy\Context;

/**
 * LightnCandy Partial handler
 */
class Partial
{
    public static $TMP_JS_FUNCTION_STR = "!!\aFuNcTiOn\a!!";                                            

    /**
     * Include all partials when using dynamic partials
     */
    public static function handleDynamic(&$context) {
        if ($context['usedFeature']['dynpartial'] == 0) {
            return;
        }

        foreach ($context['partials'] as $name => $code) {
            static::read($context, $name);
        }
    }

    /**
     * Read partial file content as string and store in context
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $code compiled PHP code when success
     */
    public static function read(&$context, $name) {
        $context['usedFeature']['partial']++;

        if (isset($context['usedPartial'][$name])) {
            return;
        }

        $cnt = static::resolve($context, $name);

        if ($cnt !== null) {
            $context['usedPartial'][$name] = SafeString::escapeTemplate($cnt);
            return static::compileDynamic($context, $name);
        }

        if (!$context['flags']['skippartial']) {
            $context['error'][] = "Can not find partial for '$name', you should provide partials or partialresolver in options";
        }
    }

    /**
     * preprocess partial template before it be stored into context
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $tmpl partial template
     * @param string $name partial name
     *
     * @return string|null $content processed partial template
     *
     * @expect 'hey' when input Array('prepartial' => false), 'hey', 'haha'
     * @expect 'haha-hoho' when input Array('prepartial' => function ($cx, $tmpl, $name) {return "$name-$tmpl";}), 'hoho', 'haha'
     */
    protected static function prePartial(&$context, $tmpl, &$name) {
        return $context['prepartial'] ? $context['prepartial']($context, $tmpl, $name) : $tmpl;
    }

    /**
     * resolve partial, return the partial content
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $content partial content
     */
    public static function resolve(&$context, &$name) {
        if (isset($context['partials'][$name])) {
            return static::prePartial($context, $context['partials'][$name], $name);
        }

        return static::resolver($context, $name);
    }

    /**
     * use partialresolver to resolve partial, return the partial content
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $content partial content
     */
    public static function resolver(&$context, &$name) {
        if ($context['partialresolver']) {
            $cnt = $context['partialresolver']($context, $name);
            return static::prePartial($context, $cnt, $name);
        }
    }

    /**
     * compile a partial to static embed PHP code
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $code PHP code string
     */
    public static function compileStatic(&$context, $name) {
        // Check for recursive partial
        if (!$context['flags']['runpart']) {
            $context['partialStack'][] = $name;
            $diff = count($context['partialStack']) - count(array_unique($context['partialStack']));
            if ($diff) {
                $context['error'][] = 'I found recursive partial includes as the path: ' . implode(' -> ', $context['partialStack']) . '! You should fix your template or compile with LightnCandy::FLAG_RUNTIMEPARTIAL flag.';
            }
        }

        $code = Compiler::compileTemplate($context, preg_replace('/^/m', $context['tokens']['partialind'], $context['usedPartial'][$name]));

        if (!$context['flags']['runpart']) {
            array_pop($context['partialStack']);
        }

        return $code;
    }

    /**
     * compile partial as closure, stored in context
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $name partial name
     *
     * @return string|null $code compiled PHP code when success
     */
    public static function compileDynamic(&$context, $name) {
        if (!$context['flags']['runpart']) {
            return;
        }

        $func = static::compile($context, $context['usedPartial'][$name]);

        if (!isset($context['partialCode'][$name])) {
            $context['partialCode'][$name] = "'$name' => $func";
        }

        return $func;
    }

    /**
     * compile a template into a closure function
     *
     * @param array<string,array|string|integer> $context Current context of compiler progress.
     * @param string $template template string
     *
     * @return string $code compiled PHP code
     */
    public static function compile(&$context, $template) {
        $tmpContext = $context;
        $tmpContext['inlinepartial'] = array();
        $tmpContext['partialblock'] = array();
        $code = Compiler::compileTemplate($tmpContext, str_replace('function', static::$TMP_JS_FUNCTION_STR, $template));
        Context::merge($context, $tmpContext);
        if (!$context['flags']['noind']) {
            $sp = ', $sp';
            $code = preg_replace('/^/m', "'{$context['ops']['seperator']}\$sp{$context['ops']['seperator']}'", $code);
            // callbacks inside partial should be aware of $sp
            $code = preg_replace('/\bfunction\s*\((.*?)\)\s*{/', 'function(\\1)use($sp){', $code);
        } else {
            $sp = '';
        }
        $code = str_replace(static::$TMP_JS_FUNCTION_STR, 'function', $code);
        return "function (\$cx, \$in{$sp}) {{$context['ops']['op_start']}'$code'{$context['ops']['op_end']}}";
    }
}



1		<?php
2		/*
3
4		Copyrights for code authored by Yahoo! Inc. is licensed under the following terms:
5		MIT License
6		Copyright (c) 2013-2015 Yahoo! Inc. All Rights Reserved.
7		Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8		The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
9		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
10
11		Origin: https://github.com/zordius/lightncandy
12		*/
13
14		/**
15		* file to keep LightnCandy partial methods
16		*
17		* @package LightnCandy
18		* @author Zordius <[email protected]>
19		*/
20
21		namespace LightnCandy;
22
23		use \LightnCandy\Compiler;
24		use \LightnCandy\SafeString;
25		use \LightnCandy\Context;
26
27		/**
28		* LightnCandy Partial handler
29		*/
30		class Partial
31		{
32		public static $TMP_JS_FUNCTION_STR = "!!\aFuNcTiOn\a!!";
33
34		/**
35		* Include all partials when using dynamic partials
36		*/
37	650	public static function handleDynamic(&$context) {
38	650	if ($context['usedFeature']['dynpartial'] == 0) {
39	646	return;
40		}
41
42	4	foreach ($context['partials'] as $name => $code) {
43	4	static::read($context, $name);
44		}
45	4	}
46
47		/**
48		* Read partial file content as string and store in context
49		*
50		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
51		* @param string $name partial name
52		*
53		* @return string\|null $code compiled PHP code when success
54		*/
55	89	public static function read(&$context, $name) {
56	89	$context['usedFeature']['partial']++;
57
58	89	if (isset($context['usedPartial'][$name])) {
59	26	return;
60		}
61
62	83	$cnt = static::resolve($context, $name);
63
64	83	if ($cnt !== null) {
65	77	$context['usedPartial'][$name] = SafeString::escapeTemplate($cnt);
66	77	return static::compileDynamic($context, $name);
67		}
68
69	6	if (!$context['flags']['skippartial']) {
70	5	$context['error'][] = "Can not find partial for '$name', you should provide partials or partialresolver in options";
71		}
72	6	}
73
74		/**
75		* preprocess partial template before it be stored into context
76		*
77		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
78		* @param string $tmpl partial template
79		* @param string $name partial name
80		*
81		* @return string\|null $content processed partial template
82		*
83		* @expect 'hey' when input Array('prepartial' => false), 'hey', 'haha'
84		* @expect 'haha-hoho' when input Array('prepartial' => function ($cx, $tmpl, $name) {return "$name-$tmpl";}), 'hoho', 'haha'
85		*/
86	78	protected static function prePartial(&$context, $tmpl, &$name) {
87	78	return $context['prepartial'] ? $context['prepartial']($context, $tmpl, $name) : $tmpl;
88		}
89
90		/**
91		* resolve partial, return the partial content
92		*
93		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
94		* @param string $name partial name
95		*
96		* @return string\|null $content partial content
97		*/
98	87	public static function resolve(&$context, &$name) {
99	87	if (isset($context['partials'][$name])) {
100	76	return static::prePartial($context, $context['partials'][$name], $name);
101		}
102
103	12	return static::resolver($context, $name);
104		}
105
106		/**
107		* use partialresolver to resolve partial, return the partial content
108		*
109		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
110		* @param string $name partial name
111		*
112		* @return string\|null $content partial content
113		*/
114	12	public static function resolver(&$context, &$name) {
115	12	if ($context['partialresolver']) {
116	1	$cnt = $context['partialresolver']($context, $name);
117	1	return static::prePartial($context, $cnt, $name);
118		}
119	11	}
120
121		/**
122		* compile a partial to static embed PHP code
123		*
124		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
125		* @param string $name partial name
126		*
127		* @return string\|null $code PHP code string
128		*/
129	9	public static function compileStatic(&$context, $name) {
130		// Check for recursive partial
131	9	if (!$context['flags']['runpart']) {
132	9	$context['partialStack'][] = $name;
133	9	$diff = count($context['partialStack']) - count(array_unique($context['partialStack']));
134	9	if ($diff) {
135	1	$context['error'][] = 'I found recursive partial includes as the path: ' . implode(' -> ', $context['partialStack']) . '! You should fix your template or compile with LightnCandy::FLAG_RUNTIMEPARTIAL flag.';
136		}
137		}
138
139	9	$code = Compiler::compileTemplate($context, preg_replace('/^/m', $context['tokens']['partialind'], $context['usedPartial'][$name]));
140
141	9	if (!$context['flags']['runpart']) {
142	9	array_pop($context['partialStack']);
143		}
144
145	9	return $code;
146		}
147
148		/**
149		* compile partial as closure, stored in context
150		*
151		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
152		* @param string $name partial name
153		*
154		* @return string\|null $code compiled PHP code when success
155		*/
156	89	public static function compileDynamic(&$context, $name) {
157	89	if (!$context['flags']['runpart']) {
158	11	return;
159		}
160
161	78	$func = static::compile($context, $context['usedPartial'][$name]);
162
163	78	if (!isset($context['partialCode'][$name])) {
164	78	$context['partialCode'][$name] = "'$name' => $func";
165		}
166
167	78	return $func;
168		}
169
170		/**
171		* compile a template into a closure function
172		*
173		* @param array<string,array\|string\|integer> $context Current context of compiler progress.
174		* @param string $template template string
175		*
176		* @return string $code compiled PHP code
177		*/
178	78	public static function compile(&$context, $template) {
179	78	$tmpContext = $context;
180	78	$tmpContext['inlinepartial'] = array();
181	78	$tmpContext['partialblock'] = array();
182	78	$code = Compiler::compileTemplate($tmpContext, str_replace('function', static::$TMP_JS_FUNCTION_STR, $template));
183	78	Context::merge($context, $tmpContext);
184	78	if (!$context['flags']['noind']) {
185	73	$sp = ', $sp';
186	73	$code = preg_replace('/^/m', "'{$context['ops']['seperator']}\$sp{$context['ops']['seperator']}'", $code);
187		// callbacks inside partial should be aware of $sp
188	73	$code = preg_replace('/\bfunction\s\((.?)\)\s*{/', 'function(\\1)use($sp){', $code);
189		} else {
190	5	$sp = '';
191		}
192	78	$code = str_replace(static::$TMP_JS_FUNCTION_STR, 'function', $code);
193	78	return "function (\$cx, \$in{$sp}) {{$context['ops']['op_start']}'$code'{$context['ops']['op_end']}}";
194		}
195		}
196
197

zordius / lightncandy

GitHub Access Token became invalid

Push — master ( 905076...6870d0 )

Partial::resolve() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like