AdminController
Extends \Joomla\CMS\MVC\Controller\BaseControllerBase 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 |
1.6 |
---|
Methods
__construct
Constructor.
__construct(array $config = array(), \Joomla\CMS\MVC\Factory\MVCFactoryInterface $factory = null)
since |
3.0 |
---|
Arguments
- $config
array
An 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\MVCFactoryInterface
The factory.
addModelPath
Adds to the stack of model paths in LIFO order.
addModelPath(mixed $path, string $prefix = '') : void
since |
3.0 |
---|
Arguments
- $path
mixed
The directory (string), or list of directories (array) to add.- $prefix
string
A prefix for models
addPath
Adds to the search path for templates and resources.
addPath(string $type, mixed $path) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $type
string
The path type (e.g. 'model', 'view').- $path
mixed
The directory string or stream array to search.
Response
\JControllerLegacy
A \JControllerLegacy object to support chaining.
addViewPath
Add one or more view paths to the controller's stack, in LIFO order.
addViewPath(mixed $path) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $path
mixed
The directory (string) or list of directories (array) to add.
Response
\JControllerLegacy
This object to support chaining.
authorise
Authorisation check
authorise(string $task) : boolean
since |
3.0 |
---|---|
deprecated |
3.0 Use \JAccess instead. |
Arguments
- $task
string
The ACO Section Value to check access on.
Response
boolean
True if authorised
checkEditId
Method to check whether an ID is in the edit list.
checkEditId(string $context, integer $id) : boolean
since |
3.0 |
---|
Arguments
- $context
string
The context for the session storage.- $id
integer
The ID of the record to add to the edit list.
Response
boolean
True if the ID is in the edit list.
checkin
Check in of one or more records.
checkin() : boolean
since |
1.6 |
---|
Response
boolean
True on success
checkToken
Checks for a form token in the request.
checkToken(string $method = 'post', boolean $redirect = true) : boolean
Use in conjunction with \JHtml::_('form.token') or \JSession::getFormToken.
since |
3.7.0 |
---|---|
see | \JSession::checkToken() |
Arguments
- $method
string
The request method in which to look for the token key.- $redirect
boolean
Whether to implicitly redirect user to the referrer page on failure or simply return false.
Response
boolean
True if found and valid, otherwise return false or redirect to referrer page.
createFileName
Create the filename for a resource.
createFileName(string $type, array $parts = array()) : string
since |
3.0 |
---|
Arguments
- $type
string
The resource type to create the filename for.- $parts
array
An associative array of filename information. Optional.
Response
string
The filename.
createModel
Method to load and return a model object.
createModel(string $name, string $prefix = '', array $config = array()) : \JModelLegacy|boolean
since |
3.0 |
---|
Arguments
- $name
string
The name of the model.- $prefix
string
Optional model prefix.- $config
array
Configuration array for the model. Optional.
Response
\JModelLegacy|boolean
Model object on success; otherwise false on failure.
createView
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
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 |
|
Arguments
- $name
string
The name of the view.- $prefix
string
Optional prefix for the view class name.- $type
string
The type of view.- $config
array
Configuration array for the view. Optional.
Response
\JViewLegacy|null
View object on success; null or error result on failure.
delete
Removes an item.
delete() : void
since |
1.6 |
---|
display
Typical view method for MVC based architecture
display(boolean $cachable = false, array $urlparams = array()) : \JControllerLegacy
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
boolean
If true, the view output will be cached- $urlparams
array
An array of safe URL parameters and their variable types, for valid values see {@link \JFilterInput::clean()}.
Response
\JControllerLegacy
A \JControllerLegacy object to support chaining.
execute
Execute a task by triggering a method in the derived class.
execute(string $task) : mixed
since |
3.0 |
---|---|
throws |
|
Arguments
- $task
string
The task to perform. If no matching task is found, the '__default' task is executed, if defined.
Response
mixed
The value returned by the called method.
getInstance
Method to get a singleton controller instance.
getInstance(string $prefix, array $config = array()) : \JControllerLegacy
since |
3.0 |
---|---|
throws |
|
Arguments
- $prefix
string
The prefix for the controller.- $config
array
An array of optional constructor options.
Response
\JControllerLegacy
getModel
Method to get a model object, loading it if required.
getModel(string $name = '', string $prefix = '', array $config = array()) : \JModelLegacy|boolean
since |
3.0 |
---|
Arguments
- $name
string
The model name. Optional.- $prefix
string
The class prefix. Optional.- $config
array
Configuration array for model. Optional.
Response
\JModelLegacy|boolean
Model object on success; otherwise false on failure.
getName
Method to get the controller name
getName() : string
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 |
|
Response
string
The name of the dispatcher
getTask
Get the last task that is being performed or was most recently performed.
getTask() : string
since |
3.0 |
---|
Response
string
The task that is being performed or was most recently performed.
getTasks
Gets the available tasks in the controller.
getTasks() : array
since |
3.0 |
---|
Response
array
Array[i] of task names.
getView
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
since |
3.0 |
---|---|
throws |
|
Arguments
- $name
string
The view name. Optional, defaults to the controller name.- $type
string
The view type. Optional.- $prefix
string
The class prefix. Optional.- $config
array
Configuration array for view. Optional.
Response
\JViewLegacy
Reference to the view or an error.
holdEditId
Method to add a record ID to the edit list.
holdEditId(string $context, integer $id) : void
since |
3.0 |
---|
Arguments
- $context
string
The context for the session storage.- $id
integer
The ID of the record to add to the edit list.
postDeleteHook
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
\JModelLegacy
The data model object.- $id
integer
The validated data.
publish
Method to publish a list of items
publish() : void
since |
1.6 |
---|
redirect
Redirects the browser or returns false if no redirect is set.
redirect() : boolean
since |
3.0 |
---|
Response
boolean
False if no redirect exists.
registerDefaultTask
Register the default task to perform if a mapping is not found.
registerDefaultTask(string $method) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $method
string
The name of the method in the derived class to perform if a named task is not found.
Response
\JControllerLegacy
A \JControllerLegacy object to support chaining.
registerTask
Register (map) a task to a method in the class.
registerTask(string $task, string $method) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $task
string
The task.- $method
string
The name of the method in the derived class to perform for this task.
Response
\JControllerLegacy
A \JControllerLegacy object to support chaining.
releaseEditId
Method to check whether an ID is in the edit list.
releaseEditId(string $context, integer $id) : void
since |
3.0 |
---|
Arguments
- $context
string
The context for the session storage.- $id
integer
The ID of the record to add to the edit list.
reorder
Changes the order of one or more records.
reorder() : boolean
since |
1.6 |
---|
Response
boolean
True on success
saveorder
Method to save the submitted ordering values for records.
saveorder() : boolean
since |
1.6 |
---|
Response
boolean
True on success
saveOrderAjax
Method to save the submitted ordering values for records via AJAX.
saveOrderAjax() : void
since |
3.0 |
---|
setMessage
Sets the internal message that is passed with a redirect
setMessage(string $text, string $type = 'message') : string
since |
3.0 |
---|
Arguments
- $text
string
Message to display on redirect.- $type
string
Message type. Optional, defaults to 'message'.
Response
string
Previous message
setPath
Sets an entire array of search paths for resources.
setPath(string $type, string $path) : void
since |
3.0 |
---|
Arguments
- $type
string
The type of path to set, typically 'view' or 'model'.- $path
string
The new set of search paths. If null or false, resets to the current directory only.
setRedirect
Set a URL for browser redirection.
setRedirect(string $url, string $msg = null, string $type = null) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $url
string
URL to redirect to.- $msg
string
Message to display on redirect. Optional, defaults to value set internally by controller, if any.- $type
string
Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.
Response
\JControllerLegacy
This object to support chaining.
unregisterTask
Unregister (unmap) a task in the class.
unregisterTask(string $task) : \JControllerLegacy
since |
3.0 |
---|
Arguments
- $task
string
The task.
Response
\JControllerLegacy
This object to support chaining.
Properties
option
The URL option for the component.
since |
1.6 |
---|
Type(s)
string
text_prefix
The prefix to use with controller messages.
since |
1.6 |
---|
Type(s)
string
view_list
The URL view list variable.
since |
1.6 |
---|
Type(s)
string
basePath
The base path of the controller
since |
3.0 |
---|
Type(s)
string
default_view
The default view for the display method.
since |
3.0 |
---|
Type(s)
string
doTask
The mapped task that was performed.
since |
3.0 |
---|
Type(s)
string
message
Redirect message.
since |
3.0 |
---|
Type(s)
string
messageType
Redirect message type.
since |
3.0 |
---|
Type(s)
string
methods
Array of class methods
since |
3.0 |
---|
Type(s)
array
name
The name of the controller
since |
3.0 |
---|
Type(s)
array
model_prefix
The prefix of the models
since |
3.0 |
---|
Type(s)
string
paths
The set of search directories for resources (views).
since |
3.0 |
---|
Type(s)
array
redirect
URL for redirection.
since |
3.0 |
---|
Type(s)
string
task
Current or most recently performed task.
since |
3.0 |
---|
Type(s)
string
taskMap
Array of class methods to call for a given task.
since |
3.0 |
---|
Type(s)
array
input
Hold a JInput object for easier access to the input variables.
since |
3.0 |
---|
Type(s)
\JInput
instance
Instance container.
since |
3.0 |
---|
Type(s)
\JControllerLegacy
views
Instance container containing the views.
since |
3.4 |
---|
Type(s)
array<mixed,\JViewLegacy>