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

(no description)

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

Defines 1 class

GroupsModel:: (5 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  _getList()

Class: GroupsModel - X-Ref

Groups Model

__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.

populateState($ordering = null, $direction = null) X-Ref

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed
to be called on the first call to the getState() method unless the model
configuration flag to ignore the request is set.

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 the 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 An identifier string to generate the store id.
return: string A store id.

getListQuery() X-Ref

Method to get a DatabaseQuery object for retrieving the data set from a database.

return: \Joomla\Database\DatabaseQuery A DatabaseQuery object to retrieve the data set.

_getList($query, $limitstart = 0, $limit = 0) X-Ref

Gets an array of objects from the results of database query.

param: string   $query       The query.
param: integer  $limitstart  Offset.
param: integer  $limit       The number of records.
return: array  An array of results.

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_fields/src/Model/ -> GroupsModel.php (summary)

Defines 1 class