| [ Index ] |
PHP Cross Reference of Joomla 4.2.2 documentation |
[Source view] [Print] [Project Stats]
(no description)
| Copyright: | (C) 2008 Open Source Matters, Inc. |
| License: | GNU General Public License version 2 or later; see LICENSE.txt |
| File Size: | 1023 lines (32 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
UserModel:: (22 methods):
__construct()
getTable()
getItem()
getForm()
loadFormData()
preprocessForm()
save()
delete()
block()
activate()
batch()
batchReset()
batchUser()
getGroups()
getAssignedGroups()
getOtpConfig()
setOtpConfig()
getOtpConfigEncryptionKey()
getTwofactorform()
generateOteps()
isValidSecretKey()
isValidOtep()
| __construct($config = array() X-Ref |
| Constructor. param: array $config An optional associative array of configuration settings. param: MVCFactoryInterface $factory The factory. |
| getTable($type = 'User', $prefix = 'Joomla\\CMS\\Table\\', $config = array() X-Ref |
| Returns a reference to the a Table object, always creating it. param: string $type The table type to instantiate param: string $prefix A prefix for the table class name. Optional. param: array $config Configuration array for model. Optional. return: Table A database object |
| getItem($pk = null) X-Ref |
| Method to get a single record. param: integer $pk The id of the primary key. return: mixed Object on success, false on failure. |
| getForm($data = array() X-Ref |
| Method to get the record form. 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|bool 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 Joomla\CMS\MVC\Model\AdminModel::preprocessForm to ensure the correct plugin group is loaded. 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 |
| save($data) X-Ref |
| Method to save the form data. param: array $data The form data. return: boolean True on success. |
| delete(&$pks) X-Ref |
| Method to delete rows. param: array &$pks An array of item ids. return: boolean Returns true on success, false on failure. |
| block(&$pks, $value = 1) X-Ref |
| Method to block user records. param: array &$pks The ids of the items to publish. param: integer $value The value of the published state return: boolean True on success. |
| activate(&$pks) X-Ref |
| Method to activate user records. param: array &$pks The ids of the items to activate. return: boolean True on success. |
| batch($commands, $pks, $contexts) X-Ref |
| Method to perform batch operations on an item or a set of items. param: array $commands An array of commands to perform. param: array $pks An array of item ids. param: array $contexts An array of item contexts. return: boolean Returns true on success, false on failure. |
| batchReset($userIds, $action) X-Ref |
| Batch flag users as being required to reset their passwords param: array $userIds An array of user IDs on which to operate param: string $action The action to perform return: boolean True on success, false on failure |
| batchUser($groupId, $userIds, $action) X-Ref |
| Perform batch operations param: integer $groupId The group ID which assignments are being edited param: array $userIds An array of user IDs on which to operate param: string $action The action to perform return: boolean True on success, false on failure |
| getGroups() X-Ref |
| Gets the available groups. return: array An array of groups |
| getAssignedGroups($userId = null) X-Ref |
| Gets the groups this object is assigned to param: integer $userId The user ID to retrieve the groups for return: array An array of assigned groups |
| getOtpConfig($userId = null) X-Ref |
| No longer used param: integer $userId Ignored return: \stdClass |
| setOtpConfig($userId, $otpConfig) X-Ref |
| No longer used param: integer $userId Ignored param: \stdClass $otpConfig Ignored return: boolean True on success |
| getOtpConfigEncryptionKey() X-Ref |
| No longer used return: string |
| getTwofactorform($userId = null) X-Ref |
| No longer used param: integer $userId Ignored return: array Empty array |
| generateOteps($userId, $count = 10) X-Ref |
| No longer used param: integer $userId Ignored param: integer $count Ignored return: array Empty array |
| isValidSecretKey($userId, $secretKey, $options = array() X-Ref |
| No longer used. Always returns true. param: integer $userId Ignored param: string $secretKey Ignored param: array $options Ignored return: boolean Always true |
| isValidOtep($userId, $otep, $otpConfig = null) X-Ref |
| No longer used param: integer $userId Ignored param: string $otep Ignored param: object $otpConfig Ignored return: boolean Always true |
| Generated: Wed Sep 7 05:41:13 2022 | Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer |