Interface Inx_Api_TriggerMailing_StateFilter

Description

An Inx_Api_TriggerMailing_StateFilter is used to retrieve trigger mailings according to their state.

An Inx_Api_TriggerMailing_StateFilter is used to retrieve trigger mailings according to their state. The StateFilter combines two different state types:

  • The mailing state: Used to retrieve mailings in one or more states.
  • The trigger state: Used to retrieve mailings whose trigger is in a particular state.
Neither type is mandatory to be set. It is possible to create a StateFilter that matches all mailing states and/or all trigger states. Omitting both states will result in an all matching StateFilter. This special filter is used to retrieve all trigger mailings of a specific list, disregarding their state, and can be obtained using the TriggerMailingManager::createAllMatchingStateFilter() method which will return a singleton. For an example on how to use StateFilters, see the TriggerMailingManager documentation.

  • author: chge, 16.07.2012
  • see: Inx_Api_TriggerMailing_TriggerState
  • see: Inx_Api_TriggerMailing_TriggerMailingState
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::selectByState( Inx_Api_List_ListContext $listContext, Inx_Api_TriggerMailing_StateFilter $stateFilter, Inx_Api_TriggerMailing_TriggerMailingAttribute $orderAttribute = null, $iOrderType = null, $sFilter = null )
  • see: Inx_Api_TriggerMailing_TriggerMailingManager::createStateFilter( array $mailingStateFilter = null,
  • since: API 1.10.0

Located in /Api/TriggerMailing/StateFilter.php (line 31)


	
			
Method Summary
Methods
getMailingStateFilter (line 40)

Returns the Inx_Api_TriggerMailing_TriggerMailingStates this StateFilter matches. indicating that this StateFilter matches any TriggerMailingState.

Returns the Inx_Api_TriggerMailing_TriggerMailingStates this StateFilter matches. May be null, indicating that this StateFilter matches any TriggerMailingState.

  • return: the TriggerMailingStates this StateFilter matches, or null if it matches any TriggerMailingState.
  • access: public
array getMailingStateFilter ()
getTriggerStateFilter (line 50)

Returns the Inx_Api_TriggerMailing_TriggerState this StateFilter matches. indicating that this StateFilter matches any TriggerState.

Returns the Inx_Api_TriggerMailing_TriggerState this StateFilter matches. May be nullitt>, indicating that this <i>StateFilter matches any TriggerState.

  • return: the TriggerState this StateFilter matches, or null if it matches any TriggerState.
  • access: public
Inx_Api_TriggerMailing_TriggerState getTriggerStateFilter ()
matchesAllMailingStates (line 69)

Returns a bool indicating whether this StateFilter matches any TriggerMailingState.

Returns a bool indicating whether this StateFilter matches any TriggerMailingState.

  • return: true if this StateFilter matches any TriggerMailingState state, false otherwise.
  • access: public
bool matchesAllMailingStates ()
matchesAllStates (line 60)

Returns a bool indicating whether this StateFilter matches any mailing and trigger state. Inx_Api_TriggerMailing_TriggerMailingManager::createAllMatchingStateFilter().

Returns a bool indicating whether this StateFilter matches any mailing and trigger state. If it does, it is equivalent to the all matching StateFilter provided by Inx_Api_TriggerMailing_TriggerMailingManager::createAllMatchingStateFilter().

  • return: true if this StateFilter matches any state, false otherwise.
  • access: public
bool matchesAllStates ()
matchesAllTriggerStates (line 78)

Returns a bool indicating whether this StateFilter matches any TriggerState.

Returns a bool indicating whether this StateFilter matches any TriggerState.

  • return: true if this StateFilter matches any TriggerState state, false otherwise.
  • access: public
bool matchesAllTriggerStates ()

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