Docs For Class JModelAdmin

Description

Prototype form model.

abstract:

Located in /libraries/legacy/model/admin.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin

Direct descendents

Class	Description
BannersModelBanner	Banner model.
BannersModelClient	Client model.
CategoriesModelCategory	Categories Component Category Model
ContactModelContact	Item Model for a Contact.
ContentModelArticle	Item Model for an Article.
FinderModelFilter	Filter model class for Finder.
LanguagesModelLanguage	Languages Component Language Model
LanguagesModelOverride	Languages Override Model
MenusModelItem	Menu Item Model for Menus.
MessagesModelMessage	Private Message model.
ModulesModelModule	Module model.
NewsfeedsModelNewsfeed	Newsfeed model.
PluginsModelPlugin	Plugin model.
RedirectModelLink	Redirect link model.
TagsModelTag	Tags Component Tag Model
TemplatesModelStyle	Template style model.
UsersModelGroup	User group model.
UsersModelLevel	User view level model.
UsersModelMail	Users mail model.
UsersModelNote	User note model.
UsersModelUser	User model.
WeblinksModelWeblink	Weblinks model.

Variable Summary

string $event_after_delete

string $event_after_save

string $event_before_delete

string $event_before_save

string $event_change_state

string $text_prefix

Method Summary

JModelAdmin __construct ([array $config = array()])

boolean batch (array $commands, array $pks, array $contexts)

boolean batchAccess (integer $value, array $pks, array $contexts)

mixed batchCopy (integer $value, array $pks, array $contexts)

Variables

string $event_after_delete = null (line 35)

The event to trigger after deleting the data.

since: 12.2
access: protected

string $event_after_save = null (line 43)

The event to trigger after saving the data.

since: 12.2
access: protected

Redefined in descendants as:

string $event_before_delete = null (line 51)

The event to trigger before deleting the data.

since: 12.2
access: protected

string $event_before_save = null (line 59)

The event to trigger before saving the data.

since: 12.2
access: protected

Redefined in descendants as:

string $event_change_state = null (line 67)

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

since: 12.2
access: protected

string $text_prefix = null (line 27)

The prefix to use with controller messages.

since: 12.2
access: protected

Redefined in descendants as:

BannersModelBanner::$text_prefix
CategoriesModelCategory::$text_prefix
ContentModelArticle::$text_prefix
FinderModelFilter::$text_prefix : The prefix to use with controller messages.
MenusModelItem::$text_prefix
ModulesModelModule::$text_prefix
NewsfeedsModelNewsfeed::$text_prefix
RedirectModelLink::$text_prefix
TagsModelTag::$text_prefix
WeblinksModelWeblink::$text_prefix : The prefix to use with controller messages.

Inherited Variables

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 77)

Constructor.

see: JModelLegacy
since: 12.2
access: public

JModelAdmin __construct ([array $config = array()])

array $config: An optional associative array of configuration settings.

Redefinition of:

JModelLegacy::__construct(): Constructor

Redefined in descendants as:

CategoriesModelCategory::__construct() : Override parent constructor.
UsersModelUser::__construct() : Constructor.

batch (line 148)

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

return: Returns true on success, false on failure.
since: 12.2
access: public

boolean batch (array $commands, array $pks, array $contexts)

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

Redefined in descendants as:

BannersModelBanner::batch() : Method to perform batch operations on an item or a set of items.
ContactModelContact::batch() : Method to perform batch operations on an item or a set of items.
MenusModelItem::batch() : Method to perform batch operations on an item or a set of items.
ModulesModelModule::batch() : Method to perform batch operations on a set of modules.
UsersModelUser::batch() : Method to perform batch operations on an item or a set of items.

batchAccess (line 273)

Batch access level changes for a group of rows.

return: True if successful, false otherwise and internal error is set.
since: 12.2
access: protected

boolean batchAccess (integer $value, array $pks, array $contexts)

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

batchCopy (line 327)

Batch copy items to a new category or current.

return: An array of new IDs on success, boolean false on failure.
since: 12.2
access: protected

mixed batchCopy (integer $value, array $pks, array $contexts)

integer $value: The new category.
array $pks: An array of row IDs.
array $contexts: An array of item contexts.

Redefined in descendants as:

BannersModelBanner::batchCopy() : Batch copy items to a new category or current.
CategoriesModelCategory::batchCopy() : Batch copy categories to a new category.
ContactModelContact::batchCopy() : Batch copy items to a new category or current.
ContentModelArticle::batchCopy() : Batch copy items to a new category or current.
MenusModelItem::batchCopy() : Batch copy menu items to a new menu or parent.
ModulesModelModule::batchCopy() : Batch copy modules to a new position or current.
NewsfeedsModelNewsfeed::batchCopy() : Batch copy items to a new category or current.

Inherited Methods

Inherited From JModelForm

JModelForm::checkin()
JModelForm::checkout()
JModelForm::getForm()
JModelForm::loadForm()
JModelForm::loadFormData()
JModelForm::preprocessData()
JModelForm::preprocessForm()
JModelForm::validate()

Inherited From JModelLegacy

JModelLegacy::__construct()
JModelLegacy::addIncludePath()
JModelLegacy::addTablePath()
JModelLegacy::cleanCache()
JModelLegacy::getDbo()
JModelLegacy::getInstance()
JModelLegacy::getName()
JModelLegacy::getState()
JModelLegacy::getTable()
JModelLegacy::loadHistory()
JModelLegacy::populateState()
JModelLegacy::setDbo()
JModelLegacy::setState()
JModelLegacy::_createFileName()
JModelLegacy::_createTable()
JModelLegacy::_getList()
JModelLegacy::_getListCount()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()