Controller/Router/Interface.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Router
version: $Id: Interface.php 20096 2010-01-06 02:05:09Z bkarwin $
Interfaces: Zend_Controller_Router_Interface

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Controller_Router_Interface
jump to top

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
subpackage: Router
Methods: route; assemble; getFrontController; setFrontController; setParam; setParams; getParam; getParams; clearParams

Description

Methods

assemble
jump to class

assemble(
          array $userParams, mixed $name
              =
              null, bool $reset
              =
              false, bool $encode
              =
              true
          )
        
        :
        string

Generates a URL path that can be used in URL creation, redirection, etc.

May be passed user params to override ones from URI, Request or even defaults. If passed parameter has a value of null, it's URL variable will be reset to default.

If null is passed as a route name assemble will use the current Route or 'default' if current is not yet set.

Reset is used to signal that all parameters should be reset to it's defaults. Ignoring all URL specified values. User specified params still get precedence.

Encode tells to url encode resulting path parts.

Arguments

$userParams: array
Options passed by a user used to override parameters
$name: mixed
The name of a Route to use
$reset: bool
Whether to reset to the route defaults ignoring URL params
$encode: bool
Tells to encode URL parts on output

Output

string: Resulting URL path

Details

visibility: public
final: false
static: false
throws

clearParams
jump to class

clearParams(
          null|string|array $name
              =
              null
          )
        
        :
        Zend_Controller_Router_Interface

Clear the controller parameter stack

By default, clears all parameters. If a parameter name is given, clears only that parameter; if an array of parameter names is provided, clears each.

Arguments

$name: nullstringarray
single key or array of keys for params to clear

Output

Zend_Controller_Router_Interface

Details

visibility: public
final: false
static: false

getFrontController
jump to class

getFrontController(
          
          )
        
        :
        Zend_Controller_Front

Retrieve Front Controller

Output

Zend_Controller_Front

Details

visibility: public
final: false
static: false

getParam
jump to class

getParam(
          string $name
          )
        
        :
        mixed

Retrieve a single parameter from the controller parameter stack

Arguments

$name: string

Output

mixed

Details

visibility: public
final: false
static: false

getParams
jump to class

getParams(
          
          )
        
        :
        array

Retrieve the parameters to pass to helper object constructors

Output

array

Details

visibility: public
final: false
static: false

route
jump to class

route(
           $dispatcher
          )
        
        :
        Zend_Controller_Request_Abstract|boolean

Processes a request and sets its controller and action. If no route was possible, an exception is thrown.

Arguments

$dispatcher: Zend_Controller_Request_Abstract

Output

Zend_Controller_Request_Abstract|boolean

Details

visibility: public
final: false
static: false
throws

setFrontController
jump to class

setFrontController(
          Zend_Controller_Front $controller
          )
        
        :
        Zend_Controller_Router_Interface

Set Front Controller

Arguments

$controller: Zend_Controller_Front

Output

Zend_Controller_Router_Interface

Details

visibility: public
final: false
static: false

setParam
jump to class

setParam(
          string $name,  $value
          )
        
        :
        Zend_Controller_Router_Interface

Add or modify a parameter with which to instantiate any helper objects

Arguments

$name: string
$value

Output

Zend_Controller_Router_Interface

Details

visibility: public
final: false
static: false

setParams
jump to class

setParams(
          array $params
          )
        
        :
        Zend_Controller_Router_Interface

Set an array of a parameters to pass to helper object constructors

Arguments

$params: array

Output

Zend_Controller_Router_Interface

Details

visibility: public
final: false
static: false

API Documentation

Controller/Router/Interface.php

Description

Zend_Controller_Router_Interfacejump to top

Description

Methods

assemblejump to class

Arguments

Output

Details

clearParamsjump to class

Arguments

Output

Details

getFrontControllerjump to class

Output

Details

getParamjump to class

Arguments

Output

Details

getParamsjump to class

Output

Details

routejump to class

Arguments

Output

Details

setFrontControllerjump to class

Arguments

Output

Details

setParamjump to class

Arguments

Output

Details

setParamsjump to class

Arguments

Output

Details

Zend_Controller_Router_Interface
jump to top

assemble
jump to class

clearParams
jump to class

getFrontController
jump to class

getParam
jump to class

getParams
jump to class

route
jump to class

setFrontController
jump to class

setParam
jump to class

setParams
jump to class