API17

Difference between revisions of "JDatabase::insertObject"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
=={{JVer|11.1}} JDatabase::insertObject==
 
=={{JVer|11.1}} JDatabase::insertObject==
 
===Description===
 
===Description===
Inserts a row into a table based on an objects properties.  
+
Inserts a row into a table based on an object's properties.  
  
 
{{Description:JDatabase::insertObject}}
 
{{Description:JDatabase::insertObject}}
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JDatabase::insertObject|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JDatabase::insertObject|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JDatabase->insertObject ($table, &$object, $keyName=NULL)
+
public function insertObject (
 +
        $table
 +
        &$object
 +
        $key=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 20: Line 23:
 
|-
 
|-
 
|$table
 
|$table
|string
 
 
|
 
|
|The name of the table
+
|
 +
|
 
|-
 
|-
 
|&$object
 
|&$object
 
|object
 
|object
 
|
 
|
|An object whose properties match table fields  
+
|$object A reference to an object whose public properties match the table fields.
 
|-
 
|-
|$keyName
+
|$key
 
|string
 
|string
|NULL
+
|null
|The name of the primary key. If provided the object property is updated.  
+
|The name of the primary key. If provided the object property is updated.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' bool True on success.
 
+
* '''Defined''' on line 484 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::insertObject source code''' on [[jplatform:database/database.php#cl-476|BitBucket]]
 +
* {{JVer|11.1}} Class [[JDatabase/11.1|JDatabase]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]]
 +
* [[JDatabase::insertObject|Other versions of JDatabase::insertObject]]
 +
{{SeeAlso:JDatabase::insertObject}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JDatabase::insertObject|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JDatabase::insertObject|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JDatabase/11.1|JDatabase]]
+
===User contributed notes===
* [[JDatabase::insertObject|Other versions of this method]]
 
{{SeeAlso:JDatabase::insertObject}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 55: Line 58:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JDatabase]][[Category:JDatabase::insertObject]]</noinclude>
 
<noinclude>[[Category:JDatabase]][[Category:JDatabase::insertObject]]</noinclude>

Revision as of 20:26, 27 April 2011

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JDatabase::insertObject[edit]

Description[edit]

Inserts a row into a table based on an object's properties.

Template:Description:JDatabase::insertObject [Edit Descripton]

public function insertObject (
        $table
        &$object
        $key=null
)
Parameter Type Default Description
$table
&$object object $object A reference to an object whose public properties match the table fields.
$key string null The name of the primary key. If provided the object property is updated.
  • Returns bool True on success.
  • Defined on line 484 of libraries/joomla/database/database.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JDatabase::insertObject [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />