AdminModel

Extends \Joomla\CMS\MVC\Model\FormModel

Prototype admin model.

abstract

Acts as a Factory class for application specific objects and provides many supporting API functions.

since

1.6

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null) 
inherited
since

1.7.0

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
inherited deprecated
since

1.7.0

deprecated

3.1.4 Classes should provide their own __toString() implementation.

Response

stringThe classname.

_createTable

Method to load and return a table object.

_createTable(string $name, string $prefix = 'Table', array $config = array()) : \Joomla\CMS\Table\Table|boolean
inherited
since

3.0

see \JTable::getInstance()

Arguments

$name

stringThe name of the view

$prefix

stringThe class prefix. Optional.

$config

arrayConfiguration settings to pass to Table::getInstance

Response

\Joomla\CMS\Table\Table|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>
inherited
since

3.0

throws

\RuntimeException

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(\Joomla\Database\DatabaseQuery|string $query) : integer
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

\Joomla\Database\DatabaseQuery|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
inherited static deprecated
since

3.0

deprecated

5.0 See LegacyModelLoaderTrait\getInstance

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.

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

arrayAn array of commands to perform.

$pks

arrayAn array of item ids.

$contexts

arrayAn array of item contexts.

Response

booleanReturns 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

integerThe new value matching an Asset Group ID.

$pks

arrayAn array of row IDs.

$contexts

arrayAn array of item contexts.

Response

booleanTrue 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

integerThe new category.

$pks

arrayAn array of row IDs.

$contexts

arrayAn array of item contexts.

Response

array|booleanAn 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

stringThe new value matching a language.

$pks

arrayAn array of row IDs.

$contexts

arrayAn array of item contexts.

Response

booleanTrue 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

integerThe new category ID.

$pks

arrayAn array of row IDs.

$contexts

arrayAn array of item contexts.

Response

booleanTrue 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

integerThe value of the new tag.

$pks

arrayAn array of row IDs.

$contexts

arrayAn array of item contexts.

Response

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

bootComponent

Boots the component with the given name.

bootComponent(string $component) : \Joomla\CMS\Extension\ComponentInterface
inherited
since

4.0.0

Arguments

$component

stringThe component name, eg. com_content.

Response

\Joomla\CMS\Extension\ComponentInterfaceThe service container

canDelete

Method to test whether a record can be deleted.

canDelete(object $record) : boolean
since

1.6

Arguments

$record

objectA record object.

Response

booleanTrue 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

objectA record object.

Response

booleanTrue 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

integerThe category ID to check

Response

boolean

checkin

Method to checkin a row.

checkin(integer $pk = null) : boolean
inherited
since

1.6

Arguments

$pk

integerThe numeric id of the primary key.

Response

booleanFalse on failure or error, true otherwise.

checkout

Method to check-out a row for editing.

checkout(integer $pk = null) : boolean
inherited
since

1.6

Arguments

$pk

integerThe numeric id of the primary key.

Response

booleanFalse on failure or error, true otherwise.

cleanCache

Clean the cache

cleanCache(string $group = null) : void
inherited
since

3.0

Arguments

$group

stringThe cache group

cleanupPostBatchCopy

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

cleanupPostBatchCopy(\Joomla\CMS\Table\TableInterface $table, integer $newId, integer $oldId) : void
since

3.8.12

Arguments

$table

\Joomla\CMS\Table\TableInterfaceThe table object containing the newly created item

$newId

integerThe id of the new item

$oldId

integerThe original item id

def

Sets a default value if not already assigned

def(string $property, mixed $default = null) : mixed
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

delete

Method to delete one or more records.

delete( &$pks) : boolean
since

1.6

Arguments

$pks

Response

booleanTrue if successful, false if an error occurs.

editAssociations

Method to load an item in com_associations.

editAssociations(array $data) : boolean
deprecated
since

3.9.0

deprecated

5.0 It is handled by regular save method now.

Arguments

$data

arrayThe form data.

Response

booleanTrue if successful, false otherwise.

generateNewTitle

Method to change the title & alias.

generateNewTitle(integer $categoryId, string $alias, string $title) : array
since

1.7

Arguments

$categoryId

integerThe id of the category.

$alias

stringThe alias.

$title

stringThe title.

Response

arrayContains 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, \Joomla\CMS\Table\Table $table) : void
since

3.2

Arguments

$categoryId

integerThe target category id

$table

\Joomla\CMS\Table\TableThe Table within which move or copy is taking place

get

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

get(string $property, mixed $default = null) : mixed
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getDbo

Get the database driver.

getDbo() : \Joomla\Database\DatabaseInterface
inherited
since

4.0.0

throws

\UnexpectedValueException

Response

\Joomla\Database\DatabaseInterfaceThe database driver.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Response

arrayArray of error messages.

getFormFactory

Get the FormFactoryInterface.

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

4.0.0

throws

\UnexpectedValueExceptionMay be thrown if the FormFactory has not been set.

Response

\Joomla\CMS\Form\FormFactoryInterface

getItem

Method to get a single record.

getItem(integer $pk = null) : \Joomla\CMS\Object\CMSObject|boolean
since

1.6

Arguments

$pk

integerThe id of the primary key.

Response

\Joomla\CMS\Object\CMSObject|booleanObject on success, false on failure.

getMVCFactory

Returns the MVC factory.

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

4.0.0

throws

\UnexpectedValueException

Response

\Joomla\CMS\MVC\Factory\MVCFactoryInterface

getName

Method to get the model name

getName() : string
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

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

getReorderConditions

A protected method to get a set of ordering conditions.

getReorderConditions(\Joomla\CMS\Table\Table $table) : array
since

1.6

Arguments

$table

\Joomla\CMS\Table\TableA \JTable object.

Response

arrayAn array of conditions to add to ordering queries.

getState

Method to get state variables.

getState(string $property = null, mixed $default = null) : mixed
inherited
since

4.0.0

Arguments

$property

stringOptional parameter name

$default

mixedOptional default value

Response

mixedThe property where specified, the state object where omitted

getTable

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

getTable(string $name = '', string $prefix = '', array $options = array()) : \Joomla\CMS\Table\Table
inherited
since

3.0

throws

\Exception

Arguments

$name

stringThe table name. Optional.

$prefix

stringThe class prefix. Optional.

$options

arrayConfiguration array for model. Optional.

Response

\Joomla\CMS\Table\TableA Table object

initBatch

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

initBatch() : void
since

3.8.2

isCheckedOut

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

isCheckedOut(\stdClass $item) : boolean
inherited

Arguments

$item

\stdClassThe record to check

Response

boolean

loadForm

Method to get a form object.

loadForm(string $name, string $source = null, array $options = array(), boolean $clear = false, string $xpath = null) : \Joomla\CMS\Form\Form
inherited
see \Joomla\CMS\Form\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

arrayOptional array of options for the form creation.

$clear

booleanOptional argument to force load a new form.

$xpath

stringAn optional xpath to search for the fields.

Response

\Joomla\CMS\Form\Form

loadFormData

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

loadFormData() : array
inherited
since

4.0.0

Response

arrayThe default data is an empty array.

populateState

Method to auto-populate the state.

populateState() : void
inherited

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 configuration flag to ignore the request is set.

note

Calling getState in this method will result in recursion.

since

4.0.0

prepareTable

Prepare and sanitise the table data prior to saving.

prepareTable(\Joomla\CMS\Table\Table $table) : void
since

1.6

Arguments

$table

\Joomla\CMS\Table\TableA reference to a \JTable object.

preprocessData

Method to allow derived classes to preprocess the data.

preprocessData(string $context,  &$data, string $group = 'content') : void
inherited
since

4.0.0

Arguments

$context

stringThe context identifier.

$data

$group

stringThe name of the plugin group to import (defaults to "content").

preprocessForm

Method to allow derived classes to preprocess the form.

preprocessForm(\Joomla\CMS\Form\Form $form, mixed $data, string $group = 'content') : void
inherited
see \Joomla\CMS\Form\FormField
since

4.0.0

throws

\Exceptionif there is an error in the form event.

Arguments

$form

\Joomla\CMS\Form\FormA Form object.

$data

mixedThe data expected for the form.

$group

stringThe 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

integerThe value of the published state.

Response

booleanTrue on success.

redirectToAssociations

Method to load an item in com_associations.

redirectToAssociations(array $data) : boolean
throws

\Exception

since

3.9.17

Arguments

$data

arrayThe form data.

Response

booleanTrue 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

integerThe ID of the primary key to move.

$delta

integerIncrement, usually +1 or -1

Response

boolean|nullFalse 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

arrayThe form data.

Response

booleanTrue on success, False on error.

saveorder

Saves the manually set order of records.

saveorder(array $pks = array(), integer $order = null) : boolean
since

1.6

Arguments

$pks

arrayAn array of primary key ids.

$order

integer+1 or -1

Response

booleanBoolean true on success, false on failure

set

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

set(string $property, mixed $value = null) : mixed
inherited
since

1.7.0

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setDbo

Set the database driver.

setDbo(\Joomla\Database\DatabaseInterface $db = null) : void
inherited
since

4.0.0

Arguments

$db

\Joomla\Database\DatabaseInterfaceThe database driver.

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

1.7.0

deprecated

3.1.4 JError has been deprecated

Arguments

$error

stringError message.

setFormFactory

Set the form factory to use.

setFormFactory(\Joomla\CMS\Form\FormFactoryInterface $formFactory = null) : $this
inherited
since

4.0.0

Arguments

$formFactory

\Joomla\CMS\Form\FormFactoryInterfaceThe form factory to use.

Response

$this

setMVCFactory

Set the MVC factory.

setMVCFactory(\Joomla\CMS\MVC\Factory\MVCFactoryInterface $mvcFactory) : void
inherited
since

4.0.0

Arguments

$mvcFactory

\Joomla\CMS\MVC\Factory\MVCFactoryInterfaceThe MVC factory

setProperties

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

setProperties(mixed $properties) : boolean
inherited
since

1.7.0

see \Joomla\CMS\Object\CMSObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

setState

Method to set state variables.

setState(string $property, mixed $value = null) : mixed
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

validate

Method to validate the form data.

validate(\Joomla\CMS\Form\Form $form, array $data, string $group = null) : array|boolean
inherited
see \Joomla\CMS\Form\FormRule \Joomla\CMS\Filter\InputFilter
since

1.6

Arguments

$form

\Joomla\CMS\Form\FormThe form to validate against.

$data

arrayThe data to validate.

$group

stringThe name of the field group to validate.

Response

array|booleanArray 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_before_change_state

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

since

4.0.0

Type(s)

string

event_change_state

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

since

1.6

Type(s)

string

event_before_batch

The event to trigger before batch.

since

4.0.0

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)

\Joomla\CMS\Table\Table

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

events_map

Maps events to plugin groups.

inherited
since

3.6

Type(s)

array

_forms

Array of form objects.

inherited
since

4.0.0

Type(s)

array<mixed,\Joomla\CMS\Form\Form>

formFactory

FormFactoryInterface

inherited

option

The URL option for the component.

inherited
since

3.0

Type(s)

string

event_clean_cache

The event to trigger when cleaning cache.

inherited
since

3.0

Type(s)

string

_db

The database driver.

inherited
since

4.0.0

Type(s)

\Joomla\Database\DatabaseInterface

mvcFactory

The mvc factory.

inherited

name

The model (base) name

inherited
since

4.0.0

Type(s)

string

paths

The include paths

inherited static
since

4.0.0

Type(s)

array

__state_set

Indicates if the internal state has been set

inherited
since

4.0.0

Type(s)

boolean

state

A state object

inherited
since

4.0.0

Type(s)

\Joomla\CMS\Object\CMSObject

_errors

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