API Documentation

Zend/Controller/Router/Rewrite.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Subpackage
Router  
Version
$Id: Rewrite.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Router_Rewrite

Package: Zend\Controller\Router

Ruby routing based Router.

Parent(s)
\Zend_Controller_Router_Abstract
See
\http://manuals.rubyonrails.com/read/chapter/65  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_chainNameSeparator= ''-''

Separator to use with chain names

Default value'-'Details
Type
string
Propertyprotected\Zend_Controller_Router_Route_Interface  $_currentRoute= 'null'

Currently matched route

Default valuenullDetails
Type
\Zend_Controller_Router_Route_Interface
Propertyprotectedarray  $_globalParams= 'array()'

Global parameters given to all routes

Default valuearray()Details
Type
array
Propertyprotectedarray  $_routes= 'array()'

Array of routes to match against

Default valuearray()Details
Type
array
Propertyprotectedboolean  $_useCurrentParamsAsGlobal= 'false'

Determines if request parameters should be used as global parameters inside this router.

Default valuefalseDetails
Type
boolean
Propertyprotectedboolean  $_useDefaultRoutes= 'true'

Whether or not to use default routes

Default valuetrueDetails
Type
boolean

Methods

methodprotected_addChainRoutesFromConfig( string $name, \Zend_Controller_Router_Route_Interface $route, \Zend_Config $childRoutesInfo ) : void

Add chain routes from a config route

Parameters
Name Type Description
$name string
$route \Zend_Controller_Router_Route_Interface
$childRoutesInfo \Zend_Config
methodprotected_getRouteFromConfig( \Zend_Config $info ) : \Zend_Controller_Router_Route_Interface

Get a route frm a config instance

Parameters
Name Type Description
$info \Zend_Config
Returns
Type Description
\Zend_Controller_Router_Route_Interface
methodprotected_setRequestParams(  $request,  $params ) : void

Parameters
Name Type Description
$request
$params
methodpublicaddConfig( \Zend_Config $config, string $section = null ) : \Zend_Controller_Router_Rewrite

Create routes out of Zend_Config configuration

Example INI: routes.archive.route = "archive/:year/*" routes.archive.defaults.controller = archive routes.archive.defaults.action = show routes.archive.defaults.year = 2000 routes.archive.reqs.year = "\d+"

routes.news.type = "Zend_Controller_Router_Route_Static" routes.news.route = "news" routes.news.defaults.controller = "news" routes.news.defaults.action = "list"

And finally after you have created a Zend_Config with above ini: $router = new Zend_Controller_Router_Rewrite(); $router->addConfig($config, 'routes');

Parameters
Name Type Description
$config \Zend_Config

Configuration object

$section string

Name of the config section containing route's definitions

Returns
Type Description
\Zend_Controller_Router_Rewrite
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicaddDefaultRoutes( ) : \Zend_Controller_Router_Rewrite

Add default routes which are used to mimic basic router behaviour

Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicaddRoute( string $name, \Zend_Controller_Router_Route_Interface $route ) : \Zend_Controller_Router_Rewrite

Add route to the route chain

If route contains method setRequest(), it is initialized with a request object

Parameters
Name Type Description
$name string

Name of the route

$route \Zend_Controller_Router_Route_Interface

Instance of the route

Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicaddRoutes( array $routes ) : \Zend_Controller_Router_Rewrite

Add routes to the route chain

Parameters
Name Type Description
$routes array

Array of routes with names as keys and routes as values

Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicassemble( 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.

Parameters
Name Type Description
$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

Returns
Type Description
string Resulting absolute URL path
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicgetChainNameSeparator( ) : string

Get the separator to use for chain names

Returns
Type Description
string
methodpublicgetCurrentRoute( ) : \Zend_Controller_Router_Route_Interface

Retrieve a currently matched route

Returns
Type Description
\Zend_Controller_Router_Route_Interface Route object
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicgetCurrentRouteName( ) : \Zend_Controller_Router_Route_Interface

Retrieve a name of currently matched route

Returns
Type Description
\Zend_Controller_Router_Route_Interface Route object
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicgetRoute( string $name ) : \Zend_Controller_Router_Route_Interface

Retrieve a named route

Parameters
Name Type Description
$name string

Name of the route

Returns
Type Description
\Zend_Controller_Router_Route_Interface Route object
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicgetRoutes( ) : array

Retrieve an array of routes added to the route chain

Returns
Type Description
array All of the defined routes
methodpublichasRoute( string $name ) : boolean

Check if named route exists

Parameters
Name Type Description
$name string

Name of the route

Returns
Type Description
boolean
methodpublicremoveDefaultRoutes( ) : \Zend_Controller_Router_Rewrite

Remove all standard default routes

Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicremoveRoute( string $name ) : \Zend_Controller_Router_Rewrite

Remove a route from the route chain

Parameters
Name Type Description
$name string

Name of the route

Returns
Type Description
\Zend_Controller_Router_Rewrite
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicroute(  $request ) : \Zend_Controller_Request_Abstract

Find a matching route to the current PATH_INFO and inject returning values to the Request object.

Parameters
Name Type Description
$request
Returns
Type Description
\Zend_Controller_Request_Abstract Request object
Throws
Exception Description
\Zend_Controller_Router_Exception
methodpublicsetChainNameSeparator( string $separator ) : \Zend_Controller_Router_Rewrite

Set the separator to use with chain names

Parameters
Name Type Description
$separator string

The separator to use

Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicsetGlobalParam( string $name, mixed $value ) : \Zend_Controller_Router_Rewrite

Set a global parameter

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Controller_Router_Rewrite
methodpublicuseRequestParametersAsGlobal( boolean|null $use = null ) : boolean|\Zend_Controller_Router_Rewrite

Determines/returns whether to use the request parameters as global parameters.

Parameters
Name Type Description
$use boolean|null

Null/unset when you want to retrieve the current state. True when request parameters should be global, false otherwise

Returns
Type Description
boolean|\Zend_Controller_Router_Rewrite Returns a boolean if first param isn't set, returns an instance of Zend_Controller_Router_Rewrite otherwise.
Documentation was generated by DocBlox 0.15.1.