com_maileon_api_contacts_Contact Class Reference

Inheritance diagram for com_maileon_api_contacts_Contact:

Public Member Functions
	__construct ($id=null, $email=null, $permission=NULL, $external_id=-1, $anonymous=false, $standard_fields=array(), $custom_fields=array(), $created=null, $updated=null)
	fromXML ($xmlElement)
	toXML ($addXMLDeclaration=true)
	toXMLString ()
	toString ()
	toCsvString ()
Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
	fromXML ($xmlElement)
	fromXMLString ($xmlString)
	toXML ()
	toXMLString ()
	toString ()

Public Attributes
	$id
	$email
	$permission
	$external_id
	$anonymous
	$created
	$updated
	$standard_fields
	$custom_fields

Detailed Description

The wrapper class for a Maileon contact. This class wraps the XML structure.

Author

Felix Heinrichs | Trusted Mails GmbH | felix.heinrichs@trusted-mails.com

Marcus Ständer | Trusted Mails GmbH | marcus.staender@trusted-mails.com

Definition at line 9 of file Contact.php.

Constructor & Destructor Documentation

com_maileon_api_contacts_Contact::__construct	(		$id = null,
			$email = null,
			$permission = NULL,
			$external_id = -1,
			$anonymous = false,
			$standard_fields = array(),
			$custom_fields = array(),
			$created = null,
			$updated = null
	)

Constructor initializing default values.

Parameters

number	$id	The Maileon contact id.
string	$email	The email-address of the contact.
string	$permission	The permission code. 1 = NONE, 2 = SOI, 3 = COI, 4 = DOI, 5 = DOI+, 6 = OTHER.
string	$external_id	The external id to identify the contact.
boolean	$anonymous
array	$standard_fields	An array of standard fields.
array	$custom_fields	An array of custom fields of the contact.

Definition at line 38 of file Contact.php.

Member Function Documentation

com_maileon_api_contacts_Contact::fromXML

(

$xmlElement

)

Initialization of the contact from a simple xml element.

Parameters

SimpleXMLElement

$xmlElement

The xml element that is used to parse the contact from.

Definition at line 66 of file Contact.php.

com_maileon_api_contacts_Contact::toXML

(

$addXMLDeclaration = true

)

Serialization to a simple XML element.

Parameters

bool

$addXMLDeclaration

Returns

SimpleXMLElement Generate a XML element from the contact object.

Definition at line 101 of file Contact.php.

com_maileon_api_contacts_Contact::toXMLString

(

)

Serialization to a simple XML element as string

Returns

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

Definition at line 154 of file Contact.php.

com_maileon_api_contacts_Contact::toString

(

)

Human readable representation of this wrapper.

Returns

string A human readable version of the contact.

Definition at line 166 of file Contact.php.

com_maileon_api_contacts_Contact::toCsvString

(

)

CSV representation of this wrapper.

Returns

string A csv version of the contact.

Definition at line 204 of file Contact.php.

---

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

• client/com/maileon/api/contacts/Contact.php