->insert() (Previous) (Next) ->delete()

View this page in Last updated: Sun, 29 Jun 2008
English | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Plain HTML

->update()

->update() -- Update objects variables into database

Description

Updates current objects variables into the database. if you supply it with a dataObject, as an argument, it will only update the differences between the new and old.

if called with DB_DATAOBJECT_WHEREADD_ONLY as the argument, the update request is built based on the whereAdd values, rather than the primary key. This enables global updates to be performed, rather than single row ones.

Parameter

  • DataObject $original - if provided the update query will be built from the difference between the current and original dataobject.

Return value

int number of rows affected or FALSE on failure

Note

This function can not be called statically.

->insert() (Previous) (Next) ->delete()

Download Documentation Last updated: Sun, 29 Jun 2008
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
Note by: evan@prodromou.name
update() will silently skip any columns that are keys -- even if they're just unique keys, not primary keys.

Say you have a table like this:

CREATE TABLE person (id integer primary key, name varchar(255), email varchar(255) unique key)

This is a pretty common pattern.

The following code will do nothing:

$p = Person::staticGet(1);
$orig = clone($p);
$p->email = 'newemail@example.com';
$result = $p->update($orig);

There doesn't seem to be a workaround for it -- I've resorted to updating unique key columns by hand.

It would be nice if the code for skipping key columns differentiated between primary keys and unique keys and let you update the latter.
Note by: pierre2543@hotmail.com
If you want to update a field to null in the database set the field in your DO to the string 'null'.

For string fields, setting it to '' or 'null' issues null in the update statement.

Example:
Set the contractNumber to null.

//INCORRECT
$contract->get(123);
$contract->contractNumber = null;
$contract->update();

//CORRECT
$contract->get(123);
$contract->contractNumber = 'null';
$contract->update();
Note by: user@example.com
When called with

$object->update($original);

this function appears to return true rather than 0 if no rows are affected.