Joomla! API

Constructor.

__construct(array $config = array(), \Joomla\CMS\MVC\Factory\MVCFactoryInterface $factory = null)

inherited

since	3.0

Arguments

$config: arrayAn optional associative array of configuration settings. Recognized key values include 'name', 'default_task', 'model_path', and 'view_path' (this list is not meant to be comprehensive).
$factory: \Joomla\CMS\MVC\Factory\MVCFactoryInterfaceThe factory.

Adds to the stack of model paths in LIFO order.

addModelPath(mixed $path, string $prefix = '') : void

inherited static

since	3.0

Arguments

$path: mixedThe directory (string), or list of directories (array) to add.
$prefix: stringA prefix for models

Adds to the search path for templates and resources.

addPath(string $type, mixed $path) : \JControllerLegacy

inherited

since	3.0

Arguments

$type: stringThe path type (e.g. 'model', 'view').
$path: mixedThe directory string or stream array to search.

Response

\JControllerLegacyA \JControllerLegacy object to support chaining.

Add one or more view paths to the controller's stack, in LIFO order.

addViewPath(mixed $path) : \JControllerLegacy

inherited

since	3.0

Arguments

$path: mixedThe directory (string) or list of directories (array) to add.

Response

\JControllerLegacyThis object to support chaining.

Authorisation check

authorise(string $task) : boolean

inherited deprecated

since	3.0
deprecated	3.0 Use \JAccess instead.

Arguments

$task: stringThe ACO Section Value to check access on.

Response

booleanTrue if authorised

Method to check whether an ID is in the edit list.

checkEditId(string $context, integer $id) : boolean

inherited

since	3.0

Arguments

$context: stringThe context for the session storage.
$id: integerThe ID of the record to add to the edit list.

Response

booleanTrue if the ID is in the edit list.

Check in of one or more records.

checkin() : boolean

since	1.6

Response

booleanTrue on success

Checks for a form token in the request.

checkToken(string $method = 'post', boolean $redirect = true) : boolean

inherited

Use in conjunction with \JHtml::_('form.token') or \JSession::getFormToken.

since	3.7.0
see	\JSession::checkToken()

Arguments

$method: stringThe request method in which to look for the token key.
$redirect: booleanWhether to implicitly redirect user to the referrer page on failure or simply return false.

Response

booleanTrue if found and valid, otherwise return false or redirect to referrer page.

Create the filename for a resource.

createFileName(string $type, array $parts = array()) : string

inherited static

since	3.0

Arguments

$type: stringThe resource type to create the filename for.
$parts: arrayAn associative array of filename information. Optional.

Response

stringThe filename.

Method to load and return a model object.

createModel(string $name, string $prefix = '', array $config = array()) : \JModelLegacy|boolean

inherited

since	3.0

Arguments

$name: stringThe name of the model.
$prefix: stringOptional model prefix.
$config: arrayConfiguration array for the model. Optional.

Response

\JModelLegacy|booleanModel object on success; otherwise false on failure.

Method to load and return a view object. This method first looks in the current template directory for a match and, failing that, uses a default set path to load the view class file.

createView(string $name, string $prefix = '', string $type = '', array $config = array()) : \JViewLegacy|null

inherited

Note the "name, prefix, type" order of parameters, which differs from the "name, type, prefix" order used in related public methods.

since	3.0
throws	`\Exception`

Arguments

$name: stringThe name of the view.
$prefix: stringOptional prefix for the view class name.
$type: stringThe type of view.
$config: arrayConfiguration array for the view. Optional.

Response

\JViewLegacy|nullView object on success; null or error result on failure.

Removes an item.

delete() : void

since	1.6

Typical view method for MVC based architecture

display(boolean $cachable = false, array $urlparams = array()) : \JControllerLegacy

inherited

This function is provide as a default implementation, in most cases you will need to override it in your own controllers.

since	3.0

Arguments

$cachable: booleanIf true, the view output will be cached
$urlparams: arrayAn array of safe URL parameters and their variable types, for valid values see {@link \JFilterInput::clean()}.

Response

\JControllerLegacyA \JControllerLegacy object to support chaining.

Execute a task by triggering a method in the derived class.

execute(string $task) : mixed

inherited

since	3.0
throws	`\Exception`

Arguments

$task: stringThe task to perform. If no matching task is found, the '__default' task is executed, if defined.

Response

mixedThe value returned by the called method.

Method to get a singleton controller instance.

getInstance(string $prefix, array $config = array()) : \JControllerLegacy

inherited static

since	3.0
throws	`\Exception`if the controller cannot be loaded.

Arguments

$prefix: stringThe prefix for the controller.
$config: arrayAn array of optional constructor options.

Response

\JControllerLegacy

Method to get a model object, loading it if required.

getModel(string $name = '', string $prefix = '', array $config = array()) : \JModelLegacy|boolean

inherited

since	3.0

Arguments

$name: stringThe model name. Optional.
$prefix: stringThe class prefix. Optional.
$config: arrayConfiguration array for model. Optional.

Response

\JModelLegacy|booleanModel object on success; otherwise false on failure.

Method to get the controller name

getName() : string

inherited

The dispatcher name is set by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor

since	3.0
throws	`\Exception`

Response

stringThe name of the dispatcher

Get the last task that is being performed or was most recently performed.

getTask() : string

inherited

since	3.0

Response

stringThe task that is being performed or was most recently performed.

Gets the available tasks in the controller.

getTasks() : array

inherited

since	3.0

Response

arrayArray[i] of task names.

Method to get a reference to the current view and load it if necessary.

getView(string $name = '', string $type = '', string $prefix = '', array $config = array()) : \JViewLegacy

inherited

since	3.0
throws	`\Exception`

Arguments

$name: stringThe view name. Optional, defaults to the controller name.
$type: stringThe view type. Optional.
$prefix: stringThe class prefix. Optional.
$config: arrayConfiguration array for view. Optional.

Response

\JViewLegacyReference to the view or an error.

Method to add a record ID to the edit list.

holdEditId(string $context, integer $id) : void

inherited

since	3.0

Arguments

$context: stringThe context for the session storage.
$id: integerThe ID of the record to add to the edit list.

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

postDeleteHook(\JModelLegacy $model, integer $id = null) : void

since	3.1

Arguments

$model: \JModelLegacyThe data model object.
$id: integerThe validated data.

Method to publish a list of items

publish() : void

since	1.6

Redirects the browser or returns false if no redirect is set.

redirect() : boolean

inherited

since	3.0

Response

booleanFalse if no redirect exists.

Register the default task to perform if a mapping is not found.

registerDefaultTask(string $method) : \JControllerLegacy

inherited

since	3.0

Arguments

$method: stringThe name of the method in the derived class to perform if a named task is not found.

Response

\JControllerLegacyA \JControllerLegacy object to support chaining.

Register (map) a task to a method in the class.

registerTask(string $task, string $method) : \JControllerLegacy

inherited

since	3.0

Arguments

$task: stringThe task.
$method: stringThe name of the method in the derived class to perform for this task.

Response

\JControllerLegacyA \JControllerLegacy object to support chaining.

Method to check whether an ID is in the edit list.

releaseEditId(string $context, integer $id) : void

inherited

since	3.0

Arguments

$context: stringThe context for the session storage.
$id: integerThe ID of the record to add to the edit list.

Changes the order of one or more records.

reorder() : boolean

since	1.6

Response

booleanTrue on success

Method to save the submitted ordering values for records.

saveorder() : boolean

since	1.6

Response

booleanTrue on success

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

saveOrderAjax() : void

since	3.0

Sets the internal message that is passed with a redirect

setMessage(string $text, string $type = 'message') : string

inherited

since	3.0

Arguments

$text: stringMessage to display on redirect.
$type: stringMessage type. Optional, defaults to 'message'.

Response

stringPrevious message

Sets an entire array of search paths for resources.

setPath(string $type, string $path) : void

inherited

since	3.0

Arguments

$type: stringThe type of path to set, typically 'view' or 'model'.
$path: stringThe new set of search paths. If null or false, resets to the current directory only.

Set a URL for browser redirection.

setRedirect(string $url, string $msg = null, string $type = null) : \JControllerLegacy

inherited

since	3.0

Arguments

$url: stringURL to redirect to.
$msg: stringMessage to display on redirect. Optional, defaults to value set internally by controller, if any.
$type: stringMessage type. Optional, defaults to 'message' or the type set by a previous call to setMessage.

Response

\JControllerLegacyThis object to support chaining.

Unregister (unmap) a task in the class.

unregisterTask(string $task) : \JControllerLegacy

inherited

since	3.0

Arguments

$task: stringThe task.

Response

\JControllerLegacyThis object to support chaining.

The URL option for the component.

since	1.6

Type(s)

string

The prefix to use with controller messages.

since	1.6

Type(s)

string

The URL view list variable.

since	1.6

Type(s)

string

The base path of the controller

inherited

since	3.0

Type(s)

string

The default view for the display method.

inherited

since	3.0

Type(s)

string

The mapped task that was performed.

inherited

since	3.0

Type(s)

string

Redirect message.

inherited

since	3.0

Type(s)

string

Redirect message type.

inherited

since	3.0

Type(s)

string

Array of class methods

inherited

since	3.0

Type(s)

array

The name of the controller

inherited

since	3.0

Type(s)

array

The prefix of the models

inherited

since	3.0

Type(s)

string

The set of search directories for resources (views).

inherited

since	3.0

Type(s)

array

URL for redirection.

inherited

since	3.0

Type(s)

string

Current or most recently performed task.

inherited

since	3.0

Type(s)

string

Array of class methods to call for a given task.

inherited

since	3.0

Type(s)

array

Hold a JInput object for easier access to the input variables.

inherited

since	3.0

Type(s)

\JInput

The factory.

inherited

since	3.10.0

Type(s)

\Joomla\CMS\MVC\Factory\MVCFactoryInterface

Instance container.

inherited static

since	3.0

Type(s)

\JControllerLegacy

Instance container containing the views.

inherited static

since	3.4

Type(s)

array<mixed,\JViewLegacy>

AdminController

Methods

__construct

Arguments

addModelPath

Arguments

addPath

Arguments

Response

addViewPath

Arguments

Response

authorise

Arguments

Response

checkEditId

Arguments

Response

checkin

Response

checkToken

Arguments

Response

createFileName

Arguments

Response

createModel

Arguments

Response

createView

Arguments

Response

delete

display

Arguments

Response

execute

Arguments

Response

getInstance

Arguments

Response

getModel

Arguments

Response

getName

Response

getTask

Response

getTasks

Response

getView

Arguments

Response

holdEditId

Arguments

postDeleteHook

Arguments

publish

redirect

Response

registerDefaultTask

Arguments

Response

registerTask

Arguments

Response

releaseEditId

Arguments

reorder

Response

saveorder

Response

saveOrderAjax

setMessage

Arguments

Response

setPath

Arguments

setRedirect