JObject/getError

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]

Get the most recent error message.

Syntax[edit]

getError($i=null, $toString=true)

Parameter Name	Default Value	Description
$i	null	$i Option error index.
$toString	true	$toString Indicates if objects should return their error message.

Returns[edit]

string Error message

Defined in[edit]

libraries/joomla/base/object.php

Importing[edit]

jimport( 'joomla.base.object' );

Source Body[edit]

public function getError($i = null, $toString = true)
{
        // Find the error
        if ($i === null)
        {
                // Default, return the last message
                $error = end($this->_errors);
        }
        else if (!array_key_exists($i, $this->_errors))
        {
                // If $i has been specified but does not exist, return false
                return false;
        }
        else {
                $error  = $this->_errors[$i];
        }

        // Check if only the string is requested
        if (JError::isError($error) && $toString) {
                return (string)$error;
        }

        return $error;
}

Examples[edit]

Code Examples[edit]

API16