1. class
  2. Joomla
  3. \
  4. CMS
  5. \
  6. Dispatcher
  7. \
  8. ModuleDispatcher

ModuleDispatcher

Since: 4.0.0

class ModuleDispatcher extends AbstractModuleDispatcher

Base class for a Joomla Module Dispatcher

Executes the single entry file of a module.

Properties

protected CMSApplicationInterface Since: 4.0.0
$app

The application instance

 from  Dispatcher
protected Input Since: 4.0.0
$input

The input instance

 from  Dispatcher
protected stdClass Since: 4.0.0
$module

The module instance

 from  AbstractModuleDispatcher

Methods

__construct(stdClass $module, CMSApplicationInterface $app, Input $input)

Constructor for Dispatcher

from  AbstractModuleDispatcher
CMSApplicationInterface
getApplication()

The application the dispatcher is working with.

from  Dispatcher
void
dispatch()

Dispatches the dispatcher.

array|false
getLayoutData()

Returns the layout data. This function can be overridden by subclasses to add more attributes for the layout.

from  AbstractModuleDispatcher
void
loadLanguage()

Load the language.

from  AbstractModuleDispatcher

Details

__construct(stdClass $module, CMSApplicationInterface $app, Input $input)

Since: 4.0.0

Constructor for Dispatcher

Parameters

stdClass $module

The module
CMSApplicationInterface $app

The application instance
Input $input

The input instance

protected CMSApplicationInterface getApplication()

Since: 4.0.0

The application the dispatcher is working with.

Return Value

CMSApplicationInterface

void dispatch()

Since: 4.0.0

Dispatches the dispatcher.

Return Value

void

protected array|false getLayoutData()

Since: 4.0.0

Returns the layout data. This function can be overridden by subclasses to add more attributes for the layout.

If false is returned, then it means that the dispatch process should be stopped.

Return Value

array|false

protected void loadLanguage()

Since: 4.0.0

Load the language.

Return Value

void