com_maileon_api_contactfilters_ContactFilter Class Reference

Inheritance diagram for com_maileon_api_contactfilters_ContactFilter:

Public Member Functions
	__construct ($id=0, $name="", $author="", $countContacts=0, $countRules=0, $created="1970-01-01 00:00:00", $state="")
	addRule ($rule)
	fromXML ($xmlElement)
	toXML ()
	toString ()
Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
	fromXML ($xmlElement)
	fromXMLString ($xmlString)
	toXML ()
	toXMLString ()
	toString ()

Public Attributes
	$author
	$countContacts
	$countRules
	$created
	$id
	$name
	$state
	$rules

Detailed Description

The wrapper class for a Maileon contact filter.

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 ContactFilter.php.

Constructor & Destructor Documentation

com_maileon_api_contactfilters_ContactFilter::__construct	(		$id = 0,
			$name = "",
			$author = "",
			$countContacts = 0,
			$countRules = 0,
			$created = "1970-01-01 00:00:00",
			$state = ""
	)

Creates a new contact filter wrapper object.

Parameters

number	$id
string	$name
string	$author
number	$countContacts
number	$countRules
string	$created
string	$state

Definition at line 33 of file ContactFilter.php.

Member Function Documentation

com_maileon_api_contactfilters_ContactFilter::addRule

(

$rule

)

Adds a rule to the contact filter

Parameters

com_maileon_api_contactfilters_Rule

$rule

Definition at line 56 of file ContactFilter.php.

com_maileon_api_contactfilters_ContactFilter::fromXML

(

$xmlElement

)

Initializes this contact filter from an XML representation.

Parameters

SimpleXMLElement

$xmlElement

the XML representation to use

Definition at line 68 of file ContactFilter.php.

com_maileon_api_contactfilters_ContactFilter::toXML

(

)

Returns

SimpleXMLElement containing the serialized representation of this contact filter

Definition at line 89 of file ContactFilter.php.

com_maileon_api_contactfilters_ContactFilter::toString

(

)

Returns

string containing a human-readable representation of this contact filter

Definition at line 120 of file ContactFilter.php.

---

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

• client/com/maileon/api/contactfilters/ContactFilter.php