API Documentation

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

\Zend_Controller_Router_Route_Module

Package: Zend\Controller\Router

Module Route

Default route for module functionality

Parent(s)
\Zend_Controller_Router_Route_Abstract
Children
\Zend_Rest_Route
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

Propertyprotected  $_actionKey= ''action''
Default value'action'Details
Type
Propertyprotected  $_controllerKey= ''controller''
Default value'controller'Details
Type
Propertyprotectedarray  $_defaults= ''

Default values for the route (ie. module, controller, action, params)

Details
Type
array
Propertyprotected\Zend_Controller_Dispatcher_Interface  $_dispatcher= ''

Propertyprotected  $_keysSet= 'false'
Default valuefalseDetails
Type
Propertyprotected  $_moduleKey= ''module''
Default value'module'Details
Type
Propertyprotected  $_moduleValid= 'false'
Default valuefalseDetails
Type
Propertyprotected\Zend_Controller_Request_Abstract  $_request= ''

Propertyprotected  $_values= 'array()'
Default valuearray()Details
Type

Methods

methodpublic__construct( array $defaults = array(), \Zend_Controller_Dispatcher_Interface $dispatcher = null, \Zend_Controller_Request_Abstract $request = null ) : void

Constructor

Parameters
Name Type Description
$defaults array

Defaults for map variables with keys as variable names

$dispatcher \Zend_Controller_Dispatcher_Interface

Dispatcher object

$request \Zend_Controller_Request_Abstract

Request object

methodprotected_setRequestKeys( ) : void

Set request keys based on values in request object

methodpublicassemble( array $data = array(), bool $reset = false,  $encode = true,  $partial = false ) : string

Assembles user submitted parameters forming a URL path defined by this route

Parameters
Name Type Description
$data array

An array of variable and value pairs used as parameters

$reset bool

Weither to reset the current params

$encode
$partial
Returns
Type Description
string Route path with user submitted parameters
methodpublicgetDefault( string $name ) : string

Return a single parameter of route's defaults

Parameters
Name Type Description
$name string

Array key of the parameter

Returns
Type Description
string Previously set default
methodpublicgetDefaults( ) : array

Return an array of defaults

Returns
Type Description
array Route defaults
methodpublicgetInstance(  $config ) : void
static

Instantiates route based on passed Zend_Config structure

Parameters
Name Type Description
$config
methodpublicgetVersion( ) : void

methodpublicmatch( string $path,  $partial = false ) : array

Matches a user submitted path. Assigns and returns an array of variables on a successful match.

If a request object is registered, it uses its setModuleName(), setControllerName(), and setActionName() accessors to set those values. Always returns the values as an array.

Parameters
Name Type Description
$path string

Path used to match against this routing map

$partial
Returns
Type Description
array An array of assigned values or a false on a mismatch
Documentation was generated by DocBlox 0.15.1.