functions.php ➔ html_select_options() - Code Metrics - Inspection of "Merge pull request #31990 from owncloud/fix-31804" - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a615bf...3f14d2 )

unknown

created 2018-07-23 15:26 UTC

functions.php ➔ html_select_options() C

↳ Parent: Project

Complexity

Conditions	12
Paths	144

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	12
nc	144
nop	3
dl	0
loc	27
rs	6.6
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * @author Bart Visscher <[email protected]>
 * @author Bernhard Posselt <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Jörn Friedrich Dreyer <[email protected]>
 * @author Lukas Reschke <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin McCorkell <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Thomas Müller <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

/**
 * Prints a sanitized string
 * @param string $string the string which will be escaped and printed
 */
function p($string) {
	print(\OCP\Util::sanitizeHTML($string));
}

/**
 * Prints an unsanitized string - usage of this function may result into XSS.
 * Consider using p() instead.
 * @param string|array $string the string which will be printed as it is
 */
function print_unescaped($string) {
	print($string);
}

/**
 * Shortcut for adding scripts to a page
 * @param string $app the appname
 * @param string|string[] $file the filename,
 * if an array is given it will add all scripts
 */
function script($app, $file = null) {
	if (\is_array($file)) {
		foreach ($file as $f) {
			OC_Util::addScript($app, $f);
		}
	} else {
		OC_Util::addScript($app, $file);
	}
}

/**
 * Shortcut for adding vendor scripts to a page
 * @param string $app the appname
 * @param string|string[] $file the filename,
 * if an array is given it will add all scripts
 */
function vendor_script($app, $file = null) {
	if (\is_array($file)) {
		foreach ($file as $f) {
			OC_Util::addVendorScript($app, $f);
		}
	} else {
		OC_Util::addVendorScript($app, $file);
	}
}

/**
 * Shortcut for adding styles to a page
 * @param string $app the appname
 * @param string|string[] $file the filename,
 * if an array is given it will add all styles
 */
function style($app, $file = null) {
	if (\is_array($file)) {
		foreach ($file as $f) {
			OC_Util::addStyle($app, $f);
		}
	} else {
		OC_Util::addStyle($app, $file);
	}
}

/**
 * Shortcut for adding vendor styles to a page
 * @param string $app the appname
 * @param string|string[] $file the filename,
 * if an array is given it will add all styles
 */
function vendor_style($app, $file = null) {
	if (\is_array($file)) {
		foreach ($file as $f) {
			OC_Util::addVendorStyle($app, $f);
		}
	} else {
		OC_Util::addVendorStyle($app, $file);
	}
}

/**
 * Shortcut for adding translations to a page
 * @param string $app the appname
 * if an array is given it will add all styles
 */
function translation($app) {
	OC_Util::addTranslations($app);
}

/**
 * Shortcut for HTML imports
 * @param string $app the appname
 * @param string|string[] $file the path relative to the app's component folder,
 * if an array is given it will add all components
 */
function component($app, $file) {
	if (\is_array($file)) {
		foreach ($file as $f) {
			$url = link_to($app, 'component/' . $f . '.html');
			OC_Util::addHeader('link', ['rel' => 'import', 'href' => $url]);
		}
	} else {
		$url = link_to($app, 'component/' . $file . '.html');
		OC_Util::addHeader('link', ['rel' => 'import', 'href' => $url]);
	}
}

/**
 * make \OCP\IURLGenerator::linkTo available as a simple function
 * @param string $app app
 * @param string $file file
 * @param array $args array with param=>value, will be appended to the returned url
 * @return string link to the file
 *
 * For further information have a look at \OCP\IURLGenerator::linkTo
 */
function link_to($app, $file, $args = []) {
	return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
}

/**
 * @param $key
 * @return string url to the online documentation
 */
function link_to_docs($key) {
	return \OC::$server->getURLGenerator()->linkToDocs($key);
}

/**
 * make \OCP\IURLGenerator::imagePath available as a simple function
 * @param string $app app
 * @param string $image image
 * @return string link to the image
 * @throws \RuntimeException
 *
 * For further information have a look at \OCP\IURLGenerator::imagePath
 */
function image_path($app, $image) {
	return \OC::$server->getURLGenerator()->imagePath($app, $image);
}

/**
 * make OC_Helper::mimetypeIcon available as a simple function
 * @param string $mimetype mimetype
 * @return string link to the image
 */
function mimetype_icon($mimetype) {
	return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype);
}

/**
 * make preview_icon available as a simple function
 * Returns the path to the preview of the image.
 * @param string $path path of file
 * @return string link to the preview
 */
function preview_icon($path) {
	return \OC::$server->getURLGenerator()->linkToRoute('core_ajax_preview', ['x' => 32, 'y' => 32, 'file' => $path]);
}

/**
 * @param string $path
 * @param string $token
 * @return string link to the public preview
 */
function publicPreview_icon($path, $token) {
	return \OC::$server->getURLGenerator()->linkToRoute('core_ajax_public_preview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
}

/**
 * make OC_Helper::humanFileSize available as a simple function
 * @param int $bytes size in bytes
 * @return string size as string
 *
 * For further information have a look at OC_Helper::humanFileSize
 */
function human_file_size($bytes) {
	return OC_Helper::humanFileSize($bytes);
}

/**
 * Strips the timestamp of its time value
 * @param int $timestamp UNIX timestamp to strip
 * @return $timestamp without time value

 */
function strip_time($timestamp) {
	$date = new \DateTime("@{$timestamp}");
	$date->setTime(0, 0, 0);
	return \intval($date->format('U'));
}

/**
 * Formats timestamp relatively to the current time using
 * a human-friendly format like "x minutes ago" or "yesterday"
 * @param int $timestamp timestamp to format
 * @param int $fromTime timestamp to compare from, defaults to current time
 * @param bool $dateOnly whether to strip time information
 * @return string timestamp
 */
function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) {
	/** @var \OC\DateTimeFormatter $formatter */
	$formatter = \OC::$server->query('DateTimeFormatter');

	if ($dateOnly) {
		return $formatter->formatDateSpan($timestamp, $fromTime);
	}
	return $formatter->formatTimeSpan($timestamp, $fromTime);
}

function html_select_options($options, $selected, $params= []) {
	if (!\is_array($selected)) {
		$selected= [$selected];
	}
	if (isset($params['combine']) && $params['combine']) {
		$options = \array_combine($options, $options);
	}
	$value_name = $label_name = false;
	if (isset($params['value'])) {
		$value_name = $params['value'];
	}
	if (isset($params['label'])) {
		$label_name = $params['label'];
	}
	$html = '';
	foreach ($options as $value => $label) {
		if ($value_name && \is_array($label)) {
			$value = $label[$value_name];
		}
		if ($label_name && \is_array($label)) {
			$label = $label[$label_name];
		}
		$select = \in_array($value, $selected) ? ' selected="selected"' : '';
		$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
	}
	return $html;
}


1			<?php
2			/**
3			* @author Bart Visscher <[email protected]>
4			* @author Bernhard Posselt <[email protected]>
5			* @author Joas Schilling <[email protected]>
6			* @author Jörn Friedrich Dreyer <[email protected]>
7			* @author Lukas Reschke <[email protected]>
8			* @author Morris Jobke <[email protected]>
9			* @author Robin McCorkell <[email protected]>
10			* @author Roeland Jago Douma <[email protected]>
11			* @author Thomas Müller <[email protected]>
12			* @author Vincent Petry <[email protected]>
13			*
14			* @copyright Copyright (c) 2018, ownCloud GmbH
15			* @license AGPL-3.0
16			*
17			* This code is free software: you can redistribute it and/or modify
18			* it under the terms of the GNU Affero General Public License, version 3,
19			* as published by the Free Software Foundation.
20			*
21			* This program is distributed in the hope that it will be useful,
22			* but WITHOUT ANY WARRANTY; without even the implied warranty of
23			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24			* GNU Affero General Public License for more details.
25			*
26			* You should have received a copy of the GNU Affero General Public License, version 3,
27			* along with this program. If not, see <http://www.gnu.org/licenses/>
28			*
29			*/
30
31			/**
32			* Prints a sanitized string
33			* @param string $string the string which will be escaped and printed
34			*/
35			function p($string) {
36			print(\OCP\Util::sanitizeHTML($string));
37			}
38
39			/**
40			* Prints an unsanitized string - usage of this function may result into XSS.
41			* Consider using p() instead.
42			* @param string\|array $string the string which will be printed as it is
43			*/
44			function print_unescaped($string) {
45			print($string);
46			}
47
48			/**
49			* Shortcut for adding scripts to a page
50			* @param string $app the appname
51			* @param string\|string[] $file the filename,
52			* if an array is given it will add all scripts
53			*/
54			function script($app, $file = null) {
55			if (\is_array($file)) {
56			foreach ($file as $f) {
57			OC_Util::addScript($app, $f);
58			}
59			} else {
60			OC_Util::addScript($app, $file);
61			}
62			}
63
64			/**
65			* Shortcut for adding vendor scripts to a page
66			* @param string $app the appname
67			* @param string\|string[] $file the filename,
68			* if an array is given it will add all scripts
69			*/
70			function vendor_script($app, $file = null) {
71			if (\is_array($file)) {
72			foreach ($file as $f) {
73			OC_Util::addVendorScript($app, $f);
74			}
75			} else {
76			OC_Util::addVendorScript($app, $file);
77			}
78			}
79
80			/**
81			* Shortcut for adding styles to a page
82			* @param string $app the appname
83			* @param string\|string[] $file the filename,
84			* if an array is given it will add all styles
85			*/
86			function style($app, $file = null) {
87			if (\is_array($file)) {
88			foreach ($file as $f) {
89			OC_Util::addStyle($app, $f);
90			}
91			} else {
92			OC_Util::addStyle($app, $file);
93			}
94			}
95
96			/**
97			* Shortcut for adding vendor styles to a page
98			* @param string $app the appname
99			* @param string\|string[] $file the filename,
100			* if an array is given it will add all styles
101			*/
102			function vendor_style($app, $file = null) {
103			if (\is_array($file)) {
104			foreach ($file as $f) {
105			OC_Util::addVendorStyle($app, $f);
106			}
107			} else {
108			OC_Util::addVendorStyle($app, $file);
109			}
110			}
111
112			/**
113			* Shortcut for adding translations to a page
114			* @param string $app the appname
115			* if an array is given it will add all styles
116			*/
117			function translation($app) {
118			OC_Util::addTranslations($app);
119			}
120
121			/**
122			* Shortcut for HTML imports
123			* @param string $app the appname
124			* @param string\|string[] $file the path relative to the app's component folder,
125			* if an array is given it will add all components
126			*/
127			function component($app, $file) {
128			if (\is_array($file)) {
129			foreach ($file as $f) {
130			$url = link_to($app, 'component/' . $f . '.html');
131			OC_Util::addHeader('link', ['rel' => 'import', 'href' => $url]);
132			}
133			} else {
134			$url = link_to($app, 'component/' . $file . '.html');
135			OC_Util::addHeader('link', ['rel' => 'import', 'href' => $url]);
136			}
137			}
138
139			/**
140			* make \OCP\IURLGenerator::linkTo available as a simple function
141			* @param string $app app
142			* @param string $file file
143			* @param array $args array with param=>value, will be appended to the returned url
144			* @return string link to the file
145			*
146			* For further information have a look at \OCP\IURLGenerator::linkTo
147			*/
148			function link_to($app, $file, $args = []) {
149			return \OC::$server->getURLGenerator()->linkTo($app, $file, $args);
150			}
151
152			/**
153			* @param $key
154			* @return string url to the online documentation
155			*/
156			function link_to_docs($key) {
157			return \OC::$server->getURLGenerator()->linkToDocs($key);
158			}
159
160			/**
161			* make \OCP\IURLGenerator::imagePath available as a simple function
162			* @param string $app app
163			* @param string $image image
164			* @return string link to the image
165			* @throws \RuntimeException
166			*
167			* For further information have a look at \OCP\IURLGenerator::imagePath
168			*/
169			function image_path($app, $image) {
170			return \OC::$server->getURLGenerator()->imagePath($app, $image);
171			}
172
173			/**
174			* make OC_Helper::mimetypeIcon available as a simple function
175			* @param string $mimetype mimetype
176			* @return string link to the image
177			*/
178			function mimetype_icon($mimetype) {
179			return \OC::$server->getMimeTypeDetector()->mimeTypeIcon($mimetype);
180			}
181
182			/**
183			* make preview_icon available as a simple function
184			* Returns the path to the preview of the image.
185			* @param string $path path of file
186			* @return string link to the preview
187			*/
188			function preview_icon($path) {
189			return \OC::$server->getURLGenerator()->linkToRoute('core_ajax_preview', ['x' => 32, 'y' => 32, 'file' => $path]);
190			}
191
192			/**
193			* @param string $path
194			* @param string $token
195			* @return string link to the public preview
196			*/
197			function publicPreview_icon($path, $token) {
198			return \OC::$server->getURLGenerator()->linkToRoute('core_ajax_public_preview', ['x' => 32, 'y' => 32, 'file' => $path, 't' => $token]);
199			}
200
201			/**
202			* make OC_Helper::humanFileSize available as a simple function
203			* @param int $bytes size in bytes
204			* @return string size as string
205			*
206			* For further information have a look at OC_Helper::humanFileSize
207			*/
208			function human_file_size($bytes) {
209			return OC_Helper::humanFileSize($bytes);
210			}
211
212			/**
213			* Strips the timestamp of its time value
214			* @param int $timestamp UNIX timestamp to strip
215			* @return $timestamp without time value
			0 ignored issues – show Documentation introduced 2015-11-21 07:38 UTC by Report Bug Copy Issue Report The doc-type `$timestamp` could not be parsed: Unknown type name "$timestamp" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
216			*/
217			function strip_time($timestamp) {
218			$date = new \DateTime("@{$timestamp}");
219			$date->setTime(0, 0, 0);
220			return \intval($date->format('U'));
221			}
222
223			/**
224			* Formats timestamp relatively to the current time using
225			* a human-friendly format like "x minutes ago" or "yesterday"
226			* @param int $timestamp timestamp to format
227			* @param int $fromTime timestamp to compare from, defaults to current time
228			* @param bool $dateOnly whether to strip time information
229			* @return string timestamp
230			*/
231			function relative_modified_date($timestamp, $fromTime = null, $dateOnly = false) {
232			/** @var \OC\DateTimeFormatter $formatter */
233			$formatter = \OC::$server->query('DateTimeFormatter');
234
235			if ($dateOnly) {
236			return $formatter->formatDateSpan($timestamp, $fromTime);
237			}
238			return $formatter->formatTimeSpan($timestamp, $fromTime);
239			}
240
241			function html_select_options($options, $selected, $params= []) {
242			if (!\is_array($selected)) {
243			$selected= [$selected];
244			}
245			if (isset($params['combine']) && $params['combine']) {
246			$options = \array_combine($options, $options);
247			}
248			$value_name = $label_name = false;
249			if (isset($params['value'])) {
250			$value_name = $params['value'];
251			}
252			if (isset($params['label'])) {
253			$label_name = $params['label'];
254			}
255			$html = '';
256			foreach ($options as $value => $label) {
257			if ($value_name && \is_array($label)) {
258			$value = $label[$value_name];
259			}
260			if ($label_name && \is_array($label)) {
261			$label = $label[$label_name];
262			}
263			$select = \in_array($value, $selected) ? ' selected="selected"' : '';
264			$html .= '<option value="' . \OCP\Util::sanitizeHTML($value) . '"' . $select . '>' . \OCP\Util::sanitizeHTML($label) . '</option>'."\n";
265			}
266			return $html;
267			}
268

owncloud / core

Push — master ( a615bf...3f14d2 )

functions.php ➔ html_select_options() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like