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: 11.1

Located in /libraries/joomla/application/component/controlleradmin.php (line 24)

JObject
   |
   --JController
      |
      --JControllerAdmin
Direct descendents
Class Description
ModulesControllerModules Modules list controller class.
MessagesControllerMessages Messages list controller class.
UsersControllerUsers Users list controller class.
UsersControllerLevels User view levels list controller class.
UsersControllerNotes User notes controller class.
UsersControllerGroups User groups list controller class.
NewsfeedsControllerNewsfeeds Newsfeeds list controller class.
LanguagesControllerOverrides Languages Overrides Controller
LanguagesControllerStrings Languages Strings JSON Controller
LanguagesControllerLanguages
WeblinksControllerWeblinks Weblinks list controller class.
PluginsControllerPlugins Plugins list controller class.
CategoriesControllerCategories The Categories List Controller
RedirectControllerLinks Redirect link list controller class.
TemplatesControllerStyles Template styles list controller class.
FinderControllerIndex Index controller class for Finder.
FinderControllerFilters Filters controller class for Finder.
FinderControllerMaps Maps controller class for Finder.
ContactControllerContacts Articles list controller class.
ContentControllerArticles Articles list controller class.
MenusControllerItems The Menu Item Controller
BannersControllerClients Clients list controller class.
BannersControllerBanners Banners list controller class.
Variable Summary
string $option
string $text_prefix
string $view_list
Method Summary
JControllerAdmin __construct ([array $config = array()])
boolean checkin ()
void delete ()
JController display ([boolean $cachable = false], [array $urlparams = false])
void publish ()
boolean reorder ()
boolean saveorder ()
Variables
string $option (line 32)

The URL option for the component.

  • since: 11.1
  • access: protected
string $text_prefix (line 40)

The prefix to use with controller messages.

  • since: 11.1
  • access: protected

Redefined in descendants as:
string $view_list (line 48)

The URL view list variable.

  • since: 11.1
  • access: protected

Inherited Variables

Inherited from JController

JController::$basePath
JController::$default_view
JController::$doTask
JController::$instance
JController::$message
JController::$messageType
JController::$methods
JController::$model_prefix
JController::$name
JController::$paths
JController::$redirect
JController::$task
JController::$taskMap
JController::$_acoSection
JController::$_acoSectionValue

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 58)

Constructor.

JControllerAdmin __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JController::__construct()
Constructor.

Redefined in descendants as:
checkin (line 303)

Check in of one or more records.

  • return: True on success
  • since: 11.1
  • access: public
boolean checkin ()

Redefined in descendants as:
delete (line 109)

Removes an item.

  • since: 11.1
  • access: public
void delete ()

Redefined in descendants as:
display (line 154)

Display is not supported by this controller.

  • return: A JController object to support chaining.
  • since: 11.1
  • access: public
JController display ([boolean $cachable = false], [array $urlparams = false])
  • 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:
JController::display()
Typical view method for MVC based architecture
publish (line 166)

Method to publish a list of items

  • since: 11.1
  • access: public
void publish ()

Redefined in descendants as:
reorder (line 227)

Changes the order of one or more records.

  • return: True on success
  • since: 11.1
  • access: public
boolean reorder ()

Redefined in descendants as:
saveorder (line 261)

Method to save the submitted ordering values for records.

  • return: True on success
  • since: 11.1
  • access: public
boolean saveorder ()

Redefined in descendants as:

Inherited Methods

Inherited From JController

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

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:53:53 -0500 by phpDocumentor 1.4.4