Dispatcher

Methods

getDefaultNamespace() : void
setDefaultNamespace(variable $defaultNamespace) : void
getActiveHandler() : void
getLastHandler() : void
getLoops() : void
setLoops(variable $loops) : void
getFinished() : void
getForwards() : void
getForwarded() : void
setSilent(variable $silent) : void
getModules() : void
setModules(variable $modules) : void
getModule() : void
setModule(variable $module) : void
getNamespace() : void
setNamespace(variable $namespace) : void
getHandler() : void
setHandler(variable $handler) : void
getAction() : void
setAction(variable $action) : void
getParams() : void
setParams(variable $params) : void
getReturnedValue() : void
setReturnedValue(variable $returnedValue) : void
getHandlers() : void
setHandlers(variable $handlers) : void
getHandlerSuffix() : void
setHandlerSuffix(variable $handlerSuffix) : void
getActionSuffix() : void
setActionSuffix(variable $actionSuffix) : void
__construct() : void

Di constructor. Fetch Di and set it as a property.
hasParam(string $key) : bool

Whether or not an param exists by key.
setParam(variable $param, variable $value) : void

Set a param by its name or numeric index.
getParam(string $key, variable $filters, variable $defaultValue, bool $allowEmpty) : void

Gets variable from params attribute applying filters if needed.
getActiveMethod() : string

Returns the current method to be/executed in the dispatcher.
addModule(string $name, array $options) : void

Add module with its dir path, initial class name and namespace
dispatch() : void

Dispatches a handle action taking into account the routing parameters.
forward(array $forward, bool $force) : void

Forwards the execution flow to another module/controller/action.
reset() : void

Reset module, handler and action to default ones, and empty the params.
zephir_init_properties_Ice_Dispatcher() : void

Methods Details

public function getDefaultNamespace()
public function setDefaultNamespace(variable $defaultNamespace)
public function getActiveHandler()
public function getLastHandler()
public function getLoops()
public function setLoops(variable $loops)
public function getFinished()
public function getForwards()
public function getForwarded()
public function setSilent(variable $silent)
public function getModules()
public function setModules(variable $modules)
public function getModule()
public function setModule(variable $module)
public function getNamespace()
public function setNamespace(variable $namespace)
public function getHandler()
public function setHandler(variable $handler)
public function getAction()
public function setAction(variable $action)
public function getParams()
public function setParams(variable $params)
public function getReturnedValue()
public function setReturnedValue(variable $returnedValue)
public function getHandlers()
public function setHandlers(variable $handlers)
public function getHandlerSuffix()
public function setHandlerSuffix(variable $handlerSuffix)
public function getActionSuffix()
public function setActionSuffix(variable $actionSuffix)
public function __construct()

Di constructor. Fetch Di and set it as a property.
public function hasParam(string $key)

Whether or not an param exists by key.
public function setParam(variable $param, variable $value)

Set a param by its name or numeric index.

public function getParam(string $key, variable $filters, variable $defaultValue, bool $allowEmpty)

Gets variable from params attribute applying filters if needed.

If no parameters are given, return all.


      //Returns value from $params["id"] without sanitizing
      $id = $this->router->getParam("id");
     
      //Returns value from $params["title"] with sanitizing
      $title = $this->router->getParam("title", "escape|repeats");
     
      //Returns value from $params["id"] with a default value
      $id = $this->router->getParam("id", null, 150);

public function getActiveMethod()

Returns the current method to be/executed in the dispatcher.
public function addModule(string $name, array $options)

Add module with its dir path, initial class name and namespace
public function dispatch()

Dispatches a handle action taking into account the routing parameters.
public function forward(array $forward, bool $force)

Forwards the execution flow to another module/controller/action.
public function reset()

Reset module, handler and action to default ones, and empty the params.
internal function zephir_init_properties_Ice_Dispatcher()