Actions

API17

Difference between revisions of "JDatabase::updateObject"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 2: Line 2:
 
=={{JVer|11.1}} JDatabase::updateObject==
 
=={{JVer|11.1}} JDatabase::updateObject==
 
===Description===
 
===Description===
Update an object in the database.  
+
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>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JDatabase->updateObject ($table, &$object, $keyName, $updateNulls=false)
+
public function updateObject (
 +
        $table
 +
        &$object
 +
        $key
 +
        $nulls=false
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 20: Line 24:
 
|-
 
|-
 
|$table
 
|$table
|string
+
|
 
|
 
|
 
|
 
|
Line 27: Line 31:
 
|object
 
|object
 
|
 
|
|
+
|$object A reference to an object whose public properties match the table fields.
 
|-
 
|-
|$keyName
+
|$key
 
|string
 
|string
 
|
 
|
|
+
|The name of the primary key.
 
|-
 
|-
|$updateNulls
+
|$nulls
|boolean
+
|bool
 
|false
 
|false
|
+
|True to update null fields or false to ignore them.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' bool True on success.
 
+
* '''Defined''' on line 958 of libraries/joomla/database/database.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/database/database.php
+
===Referenced by===
+
 
===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>
* [[JDatabase/11.1|JDatabase]]
+
===User contributed notes===
* [[JDatabase::updateObject|Other versions of this method]]
+
{{SeeAlso:JDatabase::updateObject}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 60: 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

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 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 Joomla 11.1

See also

SeeAlso:JDatabase::updateObject [Edit See Also]

User contributed notes

<CodeExamplesForm />