Controller/Router/Abstract.php

Show: PublicProtectedPrivateinherited
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 24593 2012-01-05 20:35:02Z 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

>VConstant  URI_DELIMITER = '/'
URI delimiter

Properties

>VPropertyprotected\Zend_Controller_Front $_frontController
Front controller instance
>VPropertyprotectedarray $_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
NameTypeDescription
$paramsarray
methodpublicassemble(array $userParams, mixed $name = null, bool $reset = false, bool $encode = true) : string
inherited

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

Inherited from: \Zend_Controller_Router_Interface::assemble()

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.

Parameters
NameTypeDescription
$userParamsarray

Options passed by a user used to override parameters

$namemixed

The name of a Route to use

$resetbool

Whether to reset to the route defaults ignoring URL params

$encodebool

Tells to encode URL parts on output

Returns
TypeDescription
stringResulting URL path
Throws
ExceptionDescription
\Zend_Controller_Router_Exception
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
NameTypeDescription
$namenull | string | array

single key or array of keys for params to clear

Returns
TypeDescription
\Zend_Controller_Router
methodpublicgetFrontController() : \Zend_Controller_Front

Retrieve Front Controller

Returns
TypeDescription
\Zend_Controller_Front
methodpublicgetParam(string $name) : mixed

Retrieve a single parameter from the controller parameter stack

Parameters
NameTypeDescription
$namestring
Returns
TypeDescription
mixed
methodpublicgetParams() : array

Retrieve action controller instantiation parameters

Returns
TypeDescription
array
methodpublicroute(\Zend_Controller_Request_Abstract $dispatcher) : \Zend_Controller_Request_Abstract | boolean
inherited

Processes a request and sets its controller and action.

Inherited from: \Zend_Controller_Router_Interface::route()

If no route was possible, an exception is thrown.

Parameters
NameTypeDescription
$dispatcher\Zend_Controller_Request_Abstract
Returns
TypeDescription
\Zend_Controller_Request_Abstract | boolean
Throws
ExceptionDescription
\Zend_Controller_Router_Exception
methodpublicsetFrontController(\Zend_Controller_Front $controller) : \Zend_Controller_Router_Interface

Set Front Controller

Parameters
NameTypeDescription
$controller\Zend_Controller_Front
Returns
TypeDescription
\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
NameTypeDescription
$namestring
$valuemixed
Returns
TypeDescription
\Zend_Controller_Router
methodpublicsetParams(array $params) : \Zend_Controller_Router

Set parameters to pass to action controller constructors

Parameters
NameTypeDescription
$paramsarray
Returns
TypeDescription
\Zend_Controller_Router
Documentation was generated by phpDocumentor 2.0.0a12.