Maileon PHP client  1.2.5
Easily integrate your PHP application with Maileon.
com_maileon_api_contacts_Permission Class Reference

Public Member Functions

 __construct ($code=0, $type=null)
 
 getCode ()
 
 getString ()
 

Static Public Member Functions

static init ()
 
static getPermission ($code)
 

Public Attributes

 $code
 
 $type
 

Static Public Attributes

static $NONE
 
static $SOI
 
static $COI
 
static $DOI
 
static $DOI_PLUS
 
static $OTHER
 

Detailed Description

The wrapper class for a Maileon permission. 1 = NONE, 2 = SOI, 3 = COI, 4 = DOI, 5 = DOI+, 6 = OTHER.

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

Definition at line 8 of file Permission.php.

Constructor & Destructor Documentation

com_maileon_api_contacts_Permission::__construct (   $code = 0,
  $type = null 
)

Constructor initializing the code of the permission.

Parameters
number$codeThe code to use for the constructed permission.

Definition at line 44 of file Permission.php.

Member Function Documentation

static com_maileon_api_contacts_Permission::init ( )
static

This is the initialization method for the permission types. This must be called once in the beginning.

Definition at line 25 of file Permission.php.

com_maileon_api_contacts_Permission::getCode ( )

Get the code of this permission. 1 = NONE, 2 = SOI, 3 = COI, 4 = DOI, 5 = DOI+, 6 = OTHER.

Returns
number the code of the permission object

Definition at line 61 of file Permission.php.

com_maileon_api_contacts_Permission::getString ( )

Get the type string of this permission. none = NONE, soi = SOI, coi = COI, doi = DOI, doi+ = DOI+, other = OTHER.

Returns
string the type of the permission object

Definition at line 73 of file Permission.php.

static com_maileon_api_contacts_Permission::getPermission (   $code)
static

Get the permission object from the code

Parameters
var$codeThe code or type to get the permission object for.
Returns
com_maileon_api_contacts_Permission The permission object for the given code.

Definition at line 105 of file Permission.php.


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