[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/components/com_users/models/ -> registration.php (summary)

(no description)

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

Defines 1 class

UsersModelRegistration:: (7 methods):
  activate()
  getData()
  getForm()
  loadFormData()
  preprocessForm()
  populateState()
  register()


Class: UsersModelRegistration  - X-Ref

Registration model class for Users.

activate($token)   X-Ref
Method to activate a user account.

param: string        The activation token.
return: mixed        False on failure, user object on success.

getData()   X-Ref
Method to get the registration form data.

The base form data is loaded and then an event is fired
for users plugins to extend the data.

return: mixed        Data object on success, false on failure.

getForm($data = array()   X-Ref
Method to get the registration form.

The base form is loaded from XML and then an event is fired
for users plugins to extend the form with extra fields.

param: array    $data        An optional array of data for the form to interogate.
param: boolean    $loadData    True if the form is to load its own data (default case), false if not.
return: JForm    A JForm object on success, false on failure

loadFormData()   X-Ref
Method to get the data that should be injected in the form.

return: mixed    The data for the form.

preprocessForm(JForm $form, $data, $group = 'user')   X-Ref
Override preprocessForm to load the user plugin group instead of content.

param: object    A form object.
param: mixed    The data expected for the form.

populateState()   X-Ref
Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.


register($temp)   X-Ref
Method to save the form data.

param: array        The form data.
return: mixed        The user id on success, false on failure.



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