API Documentation

Zend/Controller/Router/Abstract.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: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Router_Abstract

Package: Zend\Controller\Router

Simple first implementation of a router, to be replaced with rules-based URI processor.

Implements
\Zend_Controller_Router_Interface
Children
\Zend_Controller_Router_Rewrite
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

Constant  URI_DELIMITER = '/'

URI delimiter

Properties

Propertyprotected\Zend_Controller_Front  $_frontController= ''

Front controller instance

Details
Type
\Zend_Controller_Front
Propertyprotectedarray  $_invokeParams= 'array()'

Array of invocation parameters to use when instantiating action controllers

Default valuearray()Details
Type
array

Methods

methodpublic__construct( array $params = array() ) : void

Constructor

Parameters
Name Type Description
$params array
methodpublicclearParams( null|string|array $name = null ) : \Zend_Controller_Router

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.

Parameters
Name Type Description
$name null|string|array

single key or array of keys for params to clear

Returns
Type Description
\Zend_Controller_Router
methodpublicgetFrontController( ) : \Zend_Controller_Front

Retrieve Front Controller

Returns
Type Description
\Zend_Controller_Front
methodpublicgetParam( string $name ) : mixed

Retrieve a single parameter from the controller parameter stack

Parameters
Name Type Description
$name string
Returns
Type Description
mixed
methodpublicgetParams( ) : array

Retrieve action controller instantiation parameters

Returns
Type Description
array
methodpublicsetFrontController( \Zend_Controller_Front $controller ) : \Zend_Controller_Router_Interface

Set Front Controller

Parameters
Name Type Description
$controller \Zend_Controller_Front
Returns
Type Description
\Zend_Controller_Router_Interface
methodpublicsetParam( string $name, mixed $value ) : \Zend_Controller_Router

Add or modify a parameter to use when instantiating an action controller

Parameters
Name Type Description
$name string
$value mixed
Returns
Type Description
\Zend_Controller_Router
methodpublicsetParams( array $params ) : \Zend_Controller_Router

Set parameters to pass to action controller constructors

Parameters
Name Type Description
$params array
Returns
Type Description
\Zend_Controller_Router
Documentation was generated by DocBlox 0.15.1.