HTTP methods allowed with this route. */ private ?array $methods; /** @var array Options related to this route to pass to the routing implementation. */ private array $options = []; /** @var non-empty-string */ private string $name; /** * @param non-empty-string $path Path to match. * @param MiddlewareInterface $middleware Middleware to use when this route is matched. * @param null|list $methods Allowed HTTP methods; defaults to HTTP_METHOD_ANY. * @param null|string $name the route name */ public function __construct( private string $path, private MiddlewareInterface $middleware, ?array $methods = self::HTTP_METHOD_ANY, ?string $name = null ) { $this->methods = is_array($methods) ? $this->validateHttpMethods($methods) : $methods; if ($name === null || $name === '') { $name = $this->methods === self::HTTP_METHOD_ANY ? $path : $path . '^' . implode(self::HTTP_METHOD_SEPARATOR, $this->methods); } $this->name = $name; } /** * Proxies to the middleware composed during instantiation. */ public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface { return $this->middleware->process($request, $handler); } /** @return non-empty-string */ public function getPath(): string { return $this->path; } /** * Set the route name. * * @param non-empty-string $name */ public function setName(string $name): void { $this->name = $name; } /** @return non-empty-string */ public function getName(): string { return $this->name; } public function getMiddleware(): MiddlewareInterface { return $this->middleware; } /** * @return null|list Returns HTTP_METHOD_ANY or array of allowed methods. */ public function getAllowedMethods(): ?array { return $this->methods; } /** * Indicate whether the specified method is allowed by the route. * * @param string $method HTTP method to test. */ public function allowsMethod(string $method): bool { $method = strtoupper($method); return $this->allowsAnyMethod() || in_array($method, $this->methods ?? [], true); } /** * Indicate whether any method is allowed by the route. */ public function allowsAnyMethod(): bool { return $this->methods === self::HTTP_METHOD_ANY; } public function setOptions(array $options): void { $this->options = $options; } public function getOptions(): array { return $this->options; } /** * Validate the provided HTTP method names. * * Validates, and then normalizes to upper case. * * @param list $methods An array of HTTP method names. * @return list * @throws Exception\InvalidArgumentException For any invalid method names. */ private function validateHttpMethods(array $methods): array { if (empty($methods)) { throw new Exception\InvalidArgumentException( 'HTTP methods argument was empty; must contain at least one method' ); } if ( false === array_reduce($methods, function ($valid, $method) { if (false === $valid) { return false; } if (! is_string($method)) { return false; } if (! preg_match('/^[!#$%&\'*+.^_`\|~0-9a-z-]+$/i', $method)) { return false; } return $valid; }, true) ) { throw new Exception\InvalidArgumentException('One or more HTTP methods were invalid'); } return array_map('strtoupper', $methods); } }