API16

API16:JDatabaseMySQL/loadObjectList

From Joomla! Documentation

Revision as of 22:40, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Load a list of database objects <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<now...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Load a list of database objects

[Edit Descripton]

Template:Description:JDatabaseMySQL/loadObjectList

Syntax

loadObjectList($key='', $className= 'stdClass')
Parameter Name Default Value Description
$key The field name of a primary key
$className 'stdClass' The name of the class to return (stdClass by default).

Returns

array If is empty as sequential list of returned records.

Defined in

libraries/joomla/database/database/mysql.php

Importing

jimport( 'joomla.database.database.mysql' );

Source Body

public function loadObjectList($key='', $className = 'stdClass')
{
        if (!($cur = $this->query())) {
                return null;
        }
        $array = array();
        while ($row = mysql_fetch_object($cur, $className)) {
                if ($key) {
                        $array[$row->$key] = $row;
                } else {
                        $array[] = $row;
                }
        }
        mysql_free_result($cur);
        return $array;
}

[Edit See Also] Template:SeeAlso:JDatabaseMySQL/loadObjectList

Examples

<CodeExamplesForm />