Interface Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder

Description

The Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder is used to create a monthly trigger interval.

The Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder is used to create a monthly 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 months where X is the interval count. Do not confuse this setting with the day setting.
  • The day: Specifies the day, at which the trigger will be fired.
  • The dispatch interval: Specifies the basis for the day attribute. The following options are allowed:
    • LAST_DAY_OF_MONTH: The trigger will be fired on the last day of the month. In this case, the day setting must be omitted or set to zero.
    • SPECIFIC_DAY_OF_MONTH: The trigger will be fired on the day of month specified by the day setting.
    • SPECIFIC_DAY_BEFORE_END_OF_MONTH: The trigger will be fired on the specified day before the end of the month. For example, using the value 2 for the day setting will cause the trigger to be fired to days before the end of the current month.
The day setting is only optional when using the dispatch interval LAST_DAY_OF_MONTH. There are no other optional settings. <p/> The following snippet shows how to build a monthly trigger interval which will fire the trigger every two months, three days before the end of the month:
 $factory = $session->getTriggerMailingManager()->getTriggerIntervalBuilderFactory();
 $interval = $factory->getMonthlyIntervalBuilder()->intervalCount( 2 )->day( 3 )->dispatchInterval(
      Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval::SPECIFIC_DAY_BEFORE_END_OF_MONTH())
      ->build();

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

Inx_Api_TriggerMailing_Descriptor_TriggerIntervalBuilder
   |
   --Inx_Api_TriggerMailing_Descriptor_MonthlyTriggerIntervalBuilder
Method Summary
Methods
day (line 85)

Returns the day of the dispatch interval. LAST_DAY_OF_MONTH. the interval count setting as they are used for different purposes. months on the first day of the month, you need the following settings: <p/>

  • Interval count: 2
  • Dispatch interval: SPECIFIC_DAY_OF_MONTH
  • Day: 1
<p/> Only values between 1 and 28 inclusively are legal.

Returns the day of the dispatch interval. This setting is only optional if the dispatch interval is LAST_DAY_OF_MONTH. In this case, the day setting must be omitted or set to zero. Do not confuse this setting with the interval count setting as they are used for different purposes. For example, to fire the trigger every two months on the first day of the month, you need the following settings: <p/>

  • Interval count: 2
  • Dispatch interval: SPECIFIC_DAY_OF_MONTH
  • Day: 1
<p/> Only values between 1 and 28 inclusively are legal.

  • return: the builder.
  • throws: Inx_Api_IllegalArgumentException if the value is smaller than 1 or bigger than 28.
  • access: public
  • int $iDay: the day of the dispatch interval.
dispatchInterval (line 64)

Sets the Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval which determines the dispatch interval.

Sets the Inx_Api_TriggerMailing_Descriptor_TimeTriggerDispatchInterval which determines the dispatch interval. This setting is mandatory. The following options are legal: <p/>

  • LAST_DAY_OF_MONTH: The trigger will be fired on the last day of the month. In this case, the day setting must be omitted or set to zero.
  • SPECIFIC_DAY_OF_MONTH: The trigger will be fired on the day of month specified by the day setting.
  • SPECIFIC_DAY_BEFORE_END_OF_MONTH: The trigger will be fired on the specified day before the end of the month. For example, using the value 2 for the day setting will cause the trigger to be fired to days before the end of the current month.

  • return: the builder.
  • throws: Inx_Api_IllegalArgumentException if the dispatch interval is not one of the values listed above.
  • access: public

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:27 +0200 by phpDocumentor 1.3.2