JObject/getError
From Joomla! Documentation
< API15:JObjectRevision as of 17:11, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description===
Get the most recent error message
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi...)
Revision as of 17:11, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description===
Get the most recent error message
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi...)
The "API15" 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
Template:Description:JObject/getError
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 public
Defined in[edit]
libraries/joomla/base/object.php
Importing[edit]
jimport( 'joomla.base.object' );
Source Body[edit]
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;
}
[Edit See Also] Template:SeeAlso:JObject/getError
Examples[edit]
<CodeExamplesForm />