Joomla! API

Constructor.

__construct(mixed||string|int config = [], \Joomla\CMS\MVC\Factory\MVCFactoryInterface factory = null, \Joomla\CMS\Application\CMSApplication app = null, \Joomla\Input\Input input = null) :

since	4.0.0
throws	`Exception`

Arguments

config: array<string|int, mixed>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: MVCFactoryInterface|nullThe factory.
app: CMSApplication|nullThe Application for the dispatcher
input: Input|nullInput

Response

mixed

Method to add a new record.

add() :

since

4.0.0

throws

NotAllowed

RuntimeException

Response

void

Adds to the stack of model paths in LIFO order.

addModelPath( path,  prefix = '') :

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Will be removed without replacement. Get the model through the MVCFactory instead

Arguments

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

Response

void

Adds to the search path for templates and resources.

addPath( type,  path) :

inherited

since	3.0

Arguments

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

Response

staticA \JControllerLegacy object to support chaining.

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

addViewPath( path) :

inherited

since	3.0

Arguments

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

Response

staticThis object to support chaining.

Method to check if you can add a new record.

allowAdd(mixed||string|int data = []) :

Extended classes can override this if necessary.

since	4.0.0

Arguments

data: array<string|int, mixed>An array of input data.

Response

bool

Method to check if you can edit an existing record.

allowEdit(mixed||string|int data = [],  key = 'id') :

Extended classes can override this if necessary.

since	4.0.0

Arguments

data: array<string|int, mixed>An array of input data.
key: stringThe name of the key for the primary key; default is id.

Response

bool

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

checkEditId( context,  id) :

inherited

since	3.0

Arguments

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

Response

boolTrue if the ID is in the edit list.

Checks for a form token in the request.

checkToken( method = 'post',  redirect = true) :

inherited

Use in conjunction with HTMLHelper::_('form.token') or Session::getFormToken.

since	3.7.0
see	Session::checkToken()

Arguments

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

Response

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

Create the filename for a resource.

createFileName( type, mixed||string|int parts = []) :

inherited static

since	3.0

Arguments

type: stringThe resource type to create the filename for.
parts: array<string|int, mixed>An associative array of filename information. Optional.

Response

stringThe filename.

Method to load and return a model object.

createModel( name,  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\BaseDatabaseModel|bool

inherited

since	3.0

Arguments

name: stringThe name of the model.
prefix: stringOptional model prefix.
config: array<string|int, mixed>Configuration array for the model. Optional.

Response

BaseDatabaseModel|boolModel 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( name,  prefix = '',  type = '', mixed||string|int config = []) : \Joomla\CMS\MVC\View\ViewInterface|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: array<string|int, mixed>Configuration array for the view. Optional.

Response

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

Removes an item.

delete( id = null) :

since	4.0.0

Arguments

id: intThe primary key to delete item.

Response

void

Typical view method for MVC based architecture

display( cachable = false, mixed||string|int urlparams = []) :

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
throws	`Exception`

Arguments

cachable: boolIf true, the view output will be cached
urlparams: array<string|int, mixed>An array of safe url parameters and their variable types, for valid values see {@link InputFilter::clean()}.

Response

staticA \JControllerLegacy object to support chaining.

Basic display of an item view

displayItem( id = null) :

since	4.0.0

Arguments

id: intThe primary key to display. Leave empty if you want to retrieve data from the request

Response

staticA \JControllerLegacy object to support chaining.

Basic display of a list view

displayList() :

since	4.0.0

Response

staticA \JControllerLegacy object to support chaining.

Method to edit an existing record.

edit() :

since	4.0.0

Response

staticA \JControllerLegacy object to support chaining.

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

execute( task) :

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.

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface

inherited

The override was made to keep a backward compatibility for legacy component. TODO: Remove the override in 6.0

since	4.4.0
throws	`UnexpectedValueException`May be thrown if the dispatcher has not been set.

Response

DispatcherInterface

Method to get a singleton controller instance.

getInstance( prefix, mixed||string|int config = []) :

inherited static deprecated

since	3.0
deprecated	4.3 will be removed in 6.0 Get the controller through the MVCFactory instead Example: Factory::getApplication()->bootComponent($option)->getMVCFactory()->createController(...);
throws	`Exception`if the controller cannot be loaded.

Arguments

prefix: stringThe prefix for the controller.
config: array<string|int, mixed>An array of optional constructor options.

Response

static

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

getModel( name = '',  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Model\BaseDatabaseModel|bool

inherited

since	3.0

Arguments

name: stringThe model name. Optional.
prefix: stringThe class prefix. Optional.
config: array<string|int, mixed>Configuration array for model. Optional.

Response

BaseDatabaseModel|boolModel object on success; otherwise false on failure.

Method to get the controller name

getName() :

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() :

inherited

since	3.0

Response

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

Gets the available tasks in the controller.

getTasks() : mixed||string|int

inherited

since	3.0

Response

array<string|int, mixed>Array[i] of task names.

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

getView( name = '',  type = '',  prefix = '', mixed||string|int config = []) : \Joomla\CMS\MVC\View\ViewInterface

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: array<string|int, mixed>Configuration array for view. Optional.

Response

ViewInterfaceReference to the view or an error.

Method to add a record ID to the edit list.

holdEditId( context,  id) :

inherited

since	3.0

Arguments

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

Response

void

Method to allow extended classes to manipulate the data to be saved for an extension.

preprocessSaveData(mixed||string|int data) : mixed||string|int

since	4.0.0

Arguments

data: array<string|int, mixed>An array of input data.

Response

array<string|int, mixed>

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

redirect() :

inherited

since	3.0

Response

boolFalse if no redirect exists.

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

registerDefaultTask( method) :

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

staticA \JControllerLegacy object to support chaining.

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

registerTask( task,  method) :

inherited

since	3.0

Arguments

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

Response

staticA \JControllerLegacy object to support chaining.

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

releaseEditId( context,  id) :

inherited

since	3.0

Arguments

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

Response

void

Method to save a record.

save( recordKey = null) :

since	4.0.0

Arguments

recordKey: intThe primary key of the item (if exists)

Response

intThe record ID on success, false on failure

Sets the internal message that is passed with a redirect

setMessage( text,  type = 'message') :

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( type,  path) :

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.

Response

void

Set a URL for browser redirection.

setRedirect( url,  msg = null,  type = null) :

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

staticThis object to support chaining.

Unregister (unmap) a task in the class.

unregisterTask( task) :

inherited

since	3.0

Arguments

task: stringThe task.

Response

staticThis object to support chaining.

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<string|int, mixed>

The name of the controller

inherited

since	3.0

Type(s)

string

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<string|int, mixed>

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<string|int, mixed>

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

inherited

since	3.0

Type(s)

Input

The factory.

inherited

since	3.10.0

Type(s)

MVCFactoryInterface

Instance container.

inherited static

since	3.0

Type(s)

static

Instance container containing the views.

inherited static

since	3.4

Type(s)

array<string|int, ViewInterface>

The Application

inherited

since	4.0.0

Type(s)

CMSApplication|null

The content type of the item.

since	4.0.0

Type(s)

string

The URL option for the component.

since	4.0.0

Type(s)

string

The prefix to use with controller messages.

since	4.0.0

Type(s)

string

The context for storing internal data, e.g. record.

since	4.0.0

Type(s)

string

Items on a page

Type(s)

int

The model state to inject

Type(s)

CMSObject

since	4.0.0
package	Joomla CMS

ApiController

Methods

__construct

Arguments

Response

add

Response

addModelPath

Arguments

Response

addPath

Arguments

Response

addViewPath

Arguments

Response

allowAdd

Arguments

Response

allowEdit

Arguments

Response

checkEditId

Arguments

Response

checkToken

Arguments

Response

createFileName

Arguments

Response

createModel

Arguments

Response

createView

Arguments

Response

delete

Arguments

Response

display

Arguments

Response

displayItem

Arguments

Response

displayList

Response

edit

Response

execute

Arguments

Response

getDispatcher

Response

getInstance

Arguments

Response

getModel

Arguments

Response

getName

Response

getTask

Response

getTasks

Response

getView

Arguments

Response

holdEditId

Arguments

Response

preprocessSaveData

Arguments

Response

redirect

Response

registerDefaultTask

Arguments