A result must have a definite status assigned to it. When creating a result, it must be assigned a default status that has an option "Assign this status to all new documents" set (only one status can have this option set). During its lifetime, the status of a result may change.
To intercept and process such changes of status, the Web Form module enables a developer to provide the status handler file. A handler can call any system function to perform the desired action; for example:
File handlers are PHP scripts included when a status changes. They can be located in any directory from the site root; for example in /bitrix/php_interface/include/form/handlers/.
To specify a file handler, go to the Status parameters page. This page has the following two fields that are required to install file handlers:
The handler specified in the field "File handler to be called when changing this status to another..." can use the following variables.
Variable | Description |
---|---|
$CURRENT_STATUS_ID | The ID of the current status (before it is changed). |
$NEW_STATUS_ID | The ID of the new status. |
$RESULT_ID | The ID of the result that is changing its status. |
$arResult | Array describing the result fields. |
$ACTION | The symbolic code of the action which is to be performed:
|
The handler specified in the field "File handler to be called when changing a status to this..." can use the following variables.
Variable | Description |
---|---|
$CURRENT_STATUS_ID | The ID of the current status. |
$PREV_STATUS_ID | The ID of the previous status. |
$RESULT_ID | The ID of the result that is changing its status. |
$arResult | Array describing the result fields. |
$ACTION | The symbolic code of the action which is to be performed:
|
© 2001-2005 Bitrix | Bitrix Site Manager - Content Management & Portal Solutions |