Class **Phalcon\\Cli\\Dispatcher**
==================================

*extends* abstract class :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

*implements* :doc:`Phalcon\\Events\\EventsAwareInterface <Phalcon_Events_EventsAwareInterface>`, :doc:`Phalcon\\Di\\InjectionAwareInterface <Phalcon_Di_InjectionAwareInterface>`, :doc:`Phalcon\\DispatcherInterface <Phalcon_DispatcherInterface>`, :doc:`Phalcon\\Cli\\DispatcherInterface <Phalcon_Cli_DispatcherInterface>`

.. role:: raw-html(raw)
   :format: html

:raw-html:`<a href="https://github.com/phalcon/cphalcon/blob/master/phalcon/cli/dispatcher.zep" class="btn btn-default btn-sm">Source on GitHub</a>`

Dispatching is the process of taking the command-line arguments, extracting the module name, task name, action name, and optional parameters contained in it, and then instantiating a task and calling an action on it.  

.. code-block:: php

    <?php

    $di = new \Phalcon\Di();
    
    $dispatcher = new \Phalcon\Cli\Dispatcher();
    
      $dispatcher->setDi(di);
    
    $dispatcher->setTaskName('posts');
    $dispatcher->setActionName('index');
    $dispatcher->setParams(array());
    
    $handle = dispatcher->dispatch();



Constants
---------

*integer* **EXCEPTION_NO_DI**

*integer* **EXCEPTION_CYCLIC_ROUTING**

*integer* **EXCEPTION_HANDLER_NOT_FOUND**

*integer* **EXCEPTION_INVALID_HANDLER**

*integer* **EXCEPTION_INVALID_PARAMS**

*integer* **EXCEPTION_ACTION_NOT_FOUND**

Methods
-------

public  **setTaskSuffix** (*mixed* $taskSuffix)

Sets the default task suffix



public  **setDefaultTask** (*mixed* $taskName)

Sets the default task name



public  **setTaskName** (*mixed* $taskName)

Sets the task name to be dispatched



public  **getTaskName** ()

Gets last dispatched task name



protected  **_throwDispatchException** (*mixed* $message, [*mixed* $exceptionCode])

Throws an internal exception



protected  **_handleException** (`Exception <http://php.net/manual/en/class.exception.php>`_ $exception)

Handles a user exception



public  **getLastTask** ()

Returns the lastest dispatched controller



public  **getActiveTask** ()

Returns the active task in the dispatcher



public  **setOptions** (*array* $options)

Set the options to be dispatched



public  **getOptions** ()

Get dispatched options



public  **callActionMethod** (*mixed* $handler, *mixed* $actionMethod, [*array* $params])

...


public  **setDI** (:doc:`Phalcon\\DiInterface <Phalcon_DiInterface>` $dependencyInjector) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the dependency injector



public  **getDI** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Returns the internal dependency injector



public  **setEventsManager** (:doc:`Phalcon\\Events\\ManagerInterface <Phalcon_Events_ManagerInterface>` $eventsManager) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the events manager



public  **getEventsManager** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Returns the internal event manager



public  **setActionSuffix** (*mixed* $actionSuffix) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the default action suffix



public  **getActionSuffix** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets the default action suffix



public  **setModuleName** (*mixed* $moduleName) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the module where the controller is (only informative)



public  **getModuleName** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets the module where the controller class is



public  **setNamespaceName** (*mixed* $namespaceName) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the namespace where the controller class is



public  **getNamespaceName** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets a namespace to be prepended to the current handler name



public  **setDefaultNamespace** (*mixed* $namespaceName) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the default namespace



public  **getDefaultNamespace** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Returns the default namespace



public  **setDefaultAction** (*mixed* $actionName) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the default action name



public  **setActionName** (*mixed* $actionName) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the action name to be dispatched



public  **getActionName** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets the latest dispatched action name



public  **setParams** (*array* $params) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets action params to be dispatched



public  **getParams** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets action params



public  **setParam** (*mixed* $param, *mixed* $value) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Set a param by its name or numeric index



public *mixed* **getParam** (*mixed* $param, [*string* | *array* $filters], [*mixed* $defaultValue]) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Gets a param by its name or numeric index



public *boolean* **hasParam** (*mixed* $param) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Check if a param exists



public  **getActiveMethod** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Returns the current method to be/executed in the dispatcher



public  **isFinished** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Checks if the dispatch loop is finished or has more pendent controllers/tasks to dispatch



public  **setReturnedValue** (*mixed* $value) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Sets the latest returned value by an action manually



public *mixed* **getReturnedValue** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Returns value returned by the latest dispatched action



public  **setModelBinding** (*boolean* $value) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Enable/Disable model binding during dispatch



public *object* **dispatch** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Dispatches a handle action taking into account the routing parameters



protected *object* **_dispatch** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Dispatches a handle action taking into account the routing parameters



public  **forward** (*array* $forward) inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Forwards the execution flow to another controller/action Dispatchers are unique per module. Forwarding between modules is not allowed 

.. code-block:: php

    <?php

      $this->dispatcher->forward(array("controller" => "posts", "action" => "index"));




public  **wasForwarded** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Check if the current executed action was forwarded by another one



public  **getHandlerClass** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Possible class name that will be located to dispatch the request



protected  **_resolveEmptyProperties** () inherited from :doc:`Phalcon\\Dispatcher <Phalcon_Dispatcher>`

Set empty properties to their defaults (where defaults are available)