Interface Inx_Api_Action_SetValueCommand

Description

Use the Inx_Api_Action_SetValueCommand to set an attribute value.

Use the Inx_Api_Action_SetValueCommand to set an attribute value. There are three ways to set the attribute value:

  • CMD_TYPE_ABSOLUTE: Absolute value (e.g. 5 or 1)
  • CMD_TYPE_RELATIVE: Relative value (e.g. 2 to increment the value by 2)
  • CMD_TYPE_FREE_EXPRESSION: Free expression (e.g. "=Date()" to set a date attribute to the current date)
Note: The data type of a value must be the same as the data type of the specified attribute. Relative values can only be set for the following data types:
  • DataType.Integer
  • DataType.Double
  • DataType.Text

Located in /Api/Action/SetValueCommand.php (line 28)

Inx_Api_Action_Command
   |
   --Inx_Api_Action_SetValueCommand
Class Constant Summary
Method Summary
int getCmdType ()
string getExpression ()
Methods
getAttributeId (line 51)

Returns the id of the affected user attribute.

Returns the id of the affected user attribute.

  • return: the id of the affected user attribute.
  • access: public
int getAttributeId ()
getCmdType (line 62)

Returns the command type:

Returns the command type: Inx_Api_Action_SetValueCommand::CMD_TYPE_ABSOLUTE, Inx_Api_Action_SetValueCommand::CMD_TYPE_RELATIVE or Inx_Api_Action_SetValueCommand::CMD_TYPE_FREE_EXPRESSION

  • return: the command type.
  • access: public
int getCmdType ()
getExpression (line 70)

Returns the expression/value to set for the attribute.

Returns the expression/value to set for the attribute.

  • return: the expression/value.
  • access: public
string getExpression ()
Class Constants
CMD_TYPE_ABSOLUTE = 0 (line 33)

Command type: Sets an absolute value.

Command type: Sets an absolute value.

CMD_TYPE_FREE_EXPRESSION = 2 (line 43)

Command type: Sets a value from a free expression.

Command type: Sets a value from a free expression.

CMD_TYPE_RELATIVE = 1 (line 38)

Command type: Sets a relative value.

Command type: Sets a relative value.

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