Reference

This page provides an overview of the reference documentation for the hypervel/router package, including contracts, supporting classes, and exceptions. These components define the public API that applications interact with.

The reference documentation is organized into three sections:

• Contracts and Interfaces - UrlGenerator and UrlRoutable interface definitions
• RouteHandler and Supporting Classes - Helper classes and utilities
• Exceptions - Exception classes thrown by the routing system

Package Structure

The hypervel/router package provides the following reference components:

Type	Component	Location	Purpose
Contract	UrlGenerator	src/Contracts/UrlGenerator.php	Interface for URL generation (25 methods)
Contract	UrlRoutable	src/Contracts/UrlRoutable.php	Interface for model binding (3 methods)
Class	RouteHandler	src/RouteHandler.php	Route callback encapsulation and introspection
Exception	InvalidSignatureException	src/Exceptions/InvalidSignatureException.php	Thrown when URL signature is invalid
Exception	UrlRoutableNotFoundException	src/Exceptions/UrlRoutableNotFoundException.php	Thrown when model binding fails
Exception	BackedEnumCaseNotFoundException	src/Exceptions/BackedEnumCaseNotFoundException.php	Thrown when enum case not found
Exception	InvalidMiddlewareExclusionException	src/Exceptions/InvalidMiddlewareExclusionException.php	Thrown for invalid middleware exclusions

Component Relationships

The following diagram shows how the reference components relate to the core routing system:

Sources: src/Contracts/UrlGenerator.php1-151 src/Contracts/UrlRoutable.php1-32 src/RouteHandler.php1-117

Contracts Overview

The package defines two contracts in the Hypervel\Router\Contracts namespace:

UrlGenerator Interface

The UrlGenerator interface defines 25 methods organized into functional groups:

Method Group	Methods	Purpose
Named Routes	route(), signedRoute(), temporarySignedRoute()	Generate URLs for named routes
Path URLs	to(), query(), secure()	Generate URLs from paths
Asset URLs	asset(), secureAsset(), assetFrom()	Generate URLs for static assets
Request Info	full(), current(), previous(), previousPath()	Access current/previous request URLs
Signature Validation	hasValidSignature(), hasValidRelativeSignature(), hasCorrectSignature(), signatureHasNotExpired()	Validate signed URL security
Configuration	forceScheme(), forceHttps(), useOrigin(), formatHostUsing(), formatPathUsing(), setSignedKey()	Configure URL generation behavior
Utilities	format(), formatScheme(), isValidUrl()	Helper methods for URL manipulation

Implemented by: Hypervel\Router\UrlGenerator class
Documented in: Contracts and Interfaces

Sources: src/Contracts/UrlGenerator.php14-151

UrlRoutable Interface

The UrlRoutable interface defines 3 methods for model binding:

Method	Return Type	Purpose
getRouteKey()	mixed	Get the model's route key value
getRouteKeyName()	string	Get the route key column name
resolveRouteBinding($value)	Model|null	Resolve model from parameter value

Implemented by: Application models that need route binding
Used by: SubstituteBindings middleware
Documented in: Contracts and Interfaces

Sources: src/Contracts/UrlRoutable.php9-32

Supporting Classes

RouteHandler Class

The RouteHandler class extends Hyperf\HttpServer\Router\Handler to provide route callback introspection capabilities:

Used by: RouteCollector class for route registration
Documented in: RouteHandler and Supporting Classes

Sources: src/RouteHandler.php1-117

Exceptions

The package defines four exception classes in the Hypervel\Router\Exceptions namespace:

Exception Class	Thrown By	When Thrown
InvalidSignatureException	ValidateSignature middleware	URL signature validation fails
UrlRoutableNotFoundException	SubstituteBindings middleware	Model cannot be resolved from route parameter
BackedEnumCaseNotFoundException	SubstituteBindings middleware	Enum case not found for route parameter
InvalidMiddlewareExclusionException	MiddlewareExclusionManager	Invalid middleware exclusion configuration

Exception Hierarchy

Documented in: Exceptions

Sources: Based on package structure and middleware implementations

Contract Usage Examples

Implementing UrlRoutable

Models that need to be bound to route parameters should implement UrlRoutable:

Type-Hinting UrlGenerator

Controllers and services should type-hint the UrlGenerator interface:

Further Reading

For detailed documentation on implementing and using these contracts, see:

• Contracts and Interfaces - Complete contract documentation with usage examples
• RouteHandler and Supporting Classes - Detailed documentation of supporting utilities
• Model Binding and UrlRoutable - Guide to implementing model binding
• UrlGenerator Class - Implementation details of the UrlGenerator contract

Sources: src/Contracts/UrlGenerator.php1-151 src/Contracts/UrlRoutable.php1-32 src/RouteHandler.php1-117