Index
A
- RouteDefinitionProvider::addRouteDefinition() — Method in class RouteDefinitionProvider
- Adds a new route definition.
C
- RouteDefinition::createFromCache() — Method in class RouteDefinition
- Returns a new RouteDefinition instance based on the cached values.
F
- RouteDefinition::formatUrl() — Method in class RouteDefinition
- Returns an encoded URL for the route based on the given parameter values.
G
- MethodNotAllowedException::getAllowedMethods() — Method in class MethodNotAllowedException
- Returns a list of allowed HTTP request methods.
- HttpMethod::getAll() — Method in class HttpMethod
- Returns list of all valid HTTP request methods.
- Route::getMethod() — Method in class Route
- Returns the requested HTTP method.
- Route::getHandler() — Method in class Route
- Returns the handler for the requested route.
- Route::getPath() — Method in class Route
- Returns the unencoded canonical path for the requested route.
- Route::getUrl() — Method in class Route
- Returns the encoded URL for the requested route.
- Route::getParameter() — Method in class Route
- Returns the value for the given parameter from the requested route.
- Route::getParameters() — Method in class Route
- Returns all parameters from the requested route as an associative array.
- RouteDefinition::getDefinitionCache() — Method in class RouteDefinition
- Returns cached values for the RouteDefinition that can be used to instantiate a new RouteDefinition.
- RouteDefinition::getName() — Method in class RouteDefinition
- Returns the name of the route.
- RouteDefinition::getMethods() — Method in class RouteDefinition
- Returns the allowed methods for the route.
- RouteDefinition::getSegments() — Method in class RouteDefinition
- Returns the static segments for the route.
- RouteDefinition::getHandler() — Method in class RouteDefinition
- Returns the route handler.
- RouteDefinitionProvider::getCacheFile() — Method in class RouteDefinitionProvider
- Returns PHP code for cached RouteDefinitionProvider that can be stored in file and included.
- RouteDefinitionProvider::getRoutesByStaticPath() — Method in class RouteDefinitionProvider
- Returns route ids for routes with specific static path.
- RouteDefinitionProvider::getRoutesBySegmentCount() — Method in class RouteDefinitionProvider
- Returns route ids with specific segment count.
- RouteDefinitionProvider::getRoutesBySegmentValue() — Method in class RouteDefinitionProvider
- Returns route ids with specific value for specific segment.
- RouteDefinitionProvider::getRouteDefinition() — Method in class RouteDefinitionProvider
- Returns a route definition by a specific id.
- RouteDefinitionProvider::getRouteDefinitionByName() — Method in class RouteDefinitionProvider
- Returns a route definition by the name of the route.
- Router::generateUrl() — Method in class Router
- Returns the encoded URL for the route with the given name.
H
- HttpMethod — Class in namespace Simply\Router
- Provides valid values for the HTTP request method.
- RouteDefinition::hasSlash() — Method in class RouteDefinition
- Tells if the canonical route path ends in a forward slash or not.
I
- HttpMethod::isValid() — Method in class HttpMethod
- Tells if the given string is a valid HTTP request method.
- RouteDefinition::isStatic() — Method in class RouteDefinition
- Tells if the path is completely static without any dynamic segments.
- RouteDefinition::isMethodAllowed() — Method in class RouteDefinition
- Tells if the given HTTP request method is allowed by the route.
M
- MethodNotAllowedException — Class in namespace Simply\Router\Exception
- Exception that is thrown when the path matches, but the HTTP request method does not match any known route.
- RouteDefinition::matchPatterns() — Method in class RouteDefinition
- Matches the given segments against the dynamic path segments.
R
- RouteNotFoundException — Class in namespace Simply\Router\Exception
- Exception that is thrown when the requested path does not match any route.
- RoutingException — Class in namespace Simply\Router\Exception
- Base class for exceptions thrown that occur during routing.
- Route — Class in namespace Simply\Router
- Represents a matched request route.
- RouteDefinition — Class in namespace Simply\Router
- Definitions for a specific route.
- RouteDefinitionProvider — Class in namespace Simply\Router
- Provides route definitions and matching arrays for the router.
- $RouteDefinitionProvider#routeDefinitions — Property in class RouteDefinitionProvider
- $RouteDefinitionProvider#routesByName — Property in class RouteDefinitionProvider
- Router — Class in namespace Simply\Router
- Class for routing requested methods and paths to specific routes.
- Router::route() — Method in class Router
- Routes the given path with the given HTTP request method to a specific route.
S
- $RouteDefinitionProvider#staticRoutes — Property in class RouteDefinitionProvider
- $RouteDefinitionProvider#segmentCounts — Property in class RouteDefinitionProvider
- $RouteDefinitionProvider#segmentValues — Property in class RouteDefinitionProvider
_
- MethodNotAllowedException::__construct() — Method in class MethodNotAllowedException
- MethodNotAllowedException constructor.
- Route::__construct() — Method in class Route
- Route constructor.
- RouteDefinition::__construct() — Method in class RouteDefinition
- RouteDefinition constructor.
- Router::__construct() — Method in class Router
- Router constructor.