[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/plugins/user/joomla/ -> joomla.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2009 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 275 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

plgUserJoomla:: (5 methods):
  onUserAfterDelete()
  onUserAfterSave()
  onUserLogin()
  onUserLogout()
  _getUser()


Class: plgUserJoomla  - X-Ref

Joomla User plugin

onUserAfterDelete($user, $succes, $msg)   X-Ref
Remove all sessions for the user name

Method is called after user data is deleted from the database

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

onUserAfterSave($user, $isnew, $success, $msg)   X-Ref
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.

param: array        $user        Holds the new user data.
param: boolean        $isnew        True if a new user is stored.
param: boolean        $success    True if user was succesfully stored in the database.
param: string        $msg        Message.
return: void

onUserLogin($user, $options = array()   X-Ref
This method should handle any login logic and report back to the subject

param: array    $user        Holds the user data
param: array    $options    Array holding options (remember, autoregister, group)
return: boolean    True on success

onUserLogout($user, $options = array()   X-Ref
This method should handle any logout logic and report back to the subject

param: array    $user        Holds the user data.
param: array    $options    Array holding options (client, ...).
return: object    True on success

_getUser($user, $options = array()   X-Ref
This method will return a user object

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

param: array    $user        Holds the user data.
param: array    $options    Array holding options (remember, autoregister, group).
return: object    A JUser object



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1