summaryrefslogtreecommitdiff
path: root/ext/spl/internal/splobjectstorage.inc
blob: ffc6c994889df402472e19f1feaad6b8ea14f560 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<?php

/** @file splobjectstorage.inc
 * @ingroup SPL
 * @brief class SplObjectStorage
 * @author  Marcus Boerger
 * @date    2003 - 2009
 *
 * SPL - Standard PHP Library
 */

/**
 * @brief   Object storage
 * @author  Marcus Boerger
 * @version 1.1
 * @since PHP 5.1.2
 *
 * This container allows to store objects uniquly without the need to compare
 * them one by one. This is only possible internally. The code representation
 * here therefore has a complexity of O(n) while the actual implementation has
 * complexity O(1).
 */
class SplObjectStorage implements Iterator, Countable, ArrayAccess
{
	private $storage = array();
	private $index = 0;

	/** Rewind to top iterator as set in constructor
	 */
	function rewind()
	{
		rewind($this->storage);
	}
	
	/** @return whether iterator is valid
	 */
	function valid()
	{
		return key($this->storage) !== false;
	}
	
	/** @return current key
	 */
	function key()
	{
		return $this->index;
	}
	
	/** @return current object
	 */
	function current()
	{
		$element = current($this->storage);
		return $element ? $element[0] : NULL
	}
	
	/** @return get current object's associated information
	 * @since 5.3.0
	 */
	function getInfo()
	{
		$element = current($this->storage);
		return $element ? $element[1] : NULL
	}
	
	/** @return set current object's associated information
	 * @since 5.3.0
	 */
	function setInfo($inf = NULL)
	{
		if ($this->valid()) {
			$this->storage[$this->index][1] = $inf;
		}
	}
	
	/** Forward to next element
	 */
	function next()
	{
		next($this->storage);
		$this->index++;
	}

	/** @return number of objects in storage
	 */
	function count()
	{
		return count($this->storage);
	}

	/** @param $obj object to look for
	 * @return whether $obj is contained in storage
	 */
	function contains($obj)
	{
		if (is_object($obj))
		{
			foreach($this->storage as $element)
			{
				if ($object === $element[0])
				{
					return true;
				}
			}
		}
		return false;
	}

	/** @param $obj new object to attach to storage or object whose
	 *              associative information is to be replaced
	 * @param $inf associative information stored along the object
	 */
	function attach($obj, $inf = NULL)
	{
		if (is_object($obj) && !$this->contains($obj))
		{
			$this->storage[] = array($obj, $inf);
		}
	}

	/** @param $obj object to remove from storage
	 */
	function detach($obj)
	{
		if (is_object($obj))
		{
			foreach($this->storage as $idx => $element)
			{
				if ($object === $element[0])
				{
					unset($this->storage[$idx]);
					$this->rewind();
					return;
				}
			}
		}
	}

	/** @param $obj new object to attach to storage or object whose
	 *              associative information is to be replaced
	 * @param $inf associative information stored along the object
	 * @since 5.3.0
	 */
	function offsetSet($obj, $inf)
	{
		$this->attach($obj, $inf);
	}

	/** @param $obj Exising object to look for
	 * @return associative information stored with object
	 * @throw UnexpectedValueException if Object $obj is not contained in
	 *                                 storage
	 * @since 5.3.0
	 */
	function offsetGet($obj)
	{
		if (is_object($obj))
		{
			foreach($this->storage as $idx => $element)
			{
				if ($object === $element[0])
				{
					return $element[1];
				}
			}
		}
		throw new UnexpectedValueException('Object not found');
	}

	/** @param $obj Exising object to look for
	 * @return associative information stored with object
	 * @since 5.3.0
	 */
	function offsetUnset($obj)
	{
		$this->detach($obj);
	}

	/** @param $obj object to look for
	 * @return whether $obj is contained in storage
	 */
	function offsetEsists($obj)
	{
		return $this->contains($obj);
	}
}

?>