Class: ComDefaultDispatcher

Source Location: /administrator/components/com_default/dispatcher.php

Class Overview

KObject
   |
   --KControllerAbstract
      |
      --KDispatcherAbstract
         |
         --KDispatcherDefault
            |
            --ComDefaultDispatcher

Default Dispatcher Class

Author(s):

Johan Janssens <johan@nooku.org>

Implements interfaces:

KServiceInstantiatable

Methods

Inherited Variables

Inherited Methods

Class: KDispatcherAbstract

KDispatcherAbstract::__construct(): Constructor.
KDispatcherAbstract::getController(): Method to get a controller object
KDispatcherAbstract::setController(): Method to set a controller object attached to the dispatcher
KDispatcherAbstract::_actionDispatch(): Dispatch the controller
KDispatcherAbstract::_actionForward(): Forward after a post request
KDispatcherAbstract::_actionRender(): Push the controller data into the document
KDispatcherAbstract::_initialize(): Initializes the options for the object

Class: KControllerAbstract

KControllerAbstract::__construct(): Constructor.
KControllerAbstract::execute(): Execute an action by triggering a method in the derived class.
KControllerAbstract::getActions(): Gets the available actions in the controller.
KControllerAbstract::getRequest(): Get the request information
KControllerAbstract::isDispatched(): Has the controller been dispatched
KControllerAbstract::mixin(): Mixin an object
KControllerAbstract::registerActionAlias(): Register (map) an action to a method in the class.
KControllerAbstract::setRequest(): Set the request information
KControllerAbstract::_initialize(): Initializes the default configuration for the object
KControllerAbstract::__call(): Execute a controller action by it's name.
KControllerAbstract::__get(): Get a request property
KControllerAbstract::__set(): Set a request properties

Class: KObject

KObject::__construct(): Constructor
KObject::get(): Get the object properties
KObject::getHandle(): Get a handle for this object
KObject::getIdentifier(): Gets the service identifier.
KObject::getMethods(): Get a list of all the available methods
KObject::getService(): Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits(): Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin(): Mixin an object
KObject::set(): Set the object properties
KObject::_initialize(): Initializes the options for the object
KObject::__call(): Search the mixin method map and call the method or trigger an error
KObject::__clone(): Preform a deep clone of the object.

Class Details

[line 18]
Default Dispatcher Class

Tags:

author:

Johan Janssens <johan@nooku.org>

[ Top ]

Class Methods

static method getInstance [line 45]

static KDispatcherDefault getInstance(

$config, 
$container)

Force creation of a singleton

Tags:

access:

public

Parameters:

object An	$config	optional KConfig object with configuration options
object A	$container	KServiceInterface object

[ Top ]

method _actionDispatch [line 75]

KDispatcherDefault _actionDispatch(

$context)

Dispatch the controller and redirect

This function divert the standard behavior and will redirect if no view information can be found in the request.

Tags:

access:

protected

Overrides KDispatcherAbstract::_actionDispatch() (Dispatch the controller)

Parameters:

string

$context

The view to dispatch. If null, it will default to retrieve the controller information from the request or default to the component name if no controller info can be found.

[ Top ]

method _actionRender [line 92]

KDispatcherDefault _actionRender(

$context)

Set the mimetype of the document and hide the menu if required

Tags:

access:

protected

Overrides KDispatcherAbstract::_actionRender() (Push the controller data into the document)

Parameters:

KCommandContext

$context

[ Top ]

method _initialize [line 28]

void _initialize(

$config)

Initializes the options for the object

Called from __construct() as a first step of object instantiation.

Tags:

access:

protected

Overrides KDispatcherAbstract::_initialize() (Initializes the options for the object)

Parameters:

object An

$config

optional KConfig object with configuration options.

[ Top ]

Documentation generated on Tue, 21 May 2013 03:03:00 +0200 by phpDocumentor 1.4.3