->update()

->update() – Met à jour les variables des objets dans une base de données

Synopsis

int $DB_DataObject->update ( dataobject|boolean $original|$useWhere )

Description

Met à jour les variables des objets courants dans la base de données. Si vous fournissez un objet de données, en tant qu'argument, la méthode mettra à jour uniquement les différences entre le nouveau et l'ancien.

Si la méthode est appelée avec DB_DATAOBJECT_WHEREADD_ONLY comme argument, la requête de mise à jour est construite, basée sur les valeurs whereAdd, plutôt que sur la clé primaire. Ceci permet de meilleures performances pour les mises à jour globales, plutôt que de mettre à jour ligne par ligne.

Parameter

  • DataObject $original - si fourni, la requête de mise à jour sera construite depuis la différence entre l'objet de données actuel et l'original.

Return value

int : nombre de lignes affectées ou FALSE si une erreur survient

Throws

Possible PEAR_Error values
Code erreur Message d'erreur Signification Solution
DB_DATAOBJECT_ERROR_INVALIDCONFIG "update:No table definition for $table" Aucune définition de table pour $table
DB_DATAOBJECT_ERROR_NODATA "update: No Data specifed for query $settings" Aucune donnée fournie pour la requête $settings

Note

This function can not be called statically.

Example

Récupération et mise à jour simple

<?php
$person 
= new DataObjects_Person;
$person->get(12);
$person->name='fred';
$person->update();
$person = new DataObjects_Person;
$person->get(12);
$original = clone($person); // le clônage est émulé en PHP 4 pour des raisons de compatibilité.
$person->name='fred';
$person->update($original);
?>

SQL résultant


SELECT * FROM person WHERE id = 12
UPDATE person SET name='fred', age='21', eyes='blue' WHERE id = 12

SELECT * FROM person WHERE id = 12
UPDATE person SET name='fred'  WHERE id = 12

Récupération et mise à jour simple

<?php
$person 
= new DataObjects_Person;
$person->removed=1;
$person->whereAdd('age > 21');
$person->update();
?>

SQL résultant


SELECT * FROM person WHERE id = 12;
UPDATE person SET removed=1 WHERE age > 21
Insert les variables de l'objet courant dans la base de données (Previous) Efface des éléments d'une table (Next)
Last updated: Sun, 29 Aug 2010 — Download Documentation
Do you think that something on this page is wrong? Please file a bug report or add a note.
View this page in:

User Notes:

Note by: jacek
interesting case:

$person = new DataObjects_Person;
$person -> get(1);
$person -> name = 'fred';
$person -> update();

works but:

$person = new DataObjects_Person;
$person -> get(0);
$person -> name = 'fred';
$person -> update();

doesn't - (and apparently this is not a BUG - I tried to file bug report)

the table has only to records:

id, name
0 john
1 joe

id column is the primary key.





Note by: mike@mikebrittain.com
The second code example is missing the DB_DATAOBJECT_WHEREADD_ONLY parameter which allows for running update queries based only on whereAdd values and not by primary key. See description for this method (above).

$person = new DataObjects_Person;
$person->removed=1;
$person->whereAdd('age > 21');
$person->update(DB_DATAOBJECT_WHEREADD_ONLY);
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.