class

Athena::Routing::Router

Inherits Athena::Routing::Matcher::RequestMatcherInterface < Athena::Routing::RouterInterface < Athena::Routing::Generator::Interface < Athena::Routing::RequestContextAwareInterface < Athena::Routing::Matcher::URLMatcherInterface < Athena::Routing::RequestContextAwareInterface < Reference < Object

Constructors

new(route_collection : ART::RouteCollection, default_locale : String | Nil = nil, strict_requirements : Bool | Nil = true, context : ART::RequestContext | Nil = nil, route_provider : ART::RouteProvider.class = ART::RouteProvider)
Source

Instance methods

context

Returns the request context.

Source
context=(context : ART::RequestContext)

Sets the request context.

Source
generate(route : String, params : Hash = Hash(String, String | ::Nil).new, reference_type : ART::Generator::ReferenceType = :absolute_path) : String

Generates a URL for the provided route, optionally with the provided params and reference_type.

Source
generate(route : String, reference_type : ART::Generator::ReferenceType = :absolute_path, **params) : String

Generates a URL for the provided route, optionally with the provided params and reference_type.

Source
generator
Source
match(path : String) : ART::Parameters

Tries to match the provided path to its related route. Returns an ART::Parameters containing the route's defaults and parameters resolved from the path.

Raises an ART::Exception::ResourceNotFound if no route could be matched.

Raises an ART::Exception::MethodNotAllowed if a route exists but not for the current HTTP method.

Source
match(request : ART::Request) : ART::Parameters

Tries to match the provided request to its related route. Returns an ART::Parameters containing the route's defaults and parameters resolved from the request.

Raises an ART::Exception::ResourceNotFound if no route could be matched.

Raises an ART::Exception::MethodNotAllowed if a route exists but not for the request's method.

Source
match?(path : String) : ART::Parameters | Nil

Tries to match the provided path to its related route. Returns an ART::Parameters containing the route's defaults and parameters resolved from the path.

Returns nil if no route could be matched or a route exists but not for the current HTTP method.

Source
match?(request : ART::Request) : ART::Parameters | Nil

Tries to match the provided request to its related route. Returns an ART::Parameters containing the route's defaults and parameters resolved from the request.

Returns nil if no route could be matched or a route exists but not for the request's method.

Source
matcher
Source
route_collection

:inherit:

Source