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.
Rest Route
Request-aware route for RESTful modular routing

array
$_restfulControllers= 'null'
Specific Modules=>Controllers to receive RESTful routes
null
Details
__construct(
\Zend_Controller_Front $front, array $defaults
=
array, array $responders
=
array
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$front | \Zend_Controller_Front | Front Controller object |
$defaults | array | Defaults for map variables with keys as variable names |
$responders | array | Modules or controllers to receive RESTful routes |

_allRestful(
)
:
bool
Determines if RESTful routing applies to the entire app
Type | Description |
---|---|
bool |

_checkRestfulController(
string $moduleName, string $controllerName
)
:
bool
Determine if a specified module + controller combination supports RESTful routing
Name | Type | Description |
---|---|---|
$moduleName | string | |
$controllerName | string |
Type | Description |
---|---|
bool |

_checkRestfulModule(
string $moduleName
)
:
bool
Determine if a specified module supports RESTful routing
Name | Type | Description |
---|---|---|
$moduleName | string |
Type | Description |
---|---|
bool |

_fullRestfulModule(
string $moduleName
)
:
bool
Determines if RESTful routing applies to an entire module
Name | Type | Description |
---|---|---|
$moduleName | string |
Type | Description |
---|---|
bool |

_parseResponders(
array $responders
)
:
void
Parses the responders array sent to constructor to know which modules and/or controllers are RESTful
Name | Type | Description |
---|---|---|
$responders | array |

_setRequestKeys(
)
:
void
Set request keys based on values in request object
Inherited from: \Zend_Controller_Router_Route_Module::_setRequestKeys()
assemble(
array $data
=
array, bool $reset
=
false, bool $encode
=
true
)
:
string
Assembles user submitted parameters forming a URL path defined by this route
Name | Type | Description |
---|---|---|
$data | array | An array of variable and value pairs used as parameters |
$reset | bool | Weither to reset the current params |
$encode | bool | Weither to return urlencoded string |
Type | Description |
---|---|
string | Route path with user submitted parameters |

chain(
\Zend_Controller_Router_Route_Abstract $route, string $separator
=
/
)
:
\Zend_Controller_Router_Route_Chain
Create a new chain
Inherited from: \Zend_Controller_Router_Route_Abstract::chain()Name | Type | Description |
---|---|---|
$route | \Zend_Controller_Router_Route_Abstract | |
$separator | string |
Type | Description |
---|---|
\Zend_Controller_Router_Route_Chain |

getDefault(
string $name
)
:
string
Return a single parameter of route's defaults
Inherited from: \Zend_Controller_Router_Route_Module::getDefault()Name | Type | Description |
---|---|---|
$name | string | Array key of the parameter |
Type | Description |
---|---|
string | Previously set default |

getDefaults(
)
:
array
Return an array of defaults
Inherited from: \Zend_Controller_Router_Route_Module::getDefaults()Type | Description |
---|---|
array | Route defaults |

getInstance(
$config
)
:
void
Instantiates route based on passed Zend_Config structure
Name | Type | Description |
---|---|---|
$config |

getMatchedPath(
)
:
string
Get partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::getMatchedPath()Type | Description |
---|---|
string |

getVersion(
)
:
int
Tells Rewrite Router which version this Route is
Type | Description |
---|---|
int | Route "version" |

isAbstract(
boolean $flag
=
null
)
:
boolean
Check or set wether this is an abstract route or not
Inherited from: \Zend_Controller_Router_Route_Abstract::isAbstract()Name | Type | Description |
---|---|---|
$flag | boolean |
Type | Description |
---|---|
boolean |

match(
\Zend_Controller_Request_Http $request, $partial
=
false
)
:
array
Matches a user submitted request. 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.
Name | Type | Description |
---|---|---|
$request | \Zend_Controller_Request_Http | Request used to match against this routing ruleset |
$partial |
Type | Description |
---|---|
array | An array of assigned values or a false on a mismatch |

setMatchedPath(
string $path
)
:
void
Set partially matched path
Inherited from: \Zend_Controller_Router_Route_Abstract::setMatchedPath()Name | Type | Description |
---|---|---|
$path | string |