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
/* --------------------------------------------------------------
ContactCollection.inc.php 2015-01-30 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('ContactCollectionInterface');
/**
* Class ContactCollection
*
* Handles collection of EmailContact objects.
*
* @category System
* @package Email
* @subpackage Collections
*/
class ContactCollection extends AbstractCollection implements ContactCollectionInterface
{
/**
* Adds a new contact into the collection.
*
* @param EmailContactInterface $contact E-Mail contact.
*/
public function add(EmailContactInterface $contact)
{
$this->_add($contact);
}
/**
* Removes a contact from collection.
*
* @param EmailContactInterface $contact E-Mail contact.
*
* @throws Exception If contact cannot be found.
*/
public function remove(EmailContactInterface $contact)
{
$index = array_search($contact, $this->collectionContentArray);
if($index === false)
{
throw new Exception('Could not remove contact because it does not exist in collection.');
}
unset($this->collectionContentArray[$index]);
}
/**
* Removes all contacts of collection.
*/
public function clear()
{
$this->collectionContentArray = array();
}
/**
* Returns the type of the collection items.
*
* @return string Valid type.
*/
protected function _getValidType()
{
return 'EmailContactInterface';
}
}