Code Coverage for /Users/ericduran/Sites/drupal/drupal/core/lib/Drupal/Core/Form/OptGroup.php

1	<?php
2
3	/**
4	* @file
5	* Contains \Drupal\Core\Form\OptGroup.
6	*/
7
8	namespace Drupal\Core\Form;
9
10	/**
11	* Provides helpers for HTML option groups.
12	*/
13	class OptGroup {
14
15	/**
16	* Allows PHP array processing of multiple select options with the same value.
17	*
18	* Used for form select elements which need to validate HTML option groups
19	* and multiple options which may return the same value. Associative PHP
20	* arrays cannot handle these structures, since they share a common key.
21	*
22	* @param array $array
23	* The form options array to process.
24	*
25	* @return array
26	* An array with all hierarchical elements flattened to a single array.
27	*/
28	public static function flattenOptions(array $array) {
29	$options = array();
30	static::doFlattenOptions($array, $options);
31	return $options;
32	}
33
34	/**
35	* Iterates over an array building a flat array with duplicate keys removed.
36	*
37	* This function also handles cases where objects are passed as array values.
38	*
39	* @param array $array
40	* The form options array to process.
41	* @param array $options
42	* The array of flattened options.
43	*/
44	protected static function doFlattenOptions(array $array, array &$options) {
45	foreach ($array as $key => $value) {
46	if (is_object($value) && isset($value->option)) {
47	static::doFlattenOptions($value->option, $options);
48	}
49	elseif (is_array($value)) {
50	static::doFlattenOptions($value, $options);
51	}
52	else {
53	$options[$key] = $value;
54	}
55	}
56	}
57
58	}