PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of LevelsModel.php

(no description)

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

Defines 1 class

LevelsModel:: (6 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  reorder()
  saveorder()

Class: LevelsModel - X-Ref

Methods supporting a list of user access level 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.ordering', $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.

getListQuery() X-Ref

Build an SQL query to load the list data.

return: DatabaseQuery

reorder($pk, $direction = 0) X-Ref

Method to adjust the ordering of a row.

param: integer  $pk         The ID of the primary key to move.
param: integer  $direction  Increment, usually +1 or -1
return: boolean  False on failure or error, true otherwise.

saveorder($pks, $order) X-Ref

Saves the manually set order of records.

param: array    $pks    An array of primary key ids.
param: integer  $order  Order position
return: boolean  Boolean true on success, boolean false

PHP Cross Reference of Joomla 4.2.2 documentation

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

Defines 1 class