blob: eb3cb29eb5f51d558603339e0ce74b6f536e71c6 (
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
|
<?php
/**
* TAttributeCollection classes
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @link https://github.com/pradosoft/prado
* @copyright Copyright © 2005-2016 The PRADO Group
* @license https://github.com/pradosoft/prado/blob/master/COPYRIGHT
* @package System.Collections
*/
/**
* Includes TMap class
*/
Prado::using('System.Collections.TMap');
/**
* TAttributeCollection class
*
* TAttributeCollection implements a collection for storing attribute names and values.
*
* Besides all functionalities provided by {@link TMap}, TAttributeCollection
* allows you to get and set attribute values like getting and setting
* properties. For example, the following usages are all valid for a
* TAttributeCollection object:
* <code>
* $collection->Text='text';
* echo $collection->Text;
* </code>
* They are equivalent to the following:
* <code>
* $collection->add('Text','text');
* echo $collection->itemAt('Text');
* </code>
*
* Note, attribute names are case-insensitive. They are converted to lower-case
* in the collection storage.
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @package System.Collections
* @since 3.0
*/
class TAttributeCollection extends TMap
{
private $_caseSensitive=false;
/**
* Returns an array with the names of all variables of this object that should NOT be serialized
* because their value is the default one or useless to be cached for the next page loads.
* Reimplement in derived classes to add new variables, but remember to also to call the parent
* implementation first.
*/
protected function _getZappableSleepProps(&$exprops)
{
parent::_getZappableSleepProps($exprops);
if ($this->_caseSensitive===false)
$exprops[] = "\0TAttributeCollection\0_caseSensitive";
}
/**
* Returns a property value or an event handler list by property or event name.
* This method overrides the parent implementation by returning
* a key value if the key exists in the collection.
* @param string the property name or the event name
* @return mixed the property value or the event handler list
* @throws TInvalidOperationException if the property/event is not defined.
*/
public function __get($name)
{
return $this->contains($name)?$this->itemAt($name):parent::__get($name);
}
/**
* Sets value of a component property.
* This method overrides the parent implementation by adding a new key value
* to the collection.
* @param string the property name or event name
* @param mixed the property value or event handler
* @throws TInvalidOperationException If the property is not defined or read-only.
*/
public function __set($name,$value)
{
$this->add($name,$value);
}
/**
* @return boolean whether the keys are case-sensitive. Defaults to false.
*/
public function getCaseSensitive()
{
return $this->_caseSensitive;
}
/**
* @param boolean whether the keys are case-sensitive.
*/
public function setCaseSensitive($value)
{
$this->_caseSensitive=TPropertyValue::ensureBoolean($value);
}
/**
* Returns the item with the specified key.
* This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
* @param mixed the key
* @return mixed the element at the offset, null if no element is found at the offset
*/
public function itemAt($key)
{
return parent::itemAt($this->_caseSensitive?$key:strtolower($key));
}
/**
* Adds an item into the map.
* This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
* @param mixed key
* @param mixed value
*/
public function add($key,$value)
{
parent::add($this->_caseSensitive?$key:strtolower($key),$value);
}
/**
* Removes an item from the map by its key.
* This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
* @param mixed the key of the item to be removed
* @return mixed the removed value, null if no such key exists.
*/
public function remove($key)
{
return parent::remove($this->_caseSensitive?$key:strtolower($key));
}
/**
* Returns whether the specified is in the map.
* This overrides the parent implementation by converting the key to lower case first if CaseSensitive is false.
* @param mixed the key
* @return boolean whether the map contains an item with the specified key
*/
public function contains($key)
{
return parent::contains($this->_caseSensitive?$key:strtolower($key));
}
/**
* Determines whether a property is defined.
* This method overrides parent implementation by returning true
* if the collection contains the named key.
* @param string the property name
* @return boolean whether the property is defined
*/
public function hasProperty($name)
{
return $this->contains($name) || parent::canGetProperty($name) || parent::canSetProperty($name);
}
/**
* Determines whether a property can be read.
* This method overrides parent implementation by returning true
* if the collection contains the named key.
* @param string the property name
* @return boolean whether the property can be read
*/
public function canGetProperty($name)
{
return $this->contains($name) || parent::canGetProperty($name);
}
/**
* Determines whether a property can be set.
* This method overrides parent implementation by always returning true
* because you can always add a new value to the collection.
* @param string the property name
* @return boolean true
*/
public function canSetProperty($name)
{
return true;
}
}
|
