4 * Class CRM_Utils_OptionBag
6 class CRM_Utils_OptionBag
implements ArrayAccess
, IteratorAggregate
, Countable
{
12 public function __construct($data = array()) {
19 public function getArray() {
24 * Retrieve a value from the bag
27 * @param string|null $type
28 * @param mixed $default
30 * @throws API_Exception
32 public function get($key, $type = NULL, $default = NULL) {
33 if (!array_key_exists($key, $this->data
)) {
37 return $this->data
[$key];
39 $r = CRM_Utils_Type
::validate($this->data
[$key], $type);
44 throw new \
API_Exception(ts("Could not find valid value for %1 (%2)", array(1 => $key, 2 => $type)));
53 public function has($key) {
54 return isset($this->data
[$key]);
58 * (PHP 5 >= 5.0.0)<br/>
59 * Whether a offset exists
60 * @link http://php.net/manual/en/arrayaccess.offsetexists.php
61 * @param mixed $offset <p>
62 * An offset to check for.
64 * @return boolean true on success or false on failure.
67 * The return value will be casted to boolean if non-boolean was returned.
69 public function offsetExists($offset) {
70 return array_key_exists($offset, $this->data
);
74 * (PHP 5 >= 5.0.0)<br/>
76 * @link http://php.net/manual/en/arrayaccess.offsetget.php
77 * @param mixed $offset <p>
78 * The offset to retrieve.
80 * @return mixed Can return all value types.
82 public function offsetGet($offset) {
83 return $this->data
[$offset];
87 * (PHP 5 >= 5.0.0)<br/>
89 * @link http://php.net/manual/en/arrayaccess.offsetset.php
90 * @param mixed $offset <p>
91 * The offset to assign the value to.
93 * @param mixed $value <p>
98 public function offsetSet($offset, $value) {
99 $this->data
[$offset] = $value;
103 * (PHP 5 >= 5.0.0)<br/>
105 * @link http://php.net/manual/en/arrayaccess.offsetunset.php
106 * @param mixed $offset <p>
107 * The offset to unset.
111 public function offsetUnset($offset) {
112 unset($this->data
[$offset]);
116 * (PHP 5 >= 5.0.0)<br/>
117 * Retrieve an external iterator
118 * @link http://php.net/manual/en/iteratoraggregate.getiterator.php
119 * @return Traversable An instance of an object implementing <b>Iterator</b> or
122 public function getIterator() {
123 return new ArrayIterator($this->data
);
127 * (PHP 5 >= 5.1.0)<br/>
128 * Count elements of an object
129 * @link http://php.net/manual/en/countable.count.php
130 * @return int The custom count as an integer.
133 * The return value is cast to an integer.
135 public function count() {
136 return count($this->data
);