Class AdminModel - list of methods

Constructor.

• array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
• \Joomla\CMS\MVC\Factory\MVCFactoryInterface $factory The factory.
• \Joomla\CMS\Form\FormFactoryInterface $formFactory The form factory.

• 1.6

• \Exception

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

• array $commands An array of commands to perform.
• array $pks An array of item ids.
• array $contexts An array of item contexts.

• bool Returns true on success, false on failure.

• 1.7

Batch access level changes for a group of rows.

• int $value The new value matching an Asset Group ID.
• array $pks An array of row IDs.
• array $contexts An array of item contexts.

• bool True if successful, false otherwise and internal error is set.

• 1.7

Batch copy items to a new category or current.

• int $value The new category.
• array $pks An array of row IDs.
• array $contexts An array of item contexts.

• array|bool An array of new IDs on success, boolean false on failure.

• 1.7

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

• \Joomla\CMS\Table\TableInterface $table The table object containing the newly created item
• int $newId The id of the new item
• int $oldId The original item id

• void

• 3.8.12

Batch language changes for a group of rows.

• string $value The new value matching a language.
• array $pks An array of row IDs.
• array $contexts An array of item contexts.

• bool True if successful, false otherwise and internal error is set.

• 2.5

Batch move items to a new category

• int $value The new category ID.
• array $pks An array of row IDs.
• array $contexts An array of item contexts.

• bool True if successful, false otherwise and internal error is set.

• 1.7

Batch tag a list of item.

• int $value The value of the new tag.
• array $pks An array of row IDs.
• array $contexts An array of item contexts.

• bool True if successful, false otherwise and internal error is set.

• 3.1

Method to test whether a record can be deleted.

• object $record A record object.

• bool True if allowed to delete the record. Defaults to the permission for the component.

• 1.6

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

• object $record A record object.

• bool True if allowed to change the state of the record. Defaults to the permission for the component.

• 1.6

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

• mixed $pks The ID of the primary key or an array of IDs

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

• 1.6

Method override to check-out a record.

• int $pk The ID of the primary key.

• bool True if successful, false if an error occurs.

• 1.6

Method to delete one or more records.

• array & $pks An array of record primary keys.

• bool True if successful, false if an error occurs.

• 1.6

Method to change the title & alias.

• int $categoryId The id of the category.
• string $alias The alias.
• string $title The title.

• array Contains the modified title and alias.

• 1.7

Method to get a single record.

• int $pk The id of the primary key.

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

• 1.6

A protected method to get a set of ordering conditions.

• \Joomla\CMS\Table\Table $table A Table object.

• array An array of conditions to add to ordering queries.

• 1.6

Stock method to auto-populate the model state.

• void

• 1.6

Prepare and sanitise the table data prior to saving.

• \Joomla\CMS\Table\Table $table A reference to a Table object.

• void

• 1.6

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

• array & $pks A list of the primary keys to change.
• int $value The value of the published state.

• bool True on success.

• 1.6

Method to adjust the ordering of a row.

• int $pks The ID of the primary key to move.
• int $delta Increment, usually +1 or -1

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

• 1.6

Method to save the form data.

• array $data The form data.

• bool True on success, False on error.

• 1.6

Saves the manually set order of records.

• array $pks An array of primary key ids.
• int $order +1 or -1

• bool Boolean true on success, false on failure

• 1.6

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

• int $categoryId The category ID to check

• bool

• 3.2

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

• int $categoryId The target category id
• \Joomla\CMS\Table\Table $table The Table within which move or copy is taking place

• void

• 3.2

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

• void

• 3.8.2

Method to load an item in com_associations.

• array $data The form data.

• bool True if successful, false otherwise.

• 3.9.0

• 5.0

Method to load an item in com_associations.

• array $data The form data.

• bool True if successful, false otherwise.

• 3.9.17

• \Exception