JDatabaseMySQL/loadRowList

The "API16" 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.

Description[edit]

Load a list of database rows (numeric column indexing)

[Edit Descripton]

Template:Description:JDatabaseMySQL/loadRowList

Syntax[edit]

loadRowList($key=null)

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

Returns[edit]

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[edit]

libraries/joomla/database/database/mysql.php

Importing[edit]

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

Source Body[edit]

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[edit]

API16