ListModel
Extends \Joomla\CMS\MVC\Model\BaseDatabaseModelModel class for handling lists of items.
Acts as a Factory class for application specific objects and provides many supporting API functions.
since |
1.6 |
---|
Methods
__construct
Constructor
__construct(array $config = array())
since |
3.0 |
---|---|
throws |
|
Arguments
- $config
array
An array of configuration options (name, state, dbo, table_path, ignore_request).
_createFileName
Create the filename for a resource
_createFileName(string $type, array $parts = array()) : string
since |
3.0 |
---|
Arguments
- $type
string
The resource type to create the filename for.- $parts
array
An associative array of filename information.
Response
string
The filename
_createTable
Method to load and return a model object.
_createTable(string $name, string $prefix = 'Table', array $config = array()) : \JTable|boolean
since |
3.0 |
---|---|
see | \JTable::getInstance() |
Arguments
- $name
string
The name of the view- $prefix
string
The class prefix. Optional.- $config
array
Configuration settings to pass to \JTable::getInstance
Response
\JTable|boolean
Table object or boolean false if failed
_getList
Gets an array of objects from the results of database query.
_getList(string $query, integer $limitstart, integer $limit) : array<mixed,object>
since |
3.0 |
---|---|
throws |
|
Arguments
- $query
string
The query.- $limitstart
integer
Offset.- $limit
integer
The number of records.
Response
array<mixed,object>
An array of results.
_getListCount
Returns a record count for the query.
_getListCount(\JDatabaseQuery|string $query) : integer
Note: Current implementation of this method assumes that getListQuery() returns a set of unique rows, thus it uses SELECT COUNT(*) to count the rows. In cases that getListQuery() uses DISTINCT then either this method must be overridden by a custom implementation at the derived Model Class or a GROUP BY clause should be used to make the set unique.
since |
3.0 |
---|
Arguments
- $query
\JDatabaseQuery|string
The query.
Response
integer
Number of rows for query.
_getListQuery
Method to cache the last query constructed.
_getListQuery() : \JDatabaseQuery
This method ensures that the query is constructed only once for a given state of the model.
since |
1.6 |
---|
Response
\JDatabaseQuery
A \JDatabaseQuery object
addIncludePath
Add a directory where \JModelLegacy should search for models. You may either pass a string or an array of directories.
addIncludePath(mixed $path = '', string $prefix = '') : array
since |
3.0 |
---|
Arguments
- $path
mixed
A path or array[sting] of paths to search.- $prefix
string
A prefix for models.
Response
array
An array with directory elements. If prefix is equal to '', all directories are returned.
addTablePath
Adds to the stack of model table paths in LIFO order.
addTablePath(mixed $path) : void
since |
3.0 |
---|
Arguments
- $path
mixed
The directory as a string or directories as an array to add.
cleanCache
Clean the cache
cleanCache(string $group = null, integer $clientId) : void
since |
3.0 |
---|
Arguments
- $group
string
The cache group- $clientId
integer
The ID of the client
getActiveFilters
Function to get the active filters
getActiveFilters() : array
since |
3.2 |
---|
Response
array
Associative array in the format: array('filter_published' => 0)
getDbo
Method to get the database driver object
getDbo() : \JDatabaseDriver
getFilterForm
Get the filter form
getFilterForm(array $data = array(), boolean $loadData = true) : \JForm|boolean
since |
3.2 |
---|
Arguments
- $data
array
data- $loadData
boolean
load current data
Response
\JForm|boolean
The \JForm object or false on error
getInstance
Returns a Model object, always creating it
getInstance(string $type, string $prefix = '', array $config = array()) : \JModelLegacy|boolean
since |
3.0 |
---|
Arguments
- $type
string
The model type to instantiate- $prefix
string
Prefix for the model class name. Optional.- $config
array
Configuration array for model. Optional.
Response
\JModelLegacy|boolean
A \JModelLegacy instance or false on failure
getItems
Method to get an array of data items.
getItems() : mixed
since |
1.6 |
---|
Response
mixed
An array of data items on success, false on failure.
getListQuery
Method to get a \JDatabaseQuery object for retrieving the data set from a database.
getListQuery() : \JDatabaseQuery
getName
Method to get the model name
getName() : string
The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor
since |
3.0 |
---|---|
throws |
|
Response
string
The name of the model
getPagination
Method to get a \JPagination object for the data set.
getPagination() : \JPagination
since |
1.6 |
---|
Response
\JPagination
A \JPagination object for the data set.
getStart
Method to get the starting number of items for the data set.
getStart() : integer
since |
1.6 |
---|
Response
integer
The starting number of items available in the data set.
getState
Method to get model state variables
getState(string $property = null, mixed $default = null) : mixed
since |
3.0 |
---|
Arguments
- $property
string
Optional parameter name- $default
mixed
Optional default value
Response
mixed
The property where specified, the state object where omitted
getStoreId
Method to get a store id based on the model configuration state.
getStoreId(string $id = '') : string
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.
since |
1.6 |
---|
Arguments
- $id
string
An identifier string to generate the store id.
Response
string
A store id.
getTable
Method to get a table object, load it if necessary.
getTable(string $name = '', string $prefix = 'Table', array $options = array()) : \JTable
since |
3.0 |
---|---|
throws |
|
Arguments
- $name
string
The table name. Optional.- $prefix
string
The class prefix. Optional.- $options
array
Configuration array for model. Optional.
Response
\JTable
A \JTable object
getTotal
Method to get the total number of items for the data set.
getTotal() : integer
since |
1.6 |
---|
Response
integer
The total number of items available in the data set.
getUserStateFromRequest
Gets the value of a user state variable and sets it in the session
getUserStateFromRequest(string $key, string $request, string $default = null, string $type = 'none', boolean $resetPage = true) : mixed
This is the same as the method in \JApplication except that this also can optionally force you back to the first page when a filter has changed
since |
1.6 |
---|
Arguments
- $key
string
The key of the user state variable.- $request
string
The name of the variable passed in a request.- $default
string
The default value for the variable if not found. Optional.- $type
string
Filter for the variable, for valid values see {@link \JFilterInput::clean()}. Optional.- $resetPage
boolean
If true, the limitstart in request is set to zero
Response
mixed
The request user state.
loadForm
Method to get a form object.
loadForm(string $name, string $source = null, array $options = array(), boolean $clear = false, string|boolean $xpath = false) : \JForm|boolean
see | \JForm |
---|---|
since |
3.2 |
Arguments
- $name
string
The name of the form.- $source
string
The form source. Can be XML string if file flag is set to false.- $options
array
Optional array of options for the form creation.- $clear
boolean
Optional argument to force load a new form.- $xpath
string|boolean
An optional xpath to search for the fields.
Response
\JForm|boolean
\JForm object on success, False on error.
loadFormData
Method to get the data that should be injected in the form.
loadFormData() : mixed
since |
3.2 |
---|
Response
mixed
The data for the form.
loadHistory
Method to load a row for editing from the version history table.
loadHistory(integer $versionId, \JTable &$table) : boolean
since |
3.2 |
---|
Arguments
- $versionId
integer
Key to the version history table.- $table
\JTable
Response
boolean
False on failure or error, true otherwise.
populateState
Method to auto-populate the model state.
populateState() : void
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. |
---|---|
since |
3.0 |
preprocessForm
Method to allow derived classes to preprocess the form.
preprocessForm(\JForm $form, mixed $data, string $group = 'content') : void
since |
3.2 |
---|---|
throws |
|
Arguments
- $form
\JForm
A \JForm object.- $data
mixed
The data expected for the form.- $group
string
The name of the plugin group to import (defaults to "content").
refineSearchStringToRegex
Parse and transform the search string into a string fit for regex-ing arbitrary strings against
refineSearchStringToRegex(string $search, string $regexDelimiter = '/') : string
since |
3.4 |
---|
Arguments
- $search
string
The search string- $regexDelimiter
string
The regex delimiter to use for the quoting
Response
string
Search string escaped for regex
setDbo
Method to set the database driver object
setDbo(\JDatabaseDriver $db) : void
setState
Method to set model state variables
setState(string $property, mixed $value = null) : mixed
since |
3.0 |
---|
Arguments
- $property
string
The name of the property.- $value
mixed
The value of the property to set or null.
Response
mixed
The previous value of the property or null if not set.
Properties
cache
Internal memory based cache array of data.
since |
1.6 |
---|
Type(s)
array
context
Context string for the model type. This is used to handle uniqueness when dealing with the getStoreId() method and caching data structures.
since |
1.6 |
---|
Type(s)
string
filter_fields
Valid filter fields or ordering.
since |
1.6 |
---|
Type(s)
array
filterFormName
Name of the filter form to load
since |
3.2 |
---|
Type(s)
string
htmlFormName
Associated HTML form
since |
3.2 |
---|
Type(s)
string
filterBlacklist
A blacklist of filter variables to not merge into the model's state
since |
3.4.5 |
---|
Type(s)
array
listBlacklist
A blacklist of list variables to not merge into the model's state
since |
3.4.5 |
---|
Type(s)
array
__state_set
Indicates if the internal state has been set
since |
3.0 |
---|
Type(s)
boolean
name
The model (base) name
since |
3.0 |
---|
Type(s)
string
option
The URL option for the component.
since |
3.0 |
---|
Type(s)
string
state
A state object
since |
3.0 |
---|
Type(s)
\JObject
event_clean_cache
The event to trigger when cleaning cache.
since |
3.0 |
---|
Type(s)
string