Joomla! API

Constructor.

__construct(mixed||string|int config = [], \Joomla\CMS\MVC\Factory\MVCFactoryInterface factory = null, \Joomla\CMS\Form\FormFactoryInterface formFactory = null) :

since	1.6
throws	`Exception`

Arguments

config: array<string|int, mixed>An array of configuration options (name, state, dbo, table_path, ignore_request).
factory: MVCFactoryInterface|nullThe factory.
formFactory: FormFactoryInterface|nullThe form factory.

Response

mixed

Proxy for _db variable.

__get( name) :

inherited deprecated

since	4.2.0
deprecated	4.3 will be removed in 6.0 Use getDatabase() instead of directly accessing _db

Arguments

name: stringThe name of the element

Response

mixedThe value of the element if set, null otherwise

Create the filename for a resource

_createFileName( type, mixed||string|int parts = []) :

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement

Arguments

type: stringThe resource type to create the filename for.
parts: array<string|int, mixed>An associative array of filename information.

Response

stringThe filename

Method to load and return a table object.

_createTable( name,  prefix = 'Table', mixed||string|int config = []) : \Joomla\CMS\Table\Table|bool

inherited

since	3.0
see	Table::getInstance()

Arguments

name: stringThe name of the view
prefix: stringThe class prefix. Optional.
config: array<string|int, mixed>Configuration settings to pass to Table::getInstance

Response

Table|boolTable object or boolean false if failed

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

_getList(\Joomla\Database\DatabaseQuery|string query,  limitstart,  limit) : object||string|int

inherited

since	3.0
throws	`RuntimeException`

Arguments

query: DatabaseQuery|stringThe query.
limitstart: intOffset.
limit: intThe number of records.

Response

array<string|int, object>An array of results.

Returns a record count for the query.

_getListCount(\Joomla\Database\DatabaseQuery|string query) :

inherited

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: DatabaseQuery|stringThe query.

Response

intNumber of rows for query.

Add a directory where \JModelLegacy should search for models. You may either pass a string or an array of directories.

addIncludePath( path = '',  prefix = '') : mixed||string|int

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory + namespace instead
see	LegacyModelLoaderTrait::getInstance()

Arguments

path: mixedA path or array[sting] of paths to search.
prefix: stringA prefix for models.

Response

array<string|int, mixed>An array with directory elements. If prefix is equal to '', all directories are returned.

Adds to the stack of model table paths in LIFO order.

addTablePath( path) :

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory instead

Arguments

path: mixedThe directory as a string or directories as an array to add.

Response

void

Method to perform batch operations on an item or a set of items.

batch(mixed||string|int commands, mixed||string|int pks, mixed||string|int contexts) :

since	1.7

Arguments

commands: array<string|int, mixed>An array of commands to perform.
pks: array<string|int, mixed>An array of item ids.
contexts: array<string|int, mixed>An array of item contexts.

Response

boolReturns true on success, false on failure.

Batch access level changes for a group of rows.

batchAccess( value, mixed||string|int pks, mixed||string|int contexts) :

since	1.7

Arguments

value: intThe new value matching an Asset Group ID.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.

Response

boolTrue if successful, false otherwise and internal error is set.

Batch copy items to a new category or current.

batchCopy( value, mixed||string|int pks, mixed||string|int contexts) : array|bool

since	1.7

Arguments

value: intThe new category.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.

Response

array<string|int, mixed>|boolAn array of new IDs on success, boolean false on failure.

Batch language changes for a group of rows.

batchLanguage( value, mixed||string|int pks, mixed||string|int contexts) :

since	2.5

Arguments

value: stringThe new value matching a language.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.

Response

boolTrue if successful, false otherwise and internal error is set.

Batch move items to a new category

batchMove( value, mixed||string|int pks, mixed||string|int contexts) :

since	1.7

Arguments

value: intThe new category ID.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.

Response

boolTrue if successful, false otherwise and internal error is set.

Batch tag a list of item.

batchTag( value, mixed||string|int pks, mixed||string|int contexts) :

deprecated

since	3.1
deprecated	5.3 will be removed in 7.0

Arguments

value: intThe value of the new tag.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.

Response

boolTrue if successful, false otherwise and internal error is set.

Batch tag a list of item.

batchTags( value, mixed||string|int pks, mixed||string|int contexts,  removeTags = false) :

since	6.0.0

Arguments

value: intThe value of the new tag.
pks: array<string|int, mixed>An array of row IDs.
contexts: array<string|int, mixed>An array of item contexts.
removeTags: boolFlag indicating whether the tags in $value have to be removed.

Response

boolTrue if successful, false otherwise and internal error is set.

Boots the component with the given name.

bootComponent( component) : \Joomla\CMS\Extension\ComponentInterface

inherited

since	4.0.0

Arguments

component: stringThe component name, eg. com_content.

Response

ComponentInterfaceThe service container

Method to test whether a record can be deleted.

canDelete( record) :

since	1.6

Arguments

record: objectA record object.

Response

boolTrue if allowed to delete the record. Defaults to the permission for the component.

Method to test whether a record can have its state changed.

canEditState( record) :

since	1.6

Arguments

record: objectA record object.

Response

boolTrue if allowed to change the state of the record. Defaults to the permission for the component.

Method to check the validity of the category ID for batch copy and move

checkCategoryId( categoryId) :

since	3.2

Arguments

categoryId: intThe category ID to check

Response

bool

Method override to check-in a record or an array of record

checkin( pks = []) : int|bool

since	1.6

Arguments

pks: mixedThe ID of the primary key or an array of IDs

Response

int|boolBoolean false if there is an error, otherwise the count of records checked in.

Method override to check-out a record.

checkout( pk = null) :

since	1.6

Arguments

pk: intThe ID of the primary key.

Response

boolTrue if successful, false if an error occurs.

Clean the cache

cleanCache( group = null) :

inherited

since	3.0

Arguments

group: stringThe cache group

Response

void

Function that can be overridden to do any data cleanup after batch copying data

cleanupPostBatchCopy(\Joomla\CMS\Table\TableInterface table,  newId,  oldId) :

since	3.8.12

Arguments

table: TableInterfaceThe table object containing the newly created item
newId: intThe id of the new item
oldId: intThe original item id

Response

void

Returns a Model object by loading the component from the prefix.

createModelFromComponent( type,  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\ModelInterface|null

inherited static deprecated

since	4.0.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement

Arguments

type: stringThe model type to instantiate
prefix: stringPrefix for the model class name. Optional.
config: array<string|int, mixed>Configuration array for model. Optional.

Response

ModelInterface|nullA ModelInterface instance or null on failure

Sets a default value if not already assigned

def( property,  default = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 7.0 Defining dynamic properties should not be used anymore

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixed

Method to delete one or more records.

delete(mixed||string|int &pks) :

since	1.6

Arguments

pks: array<string|int, mixed>An array of record primary keys.

Response

boolTrue if successful, false if an error occurs.

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

dispatchEvent(\Joomla\Event\EventInterface event) :

inherited deprecated

since	4.1.0
deprecated	4.4 will be removed in 7.0. Use $this->getDispatcher() directly.

Arguments

event: EventInterfaceThe event

Response

void

Method to load an item in com_associations.

editAssociations(mixed||string|int data) :

deprecated

since	3.9.0
deprecated	4.3 will be removed in 6.0 It is handled by regular save method now.

Arguments

data: array<string|int, mixed>The form data.

Response

boolTrue if successful, false otherwise.

Method to change the title & alias.

generateNewTitle( categoryId,  alias,  title) : mixed||string|int

since	1.7

Arguments

categoryId: intThe id of the category.
alias: stringThe alias.
title: stringThe title.

Response

array<string|int, mixed>Contains the modified title and alias.

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( categoryId, \Joomla\CMS\Table\Table table) :

since	3.2

Arguments

categoryId: intThe target category id
table: TableThe Table within which move or copy is taking place

Response

void

Returns a property of the object or the default value if the property is not set.

get( property,  default = null) :

inherited deprecated

since	1.7.0
see	CMSObject::getProperties()
deprecated	4.3.0 will be removed in 7.0 Create a proper getter function for the property

Arguments

property: stringThe name of the property.
default: mixedThe default value.

Response

mixedThe value of the property.

Get the CacheControllerFactoryInterface.

getCacheControllerFactory() : \Joomla\CMS\Cache\CacheControllerFactoryInterface

inherited

since	4.2.0

Response

CacheControllerFactoryInterface

Returns the current user, if none is set the identity of the global app is returned. This will change in 6.0 and an empty user will be returned.

getCurrentUser() : \Joomla\CMS\User\User

inherited

since	4.2.0

Response

User

Get the database driver.

getDbo() : \Joomla\Database\DatabaseInterface

inherited deprecated

since	4.2.0
throws	`UnexpectedValueException`
deprecated	4.3 will be removed in 6.0 Use getDatabase() instead Example: $model->getDatabase();

Response

DatabaseInterfaceThe database driver.

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface

inherited

The override was made to keep a backward compatibility for legacy component . TODO: Remove the override ONLY when support of Legacy components will be removed (components without Dispatcher and MVCFactory).

since	4.4.0
throws	`UnexpectedValueException`May be thrown if the dispatcher has not been set.

Response

DispatcherInterface

Get the most recent error message.

getError( i = null,  toString = true) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Catch thrown Exceptions instead of getError

Arguments

i: intOption error index.
toString: boolIndicates if Exception objects should return their error message.

Response

stringError message

Return all errors, if any.

getErrors() : mixed||string|int

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

Get the FormFactoryInterface.

getFormFactory() : \Joomla\CMS\Form\FormFactoryInterface

inherited abstract

since	4.0.0
throws	`UnexpectedValueException`May be thrown if the FormFactory has not been set.

Response

FormFactoryInterface

Returns a Model object, always creating it

getInstance( type,  prefix = '', mixed||string|int config = []) : self|bool

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory instead Example: Factory::getApplication()->bootComponent('com_xxx')->getMVCFactory()->createModel($type, $prefix, $config);

Arguments

type: stringThe model type to instantiate
prefix: stringPrefix for the model class name. Optional.
config: array<string|int, mixed>Configuration array for model. Optional.

Response

self|boolA \JModelLegacy instance or false on failure

Method to get a single record.

getItem( pk = null) : \stdClass|false

since	1.6

Arguments

pk: intThe id of the primary key.

Response

stdClass|falseObject on success, false on failure.

Returns the MVC factory.

getMVCFactory() : \Joomla\CMS\MVC\Factory\MVCFactoryInterface

inherited

since	4.0.0
throws	`UnexpectedValueException`

Response

MVCFactoryInterface

Method to get the model name

getName() :

inherited

The model name. By default parsed using the classname or it can be set by passing a $config['name'] in the class constructor

since	4.0.0
throws	`Exception`

Response

stringThe name of the model

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int

inherited deprecated

since	1.7.0
see	CMSObject::get()
deprecated	4.3.0 will be removed in 7.0 Create a proper getter function for the property

Arguments

public: boolIf true, returns only the public properties.

Response

array<string|int, mixed>

A protected method to get a set of ordering conditions.

getReorderConditions(\Joomla\CMS\Table\Table table) : string||string|int

since	1.6

Arguments

table: TableA Table object.

Response

array<string|int, string>An array of conditions to add to ordering queries.

Method to get state variables.

getState( property = null,  default = null) :

inherited

since	4.0.0

Arguments

property: stringOptional parameter name
default: mixedOptional default value

Response

mixedThe property where specified, the state object where omitted

Method to get a table object, load it if necessary.

getTable( name = '',  prefix = '', mixed||string|int options = []) : \Joomla\CMS\Table\Table

inherited

since	3.0
throws	`Exception`

Arguments

name: stringThe table name. Optional.
prefix: stringThe class prefix. Optional.
options: array<string|int, mixed>Configuration array for model. Optional.

Response

TableA Table object

Method to initialize member variables used by batch methods and other methods like saveorder()

initBatch() :

since	3.8.2

Response

void

Method to check if the given record is checked out by the current user

isCheckedOut(\stdClass item) :

inherited

Arguments

item: stdClassThe record to check

Response

bool

Method to get a form object.

loadForm( name,  source = null, mixed||string|int options = [],  clear = false,  xpath = null) : \Joomla\CMS\Form\Form

inherited

see	Form
since	4.0.0
throws	`Exception`

Arguments

name: stringThe name of the form.
source: stringThe form source. Can be XML string if file flag is set to false.
options: array<string|int, mixed>Optional array of options for the form creation.
clear: boolOptional argument to force load a new form.
xpath: stringAn optional xpath to search for the fields.

Response

Form

Method to get the data that should be injected in the form.

loadFormData() : mixed||string|int

inherited

since	4.0.0

Response

array<string|int, mixed>The default data is an empty array.

Stock method to auto-populate the model state.

populateState() :

since	1.6

Response

void

Prepare and sanitise the table data prior to saving.

prepareTable(\Joomla\CMS\Table\Table table) :

since	1.6

Arguments

table: TableA reference to a Table object.

Response

void

Method to allow derived classes to preprocess the data.

preprocessData( context,  &data,  group = 'content') :

inherited

since	4.0.0

Arguments

context: stringThe context identifier.
data: mixedThe data to be processed. It gets altered directly.
group: stringThe name of the plugin group to import (defaults to "content").

Response

void

Method to allow derived classes to preprocess the form.

preprocessForm(\Joomla\CMS\Form\Form form,  data,  group = 'content') :

inherited

see	FormField
since	4.0.0
throws	`Exception`if there is an error in the form event.

Arguments

form: FormA Form object.
data: mixedThe data expected for the form.
group: stringThe name of the plugin group to import (defaults to "content").

Response

void

Method to change the published state of one or more records.

publish(mixed||string|int &pks,  value = 1) :

since	1.6

Arguments

pks: array<string|int, mixed>A list of the primary keys to change.
value: intThe value of the published state.

Response

boolTrue on success.

Method to load an item in com_associations.

redirectToAssociations(mixed||string|int data) :

throws	`Exception`
since	3.9.17

Arguments

data: array<string|int, mixed>The form data.

Response

boolTrue if successful, false otherwise.

Method to adjust the ordering of a row.

reorder( pks,  delta) : bool|null

Returns NULL if the user did not have edit privileges for any of the selected primary keys.

since	1.6

Arguments

pks: intThe ID of the primary key to move.
delta: intIncrement, usually +1 or -1

Response

bool|nullFalse on failure or error, true on success, null if the $pk is empty (no items selected).

Method to save the form data.

save(mixed||string|int data) :

since	1.6

Arguments

data: array<string|int, mixed>The form data.

Response

boolTrue on success, False on error.

Saves the manually set order of records.

saveorder(mixed||string|int pks = [],  order = null) :

since	1.6

Arguments

pks: array<string|int, mixed>An array of primary key ids.
order: int+1 or -1

Response

boolBoolean true on success, false on failure

Modifies a property of the object, creating it if it does not already exist.

set( property,  value = null) :

inherited deprecated

since	1.7.0
deprecated	4.3.0 will be removed in 7.0 Create a proper setter function for the property

Arguments

property: stringThe name of the property.
value: mixedThe value of the property to set.

Response

mixedPrevious value of the property.

Set the cache controller factory to use.

setCacheControllerFactory(\Joomla\CMS\Cache\CacheControllerFactoryInterface cacheControllerFactory = null) :

inherited

since	4.2.0

Arguments

cacheControllerFactory: CacheControllerFactoryInterface|nullThe cache controller factory to use.

Response

void

Sets the current user.

setCurrentUser(\Joomla\CMS\User\User currentUser) :

inherited

since	4.2.0

Arguments

currentUser: UserThe current user object

Response

void

Set the database driver.

setDbo(\Joomla\Database\DatabaseInterface db = null) :

inherited deprecated

since	4.2.0
deprecated	4.3 will be removed in 6.0 Use setDatabase() instead Example: $model->setDatabase($db);

Arguments

db: DatabaseInterface|nullThe database driver.

Response

void

Add an error message.

setError( error) :

inherited deprecated

since	1.7.0
deprecated	3.1.4 will be removed in 7.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error: stringError message.

Response

void

Set the form factory to use.

setFormFactory(\Joomla\CMS\Form\FormFactoryInterface formFactory = null) :

inherited

since	4.0.0

Arguments

formFactory: FormFactoryInterface|nullThe form factory to use.

Response

$this

Set the MVC factory.

setMVCFactory(\Joomla\CMS\MVC\Factory\MVCFactoryInterface mvcFactory) :

inherited

since	4.0.0

Arguments

mvcFactory: MVCFactoryInterfaceThe MVC factory

Response

void

Set the object properties based on a named array/hash.

setProperties( properties) :

inherited deprecated

since	1.7.0
see	CMSObject::set()
deprecated	4.3.0 will be removed in 7.0 Create a proper setter function for the property

Arguments

properties: mixedEither an associative array or another object.

Response

bool

Method to set state variables.

setState( property,  value = null) :

inherited

since	4.0.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

If true then subclasses should throw exceptions rather than use getError and setError.

setUseExceptions( value) :

inherited deprecated

since	5.4.0
deprecated	7.0

Arguments

value: boolThe value to set for the field.

Response

void

If true then subclasses should throw exceptions rather than use getError and setError.

shouldUseExceptions() :

inherited deprecated

since	5.4.0
deprecated	7.0

Response

bool

Method to validate the form data.

validate(\Joomla\CMS\Form\Form form, mixed||string|int data,  group = null) : array|bool

inherited

see	FormRule InputFilter
since	1.6

Arguments

form: FormThe form to validate against.
data: array<string|int, mixed>The data to validate.
group: stringThe name of the field group to validate.

Response

array<string|int, mixed>|boolArray of filtered data if valid, false otherwise.

An array of error messages or Exception objects.

inherited deprecated

since	1.7.0
deprecated	3.1.4 JError has been deprecated

Type(s)

array<string|int, mixed>

Use exceptions rather than getError/setError.

inherited deprecated

since	5.4.0
deprecated	7.0

Type(s)

bool

Indicates if the internal state has been set

inherited

since	4.0.0

Type(s)

bool

A state object

inherited

since	4.0.0
todo	Remove the State type hint in Joomla 7.0 since it will be removed see State class

Type(s)

State|Registry

The model (base) name

inherited

since	4.0.0

Type(s)

string

The include paths

inherited static

since	4.0.0

Type(s)

array<string|int, mixed>

CacheControllerFactoryInterface

inherited

since	4.2.0

Type(s)

CacheControllerFactoryInterface

The current user object.

inherited

since	4.2.0

Type(s)

User

The mvc factory.

inherited

since	4.0.0

Type(s)

MVCFactoryInterface

The URL option for the component.

inherited

since	3.0

Type(s)

string

The event to trigger when cleaning cache.

inherited

since	3.0

Type(s)

string

FormFactoryInterface

inherited

since	4.0.0

Type(s)

FormFactoryInterface

Array of form objects.

inherited

since	4.0.0

Type(s)

array<string|int, Form>

Maps events to plugin groups.

inherited

since	3.6

Type(s)

array<string|int, mixed>

The type alias for this content type (for example, 'com_content.article').

since	3.8.6

Type(s)

string

The prefix to use with controller messages.

since	1.6

Type(s)

string

The event to trigger after deleting the data.

since	1.6

Type(s)

string

The event to trigger after saving the data.

since	1.6

Type(s)

string

The event to trigger before deleting the data.

since	1.6

Type(s)

string

The event to trigger before saving the data.

since	1.6

Type(s)

string

The event to trigger before changing the published state of the data.

since	4.0.0

Type(s)

string

The event to trigger after changing the published state of the data.

since	1.6

Type(s)

string

The event to trigger before batch.

since	4.0.0

Type(s)

string

Batch copy/move command. If set to false, the batch copy/move command is not supported

since	3.4

Type(s)

string

Allowed batch commands

since	3.4

Type(s)

array<string|int, mixed>

The context used for the associations table

since	3.4.4

Type(s)

string

A flag to indicate if member variables for batch actions (and saveorder) have been initialized

since	3.8.2

Type(s)

bool|null

The user performing the actions (re-usable in batch methods & saveorder(), initialized via initBatch())

since	3.8.2

Type(s)

object

A \Joomla\CMS\Table\Table instance (of appropriate type) to manage the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())

since	3.8.2

Type(s)

Table

The class name of the \Joomla\CMS\Table\Table instance managing the DB records (re-usable in batch methods & saveorder(), initialized via initBatch())

since	3.8.2

Type(s)

string

UCM Type corresponding to the current model class (re-usable in batch action methods, initialized via initBatch())

since	3.8.2

Type(s)

object

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

AdminModel

Methods

__construct

Arguments

Response

__get

Arguments

Response

_createFileName

Arguments

Response

_createTable

Arguments

Response

_getList

Arguments

Response

_getListCount

Arguments

Response

addIncludePath

Arguments

Response

addTablePath

Arguments

Response

batch

Arguments

Response

batchAccess

Arguments

Response

batchCopy

Arguments

Response

batchLanguage

Arguments

Response

batchMove

Arguments

Response

batchTag

Arguments

Response

batchTags

Arguments

Response

bootComponent

Arguments

Response

canDelete

Arguments

Response

canEditState

Arguments

Response

checkCategoryId

Arguments

Response

checkin

Arguments

Response

checkout

Arguments

Response

cleanCache

Arguments

Response

cleanupPostBatchCopy

Arguments

Response

createModelFromComponent

Arguments

Response

def

Arguments

Response

delete

Arguments

Response