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 

<?php
/* --------------------------------------------------------------
   EmailCollection.inc.php 2015-02-06 gm
   Gambio GmbH
   http://www.gambio.de
   Copyright (c) 2015 Gambio GmbH
   Released under the GNU General Public License (Version 2)
   [http://www.gnu.org/licenses/gpl-2.0.html]
   --------------------------------------------------------------
*/

MainFactory::load_class('AbstractCollection');
MainFactory::load_class('EmailCollectionInterface');

/**
 * Class EmailCollection
 *
 * Used by operations that consider multiple email objects.
 *
 * @category   System
 * @package    Email
 * @subpackage Collections
 */
class EmailCollection extends AbstractCollection implements EmailCollectionInterface
{
    /**
     * Adds a new email to the collection.
     *
     * @param EmailInterface $email E-Mail.
     */
    public function add(EmailInterface $email)
    {
        $this->_add($email);
    }


    /**
     * Removes an email from collection.
     *
     * @param EmailInterface $email E-Mail.
     *
     * @throws Exception If email cannot be found.
     */
    public function remove(EmailInterface $email)
    {
        $index = array_search($email, $this->collectionContentArray);

        if($index === false)
        {
            throw new Exception('Could not remove email because it does not exist in collection.');
        }

        unset($this->collectionContentArray[$index]);
    }


    /**
     * Removes all emails of collection.
     */
    public function clear()
    {
        $this->collectionContentArray = array();
    }


    /**
     * Returns the type of te collection items.
     *
     * @return string Valid type.
     */
    protected function _getValidType()
    {
        return 'EmailInterface';
    }
}