Class plgUserJoomla

Description

Joomla User plugin

  • since: 1.5

Located in /plugins/user/joomla/joomla.php (line 17)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgUserJoomla
Method Summary
boolean onUserAfterDelete (array $user, boolean $succes, string $msg)
void onUserAfterSave (array $user, boolean $isnew, boolean $success, string $msg)
boolean onUserLogin (array $user, [array $options = array()])
object True onUserLogout (array $user, [array $options = array()])
object A _getUser (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
onUserAfterDelete (line 31)

Remove all sessions for the user name

Method is called after user data is deleted from the database

  • since: 1.6
  • access: public
boolean onUserAfterDelete (array $user, boolean $succes, string $msg)
  • array $user: Holds the user data
  • boolean $succes: True if user was succesfully stored in the database
  • string $msg: Message
onUserAfterSave (line 60)

Utility method to act on a user after it has been saved.

This method sends a registration email to new users created in the backend.

  • since: 1.6
  • access: public
void onUserAfterSave (array $user, boolean $isnew, boolean $success, string $msg)
  • array $user: Holds the new user data.
  • boolean $isnew: True if a new user is stored.
  • boolean $success: True if user was succesfully stored in the database.
  • string $msg: Message.
onUserLogin (line 127)

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

  • return: True on success
  • since: 1.5
  • access: public
boolean onUserLogin (array $user, [array $options = array()])
  • array $user: Holds the user data
  • array $options: Array holding options (remember, autoregister, group)
onUserLogout (line 193)

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, ...).
_getUser (line 236)

This method will return a user object

If options['autoregister'] is true, if the user doesn't exist yet he will be created

  • return: JUser object
  • since: 1.5
  • access: protected
object A _getUser (array $user, [array $options = array()])
  • array $user: Holds the user data.
  • array $options: Array holding options (remember, autoregister, group).

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:01 -0500 by phpDocumentor 1.4.4