ComponentDispatcher

Extends Dispatcher

Base class for a Joomla Component Dispatcher

Dispatchers are responsible for checking ACL of a component if appropriate and choosing an appropriate controller (and if necessary, a task) and executing it.

since

4.0.0

package

Application

Methods

__construct

Constructor for Dispatcher

__construct(\Joomla\CMS\Application\CMSApplicationInterface app, \Joomla\Input\Input input) : mixed
inherited
since

4.0.0

Arguments

app

\Joomla\CMS\Application\CMSApplicationInterfaceThe application instance

input

\Joomla\Input\InputThe input instance

Response

mixed

checkAccess

Method to check component access permission

checkAccess() : void
since

4.0.0

dispatch

Dispatch a controller task. Redirecting the user if appropriate.

dispatch() : void
since

4.0.0

getApplication

The application the dispatcher is working with.

getApplication() : \Joomla\CMS\Application\CMSApplicationInterface
inherited
since

4.0.0

Response

\Joomla\CMS\Application\CMSApplicationInterface

getController

Get a controller from the component

getController(string name, string client = '', array config = array()) : \Joomla\CMS\MVC\Controller\BaseController
since

4.0.0

Arguments

name

stringController name

client

stringOptional client (like Administrator, Site etc.)

config

arrayOptional controller config

Response

\Joomla\CMS\MVC\Controller\BaseController

loadLanguage

Load the language

loadLanguage() : void
since

4.0.0

Properties

option

The URL option for the component.

since

4.0.0

Type(s)

string

mvcFactory

The MVC factory

since

4.0.0

Type(s)

MVCFactoryInterface

app

The application instance

inherited
since

4.0.0

Type(s)

CMSApplicationInterface

input

The input instance

inherited
since

4.0.0

Type(s)

\Joomla\Input\Input