IRoute Interface Reference
[Interfaces]
A route checks if a given url can be processed and invokes the according functions. More...
Inheritance diagram for IRoute:
Public Member Functions |
|
| get_renderer ($page_data) | |
| Returns a suitable renderer. |
|
| identify () | |
| Return a string that identifies this Route -
e.g for debug purposes. |
|
| initialize ($data) | |
| Initialize the data passed. |
|
| is_directory () | |
| Returns true, if this route is a directory
(that is: ends with '/'). |
|
| weight_against_path ($path) | |
| Weight this token against path. |
|
Public Attributes |
|
| const | WEIGHT_FULL_MATCH = 0 |
| const | WEIGHT_NO_MATCH = 10000 |
Detailed Description
A route checks if a given url can be processed and invokes the according functions.
Definition at line 8 of file iroute.cls.php.
Member Function Documentation
| IRoute::get_renderer | ( | $ | page_data | ) |
| IRoute::identify | ( | ) |
Return a string that identifies this Route - e.g for debug purposes.
Implemented in NotFoundRoute, and RouteBase.
| IRoute::initialize | ( | $ | data | ) |
Initialize the data passed.
Implemented in RouteBase.
| IRoute::is_directory | ( | ) |
Returns true, if this route is a directory (that is: ends with '/').
Implemented in RouteBase.
| IRoute::weight_against_path | ( | $ | path | ) |
Weight this token against path.
Implemented in CatchAllRoute, ExactMatchRoute, ParameterizedRoute, RouteBase, and StaticPageParamterizedRoute.
Member Data Documentation
| const IRoute::WEIGHT_FULL_MATCH = 0 |
Definition at line 10 of file iroute.cls.php.
| const IRoute::WEIGHT_NO_MATCH = 10000 |
Definition at line 9 of file iroute.cls.php.
The documentation for this interface was generated from the following file:
- gyro/core/lib/interfaces/iroute.cls.php