Docs For Class JControllerAdmin

Description

Base class for a Joomla Administrator Controller

Controller (controllers are where you put all the actual code) Provides basic functionality, such as rendering views (aka displaying templates).

since: 12.2

Located in /libraries/legacy/controller/admin.php (line 22)

JObject
   |
   --JControllerLegacy
      |
      --JControllerAdmin

Direct descendents

Class	Description
BannersControllerBanners	Banners list controller class.
BannersControllerClients	Clients list controller class.
CategoriesControllerCategories	The Categories List Controller
ContactControllerContacts	Articles list controller class.
ContentControllerArticles	Articles list controller class.
ContenthistoryControllerHistory	Contenthistory list controller class.
FinderControllerFilters	Filters controller class for Finder.
FinderControllerIndex	Index controller class for Finder.
FinderControllerMaps	Maps controller class for Finder.
LanguagesControllerLanguages
LanguagesControllerOverrides	Languages Overrides Controller
LanguagesControllerStrings	Languages Strings JSON Controller
MenusControllerItems	The Menu Item Controller
MessagesControllerMessages	Messages list controller class.
ModulesControllerModules	Modules list controller class.
NewsfeedsControllerNewsfeeds	Newsfeeds list controller class.
PluginsControllerPlugins	Plugins list controller class.
RedirectControllerLinks	Redirect link list controller class.
TagsControllerTags	The Tags List Controller
TemplatesControllerStyles	Template styles list controller class.
UsersControllerGroups	User groups list controller class.
UsersControllerLevels	User view levels list controller class.
UsersControllerNotes	User notes controller class.
UsersControllerUsers	Users list controller class.
WeblinksControllerWeblinks	Weblinks list controller class.

Variable Summary

string $option

string $text_prefix

string $view_list

Method Summary

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

boolean checkin ()

void delete ()

JControllerLegacy display ([boolean $cachable = false], [array $urlparams = array()])

void postDeleteHook (JModelLegacy $model, [integer $id = null])

void publish ()

boolean reorder ()

boolean saveorder ()

void saveOrderAjax ()

Variables

string $option (line 30)

The URL option for the component.

since: 12.2
access: protected

string $text_prefix (line 38)

The prefix to use with controller messages.

since: 12.2
access: protected

Redefined in descendants as:

BannersControllerBanners::$text_prefix
BannersControllerClients::$text_prefix
LanguagesControllerOverrides::$text_prefix : The prefix to use with controller messages
UsersControllerGroups::$text_prefix
UsersControllerLevels::$text_prefix
UsersControllerNotes::$text_prefix : The prefix to use with controller messages.
UsersControllerUsers::$text_prefix

string $view_list (line 46)

The URL view list variable.

since: 12.2
access: protected

Inherited Variables

Inherited from JControllerLegacy

JControllerLegacy::$basePath
JControllerLegacy::$default_view
JControllerLegacy::$doTask
JControllerLegacy::$input
JControllerLegacy::$instance
JControllerLegacy::$message
JControllerLegacy::$messageType
JControllerLegacy::$methods
JControllerLegacy::$model_prefix
JControllerLegacy::$name
JControllerLegacy::$paths
JControllerLegacy::$redirect
JControllerLegacy::$task
JControllerLegacy::$taskMap

Inherited from JObject

JObject::$_errors

Methods

Constructor __construct (line 57)

Constructor.

see: JControllerLegacy
throws: Exception
since: 12.2
access: public

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

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

Redefinition of:

JControllerLegacy::__construct(): Constructor.

Redefined in descendants as:

BannersControllerBanners::__construct() : Constructor.
ContactControllerContacts::__construct() : Constructor.
ContentControllerArticles::__construct() : Constructor.
MenusControllerItems::__construct()
UsersControllerUsers::__construct() : Constructor.

checkin (line 321)

Check in of one or more records.

return: True on success
since: 12.2
access: public

boolean checkin ()

Redefined in descendants as:

UsersControllerGroups::checkin() : Check in of one or more records.

delete (line 108)

Removes an item.

since: 12.2
access: public

void delete ()

Redefined in descendants as:

CategoriesControllerCategories::delete() : Deletes and returns correctly.
ContentControllerFeatured::delete() : Removes an item
ContenthistoryControllerHistory::delete() : Deletes and returns correctly.
LanguagesControllerOverrides::delete() : Method for deleting one or more overrides
UsersControllerGroups::delete() : Removes an item.

display (line 170)

Display is not supported by this controller.

return: A JControllerLegacy object to support chaining.
since: 12.2
access: public

JControllerLegacy display ([boolean $cachable = false], [array $urlparams = array()])

boolean $cachable: If true, the view output will be cached
array $urlparams: An array of safe url parameters and their variable types, for valid values see JFilterInput::clean().

Redefinition of:

JControllerLegacy::display(): Typical view method for MVC based architecture

postDeleteHook (line 156)

Function that allows child controller access to model data after the item has been deleted.

since: 12.2
access: protected

void postDeleteHook (JModelLegacy $model, [integer $id = null])

JModelLegacy $model: The data model object.
integer $id: The validated data.

Redefined in descendants as:

ContactControllerContacts::postDeleteHook() : Function that allows child controller access to model data after the item has been deleted.
ContentControllerArticles::postDeleteHook() : Function that allows child controller access to model data after the item has been deleted.
NewsfeedsControllerNewsfeeds::postDeleteHook()
WeblinksControllerWeblinks::postDeleteHook() : Method to provide child classes the opportunity to process after the delete task.

publish (line 182)

Method to publish a list of items

since: 12.2
access: public

void publish ()

Redefined in descendants as:

ContentControllerFeatured::publish() : Method to publish a list of articles.
UsersControllerGroups::publish() : Method to publish a list of records.

reorder (line 246)

Changes the order of one or more records.

return: True on success
since: 12.2
access: public

boolean reorder ()

Redefined in descendants as:

UsersControllerGroups::reorder() : Changes the order of one or more records.

saveorder (line 279)

Method to save the submitted ordering values for records.

return: True on success
since: 12.2
access: public

boolean saveorder ()

Redefined in descendants as:

CategoriesControllerCategories::saveorder() : Save the manual order inputs from the categories list page.
MenusControllerItems::saveorder()
UsersControllerGroups::saveorder() : Method to save the submitted ordering values for records.

saveOrderAjax (line 353)

Method to save the submitted ordering values for records via AJAX.

since: 3.0
access: public

void saveOrderAjax ()

Redefined in descendants as:

LanguagesControllerLanguages::saveOrderAjax() : Method to save the submitted ordering values for records via AJAX.

Inherited Methods

Inherited From JControllerLegacy

JControllerLegacy::__construct()
JControllerLegacy::addModelPath()
JControllerLegacy::addPath()
JControllerLegacy::addViewPath()
JControllerLegacy::authorise()
JControllerLegacy::checkEditId()
JControllerLegacy::createFileName()
JControllerLegacy::createModel()
JControllerLegacy::createView()
JControllerLegacy::display()
JControllerLegacy::execute()
JControllerLegacy::getInstance()
JControllerLegacy::getModel()
JControllerLegacy::getName()
JControllerLegacy::getTask()
JControllerLegacy::getTasks()
JControllerLegacy::getView()
JControllerLegacy::holdEditId()
JControllerLegacy::redirect()
JControllerLegacy::registerDefaultTask()
JControllerLegacy::registerTask()
JControllerLegacy::releaseEditId()
JControllerLegacy::setMessage()
JControllerLegacy::setPath()
JControllerLegacy::setRedirect()
JControllerLegacy::unregisterTask()

Inherited From JObject

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