/www/slight : contents of flight/util/Collection.php at revision 3

: (revision 3)

To get this branch, use:

bzr branch
http://bzr.ed.am/www/slight

<?php
/**
 * Flight: An extensible micro-framework.
 *
 * @copyright   Copyright (c) 2011, Mike Cao <mike@mikecao.com>
 * @license     MIT, http://flightphp.com/license
 */

namespace flight\util;

/**
 * The Collection class allows you to access a set of data
 * using both array and object notation.
 */
class Collection implements \ArrayAccess, \Iterator, \Countable {
    /**
     * Collection data.
     *
     * @var array
     */
    private $data;

    /**
     * Constructor.
     *
     * @param array $data Initial data
     */
    public function __construct(array $data = array()) {
        $this->data = $data;
    }

    /**
     * Gets an item.
     *
     * @param string $key Key
     * @return mixed Value
     */
    public function __get($key) {
        return isset($this->data[$key]) ? $this->data[$key] : null;
    }

    /**
     * Set an item.
     *
     * @param string $key Key
     * @param mixed $value Value
     */
    public function __set($key, $value) {
        $this->data[$key] = $value;
    }

    /**
     * Checks if an item exists.
     *
     * @param string $key Key
     * @return bool Item status
     */
    public function __isset($key) {
        return isset($this->data[$key]);
    }

    /**
     * Removes an item.
     *
     * @param string $key Key
     */
    public function __unset($key) {
        unset($this->data[$key]);
    }

    /**
     * Gets an item at the offset.
     *
     * @param string $offset Offset
     * @return mixed Value
     */
    public function offsetGet($offset) {
        return isset($this->data[$offset]) ? $this->data[$offset] : null;
    }

    /**
     * Sets an item at the offset.
     *
     * @param string $offset Offset
     * @param mixed $value Value
     */
    public function offsetSet($offset, $value) {
        if (is_null($offset)) {
            $this->data[] = $value;
        }
        else {
            $this->data[$offset] = $value;
        }
    }

    /**
     * Checks if an item exists at the offset.
     *
     * @param string $offset Offset
     * @return bool Item status
     */
    public function offsetExists($offset) {
        return isset($this->data[$offset]);
    }

    /**
     * Removes an item at the offset.
     *
     * @param string $offset Offset
     */
    public function offsetUnset($offset) {
        unset($this->data[$offset]);
    }

    /**
     * Resets the collection.
     */
    public function rewind() {
        reset($this->data);
    }
 
    /**
     * Gets current collection item.
     *
     * @return mixed Value
     */ 
    public function current() {
        return current($this->data);
    }
 
    /**
     * Gets current collection key.
     *
     * @return mixed Value
     */ 
    public function key() {
        return key($this->data);
    }
 
    /**
     * Gets the next collection value.
     *
     * @return mixed Value
     */ 
    public function next() 
    {
        return next($this->data);
    }
 
    /**
     * Checks if the current collection key is valid.
     *
     * @return bool Key status
     */ 
    public function valid()
    {
        $key = key($this->data);
        return ($key !== NULL && $key !== FALSE);
    }

    /**
     * Gets the size of the collection.
     *
     * @return int Collection size
     */
    public function count() {
        return sizeof($this->data);
    }

    /**
     * Gets the item keys.
     *
     * @return array Collection keys
     */
    public function keys() {
        return array_keys($this->data);
    }

    /**
     * Gets the collection data.
     *
     * @return array Collection data
     */
    public function getData() {
        return $this->data;
    }

    /**
     * Sets the collection data.
     *
     * @param array $data New collection data
     */
    public function setData(array $data) {
        $this->data = $data;
    }

    /**
     * Removes all items from the collection.
     */
    public function clear() {
        $this->data = array();
    }
}

1 by Tim Marston initial commit	1	<?php
	2	/**
	3	* Flight: An extensible micro-framework.
	4	*
	5	* @copyright Copyright (c) 2011, Mike Cao <mike@mikecao.com>
	6	* @license MIT, http://flightphp.com/license
	7	*/
	8
	9	namespace flight\util;
	10
	11	/**
	12	* The Collection class allows you to access a set of data
	13	* using both array and object notation.
	14	*/
	15	class Collection implements \ArrayAccess, \Iterator, \Countable {
	16	/**
	17	* Collection data.
	18	*
	19	* @var array
	20	*/
	21	private $data;
	22
	23	/**
	24	* Constructor.
	25	*
	26	* @param array $data Initial data
	27	*/
	28	public function __construct(array $data = array()) {
	29	$this->data = $data;
	30	}
	31
	32	/**
	33	* Gets an item.
	34	*
	35	* @param string $key Key
	36	* @return mixed Value
	37	*/
	38	public function __get($key) {
	39	return isset($this->data[$key]) ? $this->data[$key] : null;
	40	}
	41
	42	/**
	43	* Set an item.
	44	*
	45	* @param string $key Key
	46	* @param mixed $value Value
	47	*/
	48	public function __set($key, $value) {
	49	$this->data[$key] = $value;
	50	}
	51
	52	/**
	53	* Checks if an item exists.
	54	*
	55	* @param string $key Key
	56	* @return bool Item status
	57	*/
	58	public function __isset($key) {
	59	return isset($this->data[$key]);
	60	}
	61
	62	/**
	63	* Removes an item.
	64	*
65	* @param string $key Key
66	*/
67	public function __unset($key) {
68	unset($this->data[$key]);
69	}
70
71	/**
72	* Gets an item at the offset.
73	*
74	* @param string $offset Offset
75	* @return mixed Value
76	*/
77	public function offsetGet($offset) {
78	return isset($this->data[$offset]) ? $this->data[$offset] : null;
79	}
80
81	/**
82	* Sets an item at the offset.
83	*
84	* @param string $offset Offset
85	* @param mixed $value Value
86	*/
87	public function offsetSet($offset, $value) {
88	if (is_null($offset)) {
89	$this->data[] = $value;
90	}
91	else {
92	$this->data[$offset] = $value;
93	}
94	}
95
96	/**
97	* Checks if an item exists at the offset.
98	*
99	* @param string $offset Offset
100	* @return bool Item status
101	*/
102	public function offsetExists($offset) {
103	return isset($this->data[$offset]);
104	}
105
106	/**
107	* Removes an item at the offset.
108	*
109	* @param string $offset Offset
110	*/
111	public function offsetUnset($offset) {
112	unset($this->data[$offset]);
113	}
114
115	/**
116	* Resets the collection.
117	*/
118	public function rewind() {
119	reset($this->data);
120	}
121
122	/**
123	* Gets current collection item.
124	*
125	* @return mixed Value
126	*/
127	public function current() {
128	return current($this->data);
129	}
130
131	/**
132	* Gets current collection key.
133	*
134	* @return mixed Value
135	*/
136	public function key() {
137	return key($this->data);
138	}
139
140	/**
141	* Gets the next collection value.
142	*
143	* @return mixed Value
144	*/
145	public function next()
146	{
147	return next($this->data);
148	}
149
150	/**
151	* Checks if the current collection key is valid.
152	*
153	* @return bool Key status
154	*/
155	public function valid()
156	{
157	$key = key($this->data);
158	return ($key !== NULL && $key !== FALSE);
159	}
160
161	/**
162	* Gets the size of the collection.
163	*
164	* @return int Collection size
165	*/
166	public function count() {
167	return sizeof($this->data);
168	}
169
170	/**
171	* Gets the item keys.
172	*
173	* @return array Collection keys
174	*/
175	public function keys() {
176	return array_keys($this->data);
177	}
178
179	/**
180	* Gets the collection data.
181	*
182	* @return array Collection data
183	*/
184	public function getData() {
185	return $this->data;
186	}
187
188	/**
189	* Sets the collection data.
190	*
191	* @param array $data New collection data
192	*/
193	public function setData(array $data) {
194	$this->data = $data;
195	}
196
197	/**
198	* Removes all items from the collection.
199	*/
200	public function clear() {
201	$this->data = array();
202	}
203	}