Interface Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder

Description

The Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder is used to create a weekly trigger interval.

The Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder is used to create a weekly trigger interval. The following settings are mandatory: <p/>

  • The interval count: Specifies how many times the trigger will be fired. The trigger will be fired every X weeks where X is the interval count.
  • The dispatch intervals: Specifies the days on which the trigger will be fired. The following options are allowed:
    • MONDAY: The trigger will be fired on Mondays.
    • TUESDAY: The trigger will be fired on Tuesdays.
    • WEDNESDAY: The trigger will be fired on Wednesday.
    • THURSDAY: The trigger will be fired on Thursdays.
    • FRIDAY: The trigger will be fired on Fridays.
    • SATURDAY: The trigger will be fired on Saturdays.
    • SUNDAY: The trigger will be fired on Sundays.
There are no optional settings. <p/> The following snippet shows how to build a weekly trigger interval which will fire the trigger every two weeks on Mondays and Fridays:
 $factory = $session->getTriggerMailingManager()->getTriggerIntervalBuilderFactory();
 $interval = $factory->getWeeklyIntervalBuilder()->intervalCount( 2 )->dispatchIntervals(
      array( Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval::MONDAY(),
          Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval::FRIDAY() ) )->build();

Located in /Api/TriggerMailing/Descriptor/WeeklyTriggerIntervalBuilder.php (line 43)

Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder
   |
   --Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder
Method Summary
Methods
dispatchIntervals (line 67)

Sets the set (implemented as array) of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals. <p/>

Sets the set (implemented as array) of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals. This setting is mandatory. The following options are legal: <p/>

  • MONDAY: The trigger will be fired on Mondays.
  • TUESDAY: The trigger will be fired on Tuesdays.
  • WEDNESDAY: The trigger will be fired on Wednesday.
  • THURSDAY: The trigger will be fired on Thursdays.
  • FRIDAY: The trigger will be fired on Fridays.
  • SATURDAY: The trigger will be fired on Saturdays.
  • SUNDAY: The trigger will be fired on Sundays.
<p/> The dispatch interval set can be easily created using the array function.

  • return: the builder.
  • throws: Inx_Api_IllegalArgumentException if the dispatch intervals contain a value not listed above.
  • access: public
Inx_Api_TriggerMailing_Descriptor_WeeklyTriggerIntervalBuilder dispatchIntervals ( $dispatchIntervals)
  • array $dispatchIntervals: the set of Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchIntervals which determines the dispatch intervals.

Inherited Methods

Inherited From Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder

Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder::build()
Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder::intervalCount()

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