API15:JObject/getError

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

Get the most recent error message

Syntax

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

string Error message public

Defined in

libraries/joomla/base/object.php

Importing

jimport( 'joomla.base.object' );

Source Body

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 $error->toString();
        }
 
        return $error;
}

Examples

<CodeExamplesForm />