Class JModelAdmin

Prototype admin model.

JObject

JModelLegacy

JModelForm

JModelAdmin

Abstract
Package: Joomla\Legacy\Model
Copyright: Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt
Since: 1.6
Located at legacy/model/admin.php

Methods summary

`public`	# `__construct( array $config = array() )` Constructor. Constructor. Parameters `$config` `array` - $config An optional associative array of configuration settings. Throws `Exception` Since 1.6 See `JModelLegacy` Overrides `JModelForm::__construct`
`public boolean`	# `batch( array $commands, array $pks, array $contexts )` Method to perform batch operations on an item or a set of items. Method to perform batch operations on an item or a set of items. Parameters `$commands` `array` - $commands An array of commands to perform. `$pks` `array` - $pks An array of item ids. `$contexts` `array` - $contexts An array of item contexts. Returns `boolean` - Returns true on success, false on failure. Since 1.7
`protected boolean`	# `batchAccess( integer $value, array $pks, array $contexts )` Batch access level changes for a group of rows. Batch access level changes for a group of rows. Parameters `$value` `integer` - $value The new value matching an Asset Group ID. `$pks` `array` - $pks An array of row IDs. `$contexts` `array` - $contexts An array of item contexts. Returns `boolean` - True if successful, false otherwise and internal error is set. Since 1.7
`protected array\|boolean`	# `batchCopy( integer $value, array $pks, array $contexts )` Batch copy items to a new category or current. Batch copy items to a new category or current. Parameters `$value` `integer` - $value The new category. `$pks` `array` - $pks An array of row IDs. `$contexts` `array` - $contexts An array of item contexts. Returns `array\|boolean` - An array of new IDs on success, boolean false on failure. Since 1.7
`protected boolean`	# `batchLanguage( string $value, array $pks, array $contexts )` Batch language changes for a group of rows. Batch language changes for a group of rows. Parameters `$value` `string` - $value The new value matching a language. `$pks` `array` - $pks An array of row IDs. `$contexts` `array` - $contexts An array of item contexts. Returns `boolean` - True if successful, false otherwise and internal error is set. Since 2.5
`protected boolean`	# `batchMove( integer $value, array $pks, array $contexts )` Batch move items to a new category Batch move items to a new category Parameters `$value` `integer` - $value The new category ID. `$pks` `array` - $pks An array of row IDs. `$contexts` `array` - $contexts An array of item contexts. Returns `boolean` - True if successful, false otherwise and internal error is set. Since 1.7
`protected boolean`	# `batchTag( integer $value, array $pks, array $contexts )` Batch tag a list of item. Batch tag a list of item. Parameters `$value` `integer` - $value The value of the new tag. `$pks` `array` - $pks An array of row IDs. `$contexts` `array` - $contexts An array of item contexts. Returns `boolean` - True if successful, false otherwise and internal error is set. Since 3.1
`protected boolean`	# `canDelete( object $record )` Method to test whether a record can be deleted. Method to test whether a record can be deleted. Parameters `$record` `object` - $record A record object. Returns `boolean` - True if allowed to delete the record. Defaults to the permission for the component. Since 1.6
`protected boolean`	# `canEditState( object $record )` Method to test whether a record can have its state changed. Method to test whether a record can have its state changed. Parameters `$record` `object` - $record A record object. Returns `boolean` - True if allowed to change the state of the record. Defaults to the permission for the component. Since 1.6
`public integer\|boolean`	# `checkin( mixed $pks = array() )` Method override to check-in a record or an array of record Method override to check-in a record or an array of record Parameters `$pks` `mixed` - $pks The ID of the primary key or an array of IDs Returns `integer\|boolean` - Boolean false if there is an error, otherwise the count of records checked in. Since 1.6 Overrides `JModelForm::checkin`
`public boolean`	# `checkout( integer $pk = null )` Method override to check-out a record. Method override to check-out a record. Parameters `$pk` `integer` - $pk The ID of the primary key. Returns `boolean` - True if successful, false if an error occurs. Since 1.6 Overrides `JModelForm::checkout`
`public boolean`	# `delete( array & $pks )` Method to delete one or more records. Method to delete one or more records. Parameters `$pks` `array` - &$pks An array of record primary keys. Returns `boolean` - True if successful, false if an error occurs. Since 1.6
`protected array`	# `generateNewTitle( integer $category_id, string $alias, string $title )` Method to change the title & alias. Method to change the title & alias. Parameters `$category_id` `integer` - $category_id The id of the category. `$alias` `string` - $alias The alias. `$title` `string` - $title The title. Returns `array` - Contains the modified title and alias. Since 1.7
`public JObject\|boolean`	# `getItem( integer $pk = null )` Method to get a single record. Method to get a single record. Parameters `$pk` `integer` - $pk The id of the primary key. Returns `JObject\|boolean` - Object on success, false on failure. Since 1.6
`protected array`	# `getReorderConditions( JTable $table )` A protected method to get a set of ordering conditions. A protected method to get a set of ordering conditions. Parameters `$table` `JTable` - $table A JTable object. Returns `array` - An array of conditions to add to ordering queries. Since 1.6
`protected`	# `populateState( )` Stock method to auto-populate the model state. Stock method to auto-populate the model state. Since 1.6 Overrides `JModelLegacy::populateState`
`protected`	# `prepareTable( JTable $table )` Prepare and sanitise the table data prior to saving. Prepare and sanitise the table data prior to saving. Parameters `$table` `JTable` - $table A reference to a JTable object. Since 1.6
`public boolean`	# `publish( array & $pks, integer $value = 1 )` Method to change the published state of one or more records. Method to change the published state of one or more records. Parameters `$pks` `array` - &$pks A list of the primary keys to change. `$value` `integer` - $value The value of the published state. Returns `boolean` - True on success. Since 1.6
`public boolean\|null`	# `reorder( integer $pks, integer $delta = 0 )` Method to adjust the ordering of a row. Method to adjust the ordering of a row. Returns NULL if the user did not have edit privileges for any of the selected primary keys. Parameters `$pks` `integer` - $pks The ID of the primary key to move. `$delta` `integer` - $delta Increment, usually +1 or -1 Returns `boolean\|null` - False on failure or error, true on success, null if the $pk is empty (no items selected). Since 1.6
`public boolean`	# `save( array $data )` Method to save the form data. Method to save the form data. Parameters `$data` `array` - $data The form data. Returns `boolean` - True on success, False on error. Since 1.6
`public boolean\|JException`	# `saveorder( array $pks = array(), integer $order = null )` Saves the manually set order of records. Saves the manually set order of records. Parameters `$pks` `array` - $pks An array of primary key ids. `$order` `integer` - $order +1 or -1 Returns `boolean\|JException` - Boolean true on success, false on failure, or JException if no items are selected Since 1.6
`public`	# `createTagsHelper( JTableObserverTags $tagsObserver, JUcmType $type, integer $pk, string $typeAlias, JTable $table )` Method to create a tags helper to ensure proper management of tags Method to create a tags helper to ensure proper management of tags Parameters `$tagsObserver` `JTableObserverTags` - $tagsObserver The tags observer for this table `$type` `JUcmType` - $type The type for the table being processed `$pk` `integer` - $pk Primary key of the item bing processed `$typeAlias` `string` - $typeAlias The type alias for this table `$table` `JTable` - $table The JTable object Since 3.2
`protected boolean`	# `checkCategoryId( integer $categoryId )` Method to check the validity of the category ID for batch copy and move Method to check the validity of the category ID for batch copy and move Parameters `$categoryId` `integer` - $categoryId The category ID to check Returns `boolean` Since 3.2
`public`	# `generateTitle( integer $categoryId, JTable $table )` 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 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 Parameters `$categoryId` `integer` - $categoryId The target category id `$table` `JTable` - $table The JTable within which move or copy is taking place Since 3.2

Magic methods summary

Properties summary

`protected string`	`$text_prefix`	# The prefix to use with controller messages. The prefix to use with controller messages. Since 1.6
`protected string`	`$event_after_delete`	# The event to trigger after deleting the data. The event to trigger after deleting the data. Since 1.6
`protected string`	`$event_after_save`	# The event to trigger after saving the data. The event to trigger after saving the data. Since 1.6
`protected string`	`$event_before_delete`	# The event to trigger before deleting the data. The event to trigger before deleting the data. Since 1.6
`protected string`	`$event_before_save`	# The event to trigger before saving the data. The event to trigger before saving the data. Since 1.6
`protected string`	`$event_change_state`	# The event to trigger after changing the published state of the data. The event to trigger after changing the published state of the data. Since 1.6
`protected string`	`$batch_copymove`	# Batch copy/move command. If set to false, the batch copy/move command is not supported Batch copy/move command. If set to false, the batch copy/move command is not supported Since 3.4
`protected array`	`$batch_commands`	# Allowed batch commands Allowed batch commands Since 3.4
`protected string`	`$associationsContext`	# The context used for the associations table The context used for the associations table Since 3.4.4

Properties inherited from JModelForm

$_forms, $events_map

Properties inherited from JModelLegacy

$__state_set, $_db, $event_clean_cache, $name, $option, $state

Properties inherited from JObject

$_errors

Namespaces

Classes

Interfaces

Exceptions

Constants

Functions

Class JModelAdmin

Methods summary

Parameters

Throws

Since

See

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Overrides

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Since

Overrides

Parameters

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Returns

Since

Parameters

Since

Parameters

Returns

Since

Parameters

Since