ApiDispatcher

Extends \Joomla\CMS\Dispatcher\ComponentDispatcher

API Implementation for our dispatcher. It loads a component's administrator language files, and calls the API Controller so that components that haven't implemented web services can add their own handling.

final

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

Methods

__construct

Constructor for Dispatcher

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

4.0.0

Arguments

$app

\Joomla\CMS\Application\CMSApplicationInterfaceThe application instance

$input

\Joomla\Input\InputThe input instance

checkAccess

Method to check component access permission

checkAccess() : void
inherited
since

4.0.0

dispatch

Dispatch a controller task. Redirecting the user if appropriate.

dispatch() : void
inherited
since

4.0.0

getApplication

The application the dispatcher is working with.

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

getController

Get a controller from the component

getController(string $name, string $client = '', array $config = array()) : \Joomla\CMS\MVC\Controller\BaseController
inherited
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
inherited
since

4.0.0

Properties

option

The URL option for the component.

inherited
since

4.0.0

Type(s)

string

mvcFactory

The MVC factory

inherited

app

The application instance

inherited

input

The input instance

inherited
since

4.0.0

Type(s)

\Joomla\Input\Input