class Athena::Routing::Generator::URLGenerator

Overview

Default implementation of ART::Generator::Interface.

Included Modules

Defined in:

generator/url_generator.cr

Constructors

Instance Method Summary

Instance methods inherited from module Athena::Routing::Generator::ConfigurableRequirementsInterface

strict_requirements=(enabled : Bool | Nil) strict_requirements=, strict_requirements? : Bool | Nil strict_requirements?

Instance methods inherited from module Athena::Routing::Generator::Interface

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

Instance methods inherited from module Athena::Routing::RequestContextAwareInterface

context : ART::RequestContext context, context=(context : ART::RequestContext) context=

Constructor Detail

def self.new(context : ART::RequestContext, default_locale : String | Nil = nil) #

[View source]

Instance Method Detail

def context : ART::RequestContext #

Returns the request context.


[View source]
def context=(context : ART::RequestContext) #

Sets the request context.


[View source]
def generate(route : String, params : Hash(String, String | Nil) = 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.


[View source]
def generate(route : String, params : Hash(String, _) = Hash(String, String | ::Nil).new, reference_type : ART::Generator::ReferenceType = :absolute_path) : String #

:inherit:


[View source]
def 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.


[View source]
def strict_requirements=(enabled : Bool | Nil) #
Description copied from module Athena::Routing::Generator::ConfigurableRequirementsInterface

Sets how invalid parameters should be treated:

  • true - Raise an exception for mismatched requirements.
  • false - Do not raise an exception, but return an empty string.
  • nil - Disables checks, returning a URL with possibly invalid parameters.

[View source]
def strict_requirements? : Bool | Nil #

Returns the current strict requirements mode.


[View source]