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 

<?php

/* --------------------------------------------------------------
   EditableCollection.php 2016-08-12
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2016 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

/**
 * Class EditableCollection
 *
 * @category System
 * @package  Shared
 */
class EditableCollection extends AbstractCollection
{
    /**
     * Sets an item to the collection.
     * If the index already exists, the value gets override.
     *
     * @param int|IntType $index Gets validate internally with the IntType.
     * @param mixed       $value
     *
     * @throws InvalidArgumentException When value has an invalid type.
     * @return $this Same instance to make chained method calls possible.
     */
    public function setItem($index, $value)
    {
        // passed args through type objects to force their validation without using type hints.
        new IntType($index);
        
        if(!$this->_itemIsValid($value))
        {
            $exceptionText = $this->_getExceptionText();
            throw new InvalidArgumentException($exceptionText);
        }
        $this->collectionContentArray[$index] = $value;
        
        return $this;
    }
    
    
    /**
     * Adds a new item to the collection.
     *
     * @param mixed $value
     *
     * @throws InvalidArgumentException When value has an invalid type.
     * @return $this Same instance to make chained method calls possible.
     */
    public function addItem($value)
    {
        $this->_add($value);
        
        return $this;
    }
    
    
    /**
     * Add another collection to this one.
     *
     * @param EditableCollection $collection Collection to add.
     *
     * @throws InvalidArgumentException When the item types of the passed collection are invalid.
     * @return $this Same instance to make chained method calls possible.
     */
    public function addCollection(EditableCollection $collection)
    {
        foreach($collection->getArray() as $collectionItem)
        {
            $this->_add($collectionItem);
        }
        
        return $this;
    }
    
    
    /**
     * Return a clone of the current editable key value collection instance.
     */
    public function getClone()
    {
        return clone $this;
    }
    
    
    /**
     * Get valid type.
     *
     * This method must be implemented in the child-collection classes.
     *
     * @return string
     */
    protected function _getValidType()
    {
        return 'string';
    }
}