TJavaScript::quoteJsLiteral() - Code Metrics - Inspection of "TModule::dyInit and subclass init chaining, TParam..." - pradosoft/prado - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a355c3...d448eb )

by Fabio

created 2021-05-11 07:02 UTC

TJavaScript::quoteJsLiteral() A

↳ Parent: TJavaScript

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

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

<?php
/**
 * TJavaScript class file
 *
 * @author Wei Zhuo<weizhuo[at]gmail[dot]com>
 * @link https://github.com/pradosoft/prado
 * @license https://github.com/pradosoft/prado/blob/master/LICENSE
 * @package Prado\Web\Javascripts
 */

namespace Prado\Web\Javascripts;

use Prado\Web\THttpUtility;
use Prado\Prado;

/**
 * TJavaScript class.
 *
 * TJavaScript is a utility class containing commonly-used javascript-related
 * functions.
 *
 * @author Wei Zhuo<weizhuo[at]gmail[dot]com>
 * @package Prado\Web\Javascripts
 * @since 3.0
 */
class TJavaScript
{
	/**
	 * Renders a list of javascript files
	 * @param array $files URLs to the javascript files
	 * @return string rendering result
	 */
	public static function renderScriptFiles($files)
	{
		$str = '';
		foreach ($files as $file) {
			$str .= self::renderScriptFile($file);
		}
		return $str;
	}

	/**
	 * Renders a javascript file
	 * @param Prado\Web\Javascripts\TJavaScriptAsset|string $asset URL to the javascript file or TJavaScriptAsset
filter:
    dependency_paths: ["lib/*"]
	 * @return string rendering result
	 */
	public static function renderScriptFile($asset)
	{
		if (is_object($asset) && ($asset instanceof TJavaScriptAsset)) {
			return $asset->__toString() . "\n";
		}
		return '<script src="' . THttpUtility::htmlEncode($asset) . "\"></script>\n";
	}

	/**
	 * Renders a list of javascript blocks
	 * @param array $scripts javascript blocks
	 * @return string rendering result
	 */
	public static function renderScriptBlocks($scripts)
	{
		if (count($scripts)) {
			return "<script>\n/*<![CDATA[*/\n" . implode("\n", $scripts) . "\n/*]]>*/\n</script>\n";
		} else {
			return '';
		}
	}

	/**
	 * Renders a list of javascript code
	 * @param array $scripts javascript blocks
	 * @return string rendering result
	 */
	public static function renderScriptBlocksCallback($scripts)
	{
		if (count($scripts)) {
			return implode("\n", $scripts) . "\n";
		} else {
			return '';
		}
	}

	/**
	 * Renders javascript block
	 * @param string $script javascript block
	 * @return string rendering result
	 */
	public static function renderScriptBlock($script)
	{
		return "<script>\n/*<![CDATA[*/\n{$script}\n/*]]>*/\n</script>\n";
	}

	/**
	 * Quotes a javascript string.
	 * After processing, the string is safely enclosed within a pair of
	 * quotation marks and can serve as a javascript string.
	 * @param string $js string to be quoted
	 * @return string the quoted string
	 */
	public static function quoteString($js)
	{
		return self::jsonEncode($js, JSON_HEX_QUOT | JSON_HEX_APOS | JSON_HEX_TAG);
	}

	/**
	 * @param mixed $js
	 * @return TJavaScriptLiteral Marks a string as a javascript function. Once marke, the string is considered as a
	 * raw javascript function that is not supposed to be encoded by {@link encode}
	 */
	public static function quoteJsLiteral($js)
	{
		if ($js instanceof TJavaScriptLiteral) {
			return $js;
		} else {
			return new TJavaScriptLiteral($js);
		}
	}

	/**
	 * @param mixed $js
	 * @return bool true if the parameter is marked as a javascript function, i.e. if it's considered as a
	 * raw javascript function that is not supposed to be encoded by {@link encode}
	 */
	public static function isJsLiteral($js)
	{
		return ($js instanceof TJavaScriptLiteral);
	}

	/**
	 * Encodes a PHP variable into javascript representation.
	 *
	 * Example:
	 * <code>
	 * $options['onLoading'] = "doit";
	 * $options['onComplete'] = "more";
	 * echo TJavaScript::encode($options);
	 * //expects the following javascript code
	 * // {'onLoading':'doit','onComplete':'more'}
	 * </code>
	 *
	 * For higher complexity data structures use {@link jsonEncode} and {@link jsonDecode}
	 * to serialize and unserialize.
	 *
	 * @param mixed $value PHP variable to be encoded
	 * @param bool $toMap whether the output is a map or a list.
	 * @since 3.1.5
	 * @param bool $encodeEmptyStrings wether to encode empty strings too. Default to false for BC.
	 * @return string the encoded string
	 */
	public static function encode($value, $toMap = true, $encodeEmptyStrings = false)
	{
		if (is_string($value)) {
			return self::quoteString($value);
		} elseif (is_bool($value)) {
			return $value ? 'true' : 'false';
		} elseif (is_array($value)) {
			$results = '';
			if (($n = count($value)) > 0 && array_keys($value) !== range(0, $n - 1)) {
				foreach ($value as $k => $v) {
					if ($v !== '' || $encodeEmptyStrings) {
						if ($results !== '') {
							$results .= ',';
						}
						$results .= "'$k':" . self::encode($v, $toMap, $encodeEmptyStrings);
					}
				}
				return '{' . $results . '}';
			} else {
				foreach ($value as $v) {
					if ($v !== '' || $encodeEmptyStrings) {
						if ($results !== '') {
							$results .= ',';
						}
						$results .= self::encode($v, $toMap, $encodeEmptyStrings);
					}
				}
				return '[' . $results . ']';
			}
		} elseif (is_int($value)) {
			return "$value";
		} elseif (is_float($value)) {
			switch ($value) {
				case -INF:
					return 'Number.NEGATIVE_INFINITY';
					break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
				case INF:
					return 'Number.POSITIVE_INFINITY';
					break;
				default:
					$locale = localeConv();
					if ($locale['decimal_point'] == '.') {
						return "$value";
					} else {
						return str_replace($locale['decimal_point'], '.', "$value");
					}
					break;
			}
		} elseif (is_object($value)) {
			if ($value instanceof TJavaScriptLiteral) {
				return $value->toJavaScriptLiteral();
			} else {
				return self::encode(get_object_vars($value), $toMap);
			}
		} elseif ($value === null) {
			return 'null';
		} else {
			return '';
		}
	}
	/**
	 * Encodes a PHP variable into javascript string.
	 * This method invokes json_encode to perform the encoding.
	 * @param mixed $value variable to be encoded
	 * @param mixed $options
	 * @return string encoded string
	 */
	public static function jsonEncode($value, $options = 0)
	{
		if (($g = Prado::getApplication()->getGlobalization(false)) !== null &&
			strtoupper($enc = $g->getCharset()) != 'UTF-8') {
			self::convertToUtf8($value, $enc);
		}

		$s = @json_encode($value, $options);
		self::checkJsonError();
		return $s;

	}

	/**
	 * Encodes an string or the content of an array to UTF8
	 * @param array|mixed|string $value
	 * @param string $sourceEncoding
	 */
	private static function convertToUtf8(&$value, $sourceEncoding)
	{
		if (is_string($value)) {
			$value = iconv($sourceEncoding, 'UTF-8', $value);
		} elseif (is_array($value)) {
			foreach ($value as &$element) {
				self::convertToUtf8($element, $sourceEncoding);
			}
		}
	}

	/**
	 * Decodes a javascript string into PHP variable.
	 * This method invokes json_decode to perform the decoding.
	 * @param string $value string to be decoded
	 * @param bool $assoc whether to convert returned objects to associative arrays
	 * @param int $depth recursion depth
	 * @return mixed decoded variable
	 */
	public static function jsonDecode($value, $assoc = false, $depth = 512)
	{
		$s = @json_decode($value, $assoc, $depth);
		self::checkJsonError();
		return $s;
	}

	private static function checkJsonError()
	{
		switch ($err = json_last_error()) {
			case JSON_ERROR_NONE:
				return;
				break;
switch ($x) {
    case 1:
        return 'foo';
        break; // This break is not necessary and can be left off.
}
			case JSON_ERROR_DEPTH:
				$msg = 'Maximum stack depth exceeded';
				break;
			case JSON_ERROR_STATE_MISMATCH:
				$msg = 'Underflow or the modes mismatch';
				break;
			case JSON_ERROR_CTRL_CHAR:
				$msg = 'Unexpected control character found';
				break;
			case JSON_ERROR_SYNTAX:
				$msg = 'Syntax error, malformed JSON';
				break;
			case JSON_ERROR_UTF8:
				$msg = 'Malformed UTF-8 characters, possibly incorrectly encoded';
				break;
			default:
				$msg = 'Unknown error';
				break;
		}
		throw new \Exception("JSON error ($err): $msg");
	}

	/**
	 * Minimize the size of a javascript script.
	 * This method is based on Douglas Crockford's JSMin.
	 * @param string $code code that you want to minimzie
	 * @return string minimized version of the code
	 */
	public static function JSMin($code)
	{
		return \JSMin\JSMin::minify($code);
	}
}


1		<?php
2		/**
3		* TJavaScript class file
4		*
5		* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
6		* @link https://github.com/pradosoft/prado
7		* @license https://github.com/pradosoft/prado/blob/master/LICENSE
8		* @package Prado\Web\Javascripts
9		*/
10
11		namespace Prado\Web\Javascripts;
12
13		use Prado\Web\THttpUtility;
14		use Prado\Prado;
15
16		/**
17		* TJavaScript class.
18		*
19		* TJavaScript is a utility class containing commonly-used javascript-related
20		* functions.
21		*
22		* @author Wei Zhuo<weizhuo[at]gmail[dot]com>
23		* @package Prado\Web\Javascripts
24		* @since 3.0
25		*/
26		class TJavaScript
27		{
28		/**
29		* Renders a list of javascript files
30		* @param array $files URLs to the javascript files
31		* @return string rendering result
32		*/
33		public static function renderScriptFiles($files)
34		{
35		$str = '';
36		foreach ($files as $file) {
37		$str .= self::renderScriptFile($file);
38		}
39		return $str;
40		}
41
42		/**
43		* Renders a javascript file
44		* @param Prado\Web\Javascripts\TJavaScriptAsset\|string $asset URL to the javascript file or TJavaScriptAsset
		0 ignored issues – show Bug introduced 2021-05-10 22:56 UTC by Report Bug Copy Issue Report The type `Prado\Prado\Web\Javascripts\TJavaScriptAsset` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
45		* @return string rendering result
46		*/
47		public static function renderScriptFile($asset)
48		{
49		if (is_object($asset) && ($asset instanceof TJavaScriptAsset)) {
50		return $asset->__toString() . "\n";
51		}
52		return '<script src="' . THttpUtility::htmlEncode($asset) . "\"></script>\n";
53		}
54
55		/**
56		* Renders a list of javascript blocks
57		* @param array $scripts javascript blocks
58		* @return string rendering result
59		*/
60		public static function renderScriptBlocks($scripts)
61		{
62		if (count($scripts)) {
63		return "<script>\n/<![CDATA[/\n" . implode("\n", $scripts) . "\n/]]>/\n</script>\n";
64		} else {
65		return '';
66		}
67		}
68
69		/**
70		* Renders a list of javascript code
71		* @param array $scripts javascript blocks
72		* @return string rendering result
73		*/
74		public static function renderScriptBlocksCallback($scripts)
75		{
76		if (count($scripts)) {
77		return implode("\n", $scripts) . "\n";
78		} else {
79		return '';
80		}
81		}
82
83		/**
84		* Renders javascript block
85		* @param string $script javascript block
86		* @return string rendering result
87		*/
88		public static function renderScriptBlock($script)
89		{
90		return "<script>\n/<![CDATA[/\n{$script}\n/]]>/\n</script>\n";
91		}
92
93		/**
94		* Quotes a javascript string.
95		* After processing, the string is safely enclosed within a pair of
96		* quotation marks and can serve as a javascript string.
97		* @param string $js string to be quoted
98		* @return string the quoted string
99		*/
100		public static function quoteString($js)
101		{
102		return self::jsonEncode($js, JSON_HEX_QUOT \| JSON_HEX_APOS \| JSON_HEX_TAG);
103		}
104
105		/**
106		* @param mixed $js
107		* @return TJavaScriptLiteral Marks a string as a javascript function. Once marke, the string is considered as a
108		* raw javascript function that is not supposed to be encoded by {@link encode}
109		*/
110		public static function quoteJsLiteral($js)
111		{
112		if ($js instanceof TJavaScriptLiteral) {
113		return $js;
114		} else {
115		return new TJavaScriptLiteral($js);
116		}
117		}
118
119		/**
120		* @param mixed $js
121	92	* @return bool true if the parameter is marked as a javascript function, i.e. if it's considered as a
122		* raw javascript function that is not supposed to be encoded by {@link encode}
123	92	*/
124		public static function isJsLiteral($js)
125		{
126		return ($js instanceof TJavaScriptLiteral);
127		}
128
129		/**
130		* Encodes a PHP variable into javascript representation.
131		*
132		* Example:
133		* <code>
134		* $options['onLoading'] = "doit";
135		* $options['onComplete'] = "more";
136		* echo TJavaScript::encode($options);
137		* //expects the following javascript code
138		* // {'onLoading':'doit','onComplete':'more'}
139		* </code>
140		*
141		* For higher complexity data structures use {@link jsonEncode} and {@link jsonDecode}
142		* to serialize and unserialize.
143		*
144		* @param mixed $value PHP variable to be encoded
145		* @param bool $toMap whether the output is a map or a list.
146		* @since 3.1.5
147		* @param bool $encodeEmptyStrings wether to encode empty strings too. Default to false for BC.
148		* @return string the encoded string
149		*/
150		public static function encode($value, $toMap = true, $encodeEmptyStrings = false)
151		{
152		if (is_string($value)) {
153		return self::quoteString($value);
154		} elseif (is_bool($value)) {
155		return $value ? 'true' : 'false';
156		} elseif (is_array($value)) {
157		$results = '';
158		if (($n = count($value)) > 0 && array_keys($value) !== range(0, $n - 1)) {
159		foreach ($value as $k => $v) {
160		if ($v !== '' \|\| $encodeEmptyStrings) {
161		if ($results !== '') {
162		$results .= ',';
163		}
164		$results .= "'$k':" . self::encode($v, $toMap, $encodeEmptyStrings);
165		}
166		}
167		return '{' . $results . '}';
168		} else {
169		foreach ($value as $v) {
170		if ($v !== '' \|\| $encodeEmptyStrings) {
171		if ($results !== '') {
172		$results .= ',';
173		}
174		$results .= self::encode($v, $toMap, $encodeEmptyStrings);
175		}
176		}
177		return '[' . $results . ']';
178		}
179		} elseif (is_int($value)) {
180		return "$value";
181		} elseif (is_float($value)) {
182		switch ($value) {
183		case -INF:
184		return 'Number.NEGATIVE_INFINITY';
185		break;
		0 ignored issues – show Unused Code introduced 2018-02-15 21:32 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
186		case INF:
187		return 'Number.POSITIVE_INFINITY';
188		break;
189		default:
190		$locale = localeConv();
191		if ($locale['decimal_point'] == '.') {
192		return "$value";
193		} else {
194		return str_replace($locale['decimal_point'], '.', "$value");
195		}
196		break;
197		}
198		} elseif (is_object($value)) {
199		if ($value instanceof TJavaScriptLiteral) {
200		return $value->toJavaScriptLiteral();
201		} else {
202		return self::encode(get_object_vars($value), $toMap);
203		}
204		} elseif ($value === null) {
205		return 'null';
206		} else {
207		return '';
208		}
209		}
210		/**
211		* Encodes a PHP variable into javascript string.
212		* This method invokes json_encode to perform the encoding.
213		* @param mixed $value variable to be encoded
214		* @param mixed $options
215		* @return string encoded string
216		*/
217		public static function jsonEncode($value, $options = 0)
218		{
219		if (($g = Prado::getApplication()->getGlobalization(false)) !== null &&
220		strtoupper($enc = $g->getCharset()) != 'UTF-8') {
221		self::convertToUtf8($value, $enc);
222		}
223
224		$s = @json_encode($value, $options);
225		self::checkJsonError();
226		return $s;
		0 ignored issues – show Bug Best Practice introduced 2021-01-28 17:38 UTC by Report Bug Copy Issue Report The expression `return $s` could also return `false` which is incompatible with the documented return type `string`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
227		}
228
229		/**
230		* Encodes an string or the content of an array to UTF8
231		* @param array\|mixed\|string $value
232		* @param string $sourceEncoding
233		*/
234		private static function convertToUtf8(&$value, $sourceEncoding)
235		{
236		if (is_string($value)) {
237		$value = iconv($sourceEncoding, 'UTF-8', $value);
238		} elseif (is_array($value)) {
239		foreach ($value as &$element) {
240		self::convertToUtf8($element, $sourceEncoding);
241		}
242		}
243		}
244
245		/**
246		* Decodes a javascript string into PHP variable.
247		* This method invokes json_decode to perform the decoding.
248		* @param string $value string to be decoded
249		* @param bool $assoc whether to convert returned objects to associative arrays
250		* @param int $depth recursion depth
251		* @return mixed decoded variable
252		*/
253		public static function jsonDecode($value, $assoc = false, $depth = 512)
254		{
255		$s = @json_decode($value, $assoc, $depth);
256		self::checkJsonError();
257		return $s;
258		}
259
260		private static function checkJsonError()
261		{
262		switch ($err = json_last_error()) {
263		case JSON_ERROR_NONE:
264		return;
265		break;
		0 ignored issues – show Unused Code introduced 2018-02-15 21:32 UTC by Report Bug Copy Issue Report `break` is not strictly necessary here and could be removed. The `break` statement is not necessary if it is preceded for example by a `return` statement: switch ($x) { case 1: return 'foo'; break; // This break is not necessary and can be left off. } If you would like to keep this construct to be consistent with other `case` statements, you can safely mark this issue as a false-positive. Loading history...
266		case JSON_ERROR_DEPTH:
267		$msg = 'Maximum stack depth exceeded';
268		break;
269		case JSON_ERROR_STATE_MISMATCH:
270		$msg = 'Underflow or the modes mismatch';
271		break;
272		case JSON_ERROR_CTRL_CHAR:
273		$msg = 'Unexpected control character found';
274		break;
275		case JSON_ERROR_SYNTAX:
276		$msg = 'Syntax error, malformed JSON';
277		break;
278		case JSON_ERROR_UTF8:
279		$msg = 'Malformed UTF-8 characters, possibly incorrectly encoded';
280		break;
281		default:
282		$msg = 'Unknown error';
283		break;
284		}
285		throw new \Exception("JSON error ($err): $msg");
286		}
287
288		/**
289		* Minimize the size of a javascript script.
290		* This method is based on Douglas Crockford's JSMin.
291		* @param string $code code that you want to minimzie
292		* @return string minimized version of the code
293		*/
294		public static function JSMin($code)
295		{
296		return \JSMin\JSMin::minify($code);
297		}
298		}
299

pradosoft / prado

Push — master ( a355c3...d448eb )

TJavaScript::quoteJsLiteral() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like