JObject/getError: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Get the most recent error message
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi... |
m preparing for archive only |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 62: | Line 62: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=getError | category=getError | ||
category=JObject | category=JObject | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API15]] | |||
Latest revision as of 00:59, 25 March 2017
Description
Get the most recent error message
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
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;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples
Code Examples