[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

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

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: example.php 14401 2010-01-26 14:10:00Z louis $
File Size: 174 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

plgUserExample:: (7 methods):
  plgUserExample()
  onBeforeStoreUser()
  onAfterStoreUser()
  onBeforeDeleteUser()
  onAfterDeleteUser()
  onLoginUser()
  onLogoutUser()


Class: plgUserExample  - X-Ref

Example User Plugin

plgUserExample(& $subject, $config)   X-Ref
Constructor

For php4 compatability we must not use the __constructor as a constructor for plugins
because func_get_args ( void ) returns a copy of all passed arguments NOT references.
This causes problems with cross-referencing necessary for the observer design pattern.

param: object $subject The object to observe
param: array  $config  An array that holds the plugin configuration

onBeforeStoreUser($user, $isnew)   X-Ref
Example store user method

Method is called before user data is stored in the database

param: array        holds the old user data
param: boolean        true if a new user is stored

onAfterStoreUser($user, $isnew, $success, $msg)   X-Ref
Example store user method

Method is called after user data is stored in the database

param: array        holds the new user data
param: boolean        true if a new user is stored
param: boolean        true if user was succesfully stored in the database
param: string        message

onBeforeDeleteUser($user)   X-Ref
Example store user method

Method is called before user data is deleted from the database

param: array        holds the user data

onAfterDeleteUser($user, $succes, $msg)   X-Ref
Example store user method

Method is called after user data is deleted from the database

param: array        holds the user data
param: boolean        true if user was succesfully stored in the database
param: string        message

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

param: array     holds the user data
param: array    extra options
return: boolean    True on success

onLogoutUser($user)   X-Ref
This method should handle any logout logic and report back to the subject

param: array holds the user data
return: boolean True on success



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1