Class Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset

Description

An Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset is used to adjust the dispatch date of an attribute driven time trigger mailing.

An Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset is used to adjust the dispatch date of an attribute driven time trigger mailing. A TimeTriggerOffset consists of three parts:

  1. The offset type: Defines whether the offset is positive or negative.
  2. The offset unit: Defines the unit of the offset (e.g. day, week, month,...).
  3. The offset value: Defines the actual offset.
The following snippet shows how to create a tomorrow offset:
 $tomorrow = new Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset(
      Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffsetType::IS_IN(),
      Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit::DAY(), 1 );

  • author: chge, 16.07.2012
  • since: API 1.10.0

Located in /Api/TriggerMailing/Descriptor/TimeTriggerOffset.php (line 27)


	
			
Method Summary
Methods
Constructor __construct (line 45)

Creates a new offset with the given type, unit and offset value.

Creates a new offset with the given type, unit and offset value. The value may not be negative. If all parameters are omitted, creates an offset which represents "now".

  • throws: Inx_Api_IllegalArgumentException if the value is negative.
  • access: public
Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffset __construct ([Inx_Api_TriggerMailing_Descriptor_TimeTriggerOffsetType $type = null], [Inx_Api_TriggerMailing_Descriptor_TimeTriggerUnit $unit = null], [int $iValue = null])
equals (line 99)

Compares this TimeTriggerOffset and the given object for equality. equal if they are the same or are both TimeTriggerOffsets of the same type with the same unit and value.

Compares this TimeTriggerOffset and the given object for equality. The two objects are considered equal if they are the same or are both TimeTriggerOffsets of the same type with the same unit and value.

  • return: true if the the given object is equal to this TimeTriggerOffset, false otherwise.
  • access: public
bool equals (mixed $obj)
  • mixed $obj: the object to be compared to this TimeTriggerOffset for equality.
getType (line 62)

Returns the offset type.

Returns the offset type.

  • return: the offset type.
  • access: public
getUnit (line 73)

Returns the offset unit.

Returns the offset unit.

  • return: the offset unit.
  • access: public
getValue (line 84)

Returns the actual offset value.

Returns the actual offset value.

  • return: the offset value.
  • access: public
int getValue ()

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