API17:JDatabase::updateObject
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JDatabase::updateObject== | =={{JVer|11.1}} JDatabase::updateObject== | ||
===Description=== | ===Description=== | ||
| − | + | Updates a row in a table based on an object's properties. | |
{{Description:JDatabase::updateObject}} | {{Description:JDatabase::updateObject}} | ||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JDatabase::updateObject|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JDatabase::updateObject|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function updateObject ( |
| + | $table | ||
| + | &$object | ||
| + | $key | ||
| + | $nulls=false | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 20: | Line 24: | ||
|- | |- | ||
|$table | |$table | ||
| − | | | + | | |
| | | | ||
| | | | ||
| Line 27: | Line 31: | ||
|object | |object | ||
| | | | ||
| − | | | + | |$object A reference to an object whose public properties match the table fields. |
|- | |- | ||
| − | |$ | + | |$key |
|string | |string | ||
| | | | ||
| − | | | + | |The name of the primary key. |
|- | |- | ||
| − | |$ | + | |$nulls |
| − | | | + | |bool |
|false | |false | ||
| − | | | + | |True to update null fields or false to ignore them. |
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' bool True on success. | |
| − | + | * '''Defined''' on line 958 of libraries/joomla/database/database.php | |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/database/database.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JDatabase::updateObject source code''' on [[jplatform:database/database.php#cl-950|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JDatabase/11.1|JDatabase]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]] | ||
| + | * [[JDatabase::updateObject|Other versions of JDatabase::updateObject]] | ||
| + | {{SeeAlso:JDatabase::updateObject}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JDatabase::updateObject|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JDatabase::updateObject|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 61: | Line 64: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JDatabase]][[Category:JDatabase::updateObject]]</noinclude> | <noinclude>[[Category:JDatabase]][[Category:JDatabase::updateObject]]</noinclude> | ||
Revision as of 20:27, 27 April 2011
JDatabase::updateObject
Description
Updates a row in a table based on an object's properties.
Description:JDatabase::updateObject [Edit Descripton]
public function updateObject ( $table &$object $key $nulls=false )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $table | |||
| &$object | object | $object A reference to an object whose public properties match the table fields. | |
| $key | string | The name of the primary key. | |
| $nulls | bool | false | True to update null fields or false to ignore them. |
- Returns bool True on success.
- Defined on line 958 of libraries/joomla/database/database.php
- Since
See also
- JDatabase::updateObject source code on BitBucket
- Class JDatabase
- Subpackage Database
- Other versions of JDatabase::updateObject
SeeAlso:JDatabase::updateObject [Edit See Also]
User contributed notes
<CodeExamplesForm />
