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

Public Member Functions

 __construct ($id=null, $name=null, $attributes=array(), $archivingDuration=null, $storeOnly=false, $description=null)
 
 fromXML ($xmlElement)
 
 toString ()
 
 toXML ()
 
 toXMLString ()
 
- Public Member Functions inherited from com_maileon_api_xml_AbstractXMLWrapper
 fromXML ($xmlElement)
 
 fromXMLString ($xmlString)
 
 toXML ()
 
 toXMLString ()
 
 toString ()
 

Public Attributes

 $id
 
 $name
 
 $description
 
 $attributes
 
 $archivingDuration
 
 $storeOnly
 

Detailed Description

Wrapper class for Maileon transaction types.

Author
Viktor Balogh | Wanadis Kft. | balogh.viktor@maileon.hu
Marcus Beckerle | XQueue GmbH | marcus.beckerle@xqueue.com

Definition at line 9 of file TransactionType.php.

Constructor & Destructor Documentation

com_maileon_api_transactions_TransactionType::__construct (   $id = null,
  $name = null,
  $attributes = array(),
  $archivingDuration = null,
  $storeOnly = false,
  $description = null 
)

Creates a new transaction type object.

Parameters
string$idthe ID of the transaction type
string$namethe name of the transaction type
array$attributesan array of com_maileon_api_transactions_AttributeType attributes associated with the transaction
integer$archivingDurationArchiving duration in days [1..n] after which the transaction events will be deleted, 0 and empty = forever (default)
integer$storeOnlyIf nothing or false is specified, the limit for strings attributes of the transaction is set to 1000 characters and the transaction event can be used in any contactfilter, e.g. "give me all contacts that received contact event X with value Y in attribute Z". If storeOnly is set to true, the attributes of the transaction cannot be used as comparision inputs for contactfilters but the allowed length is raised to 64.000 characters.
string$descriptionthe description of the transaction type

Definition at line 67 of file TransactionType.php.

Member Function Documentation

com_maileon_api_transactions_TransactionType::fromXML (   $xmlElement)

Initializes this transaction type from an XML representation.

Parameters
SimpleXMLElement$xmlElementthe serialized XML representation to use

Definition at line 89 of file TransactionType.php.

com_maileon_api_transactions_TransactionType::toString ( )
Returns
string a human-readable representation of this object

Definition at line 115 of file TransactionType.php.

com_maileon_api_transactions_TransactionType::toXML ( )
Returns
SimpleXMLElement containing the XML serialization of this object

Definition at line 136 of file TransactionType.php.

com_maileon_api_transactions_TransactionType::toXMLString ( )
Returns
string containing the XML serialization of this object

Definition at line 167 of file TransactionType.php.


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