Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • AdminHttpViewControllers
  • ApiV2Controllers
  • Authentication
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Strategies
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Storages
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Extensions
    • Customers
    • Emails
    • Helpers
    • Invoices
    • Orders
    • Serializers
    • Templates
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • HttpViewControllers
  • InfoBox
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
  • Invoice
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • Modules
    • Collections
    • Controllers
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Precheck
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • ClassFinder
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • SharedShoppingCart
    • Interfaces
  • Slider
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AttachmentCollection
  • ContactCollection
  • EmailCollection

Class ContactCollection

Class ContactCollection

Handles collection of EmailContact objects.

AbstractCollection implements IteratorAggregate, Countable
Extended by ContactCollection implements ContactCollectionInterface
Package: Email\Collections
Category: System
Located at Services/System/Email/Collections/ContactCollection.inc.php

Methods summary

public
# add( EmailContactInterface $contact )

Adds a new contact into the collection.

Adds a new contact into the collection.

Parameters

$contact
E-Mail contact.

Implementation of

ContactCollectionInterface::add()
public
# remove( EmailContactInterface $contact )

Removes a contact from collection.

Removes a contact from collection.

Parameters

$contact
E-Mail contact.

Throws

Exception
If contact cannot be found.

Implementation of

ContactCollectionInterface::remove()
public
# clear( )

Removes all contacts of collection.

Removes all contacts of collection.

Implementation of

ContactCollectionInterface::clear()
protected string
# _getValidType( )

Returns the type of the collection items.

Returns the type of the collection items.

Returns

string
Valid type.

Methods inherited from AbstractCollection

__construct(), _add(), _getExceptionText(), _itemIsValid(), count(), getArray(), getItem(), getIterator(), isEmpty()

Properties summary

Properties inherited from AbstractCollection

$collectionContentArray

API documentation generated by ApiGen