AdminModel
Extends \Joomla\CMS\MVC\Model\FormModelPrototype admin 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(), \Joomla\CMS\MVC\Factory\MVCFactoryInterface $factory = null)
since |
3.0 |
---|---|
throws |
|
Arguments
- $config
array
An array of configuration options (name, state, dbo, table_path, ignore_request).- $factory
\Joomla\CMS\MVC\Factory\MVCFactoryInterface
The factory.
_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.
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.
batch
Method to perform batch operations on an item or a set of items.
batch(array $commands, array $pks, array $contexts) : boolean
since |
1.7 |
---|
Arguments
- $commands
array
An array of commands to perform.- $pks
array
An array of item ids.- $contexts
array
An array of item contexts.
Response
boolean
Returns true on success, false on failure.
batchAccess
Batch access level changes for a group of rows.
batchAccess(integer $value, array $pks, array $contexts) : boolean
since |
1.7 |
---|
Arguments
- $value
integer
The new value matching an Asset Group ID.- $pks
array
An array of row IDs.- $contexts
array
An array of item contexts.
Response
boolean
True if successful, false otherwise and internal error is set.
batchCopy
Batch copy items to a new category or current.
batchCopy(integer $value, array $pks, array $contexts) : array|boolean
since |
1.7 |
---|
Arguments
- $value
integer
The new category.- $pks
array
An array of row IDs.- $contexts
array
An array of item contexts.
Response
array|boolean
An array of new IDs on success, boolean false on failure.
batchLanguage
Batch language changes for a group of rows.
batchLanguage(string $value, array $pks, array $contexts) : boolean
since |
2.5 |
---|
Arguments
- $value
string
The new value matching a language.- $pks
array
An array of row IDs.- $contexts
array
An array of item contexts.
Response
boolean
True if successful, false otherwise and internal error is set.
batchMove
Batch move items to a new category
batchMove(integer $value, array $pks, array $contexts) : boolean
since |
1.7 |
---|
Arguments
- $value
integer
The new category ID.- $pks
array
An array of row IDs.- $contexts
array
An array of item contexts.
Response
boolean
True if successful, false otherwise and internal error is set.
batchTag
Batch tag a list of item.
batchTag(integer $value, array $pks, array $contexts) : boolean
since |
3.1 |
---|
Arguments
- $value
integer
The value of the new tag.- $pks
array
An array of row IDs.- $contexts
array
An array of item contexts.
Response
boolean
True if successful, false otherwise and internal error is set.
canDelete
Method to test whether a record can be deleted.
canDelete(object $record) : boolean
since |
1.6 |
---|
Arguments
- $record
object
A record object.
Response
boolean
True if allowed to delete the record. Defaults to the permission for the component.
canEditState
Method to test whether a record can have its state changed.
canEditState(object $record) : boolean
since |
1.6 |
---|
Arguments
- $record
object
A record object.
Response
boolean
True if allowed to change the state of the record. Defaults to the permission for the component.
checkCategoryId
Method to check the validity of the category ID for batch copy and move
checkCategoryId(integer $categoryId) : boolean
since |
3.2 |
---|
Arguments
- $categoryId
integer
The category ID to check
Response
boolean
checkin
Method to checkin a row.
checkin(integer $pk = null) : boolean
since |
1.6 |
---|
Arguments
- $pk
integer
The numeric id of the primary key.
Response
boolean
False on failure or error, true otherwise.
checkout
Method to check-out a row for editing.
checkout(integer $pk = null) : boolean
since |
1.6 |
---|
Arguments
- $pk
integer
The numeric id of the primary key.
Response
boolean
False on failure or error, true otherwise.
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
cleanupPostBatchCopy
Function that can be overridden to do any data cleanup after batch copying data
cleanupPostBatchCopy(\JTableInterface $table, integer $newId, integer $oldId) : void
since |
3.8.12 |
---|
Arguments
- $table
\JTableInterface
The table object containing the newly created item- $newId
integer
The id of the new item- $oldId
integer
The original item id
createTagsHelper
Method to create a tags helper to ensure proper management of tags
createTagsHelper(\JTableObserverTags $tagsObserver, \JUcmType $type, integer $pk, string $typeAlias, \JTable $table) : void
since |
3.2 |
---|
Arguments
- $tagsObserver
\JTableObserverTags
The tags observer for this table- $type
\JUcmType
The type for the table being processed- $pk
integer
Primary key of the item bing processed- $typeAlias
string
The type alias for this table- $table
\JTable
The \JTable object
delete
Method to delete one or more records.
delete( &$pks) : boolean
since |
1.6 |
---|
Arguments
- $pks
Response
boolean
True if successful, false if an error occurs.
editAssociations
Method to load an item in com_associations.
editAssociations(array $data) : boolean
since |
3.9.0 |
---|---|
deprecated |
5.0 It is handled by regular save method now. |
Arguments
- $data
array
The form data.
Response
boolean
True if successful, false otherwise.
generateNewTitle
Method to change the title & alias.
generateNewTitle(integer $categoryId, string $alias, string $title) : array
since |
1.7 |
---|
Arguments
- $categoryId
integer
The id of the category.- $alias
string
The alias.- $title
string
The title.
Response
array
Contains the modified title and alias.
generateTitle
A method to preprocess generating a new title in order to allow tables with alternative names for alias and title to use the batch move and copy methods
generateTitle(integer $categoryId, \JTable $table) : void
since |
3.2 |
---|
Arguments
- $categoryId
integer
The target category id- $table
\JTable
The \JTable within which move or copy is taking place
getDbo
Method to get the database driver object
getDbo() : \JDatabaseDriver
getForm
Abstract method for getting the form from the model.
getForm(array $data = array(), boolean $loadData = true) : \JForm|boolean
since |
1.6 |
---|
Arguments
- $data
array
Data for the form.- $loadData
boolean
True if the form is to load its own data (default case), false if not.
Response
\JForm|boolean
A \JForm object on success, false on failure
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
getItem
Method to get a single record.
getItem(integer $pk = null) : \JObject|boolean
since |
1.6 |
---|
Arguments
- $pk
integer
The id of the primary key.
Response
\JObject|boolean
Object on success, 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
string
The name of the model
getReorderConditions
A protected method to get a set of ordering conditions.
getReorderConditions(\JTable $table) : array
since |
1.6 |
---|
Arguments
- $table
\JTable
A \JTable object.
Response
array
An array of conditions to add to ordering queries.
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
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
initBatch
Method to initialize member variables used by batch methods and other methods like saveorder()
initBatch() : void
since |
3.8.2 |
---|
loadForm
Method to get a form object.
loadForm(string $name, string $source = null, array $options = array(), boolean $clear = false, string $xpath = false) : \JForm|boolean
see | \JForm |
---|---|
since |
1.6 |
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
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() : array
since |
1.6 |
---|
Response
array
The default data is an empty array.
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 |
prepareTable
Prepare and sanitise the table data prior to saving.
prepareTable(\JTable $table) : void
since |
1.6 |
---|
Arguments
- $table
\JTable
A reference to a \JTable object.
preprocessData
Method to allow derived classes to preprocess the data.
preprocessData(string $context, &$data, string $group = 'content') : void
since |
3.1 |
---|
Arguments
- $context
string
The context identifier.- $data
- $group
string
The name of the plugin group to import (defaults to "content").
preprocessForm
Method to allow derived classes to preprocess the form.
preprocessForm(\JForm $form, mixed $data, string $group = 'content') : void
see | \JFormField |
---|---|
since |
1.6 |
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").
publish
Method to change the published state of one or more records.
publish( &$pks, integer $value = 1) : boolean
since |
1.6 |
---|
Arguments
- $pks
- $value
integer
The value of the published state.
Response
boolean
True on success.
redirectToAssociations
Method to load an item in com_associations.
redirectToAssociations(array $data) : boolean
throws |
|
---|---|
since |
3.9.17 |
Arguments
- $data
array
The form data.
Response
boolean
True if successful, false otherwise.
reorder
Method to adjust the ordering of a row.
reorder(integer $pks, integer $delta) : boolean|null
Returns NULL if the user did not have edit privileges for any of the selected primary keys.
since |
1.6 |
---|
Arguments
- $pks
integer
The ID of the primary key to move.- $delta
integer
Increment, usually +1 or -1
Response
boolean|null
False on failure or error, true on success, null if the $pk is empty (no items selected).
save
Method to save the form data.
save(array $data) : boolean
since |
1.6 |
---|
Arguments
- $data
array
The form data.
Response
boolean
True on success, False on error.
saveorder
Saves the manually set order of records.
saveorder(array $pks = array(), integer $order = null) : boolean|\JException
since |
1.6 |
---|
Arguments
- $pks
array
An array of primary key ids.- $order
integer
+1 or -1
Response
boolean|\JException
Boolean true on success, false on failure, or \JException if no items are selected
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.
validate
Method to validate the form data.
validate(\JForm $form, array $data, string $group = null) : array|boolean
see | \JFormRule \JFilterInput |
---|---|
since |
1.6 |
Arguments
- $form
\JForm
The form to validate against.- $data
array
The data to validate.- $group
string
The name of the field group to validate.
Response
array|boolean
Array of filtered data if valid, false otherwise.
Properties
typeAlias
The type alias for this content type (for example, 'com_content.article').
since |
3.8.6 |
---|
Type(s)
string
text_prefix
The prefix to use with controller messages.
since |
1.6 |
---|
Type(s)
string
event_after_delete
The event to trigger after deleting the data.
since |
1.6 |
---|
Type(s)
string
event_after_save
The event to trigger after saving the data.
since |
1.6 |
---|
Type(s)
string
event_before_delete
The event to trigger before deleting the data.
since |
1.6 |
---|
Type(s)
string
event_before_save
The event to trigger before saving the data.
since |
1.6 |
---|
Type(s)
string
event_change_state
The event to trigger after changing the published state of the data.
since |
1.6 |
---|
Type(s)
string
batch_copymove
Batch copy/move command. If set to false, the batch copy/move command is not supported
since |
3.4 |
---|
Type(s)
string
batch_commands
Allowed batch commands
since |
3.4 |
---|
Type(s)
array
associationsContext
The context used for the associations table
since |
3.4.4 |
---|
Type(s)
string
batchSet
A flag to indicate if member variables for batch actions (and saveorder) have been initialized
since |
3.8.2 |
---|
Type(s)
object
user
The user performing the actions (re-usable in batch methods & saveorder(), initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
object
table
A JTable instance (of appropriate type) to manage the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
object
tableClassName
The class name of the JTable instance managing the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
string
contentType
UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
object
type
DB data of UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
object
tagsObserver
A tags Observer instance to handle assigned tags (re-usable in batch action methods, initialized via initBatch())
since |
3.8.2 |
---|
Type(s)
object
_forms
Array of form objects.
since |
1.6 |
---|
Type(s)
array<mixed,\JForm>
events_map
Maps events to plugin groups.
since |
3.6 |
---|
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
factory
The factory.
since |
3.10.0 |
---|---|
deprecated |
4.0 This is a temporary property that will be moved into a trait in Joomla 4 |
Type(s)
\Joomla\CMS\MVC\Factory\MVCFactoryInterface