com_maileon_api_mailings_Mailing Class Reference

Inheritance diagram for com_maileon_api_mailings_Mailing:

Public Member Functions
	__construct ($id=null, $fields=array())
	fromXML ($xmlElement)
	getFieldValue ($fieldName)
	toXML ($addXMLDeclaration=true)
	toXMLString ()
	toString ()
Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
	fromXML ($xmlElement)
	fromXMLString ($xmlString)
	toXML ()
	toXMLString ()
	toString ()

Public Attributes
	$id
	$fields

Detailed Description

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

Author

Marcus Ständer | Trusted Technologies GmbH | marcus.staender@trusted-technologies.de

Definition at line 8 of file Mailing.php.

Constructor & Destructor Documentation

com_maileon_api_mailings_Mailing::__construct	(		$id = null,
			$fields = array()
	)

Constructor initializing default values.

Parameters

number	$id	The Maileon mailing id.
array	$fields	An array of fields.

Definition at line 21 of file Mailing.php.

Member Function Documentation

com_maileon_api_mailings_Mailing::fromXML

(

$xmlElement

)

Initialization of the mailing from a simple xml element.

Parameters

SimpleXMLElement

$xmlElement

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

Definition at line 35 of file Mailing.php.

com_maileon_api_mailings_Mailing::getFieldValue

(

$fieldName

)

Returns the value of the field with the given name

Parameters

string

fieldName The field name of the element to return the value of

Returns

string The value or undefined, if not found

Definition at line 56 of file Mailing.php.

com_maileon_api_mailings_Mailing::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 73 of file Mailing.php.

com_maileon_api_mailings_Mailing::toXMLString

(

)

Serialization to a simple XML element as string

Returns

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

Definition at line 99 of file Mailing.php.

com_maileon_api_mailings_Mailing::toString

(

)

Human readable representation of this wrapper.

Returns

string A human readable version of the mailing.

Definition at line 111 of file Mailing.php.

---

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

• client/com/maileon/api/mailings/Mailing.php