API16:JDatabaseMySQL/explain

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

Diagnostic function

Syntax

explain()

Returns

string

Defined in

libraries/joomla/database/database/mysql.php

Importing

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

Source Body

public function explain()
{
        $temp = $this->_sql;
        $this->_sql = "EXPLAIN $this->_sql";
 
        if (!($cur = $this->query())) {
                return null;
        }
        $first = true;
 
        $buffer = '<table id="explain-sql">';
        $buffer .= '<thead><tr><td colspan="99">'.$this->getQuery().'</td></tr>';
        while ($row = mysql_fetch_assoc($cur)) {
                if ($first) {
                        $buffer .= '<tr>';
                        foreach ($row as $k=>$v) {
                                $buffer .= '<th>'.$k.'</th>';
                        }
                        $buffer .= '</tr></thead><tbody>';
                        $first = false;
                }
                $buffer .= '<tr>';
                foreach ($row as $k=>$v) {
                        $buffer .= '<td>'.$v.'</td>';
                }
                $buffer .= '</tr>';
        }
        $buffer .= '</tbody></table>';
        mysql_free_result($cur);
 
        $this->_sql = $temp;
 
        return $buffer;
}

Examples

<CodeExamplesForm />