Class Inx_Api_TriggerMailing_FilterConcatenationType

Description

The Inx_Api_TriggerMailing_FilterConcatenationType enumeration defines the different ways in which filters (target groups) can be combined.

The Inx_Api_TriggerMailing_FilterConcatenationType enumeration defines the different ways in which filters (target groups) can be combined. A note for programmers who are not familiar with the concept of enumerations: Enumerations or enumerated types are basically a fixed set of named values. They are usually used to define a couple of legitimate values in a specific context and serve a purpose similar to integer constants. The advantage of enumerations is, that you cannot specify any "weird" values because every value has to be an instance of the enumerated type. It is also possible to associate data or even behaviour (methods) with the values. PHP does not support such a language feature like Java and C# do. In most languages the named values are a sort of constant whose value is an instance of the enumerated type. In PHP a constant cannot contain a reference type. Therefore, we implemented enumerations as classes with private constructor and methods which return the named values. Be aware that the objects returned by the static methods are always the same object. That way it is possible to use the identity operator (===) on these objects and use them comfortably in switch statements.

Located in /Api/TriggerMailing/FilterConcatenationType.php (line 26)


	
			
Method Summary
static void FILTER_AND ()
static void FILTER_NOT_IN ()
static void FILTER_OR ()
static void UNKNOWN ()
static array values ()
int getId ()
Methods
static method byId (line 126)

Returns the FilterConcatenationType corresponding to the given id. UNKNOWN type will be returned. inside client code.

Returns the FilterConcatenationType corresponding to the given id. If the id is unknown, the UNKNOWN type will be returned. The ID is used for transmission purposes and should not be used inside client code.

  • return: the FilterConcatenationType corresponding to the given ID.
  • access: public
  • int $iId: the ID of the FilterConcatenationType to retrieve.
static method FILTER_AND (line 43)

Filter constant for the AND operator. groups) defined by TriggerMailing::getFilderIds().

Filter constant for the AND operator. The AND operator requires a recipient to be a member of all filters (target groups) defined by TriggerMailing::getFilderIds().

static void FILTER_AND ()
static method FILTER_NOT_IN (line 73)

Filter constant for the NOT IN operator. filters (target groups) defined by TriggerMailing::getFilderIds().

Filter constant for the NOT IN operator. The NOT IN operator requires a recipient to not be a member of all filters (target groups) defined by TriggerMailing::getFilderIds().

static void FILTER_NOT_IN ()
static method FILTER_OR (line 58)

Filter constant for the OR operator. (target group) defined by TriggerMailing::getFilderIds().

Filter constant for the OR operator. The OR operator requires a recipient to be a member of a least one filter (target group) defined by TriggerMailing::getFilderIds().

static void FILTER_OR ()
static method UNKNOWN (line 88)

Filter constant for an unknown filter concatenation type. server.

Filter constant for an unknown filter concatenation type. This type indicates a version mismatch between API and server.

static void UNKNOWN ()
static method values (line 144)

Returns an array containing all available FilterConcatenationTypes including UNKNOWN.

Returns an array containing all available FilterConcatenationTypes including UNKNOWN.

  • return: an array containing all available FilterConcatenationTypes including UNKNOWN.
  • access: public
static array values ()
getId (line 111)

Returns the ID of the

Returns the ID of the

  • return: the ID of the FilterConcatenationType.
  • access: public
int getId ()

Documentation generated on Thu, 17 Sep 2015 14:27:24 +0200 by phpDocumentor 1.3.2