Maileon PHP client  1.5.5
Easily integrate your PHP application with Maileon.
com_maileon_api_contacts_Contacts Class Reference
Inheritance diagram for com_maileon_api_contacts_Contacts:
com_maileon_api_xml_AbstractXMLWrapper

Public Member Functions

 __construct ($contacts=array())
 
 addContact ($contact)
 
 getIterator ()
 
 fromXML ($xmlElement)
 
 toXML ()
 
 toXMLString ()
 
 toString ()
 
- Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
 fromXML ($xmlElement)
 
 fromXMLString ($xmlString)
 
 toXML ()
 
 toXMLString ()
 
 toString ()
 

Detailed Description

A wrapper class for a list of Maileon contacts. To access the contacts contained within this list, iterate this object using foreach (i.e. IteratorAggregate is implemented).

Definition at line 7 of file Contacts.php.

Constructor & Destructor Documentation

com_maileon_api_contacts_Contacts::__construct (   $contacts = array())

Creates a new list of contacts.

Parameters
com_maileon_api_contacts_Contacts[]$contacts the contacts in the list of contacts

Definition at line 17 of file Contacts.php.

Member Function Documentation

com_maileon_api_contacts_Contacts::addContact (   $contact)

Adds a new contact to this list of contacts.

Parameters
com_maileon_api_contacts_Contact$contact

Definition at line 28 of file Contacts.php.

com_maileon_api_contacts_Contacts::getIterator ( )
Returns
ArrayIterator an iterator for the contacts in this list of contacts

Definition at line 37 of file Contacts.php.

com_maileon_api_contacts_Contacts::fromXML (   $xmlElement)

Initialization of the contact from a simple xml element. NOT YET IMPLEMENTED.

Parameters
SimpleXMLElement$xmlElementThe xml element that is used to parse the contact list from.

Definition at line 48 of file Contacts.php.

com_maileon_api_contacts_Contacts::toXML ( )

Serialization to a simple XML element.

Returns
SimpleXMLElement Generate a XML element from the contact object.

Definition at line 65 of file Contacts.php.

com_maileon_api_contacts_Contacts::toXMLString ( )

Serialization to a simple XML element as string

Returns
string The string representation of the XML document for this contact.

Definition at line 84 of file Contacts.php.

com_maileon_api_contacts_Contacts::toString ( )

Human readable representation of this wrapper.

Returns
string A human readable version of the contact list.

Definition at line 96 of file Contacts.php.


The documentation for this class was generated from the following file: