Partners
Download
BuyDB2 PHP Generator online Help
| Prev | Return to chapter overview | Next |
OnBeforeUpdateRecord
This event occurs when the Update command is executed, and before the actual update.
Signature:
function OnBeforeUpdateRecord ($page, $oldRowData, &$rowData, &$cancel, &$message,
&$messageDisplayTime, $tableName)
Parameters:
$page |
An instance of the Page class declared in components/page.php. |
$oldRowData |
The associative array of old (previous) values of the currently processed row. |
$rowData |
The associative array of values that corresponds to the currently processed row. |
$cancel |
The value indicating whether the operation should be canceled. |
$message |
The message string that is displayed after the operation is completed (or canceled). |
$messageDisplayTime |
A time interval (in seconds) after which the message will disappear automatically. Default value is 0 (the message will not disappear). |
$tableName |
The name of processed table. |
Example 1:
if (!(allowDataEditing())) {
$cancel = true;
$message = 'The application is running in read-only mode.';
}
Example 2:
The following code allows to assign values to some fields (usually these fields are not included in an edit form)
before updating of a record:
$rowData['line_total'] = $rowData['quantity'] * $rowData['unit_price'];
$rowData['update_datetime'] = SMDateTime::Now();
$rowData['last_updated_by'] = $page->GetCurrentUserId();
See also: OnBeforeDeleteRecord, OnBeforeInsertRecord, OnAfterUpdateRecord.
| Prev | Return to chapter overview | Next |
