ClassInterface Zend_Controller_Router_Interface

Description
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Controller/Router/Interface.php (line 29)


	
			
Method Summary
 string assemble (array $userParams, [mixed $name = null], [bool $reset = false], [bool $encode = true])
 Zend_Controller_Router_Interface clearParams ([null|string|array $name = null])
 mixed getParam (string $name)
 array getParams ()
 Zend_Controller_Router_Interface setParam (string $name,  $value, mixed $param)
Methods
assemble (line 63)

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.

  • return: Resulting URL path
  • throws: Zend_Controller_Router_Exception
  • access: public
string assemble (array $userParams, [mixed $name = null], [bool $reset = false], [bool $encode = true])
  • array $userParams: Options passed by a user used to override parameters
  • mixed $name: The name of a Route to use
  • bool $reset: Whether to reset to the route defaults ignoring URL params
  • bool $encode: Tells to encode URL parts on output
clearParams (line 122)

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.

  • access: public
Zend_Controller_Router_Interface clearParams ([null|string|array $name = null])
  • null|string|array $name: single key or array of keys for params to clear
getFrontController (line 70)

Retrieve Front Controller

  • access: public
Zend_Controller_Front getFrontController ()
getParam (line 103)

Retrieve a single parameter from the controller parameter stack

  • access: public
mixed getParam (string $name)
  • string $name
getParams (line 110)

Retrieve the parameters to pass to helper object constructors

  • access: public
array getParams ()
route (line 39)

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

  • throws: Zend_Controller_Router_Exception
  • access: public
setFrontController (line 78)

Set Front Controller

  • access: public
Zend_Controller_Router_Interface setFrontController (Zend_Controller_Front $controller)
setParam (line 87)

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

  • access: public
Zend_Controller_Router_Interface setParam (string $name,  $value, mixed $param)
  • string $name
  • mixed $param
  • $value
setParams (line 95)

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

  • access: public
Zend_Controller_Router_Interface setParams ( $params)
  • array $params

Documentation generated on Mon, 21 Jun 2010 15:29:35 -0400 by phpDocumentor 1.4.3