Actions

API16

JDocumentError/setError

From Joomla! Documentation

< API16:JDocumentError
Revision as of 17:44, 22 March 2010 by Doxiki (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
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.

Contents

Description

Set error object

[Edit Descripton]

Description:JDocumentError/setError

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;
        }
}

[Edit See Also] SeeAlso:JDocumentError/setError

Examples

<CodeExamplesForm />