Docs For Class PlgSystemLogout

Description

Plugin class for logout redirect handling.

since: 1-6

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

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgSystemLogout

Variable Summary

boolean $autoloadLanguage

Method Summary

static void handleError ( &$error)

void __construct (object The &$subject, object The $config)

boolean onUserLogout (array $user, [array $options = array()])

Variables

boolean $autoloadLanguage = true (line 27)

Load the language file on instantiation.

since: 3.1
access: protected

Redefinition of:

JPlugin::$autoloadLanguage: Affects constructor behavior. If true, language files will be loaded automatically.

Inherited Variables

Inherited from JPlugin

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

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

static handleError (line 80)

access: public

static void handleError ( &$error)

&$error

Constructor __construct (line 38)

Object Constructor.

since: 1.6
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 66)

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

return: Always returns true
since: 1.6
access: public

boolean 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()