Source for file Hashtable.php

Documentation is available at Hashtable.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\Collections
18: * @version $Id$
19: */
20:
21:
22:
23: require_once dirname(__FILE__) . '/../Collections/Collection.php';
24:
25: require_once dirname(__FILE__) . '/../Collections/IMap.php';
26:
27:
28:
29: /**
30: * The exception that is thrown when the key specified for accessing
31: * an element in a collection does not match any key.
32: * @package Nette\Collections
33: */
34: class KeyNotFoundException extends RuntimeException
35: {
36: }
37:
38:
39:
40: /**
41: * Provides the base class for a generic collection of keys and values.
42: *
43: * @author David Grudl
44: * @copyright Copyright (c) 2004, 2009 David Grudl
45: * @package Nette\Collections
46: */
47: class Hashtable extends Collection implements IMap
48: {
49: /** @var bool */
50: private $throwKeyNotFound = FALSE;
51:
52:
53:
54: /**
55: * Inserts the specified element to the map.
56: * @param mixed
57: * @param mixed
58: * @return bool
59: * @throws InvalidArgumentException, \InvalidStateException
60: */
61: public function add($key, $item)
62: {
63: // note: $item is nullable to be compatible with that of ICollection::add()
64: if (!is_scalar($key)) {
65: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
66: }
67:
68: if (parent::offsetExists($key)) {
69: throw new InvalidStateException('An element with the same key already exists.');
70: }
71:
72: $this->beforeAdd($item);
73: parent::offsetSet($key, $item);
74: return TRUE;
75: }
76:
77:
78:
79: /**
80: * Append is not supported.
81: */
82: public function append($item)
83: {
84: throw new NotSupportedException;
85: }
86:
87:
88:
89: /**
90: * Returns a array of the keys contained in this map.
91: * return array
92: */
93: public function getKeys()
94: {
95: return array_keys($this->getArrayCopy());
96: }
97:
98:
99:
100: /**
101: * Returns the key of the first occurrence of the specified element,.
102: * or FALSE if this map does not contain this element.
103: * @param mixed
104: * @return mixed
105: */
106: public function search($item)
107: {
108: return array_search($item, $this->getArrayCopy(), TRUE);
109: }
110:
111:
112:
113: /**
114: * Import from array or any traversable object.
115: * @param array|\Traversable
116: * @return void
117: * @throws InvalidArgumentException
118: */
119: public function import($arr)
120: {
121: if (!(is_array($arr) || $arr instanceof Traversable)) {
122: throw new InvalidArgumentException("Argument must be traversable.");
123: }
124:
125: if (!$this->readOnly && $this->itemType === NULL) { // optimalization
126: $this->setArray((array) $arr);
127:
128: } else {
129: $this->clear();
130: foreach ($arr as $key => $item) {
131: $this->offsetSet($key, $item);
132: }
133: }
134: }
135:
136:
137:
138: /**
139: * Returns variable or $default if there is no element.
140: * @param string key
141: * @param mixed default value
142: * @return mixed
143: * @throws InvalidArgumentException
144: */
145: public function get($key, $default = NULL)
146: {
147: if (!is_scalar($key)) {
148: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
149: }
150:
151: if (parent::offsetExists($key)) {
152: return parent::offsetGet($key);
153:
154: } else {
155: return $default;
156: }
157: }
158:
159:
160:
161: /**
162: * Do throw KeyNotFoundException?
163: * @return void
164: */
165: public function throwKeyNotFound($val = TRUE)
166: {
167: $this->throwKeyNotFound = (bool) $val;
168: }
169:
170:
171:
172: /********************* interface \ArrayAccess ****************d*g**/
173:
174:
175:
176: /**
177: * Inserts (replaces) item (\ArrayAccess implementation).
178: * @param string key
179: * @param object
180: * @return void
181: * @throws NotSupportedException, \InvalidArgumentException
182: */
183: public function offsetSet($key, $item)
184: {
185: if (!is_scalar($key)) { // prevents NULL
186: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
187: }
188:
189: $this->beforeAdd($item);
190: parent::offsetSet($key, $item);
191: }
192:
193:
194:
195: /**
196: * Returns item (\ArrayAccess implementation).
197: * @param string key
198: * @return mixed
199: * @throws KeyNotFoundException, \InvalidArgumentException
200: */
201: public function offsetGet($key)
202: {
203: if (!is_scalar($key)) {
204: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
205: }
206:
207: if (parent::offsetExists($key)) {
208: return parent::offsetGet($key);
209:
210: } elseif ($this->throwKeyNotFound) {
211: throw new KeyNotFoundException;
212:
213: } else {
214: return NULL;
215: }
216: }
217:
218:
219:
220: /**
221: * Exists item? (\ArrayAccess implementation).
222: * @param string key
223: * @return bool
224: * @throws InvalidArgumentException
225: */
226: public function offsetExists($key)
227: {
228: if (!is_scalar($key)) {
229: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
230: }
231:
232: return parent::offsetExists($key);
233: }
234:
235:
236:
237: /**
238: * Removes the element at the specified position in this list.
239: * @param string key
240: * @return void
241: * @throws NotSupportedException, \InvalidArgumentException
242: */
243: public function offsetUnset($key)
244: {
245: if (!is_scalar($key)) {
246: throw new InvalidArgumentException("Key must be either a string or an integer, " . gettype($key) ." given.");
247: }
248:
249: $this->beforeRemove();
250: if (parent::offsetExists($key)) {
251: parent::offsetUnset($key);
252: }
253: }
254:
255: }

Source for file Hashtable.php

Namespaces