com_maileon_api_mailings_Schedule Class Reference

Inheritance diagram for com_maileon_api_mailings_Schedule:

Public Member Functions
	__construct ($minutes=null, $hours=null, $state=null, $date=null)
	fromXML ($xmlElement)
	toXML ($addXMLDeclaration=true)
	toXMLString ()
	toString ()
	toDateTime ()
Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
	fromXML ($xmlElement)
	fromXMLString ($xmlString)
	toXML ()
	toXMLString ()
	toString ()

Public Attributes
	$minutes
	$hours
	$state
	$date

Detailed Description

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

Author

Marcus Ständer

Definition at line 8 of file Schedule.php.

Constructor & Destructor Documentation

com_maileon_api_mailings_Schedule::__construct	(		$minutes = null,
			$hours = null,
			$state = null,
			$date = null
	)

Constructor initializing default values.

Parameters

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

Definition at line 22 of file Schedule.php.

Member Function Documentation

com_maileon_api_mailings_Schedule::fromXML

(

$xmlElement

)

Initialization of the schedule from a simple xml element.

Parameters

SimpleXMLElement

$xmlElement

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

Definition at line 39 of file Schedule.php.

com_maileon_api_mailings_Schedule::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 54 of file Schedule.php.

com_maileon_api_mailings_Schedule::toXMLString

(

)

Serialization to a simple XML element as string

Returns

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

Definition at line 72 of file Schedule.php.

com_maileon_api_mailings_Schedule::toString

(

)

Human readable representation of this wrapper.

Returns

string A human readable version of the schedule.

Definition at line 83 of file Schedule.php.

com_maileon_api_mailings_Schedule::toDateTime

(

)

Date and time representation of this wrapper.

Returns

string A date time version of the schedule.

Definition at line 93 of file Schedule.php.

---

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

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