JModelItem
Extends \JModelPrototype item model.
Acts as a Factory class for application specific objects and provides many supporting API functions.
| package |
Joomla.Platform |
|---|---|
| subpackage |
Application |
| since |
11.1 |
Methods
__construct
Class constructor, overridden in descendant classes.
__construct(mixed $properties = null)
| since |
11.1 |
|---|
Arguments
- $properties
mixedEither and associative array or another object to set the initial properties of the object.
__toString
Magic method to convert the object to a string gracefully.
__toString() : string
| since |
11.1 |
|---|---|
| deprecated |
12.3 Classes should provide their own __toString() implementation. |
Response
stringThe classname.
_createFileName
Create the filename for a resource
_createFileName(string $type, array $parts = array()) : string
| since |
11.1 |
|---|
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()) : mixed
| since |
11.1 |
|---|---|
| see | \JTable::getInstance |
Arguments
- $name
stringThe name of the view- $prefix
stringThe class prefix. Optional.- $config
arrayConfiguration settings to pass to JTable::getInstance
Response
mixedModel 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
| since |
11.1 |
|---|
Arguments
- $query
stringThe query.- $limitstart
integerOffset.- $limit
integerThe number of records.
Response
arrayAn array of results.
_getListCount
Returns a record count for the query
_getListCount(string $query) : integer
| since |
11.1 |
|---|
Arguments
- $query
stringThe query.
Response
integerNumber of rows for query
addIncludePath
Add a directory where JModel should search for models. You may either pass a string or an array of directories.
addIncludePath(mixed $path = '', string $prefix = '') : array
| since |
11.1 |
|---|
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 |
11.1 |
|---|
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 |
11.1 |
|---|
Arguments
- $group
stringThe cache group- $client_id
integerThe ID of the client
def
Sets a default value if not alreay assigned
def(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixed
get
Returns a property of the object or the default value if the property is not set.
get(string $property, mixed $default = null) : mixed
| since |
11.1 |
|---|---|
| see | \JObject::getProperties() |
Arguments
- $property
stringThe name of the property.- $default
mixedThe default value.
Response
mixedThe value of the property.
getError
Get the most recent error message.
getError(integer $i = null, boolean $toString = true) : string
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $i
integerOption error index.- $toString
booleanIndicates if JError objects should return their error message.
Response
stringError message
getErrors
Return all errors, if any.
getErrors() : array
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Response
arrayArray of error messages or JErrors.
getInstance
Returns a Model object, always creating it
getInstance(string $type, string $prefix = '', array $config = array()) : mixed
| since |
11.1 |
|---|
Arguments
- $type
stringThe model type to instantiate- $prefix
stringPrefix for the model class name. Optional.- $config
arrayConfiguration array for model. Optional.
Response
mixedA model object 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 |
11.1 |
|---|
Response
stringThe name of the model
getProperties
Returns an associative array of object properties.
getProperties(boolean $public = true) : array
| since |
11.1 |
|---|---|
| see | \JObject::get() |
Arguments
- $public
booleanIf true, returns only the public properties.
Response
array
getState
Method to get model state variables
getState(string $property = null, mixed $default = null) : object
| since |
11.1 |
|---|
Arguments
- $property
stringOptional parameter name- $default
mixedOptional default value
Response
objectThe 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 |
11.1 |
|---|
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 |
11.1 |
|---|
Arguments
- $name
stringThe table name. Optional.- $prefix
stringThe class prefix. Optional.- $options
arrayConfiguration array for model. Optional.
Response
\JTableA JTable object
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 |
11.1 |
set
Modifies a property of the object, creating it if it does not already exist.
set(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
Arguments
- $property
stringThe name of the property.- $value
mixedThe value of the property to set.
Response
mixedPrevious value of the property.
setDbo
Method to set the database driver object
setDbo( &$db) : void
| since |
11.1 |
|---|
Arguments
- $db
setError
Add an error message.
setError(string $error) : void
| since |
11.1 |
|---|---|
| see | \JError |
| deprecated |
12.3 JError has been deprecated |
Arguments
- $error
stringError message.
setProperties
Set the object properties based on a named array/hash.
setProperties(mixed $properties) : boolean
| since |
11.1 |
|---|---|
| see | \JObject::set() |
Arguments
- $properties
mixedEither an associative array or another object.
Response
boolean
setState
Method to set model state variables
setState(string $property, mixed $value = null) : mixed
| since |
11.1 |
|---|
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.
toString
Converts the object to a string (the class name).
toString() : string
Properties
_item
An item.
Type(s)
array
_context
Model context string.
| since |
11.1 |
|---|
Type(s)
string
__state_set
Indicates if the internal state has been set
| since |
11.1 |
|---|
Type(s)
boolean
_db
Database Connector
| since |
11.1 |
|---|
Type(s)
object
name
The model (base) name
| note |
Replaces _name variable in 11.1 |
|---|---|
| since |
11.1 |
Type(s)
string
option
The URL option for the component.
| since |
11.1 |
|---|
Type(s)
string
state
A state object
| note |
Replaces _state variable in 11.1 |
|---|---|
| since |
11.1 |
Type(s)
string
event_clean_cache
The event to trigger when cleaning cache.
| since |
11.1 |
|---|
Type(s)
string
_errors
An array of error messages or Exception objects.