Radicore Forum: Bug Reports » Documentation deleteRecord

Home » RADICORE development » Bug Reports » Documentation deleteRecord

Show: Today's Messages :: Polls :: Message Navigator
E-mail to friend

Documentation deleteRecord [message #5896]

Tue, 27 September 2016 08:13

kong
Messages: 90
Registered: December 2011

Member

Notice that the documentation on deleteRecord (http:// www.tonymarston.net/php-mysql/functions-and-variables.html#n otes.deleterecord) is not in sync with the source code any longer. This is the current description:

$rowdata = $object->deleteRecord ($rowdata)
$rowdata (IN) is an associative array containing the details of a single database occurrence.
$rowdata (OUT) is the same array.
The steps in this operation are as follows:

Call isPkeyComplete to verify that a single record has been selected via its primary key.
Call _cm_pre_deleteRecord to perform any custom pre-processing.
Call deleteRelations() to delete any child relations.
Call _dml_deleteRecord() to update the database.
Call _cm_post_deleteRecord to perform any custom post-processing.

$this->errors will contain any error messages.
Note that the deletion may have been verified beforehand by a call to validateDelete().
____________________________________________________________

If we apply a consistent standard as in http:// www.tonymarston.net/php-mysql/functions-and-variables.html#n otes.updaterecord, would like to propose to update this to:

$rowdata = $object->deleteRecord ($rowdata)
$rowdata (IN) is an associative array containing the details of a single database occurrence.
$rowdata (OUT) is the same array.
The steps in this operation are as follows:

Call _cm_pre_deleteRecord to perform any custom pre-processing.
Call isPkeyComplete to verify that a single record has been selected via its primary key.
Call _dml_readbeforeupdate() to re-read the original database record.
Call _cm_validateDelete to perform any custom validation.
Call deleteRelations() to delete any child relations.
Call _dml_deleteRecord() to update the database.
Call _cm_post_deleteRecord to perform any custom post-processing.