API Reference

Complete reference for all public classes and methods.

Table of contents

• RouteRegistrar
  • Route Registration
  • Attribute Loading
  • Inspection
• Router
  • Middleware
  • Caching
  • Request Handling
  • URL Generation
  • Inspection
• RouteCollection
• Route
• UrlGenerator
• AttributeRouteLoader
• RouteDiagnostics
• RouteCompiler
• Exceptions

---

RouteRegistrar

Standalone route registration builder. Provides a fluent API for manual route registration, attribute-based loading, and route groups.

use AsceticSoft\Waypoint\RouteRegistrar;

$registrar = new RouteRegistrar();

Route Registration

Method	Description
addRoute(string $path, array\|Closure $handler, array $methods, array $middleware, string $name, int $priority): self	Register a route for specific HTTP methods
get(string $path, array\|Closure $handler, ...): self	Register a GET route
post(string $path, array\|Closure $handler, ...): self	Register a POST route
put(string $path, array\|Closure $handler, ...): self	Register a PUT route
delete(string $path, array\|Closure $handler, ...): self	Register a DELETE route
group(string $prefix, Closure $callback, array $middleware): self	Group routes under a shared prefix

Attribute Loading

Method	Description
loadAttributes(string ...$classes): self	Load routes from #[Route] attributes
scanDirectory(string $directory, string $namespace, string $filePattern = '*.php'): self	Auto-discover routes by scanning a directory

Inspection

Method	Description
getRouteCollection(): RouteCollection	Get the route collection built by this registrar

---

Router

PSR-15 request handler that dispatches to matched routes through a middleware pipeline. Implements Psr\Http\Server\RequestHandlerInterface.

use AsceticSoft\Waypoint\Router;

$router = new Router(
    ContainerInterface $container,
    RouteCollection $routes = new RouteCollection(),
    ?UrlMatcherInterface $matcher = null,
);

Middleware

Method	Description
addMiddleware(string\|MiddlewareInterface ...$middleware): self	Add global middleware

Caching

Method	Description
loadCache(string $cacheFilePath): self	Load routes from a compiled cache file

Request Handling

Method	Description
handle(ServerRequestInterface $request): ResponseInterface	PSR-15 request handler

URL Generation

Method	Description
setBaseUrl(string $baseUrl): self	Set base URL for absolute URL generation
getUrlGenerator(): UrlGenerator	Get the URL generator instance (lazily created)

Inspection

Method	Description
getRouteCollection(): RouteCollection	Get the route collection
getMatcher(): UrlMatcherInterface	Get the URL matcher (lazily created from route collection)

---

RouteCollection

Stores and matches routes. Uses RouteTrie for fast matching.

Method	Description
add(Route $route): void	Add a route to the collection
match(string $method, string $uri): RouteMatchResult	Match HTTP method and URI to a route
all(): Route[]	Get all routes sorted by priority
findByName(string $name): ?Route	Find a route by its name

---

Route

Immutable value object representing a single route.

Method	Description
compile(): string	Compile pattern to regex
match(string $uri): ?array	Match URI against route, returns parameters or null
allowsMethod(string $method): bool	Check if HTTP method is allowed
toArray(): array	Serialize for caching
fromArray(array $data): static	Deserialize from cache

---

UrlGenerator

Reverse routing — generates URLs from route names and parameters.

use AsceticSoft\Waypoint\UrlGenerator;

$generator = new UrlGenerator(RouteCollection $routes, string $baseUrl = '');

Method	Description
generate(string $name, array $params = [], array $query = [], bool $absolute = false): string	Generate a URL from a route name

---

AttributeRouteLoader

Reads #[Route] attributes from controller classes.

use AsceticSoft\Waypoint\Loader\AttributeRouteLoader;

$loader = new AttributeRouteLoader();

Method	Description
loadFromClass(string $className): Route[]	Load routes from a single class
loadFromDirectory(string $directory, string $namespace, string $filePattern = '*.php'): Route[]	Scan directory for controllers with #[Route]

---

RouteDiagnostics

Route conflict detection and reporting.

use AsceticSoft\Waypoint\Diagnostic\RouteDiagnostics;

$diagnostics = new RouteDiagnostics(RouteCollection $routes);

Method	Description
listRoutes(): void	Print formatted route table
findConflicts(): DiagnosticReport	Detect conflicts and return a report
printReport(): void	Print full diagnostic report

---

RouteCompiler

Compiles and loads route cache files.

use AsceticSoft\Waypoint\Cache\RouteCompiler;

$compiler = new RouteCompiler();

Method	Description
compile(RouteCollection $routes, string $cacheFilePath): void	Compile routes to a PHP cache file (compiled matcher class)
load(string $cacheFilePath): UrlMatcherInterface	Load a matcher from a compiled cache file
isFresh(string $cacheFilePath): bool	Check whether the cache file exists

---

Exceptions

Exception	When
RouteNotFoundException	No route matches the URI (HTTP 404)
MethodNotAllowedException	URI matches but method is not allowed (HTTP 405)
RouteNameNotFoundException	Route name not found during URL generation
MissingParametersException	Required route parameters missing during URL generation
BaseUrlNotSetException	Absolute URL requested but base URL not configured

MethodNotAllowedException provides getAllowedMethods(): array to retrieve the list of allowed HTTP methods for the matched URI.