Class plgSystemLogout

Description

Plugin class for logout redirect handling.

Located in /plugins/system/logout/logout.php (line 15)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgSystemLogout
Method Summary
static void handleError ( &$error)
void __construct (object The &$subject, object The $config)
object True onUserLogout (array $user, [array $options = array()])
Variables

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
static method handleError (line 68)
static void handleError ( &$error)
  • &$error
Constructor __construct (line 26)

Object Constructor.

  • since: 1.5
  • access: public
void __construct (object The &$subject, object The $config)
  • object The &$subject: object to observe -- event dispatcher.
  • object The $config: configuration object for the plugin.

Redefinition of:
JPlugin::__construct()
Constructor
onUserLogout (line 54)

This method should handle any logout logic and report back to the subject

  • return: on success
  • since: 1.5
  • access: public
object True onUserLogout (array $user, [array $options = array()])
  • array $user: Holds the user data.
  • array $options: Array holding options (client, ...).

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:56:30 -0500 by phpDocumentor 1.4.4