ApiDispatcher
Extends ComponentDispatcherAPI 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.
| since |
4.0.0 |
|---|---|
| package |
Joomla CMS |
Methods
__construct
Constructor for ComponentDispatcher
__construct(\Joomla\CMS\Application\CMSApplicationInterface app, \Joomla\Input\Input input, \Joomla\CMS\MVC\Factory\MVCFactoryInterface mvcFactory) :
| since |
4.0.0 |
|---|
Arguments
- app
CMSApplicationInterfaceThe application instance- input
InputThe input instance- mvcFactory
MVCFactoryInterfaceThe MVC factory instance
Response
mixed
checkAccess
Method to check component access permission
checkAccess() :
| since |
4.0.0 |
|---|
Response
void
dispatch
Dispatch a controller task. API Overrides to ensure there is no redirects.
dispatch() :
| since |
4.0.0 |
|---|
Response
void
getApplication
The application the dispatcher is working with.
getApplication() : \Joomla\CMS\Application\CMSApplicationInterface
getController
Get a controller from the component
getController( name, client = '', mixed||string|int config = []) : \Joomla\CMS\MVC\Controller\BaseController
| since |
4.0.0 |
|---|
Arguments
- name
stringController name- client
stringOptional client (like Administrator, Site etc.)- config
array<string|int, mixed>Optional controller config
Response
loadLanguage
Load the component's administrator language
loadLanguage() :
| since |
4.0.0 |
|---|
Response
void
Properties
input
The input instance
| since |
4.0.0 |
|---|
Type(s)
Input
option
The URL option for the component.
| since |
4.0.0 |
|---|
Type(s)
string