Chris@0: <?php
Chris@0: /*
Chris@0:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
Chris@0:  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
Chris@0:  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
Chris@0:  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
Chris@0:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
Chris@0:  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Chris@0:  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Chris@0:  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Chris@0:  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Chris@0:  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Chris@0:  *
Chris@0:  * This software consists of voluntary contributions made by many individuals
Chris@0:  * and is licensed under the MIT license. For more information, see
Chris@0:  * <http://www.doctrine-project.org>.
Chris@0:  */
Chris@0: 
Chris@0: namespace Doctrine\Common\Collections;
Chris@0: 
Chris@0: use ArrayIterator;
Chris@0: use Closure;
Chris@0: use Doctrine\Common\Collections\Expr\ClosureExpressionVisitor;
Chris@0: 
Chris@0: /**
Chris@0:  * An ArrayCollection is a Collection implementation that wraps a regular PHP array.
Chris@0:  *
Chris@12:  * Warning: Using (un-)serialize() on a collection is not a supported use-case
Chris@12:  * and may break when we change the internals in the future. If you need to
Chris@12:  * serialize a collection use {@link toArray()} and reconstruct the collection
Chris@12:  * manually.
Chris@12:  *
Chris@0:  * @since  2.0
Chris@0:  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
Chris@0:  * @author Jonathan Wage <jonwage@gmail.com>
Chris@0:  * @author Roman Borschel <roman@code-factory.org>
Chris@0:  */
Chris@0: class ArrayCollection implements Collection, Selectable
Chris@0: {
Chris@0:     /**
Chris@0:      * An array containing the entries of this collection.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $elements;
Chris@0: 
Chris@0:     /**
Chris@0:      * Initializes a new ArrayCollection.
Chris@0:      *
Chris@0:      * @param array $elements
Chris@0:      */
Chris@0:     public function __construct(array $elements = array())
Chris@0:     {
Chris@0:         $this->elements = $elements;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@12:      * Creates a new instance from the specified elements.
Chris@12:      *
Chris@12:      * This method is provided for derived classes to specify how a new
Chris@12:      * instance should be created when constructor semantics have changed.
Chris@12:      *
Chris@12:      * @param array $elements Elements.
Chris@12:      *
Chris@12:      * @return static
Chris@12:      */
Chris@12:     protected function createFrom(array $elements)
Chris@12:     {
Chris@12:         return new static($elements);
Chris@12:     }
Chris@12: 
Chris@12:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function toArray()
Chris@0:     {
Chris@0:         return $this->elements;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function first()
Chris@0:     {
Chris@0:         return reset($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function last()
Chris@0:     {
Chris@0:         return end($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function key()
Chris@0:     {
Chris@0:         return key($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function next()
Chris@0:     {
Chris@0:         return next($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function current()
Chris@0:     {
Chris@0:         return current($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function remove($key)
Chris@0:     {
Chris@0:         if ( ! isset($this->elements[$key]) && ! array_key_exists($key, $this->elements)) {
Chris@0:             return null;
Chris@0:         }
Chris@0: 
Chris@0:         $removed = $this->elements[$key];
Chris@0:         unset($this->elements[$key]);
Chris@0: 
Chris@0:         return $removed;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function removeElement($element)
Chris@0:     {
Chris@0:         $key = array_search($element, $this->elements, true);
Chris@0: 
Chris@0:         if ($key === false) {
Chris@0:             return false;
Chris@0:         }
Chris@0: 
Chris@0:         unset($this->elements[$key]);
Chris@0: 
Chris@0:         return true;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Required by interface ArrayAccess.
Chris@0:      *
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function offsetExists($offset)
Chris@0:     {
Chris@0:         return $this->containsKey($offset);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Required by interface ArrayAccess.
Chris@0:      *
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function offsetGet($offset)
Chris@0:     {
Chris@0:         return $this->get($offset);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Required by interface ArrayAccess.
Chris@0:      *
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function offsetSet($offset, $value)
Chris@0:     {
Chris@0:         if ( ! isset($offset)) {
Chris@0:             return $this->add($value);
Chris@0:         }
Chris@0: 
Chris@0:         $this->set($offset, $value);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Required by interface ArrayAccess.
Chris@0:      *
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function offsetUnset($offset)
Chris@0:     {
Chris@0:         return $this->remove($offset);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function containsKey($key)
Chris@0:     {
Chris@0:         return isset($this->elements[$key]) || array_key_exists($key, $this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function contains($element)
Chris@0:     {
Chris@0:         return in_array($element, $this->elements, true);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function exists(Closure $p)
Chris@0:     {
Chris@0:         foreach ($this->elements as $key => $element) {
Chris@0:             if ($p($key, $element)) {
Chris@0:                 return true;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return false;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function indexOf($element)
Chris@0:     {
Chris@0:         return array_search($element, $this->elements, true);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function get($key)
Chris@0:     {
Chris@0:         return isset($this->elements[$key]) ? $this->elements[$key] : null;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function getKeys()
Chris@0:     {
Chris@0:         return array_keys($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function getValues()
Chris@0:     {
Chris@0:         return array_values($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function count()
Chris@0:     {
Chris@0:         return count($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function set($key, $value)
Chris@0:     {
Chris@0:         $this->elements[$key] = $value;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@12:     public function add($element)
Chris@0:     {
Chris@12:         $this->elements[] = $element;
Chris@0: 
Chris@0:         return true;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function isEmpty()
Chris@0:     {
Chris@0:         return empty($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Required by interface IteratorAggregate.
Chris@0:      *
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function getIterator()
Chris@0:     {
Chris@0:         return new ArrayIterator($this->elements);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function map(Closure $func)
Chris@0:     {
Chris@12:         return $this->createFrom(array_map($func, $this->elements));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function filter(Closure $p)
Chris@0:     {
Chris@12:         return $this->createFrom(array_filter($this->elements, $p));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function forAll(Closure $p)
Chris@0:     {
Chris@0:         foreach ($this->elements as $key => $element) {
Chris@0:             if ( ! $p($key, $element)) {
Chris@0:                 return false;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return true;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function partition(Closure $p)
Chris@0:     {
Chris@0:         $matches = $noMatches = array();
Chris@0: 
Chris@0:         foreach ($this->elements as $key => $element) {
Chris@0:             if ($p($key, $element)) {
Chris@0:                 $matches[$key] = $element;
Chris@0:             } else {
Chris@0:                 $noMatches[$key] = $element;
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@12:         return array($this->createFrom($matches), $this->createFrom($noMatches));
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns a string representation of this object.
Chris@0:      *
Chris@0:      * @return string
Chris@0:      */
Chris@0:     public function __toString()
Chris@0:     {
Chris@0:         return __CLASS__ . '@' . spl_object_hash($this);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function clear()
Chris@0:     {
Chris@0:         $this->elements = array();
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function slice($offset, $length = null)
Chris@0:     {
Chris@0:         return array_slice($this->elements, $offset, $length, true);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritDoc}
Chris@0:      */
Chris@0:     public function matching(Criteria $criteria)
Chris@0:     {
Chris@0:         $expr     = $criteria->getWhereExpression();
Chris@0:         $filtered = $this->elements;
Chris@0: 
Chris@0:         if ($expr) {
Chris@0:             $visitor  = new ClosureExpressionVisitor();
Chris@0:             $filter   = $visitor->dispatch($expr);
Chris@0:             $filtered = array_filter($filtered, $filter);
Chris@0:         }
Chris@0: 
Chris@0:         if ($orderings = $criteria->getOrderings()) {
Chris@12:             $next = null;
Chris@0:             foreach (array_reverse($orderings) as $field => $ordering) {
Chris@12:                 $next = ClosureExpressionVisitor::sortByField($field, $ordering == Criteria::DESC ? -1 : 1, $next);
Chris@0:             }
Chris@0: 
Chris@0:             uasort($filtered, $next);
Chris@0:         }
Chris@0: 
Chris@0:         $offset = $criteria->getFirstResult();
Chris@0:         $length = $criteria->getMaxResults();
Chris@0: 
Chris@0:         if ($offset || $length) {
Chris@0:             $filtered = array_slice($filtered, (int)$offset, $length);
Chris@0:         }
Chris@0: 
Chris@12:         return $this->createFrom($filtered);
Chris@0:     }
Chris@0: }