Docs For Class PlgUserJoomla

Description

Joomla User plugin

since: 1.5

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

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgUserJoomla

Variable Summary

JApplicationCms $app

JDatabaseDriver $db

boolean $useStrongEncryption

Method Summary

static string setDefaultEncryption (JRegistry $userPluginParams)

PlgUserJoomla __construct (object &$subject, [array $config = array()])

boolean onUserAfterDelete (array $user, boolean $success, string $msg)

boolean onUserAfterLogin (array $options)

boolean onUserAfterLogout (array $options)

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

JApplicationCms $app (line 27)

Application object

since: 3.2
access: protected

JDatabaseDriver $db (line 35)

Database object

since: 3.2
access: protected

boolean $useStrongEncryption (line 43)

True to use strong password encryption

since: 3.2
access: protected

Inherited Variables

Inherited from JPlugin

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

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

static setDefaultEncryption (line 503)

Method to set the default encryption for passwords

return: The default encryption method based on plugin parameters
since: 3.2
access: public

static string setDefaultEncryption (JRegistry $userPluginParams)

JRegistry $userPluginParams: User plugin params

Constructor __construct (line 55)

Constructor. We use it to set the app and db properties.

since: 3.2
access: public

PlgUserJoomla __construct (object &$subject, [array $config = array()])

object &$subject: The object to observe
array $config: An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params', 'language' (this list is not meant to be comprehensive).

Redefinition of:

JPlugin::__construct(): Constructor

onUserAfterDelete (line 76)

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 $success, string $msg)

array $user: Holds the user data
boolean $success: True if user was succesfully stored in the database
string $msg: Message

onUserAfterLogin (line 355)

We set the authentication cookie only after login is successfullly finished.

We set a new cookie either for a user with no cookies or one where the user used a cookie to authenticate.

return: True on success
since: 3.2
access: public

boolean onUserAfterLogin (array $options)

array $options: options Array holding options

onUserAfterLogout (line 465)

This is where we delete any authentication cookie when a user logs out

return: True on success
since: 3.2
access: public

boolean onUserAfterLogout (array $options)

array $options: Array holding options (length, timeToExpiration)

onUserAfterSave (line 105)

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 172)

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 255)

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 298)

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