Source for file SelectBox.php

Documentation is available at SelectBox.php

1: <?php
2:
3: /**
4: * Nette Framework
5: *
6: * Copyright (c) 2004, 2009 David Grudl (http://davidgrudl.com)
7: *
8: * This source file is subject to the "Nette license" that is bundled
9: * with this package in the file license.txt.
10: *
11: * For more information please see https://nette.org
12: *
13: * @copyright Copyright (c) 2004, 2009 David Grudl
14: * @license https://nette.org/license Nette license
15: * @link https://nette.org
16: * @category Nette
17: * @package Nette\Forms
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../../Forms/Controls/FormControl.php';
24:
25:
26:
27: /**
28: * Select box control that allows single item selection.
29: *
30: * @author David Grudl
31: * @copyright Copyright (c) 2004, 2009 David Grudl
32: * @package Nette\Forms
33: */
34: class SelectBox extends FormControl
35: {
36: /** @var array */
37: private $items = array();
38:
39: /** @var array */
40: protected $allowed = array();
41:
42: /** @var bool */
43: private $skipFirst = FALSE;
44:
45: /** @var bool */
46: private $useKeys = TRUE;
47:
48:
49:
50: /**
51: * @param string label
52: * @param array items from which to choose
53: * @param int number of rows that should be visible
54: */
55: public function __construct($label, array $items = NULL, $size = NULL)
56: {
57: parent::__construct($label);
58: $this->control->setName('select');
59: $this->control->size = $size > 1 ? (int) $size : NULL;
60: $this->control->onfocus = 'this.onmousewheel=function(){return false}'; // prevents accidental change in IE
61: $this->label->onclick = 'return false'; // prevents deselect in IE 5 - 6
62: if ($items !== NULL) {
63: $this->setItems($items);
64: }
65: }
66:
67:
68:
69: /**
70: * Returns selected item key.
71: * @return mixed
72: */
73: public function getValue()
74: {
75: $allowed = $this->allowed;
76: if ($this->skipFirst) {
77: $allowed = array_slice($allowed, 1, count($allowed), TRUE);
78: }
79:
80: return is_scalar($this->value) && isset($allowed[$this->value]) ? $this->value : NULL;
81: }
82:
83:
84:
85: /**
86: * Returns selected item key (not checked).
87: * @return mixed
88: */
89: public function getRawValue()
90: {
91: return is_scalar($this->value) ? $this->value : NULL;
92: }
93:
94:
95:
96: /**
97: * Ignores the first item in select box.
98: * @param bool
99: * @return SelectBox provides a fluent interface
100: */
101: public function skipFirst($value = TRUE)
102: {
103: $this->skipFirst = (bool) $value;
104: return $this;
105: }
106:
107:
108:
109: /**
110: * Is first item in select box ignored?
111: * @return bool
112: */
113: final public function isFirstSkipped()
114: {
115: return $this->skipFirst;
116: }
117:
118:
119:
120: /**
121: * Are the keys used?
122: * @return bool
123: */
124: final public function areKeysUsed()
125: {
126: return $this->useKeys;
127: }
128:
129:
130:
131: /**
132: * Sets items from which to choose.
133: * @param array
134: * @return SelectBox provides a fluent interface
135: */
136: public function setItems(array $items, $useKeys = TRUE)
137: {
138: $this->items = $items;
139: $this->allowed = array();
140: $this->useKeys = (bool) $useKeys;
141:
142: foreach ($items as $key => $value) {
143: if (!is_array($value)) {
144: $value = array($key => $value);
145: }
146:
147: foreach ($value as $key2 => $value2) {
148: if (!$this->useKeys) {
149: if (!is_scalar($value2)) {
150: throw new InvalidArgumentException("All items must be scalars.");
151: }
152: $key2 = $value2;
153: }
154:
155: if (isset($this->allowed[$key2])) {
156: throw new InvalidArgumentException("Items contain duplication for key '$key2'.");
157: }
158:
159: $this->allowed[$key2] = $value2;
160: }
161: }
162: return $this;
163: }
164:
165:
166:
167: /**
168: * Returns items from which to choose.
169: * @return array
170: */
171: final public function getItems()
172: {
173: return $this->items;
174: }
175:
176:
177:
178: /**
179: * Returns selected value.
180: * @return string
181: */
182: public function getSelectedItem()
183: {
184: if (!$this->useKeys) {
185: return $this->getValue();
186:
187: } else {
188: $value = $this->getValue();
189: return $value === NULL ? NULL : $this->allowed[$value];
190: }
191: }
192:
193:
194:
195: /**
196: * Generates control's HTML element.
197: * @return Html
198: */
199: public function getControl()
200: {
201: $control = parent::getControl();
202: $selected = $this->getValue();
203: $selected = is_array($selected) ? array_flip($selected) : array($selected => TRUE);
204: $option = Html::el('option');
205:
206: foreach ($this->items as $key => $value) {
207: if (!is_array($value)) {
208: $value = array($key => $value);
209: $dest = $control;
210:
211: } else {
212: $dest = $control->create('optgroup')->label($key);
213: }
214:
215: foreach ($value as $key2 => $value2) {
216: if ($value2 instanceof Html) {
217: $dest->add((string) $value2->selected(isset($selected[$key2])));
218:
219: } elseif ($this->useKeys) {
220: $dest->add((string) $option->value($key2)->selected(isset($selected[$key2]))->setText($this->translate($value2)));
221:
222: } else {
223: $dest->add((string) $option->selected(isset($selected[$value2]))->setText($this->translate($value2)));
224: }
225: }
226: }
227: return $control;
228: }
229:
230:
231:
232: /**
233: * Filled validator: has been any item selected?
234: * @param IFormControl
235: * @return bool
236: */
237: public static function validateFilled(IFormControl $control)
238: {
239: $value = $control->getValue();
240: return is_array($value) ? count($value) > 0 : $value !== NULL;
241: }
242:
243: }

Source for file SelectBox.php

Namespaces