[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_users/src/Model/ -> RegistrationModel.php (summary)

(no description)

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

Defines 1 class

RegistrationModel:: (9 methods):
  __construct()
  getUserIdFromToken()
  activate()
  getData()
  getForm()
  loadFormData()
  preprocessForm()
  populateState()
  register()


Class: RegistrationModel  - X-Ref

Registration model class for Users.

__construct($config = array()   X-Ref
Constructor.

param: array                 $config       An array of configuration options (name, state, dbo, table_path, ignore_request).
param: MVCFactoryInterface   $factory      The factory.
param: FormFactoryInterface  $formFactory  The form factory.

getUserIdFromToken($token)   X-Ref
Method to get the user ID from the given token

param: string  $token  The activation token.
return: mixed   False on failure, id of the user on success

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

param: string  $token  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 interrogate.
param: boolean  $loadData  True if the form is to load its own data (default case), false if not.
return: Form  A Form 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(Form $form, $data, $group = 'user')   X-Ref
Override preprocessForm to load the user plugin group instead of content.

param: Form    $form   A Form object.
param: mixed   $data   The data expected for the form.
param: string  $group  The name of the plugin group to import (defaults to "content").
return: void

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

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

return: void

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

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



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer