[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

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

(no description)

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

Defines 1 class

UsersModel:: (8 methods):
  __construct()
  populateState()
  getStoreId()
  getItems()
  getFilterForm()
  getListQuery()
  buildDateRange()
  getUserDisplayedGroups()


Class: UsersModel  - X-Ref

Methods supporting a list of user records.

__construct($config = array()   X-Ref
Override parent constructor.

param: array                $config   An optional associative array of configuration settings.
param: MVCFactoryInterface  $factory  The factory.

populateState($ordering = 'a.name', $direction = 'asc')   X-Ref
Method to auto-populate the model state.

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

param: string  $ordering   An optional ordering field.
param: string  $direction  An optional direction (asc|desc).
return: void

getStoreId($id = '')   X-Ref
Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and
different modules that might need different sets of data or different
ordering requirements.

param: string  $id  A prefix for the store id.
return: string  A store id.

getItems()   X-Ref
Gets the list of users and adds expensive joins to the result set.

return: mixed  An array of data items on success, false on failure.

getFilterForm($data = [], $loadData = true)   X-Ref
Get the filter form

param: array    $data      data
param: boolean  $loadData  load current data
return: Form|null  The \JForm object or null if the form can't be found

getListQuery()   X-Ref
Build an SQL query to load the list data.

return: DatabaseQuery

buildDateRange($range)   X-Ref
Construct the date range to filter on.

param: string  $range  The textual range to construct the filter for.
return: array  The date range to filter on.

getUserDisplayedGroups($userId)   X-Ref
SQL server change

param: integer  $userId  User identifier
return: string   Groups titles imploded :$



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