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

boolean $use_where - use the whereAdd() conditions (by default, delete will only use primary keys)

Return value

int number of rows affected or FALSE on failure

Throws

Table 21-1. Possible PEAR_Error values

Error code	Error message	Meaning	Solution
DB_*	"*"	see PEAR::DB	see PEAR::DB
DB_DATAOBJECT_ERROR_NODATA	"delete: No Data specifed for query `$condition`"

Note

This function can not be called statically.

Example

Example 21-1. Simple Delete

$person = new DataObjects_Person; $person->get(12); $person->delete();   $person = new DataObjects_Person; $person->whereAdd('age < 21'); $person->delete(DB_DATAOBJECT_WHEREADD_ONLY);

Example 21-2. Resulting SQL

SELECT * FROM person WHERE id=12 DELETE FROM person WHERE id=12 AND name='test' AND age=21 DELETE FROM person WHERE age < 21

Prev	Home	Next
->update()	Up	Selecting Specific data (SELECT)

Who's Online
Guest Users: 10

Free Sample Chapters
	Deliver First Class Web Sites: 101 Essential Checklists Want to learn how to make your web sites usable and accessible? Want to ensure that your sites meet current best practice, without spending hours trawling through incomprehensible specifications and recommendations from dozens of different books, research papers, and web sites? Want to make sure that the sites you build are "right the first time," requiring no costly redevelopments?
More Sample Chapters

PHP General