API16

JDocumentError/setError: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 45: Line 45:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=setError
  category=setError
  category=JDocumentError
  category=JDocumentError
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:32, 25 March 2017

Description

Set error object


<! removed transcluded page call, red link never existed >

Syntax

setError($error)
Parameter Name Default Value Description
$error $error Error object to set

Returns

boolean True on success

Defined in

libraries/joomla/document/error/error.php

Importing

jimport( 'joomla.document.error.error' );

Source Body

function setError($error)
{
        if (JError::isError($error)) {
                $this->_error = & $error;
                return true;
        } else {
                return false;
        }
}


<! removed transcluded page call, red link never existed >

Examples

Code Examples