ItemModel
Extends \Joomla\CMS\MVC\Model\BaseDatabaseModelPrototype item model.
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
arrayAn 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
stringThe resource type to create the filename for.- $parts
arrayAn associative array of filename information.
Response
stringThe 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
stringThe name of the view- $prefix
stringThe class prefix. Optional.- $config
arrayConfiguration settings to pass to \JTable::getInstance
Response
\JTable|booleanTable 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
stringThe query.- $limitstart
integerOffset.- $limit
integerThe 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 overriden 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|stringThe query.
Response
integerNumber of rows for query.
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
mixedA path or array[sting] of paths to search.- $prefix
stringA prefix for models.
Response
arrayAn 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
mixedThe directory as a string or directories as an array to add.
cleanCache
Clean the cache
cleanCache(string $group = null, integer $client_id) : void
| since |
3.0 |
|---|
Arguments
- $group
stringThe cache group- $client_id
integerThe ID of the client
getDbo
Method to get the database driver object
getDbo() : \JDatabaseDriver
getInstance
Returns a Model object, always creating it
getInstance(string $type, string $prefix = '', array $config = array()) : \JModelLegacy|boolean
| since |
3.0 |
|---|
Arguments
- $type
stringThe model type to instantiate- $prefix
stringPrefix for the model class name. Optional.- $config
arrayConfiguration array for model. Optional.
Response
\JModelLegacy|booleanA \JModelLegacy instance or false on failure
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
stringThe name of the model
getState
Method to get model state variables
getState(string $property = null, mixed $default = null) : mixed
| since |
3.0 |
|---|
Arguments
- $property
stringOptional parameter name- $default
mixedOptional default value
Response
mixedThe property where specified, the state object where omitted
getStoreId
Method to get a store id based on 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
stringA prefix for the store id.
Response
stringA 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
stringThe table name. Optional.- $prefix
stringThe class prefix. Optional.- $options
arrayConfiguration array for model. Optional.
Response
\JTableA \JTable object
loadHistory
Method to load a row for editing from the version history table.
loadHistory(integer $version_id, \JTable &$table) : boolean
| since |
3.2 |
|---|
Arguments
- $version_id
integerKey to the version history table.- $table
\JTable
Response
booleanFalse 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 |
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
stringThe name of the property.- $value
mixedThe value of the property to set or null.
Response
mixedThe previous value of the property or null if not set.
Properties
_item
An item.
| since |
1.6 |
|---|
Type(s)
array
_context
Model context string.
| since |
1.6 |
|---|
Type(s)
string
__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