class.ilBuddySystemArrayCollection.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2015 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Contact/BuddySystem/interfaces/interface.ilBuddySystemCollection.php';

abstract class ilBuddySystemArrayCollection implements ilBuddySystemCollection
{
        private $elements = array();

        public function __construct(array $elements = array())
        {
                $this->elements = $elements;
        }

        public function getIterator()
        {
                return new ArrayIterator($this->elements);
        }

        public function offsetExists($offset)
        {
                return $this->containsKey($offset);
        }

        public function offsetGet($offset)
        {
                return $this->get($offset);
        }

        public function offsetSet($offset, $value)
        {
                if(!isset($offset))
                {
                        $this->add($value);
                        return;
                }

                $this->set($offset, $value);
        }

        public function offsetUnset($offset)
        {
                $this->remove($offset);
        }

        public function count()
        {
                return count($this->elements);
        }

        public function add($element)
        {
                $this->elements[] = $element;
        }

        public function remove($key)
        {
                if(!isset($this->elements[$key]) && !array_key_exists($key, $this->elements))
                {
                        throw new InvalidArgumentException(sprintf("Could not find an element for key: ", $key));
                }
                unset($this->elements[$key]);
        }

        public function removeElement($element)
        {
                $key = array_search($element, $this->elements, true);
                if(false === $key)
                {
                        throw new InvalidArgumentException("Could not find an key for the passed element.");
                }
                unset($this->elements[$key]);
        }

        public function containsKey($key)
        {
                return isset($this->elements[$key]) || array_key_exists($key, $this->elements);
        }

        public function getKey($element)
        {
                return array_search($element, $this->elements, true);
        }

        public function clear()
        {
                $this->elements = array();
        }

        public function contains($element)
        {
                return in_array($element, $this->elements, true);
        }

        public function get($key)
        {
                return isset($this->elements[$key]) ? $this->elements[$key] : null;
        }

        public function set($key, $value)
        {
                $this->elements[$key] = $value;
        }

        public function isEmpty()
        {
                return empty($this->elements);
        }

        public function getKeys()
        {
                return array_keys($this->elements);
        }

        public function getValues()
        {
                return array_values($this->elements);
        }

        public function filter(Closure $p)
        {
                return new static(array_filter($this->elements, $p));
        }

        public function slice($offset, $length = null)
        {
                return new static(array_slice($this->elements, $offset, $length, true));
        }

        public function toArray()
        {
                return $this->elements;
        }
}