API16:JObject/getError
From Joomla! Documentation
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
Defined in
libraries/joomla/base/object.php
Importing
jimport( 'joomla.base.object' );
Source Body
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
Code Examples