 |
VOOZH | about |
|
VOOZH | about |
This document provides reference documentation for the supporting classes used in the Hypervel Router routing system. These classes encapsulate internal data structures and provide utilities for route file management and route callback handling.
The two primary classes covered here are:
For information about how routes are collected and processed, see Route Collection and Registration. For information about how the dispatcher factory uses these components, see Route Dispatching and Initialization.
The RouteHandler class extends Hyperf\HttpServer\Router\Handler and serves as an enhanced wrapper around route callbacks. It provides introspection capabilities to determine whether a route uses a closure or controller action, extract controller information, and access route metadata such as names and middleware.
RouteHandler is created by the RouteCollector during route registration. Each registered route is associated with a RouteHandler instance that encapsulates:
The class provides a clean interface for other components to inspect route handlers without needing to understand the underlying callback structure.
Sources: src/RouteHandler.php1-117
The RouteHandler provides methods to determine the type of callback associated with a route:
| Method | Return Type | Description |
|---|---|---|
getCallback() | array|callable|string | Returns the raw callback value |
isClosure() | bool | Returns true if the callback is a Closure instance |
isControllerAction() | bool | Returns true if the callback is a controller (not a closure) |
Example Usage Pattern:
Sources: src/RouteHandler.php19-40
The class provides convenient access to route metadata stored in the options array:
| Method | Return Type | Description |
|---|---|---|
getRoute() | string | Returns the route path pattern |
getOptions() | array | Returns all route options |
getName() | string|null | Returns the route name from options['as'] |
getMiddleware() | array | Returns middleware array from options['middleware'] |
These methods abstract away direct array access and provide a consistent interface for accessing route properties throughout the routing system.
Sources: src/RouteHandler.php42-72
The RouteHandler includes logic to parse controller strings into a standardized [class, method] array format. This parsing is lazy-loaded and cached in the parsedControllerCallback property.
The parser handles multiple controller specification formats:
Sources: src/RouteHandler.php97-115
The parseControllerCallback() method src/RouteHandler.php99-115 implements the following logic:
@ separator: Split into [class, method] using explode('@', $this->callback) src/RouteHandler.php102-103:: separator: Split into [class, method] using explode('::', $this->callback) src/RouteHandler.php105-106[$this->callback, '__invoke'] src/RouteHandler.php108RuntimeException src/RouteHandler.php114The getControllerClass() method src/RouteHandler.php77-82 provides a convenient way to extract just the controller class name:
null for closure-based routesThe getControllerCallback() method src/RouteHandler.php87-94 implements lazy loading with caching via the parsedControllerCallback property src/RouteHandler.php16
Sources: src/RouteHandler.php74-115
The RouteFileCollector class manages the collection of route definition file paths. It provides a centralized location for configuring which PHP files should be loaded to register routes with the application.
The DispatcherFactory uses RouteFileCollector to determine which files to load during route initialization. This separation allows for flexible route file configuration and makes it easy to add routes from multiple sources (e.g., package routes, application routes, module routes).
Sources: src/RouteFileCollector.php1-37
The constructor src/RouteFileCollector.php11-15 accepts an optional array of route file paths. If no files are provided, it defaults to a single file: BASE_PATH . '/config/routes.php'.
This default provides convention-over-configuration for standard Hyperf applications while allowing complete customization when needed.
Sources: src/RouteFileCollector.php11-15
The class provides three methods for managing the route file collection:
| Method | Parameters | Behavior | Use Case |
|---|---|---|---|
addRouteFile() | string $routeFile | Adds a single file to the collection | Adding one additional route file |
addRouteFiles() | array $routeFiles | Merges array of files, removes duplicates | Adding multiple files from a package |
setRouteFiles() | array $routeFiles | Replaces entire collection | Complete override of route files |
The addRouteFile() method src/RouteFileCollector.php17-20 is a convenience wrapper that delegates to addRouteFiles():
The addRouteFiles() method src/RouteFileCollector.php22-25 merges new files with existing ones and ensures no duplicates:
The use of array_unique() ensures that the same file path is never loaded twice, even if it's added multiple times by different components.
The setRouteFiles() method src/RouteFileCollector.php27-30 provides a complete replacement of the route file collection:
This is useful for scenarios where you want complete control over which route files are loaded, ignoring any defaults or previously added files.
Sources: src/RouteFileCollector.php17-30
The getRouteFiles() method src/RouteFileCollector.php32-35 returns the current array of route file paths:
This method is called by DispatcherFactory during the route initialization process to determine which files to load and execute for route registration.
Sources: src/RouteFileCollector.php32-35
The following diagram shows how RouteHandler and RouteFileCollector integrate with the broader routing system:
Sources: src/RouteHandler.php1-117 src/RouteFileCollector.php1-37
The DispatcherFactory retrieves route files from RouteFileCollector and requires each file. These files typically contain calls to Router methods that ultimately create RouteHandler instances via RouteCollector.
Sources: src/RouteHandler.php1-117
The RouteHandler implements lazy parsing for controller callbacks through the parsedControllerCallback property src/RouteHandler.php16 This property is initialized to null and only populated when getControllerCallback() is first called src/RouteHandler.php89-94
Benefits:
The RouteFileCollector uses defensive array operations to ensure data integrity:
array_unique() in addRouteFiles() prevents duplicate file paths src/RouteFileCollector.php24array_merge() preserves existing files when adding new ones src/RouteFileCollector.php24By extending Hyperf\HttpServer\Router\Handler src/RouteHandler.php11 the RouteHandler maintains compatibility with Hyperf's routing internals while adding additional functionality specific to Hypervel's needs. This allows Hypervel routes to work seamlessly with Hyperf's HTTP server while providing enhanced introspection capabilities.
Sources: src/RouteHandler.php11-117 src/RouteFileCollector.php22-25
The supporting classes documented here provide essential infrastructure for the Hypervel Router:
These classes are used internally by the routing system and are generally not accessed directly by application code. Understanding their functionality is primarily useful for:
For practical usage of the routing system, refer to Router Class and Route Collection and Registration.
Sources: src/RouteHandler.php1-117 src/RouteFileCollector.php1-37
Refresh this wiki