struct Athena::Routing::Action(Controller, ActionType, ReturnType, ArgTypeTuple, ArgumentsType)
- Athena::Routing::Action(Controller, ActionType, ReturnType, ArgTypeTuple, ArgumentsType)
- Athena::Routing::ActionBase
- Struct
- Value
- Object
Overview
Represents an endpoint within the application.
Includes metadata about the endpoint, such as its controller, arguments, return type, and the action that should be executed.
Defined in:
action.crConstructors
Instance Method Summary
-
#annotation_configurations : ACF::AnnotationConfigurations
Returns annotation configurations registered via
Athena::Config.configuration_annotation
and applied toself
. -
#arguments : ArgumentsType
Returns an
Array(ART::Arguments::ArgumentMetadata)
thatself
requires. -
#constraints : Hash(String, Regex)
Returns any routing constraints related to
self
. -
#controller : Controller.class
The
ART::Controller
that includesself
. -
#execute(arguments : Array) : ReturnType
Executes the action related to
self
with the provided arguments array. -
#method : String
Returns the HTTP method associated with
self
. -
#name : String
Returns the name of the the controller action related to
self
. -
#param_converters : Array(ART::ParamConverterInterface::ConfigurationInterface)
Returns an
Array(ART::ParamConverterInterface::ConfigurationInterface)
representing theART::ParamConverter
s applied toself
. - #params : Array(ART::Params::ParamInterface)
-
#path : String
Returns the URL path related to
self
. -
#return_type : ReturnType.class
The type that
self
's route should return. -
#view_context : ART::Action::ViewContext
Returns the
ART::Action::ViewContext
related toself
.
Instance methods inherited from struct Athena::Routing::ActionBase
initialize
initialize
Constructor methods inherited from struct Athena::Routing::ActionBase
new
new
Constructor Detail
Instance Method Detail
Returns annotation configurations registered via Athena::Config.configuration_annotation
and applied to self
.
These configurations could then be accessed within ART::ParamConverterInterface
s and/or ART::Listeners
s.
See ART::Events::RequestAware
for an example.
Returns an Array(ART::Arguments::ArgumentMetadata)
that self
requires.
Executes the action related to self
with the provided arguments array.
Returns an Array(ART::ParamConverterInterface::ConfigurationInterface)
representing the ART::ParamConverter
s applied to self
.