Actions

Difference between revisions of "JTable/load"

From Joomla! Documentation

 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{review}}
 
{{review}}
 
===Syntax===
 
===Syntax===
''void''  load  ($oid = NULL)  
+
''void''  load  ($keys = NULL,$reset = true)
  
 
=== Parameters ===
 
=== Parameters ===
Line 10: Line 10:
 
!Default
 
!Default
 
|-
 
|-
|$oid
+
|$keys
|integer
+
|mixed
|Optional primary key. If not specifed, the value of current key is used.
+
|An optional primary key value to load the row by, or an array of fields to match.
 +
|''NULL''
 +
|-
 +
|$reset
 +
|boolean
 +
|True to reset the default values before loading the new row.
 
|''NULL''
 
|''NULL''
 
|}
 
|}
  
 
=== Returns ===
 
=== Returns ===
nothing
+
True if successful. False if row not found or on error (internal error state set in that case).
  
 
=== Description ===
 
=== Description ===
 
JTable::load() - Loads a row from the database and binds the fields to the object properties.
 
JTable::load() - Loads a row from the database and binds the fields to the object properties.
 
=== Preconditions ===
 
=== Preconditions ===
JTable is an abstract class. You need to write a child class, to use its functionality. See [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface#Creating the Table Class | Part 4 of the MVC Tutorial]]
+
JTable is an abstract class. You need to write a child class, to use its functionality. See [[J3.2:Developing a MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of Developing a MVC Component/Using the database]]
  
 
===Example===
 
===Example===
Line 65: Line 70:
 
===See also===
 
===See also===
 
* [[JTable/bind]]
 
* [[JTable/bind]]
* [[Developing a Model-View-Controller Component - Part 4 - Creating an Administrator Interface#Creating the Table Class | Creating a JTable Child Class (MVC Tutorial Part 4)]]
+
* [[J3.2:Developing a MVC Component/Using the database#admin.2Ftables.2Fhelloworld.php | Part 7 of J3.2:Developing a MVC Component/Using the database]]
 +
*[[J2.5:Developing a MVC Component/Adding configuration#admin.2Ftables.2Fhelloworld.php | Part 14 of J2.5:Developing a MVC Component/Adding configuration]]
 
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JTable]]</noinclude>
 
<noinclude>[[Category:Development]][[Category:Framework]][[Category:JTable]]</noinclude>

Latest revision as of 20:52, 12 February 2014

Copyedit.png
This Article Needs Your Help

This article is tagged because it NEEDS REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.


Contents

Syntax

void load ($keys = NULL,$reset = true)

Parameters

Argument Data type Description Default
$keys mixed An optional primary key value to load the row by, or an array of fields to match. NULL
$reset boolean True to reset the default values before loading the new row. NULL

Returns

True if successful. False if row not found or on error (internal error state set in that case).

Description

JTable::load() - Loads a row from the database and binds the fields to the object properties.

Preconditions

JTable is an abstract class. You need to write a child class, to use its functionality. See Part 7 of Developing a MVC Component/Using the database

Example

Let's say we have a table, that stores greetings of different languages:

id greeting language
1 Hello English
2 Bonjour French
3 Guten Tag German

If we'd like to load the record with the id #3, we can call the table object from within the model, and load the record:

$table = $this->getTable('greeting');
$table->load(3);
echo '<pre>';
print_r($table);
echo '</pre>';
 
/* RETURNS:
TableGreeting Object
(
    [id] => 3
    [greeting] => Guten Tag
    [language] => German
)
 
*/

See also