API Documentation

Controller/Router/Abstract.php

Includes Classes 
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: Abstract.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Controller_Router_Abstract

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_Abstract
jump to top

Implements
Zend_Controller_Router_Interface
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
Properties
$_frontController
$_invokeParams
Methods
__construct
setParam
setParams
getParam
getParams
clearParams
getFrontController
setFrontController

Description

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

Properties

$_frontController
jump to class

Zend_Controller_Front $_frontController = ''

Front controller instance

Details

$_frontController
Zend_Controller_Front
visibility
protected
default
final
false
static
false

$_invokeParams
jump to class

array $_invokeParams = 'array'

Array of invocation parameters to use when instantiating action controllers

Details

$_invokeParams
array
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( array $params = array ) : void

Constructor

Arguments
$params
array
Details
visibility
public
final
false
static
false

clearParams
jump to class

clearParams( 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.

Arguments
$name
nullstringarray
single key or array of keys for params to clear
Output
Zend_Controller_Router
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 action controller instantiation parameters

Output
array
Details
visibility
public
final
false
static
false

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, mixed $value ) : Zend_Controller_Router

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

Arguments
$name
string
$value
mixed
Output
Zend_Controller_Router
Details
visibility
public
final
false
static
false

setParams
jump to class

setParams( array $params ) : Zend_Controller_Router

Set parameters to pass to action controller constructors

Arguments
$params
array
Output
Zend_Controller_Router
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.