->delete()

->delete() -- Delete items from table

Synopsis

int $DB_DataObject->delete ([boolean $useWhere])

Description

Deletes data from the database, either using primary key or based on a whereAdd() method call. By default the delete will base it's query on the set variables, however if you wish to use the whereAdd() method you should set the $useWhere parameter to DB_DATAOBJECT_WHEREADD_ONLY.

Parameter

Return value

int number of rows affected or FALSE on failure

Throws

Table 26-1. Possible PEAR_Error values

Error codeError messageMeaningSolution
DB_*"*"see PEAR::DBsee PEAR::DB
DB_DATAOBJECT_ERROR_NODATA "delete: No Data specifed for query $condition"   

Note

This function can not be called statically.

Example