API16:JDatabaseMySQL/loadRowList

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.

Description

Load a list of database rows (numeric column indexing)

Syntax

loadRowList($key=null)

Parameter Name	Default Value	Description
$key	null	The field name of a primary key

Returns

array If is empty as sequential list of returned records. If is not empty then the returned array is indexed by the value the database key. Returns if the query fails.

Defined in

libraries/joomla/database/database/mysql.php

Importing

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

Source Body

public function loadRowList($key=null)
{
        if (!($cur = $this->query())) {
                return null;
        }
        $array = array();
        while ($row = mysql_fetch_row($cur)) {
                if ($key !== null) {
                        $array[$row[$key]] = $row;
                } else {
                        $array[] = $row;
                }
        }
        mysql_free_result($cur);
        return $array;
}

Examples

<CodeExamplesForm />