This class represents a Cutelyst Action. More...

#include <Cutelyst/Action>

Inheritance diagram for Cutelyst::Action:

[legend]

Public Member Functions
	Action (QObject *parent=nullptr)

virtual	~Action () override=default

QString	attribute (const QString &name, const QString &defaultValue={}) const

ParamsMultiMap	attributes () const noexcept

QString	className () const noexcept

Controller *	controller () const noexcept

bool	dispatch (Context *c)

virtual bool	match (int numberOfArgs) const noexcept

virtual bool	matchCaptures (int numberOfCaptures) const noexcept

virtual Modifiers	modifiers () const override

QString	ns () const noexcept

virtual qint8	numberOfArgs () const

virtual qint8	numberOfCaptures () const

void	setAttributes (const ParamsMultiMap &attributes)

Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)

virtual	~Component () override

bool	execute (Context *c)

virtual bool	init (Application *application, const QVariantHash &args)

QString	name () const noexcept

QString	reverse () const noexcept

void	setName (const QString &name)

void	setReverse (const QString &reverse)

Protected Member Functions
	Action (ActionPrivate ptr, QObject parent=nullptr)

bool	doExecute (Context *c) override

void	setController (Controller *controller)

void	setMethod (const QMetaMethod &method)

void	setupAction (const QVariantHash &args, Application *app)

Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate d, QObject parent=nullptr)

virtual bool	afterExecute (Context *c)

void	applyRoles (const QStack< Component * > &roles)

virtual bool	aroundExecute (Context c, QStack< Component > stack)

virtual bool	beforeExecute (Context *c)

virtual bool	dispatcherReady (const Dispatcher dispatch, Controller controller)

Friends
class	ControllerPrivate

class	Dispatcher

Additional Inherited Members
Public Types inherited from Cutelyst::Component
enum	Modifier { None , OnlyExecute , BeforeExecute , AroundExecute , AfterExecute }

Detailed Description

This class represents a Cutelyst Action.

It encapsulates a Controller method that was defined with C_ATTR() macro, it’s usually automatically created by Controller using it’s introspection information. This class allows Cutelyst to call a Controller method.

You can access the object for the currently dispatched action via c->action(). See the Dispatcher for more information on how actions are dispatched.

Definition at line 34 of file action.h.

Constructor & Destructor Documentation

◆ Action() [1/2]

Action::Action ( QObject * parent = nullptr )

explicit

Constructs an Action object with the given parent.

Definition at line 13 of file action.cpp.

References Cutelyst::Component::Component().

Referenced by Cutelyst::ActionChain::ActionChain(), Cutelyst::ActionREST::ActionREST(), Cutelyst::RenderView::RenderView(), attribute(), attributes(), className(), controller(), doExecute(), Cutelyst::ActionChain::doExecute(), match(), matchCaptures(), ns(), numberOfArgs(), numberOfCaptures(), setAttributes(), setController(), setMethod(), and setupAction().

◆ ~Action()

virtual Cutelyst::Action::~Action ( )

overridevirtualdefault

Destroys the Action object.

References attribute(), attributes(), modifiers(), and Cutelyst::Component::name().

◆ Action() [2/2]

Action::Action	(	ActionPrivate *	ptr,
		QObject *	parent = nullptr )

explicitprotected

A derived class using pimpl should call this constructor, to reduce the number of memory allocations.

Definition at line 18 of file action.cpp.

References Cutelyst::Component::Component().

Member Function Documentation

◆ attribute()

QString Action::attribute	(	const QString &	name,
		const QString &	defaultValue = {} ) const

nodiscard

Returns the value attribute by it’s name, if not found defaultValue is returned.

Attributes can be defined using the C_ATTR macro on Controller’s method declaration.

Definition at line 75 of file action.cpp.

References Action(), and Cutelyst::Component::name().

Referenced by ~Action(), Cutelyst::DispatchTypeChained::expandAction(), and Cutelyst::DispatchTypePath::list().

◆ attributes()

ParamsMultiMap Action::attributes ( ) const

nodiscardnoexcept

Returns the attributes that are set for this action, like Local, Path, Private and so on. This determines how the action is dispatched to.

Definition at line 69 of file action.cpp.

References Action().

Referenced by ~Action(), Cutelyst::DispatchTypeChained::expandAction(), Cutelyst::RenderView::init(), Cutelyst::DispatchTypeChained::list(), Cutelyst::DispatchTypeChained::registerAction(), Cutelyst::DispatchTypePath::registerAction(), setAttributes(), setupAction(), Cutelyst::DispatchTypeChained::uriForAction(), and Cutelyst::DispatchTypePath::uriForAction().

◆ className()

QString Action::className ( ) const

nodiscardnoexcept

Returns the name of the component where this action is defined.

Definition at line 87 of file action.cpp.

References Action().

Referenced by Cutelyst::RenderView::RenderView().

◆ controller()

Controller * Action::controller ( ) const

nodiscardnoexcept

Returns the controller where this action is defined.

Definition at line 93 of file action.cpp.

References Action().

Referenced by Cutelyst::Dispatcher::dispatch(), and setController().

◆ dispatch()

bool Cutelyst::Action::dispatch ( Context * c )

inline

Dispatch this action against context c.

Definition at line 88 of file action.h.

References dispatch().

Referenced by Cutelyst::Controller::_DISPATCH(), dispatch(), Cutelyst::ActionChain::doExecute(), and Cutelyst::Dispatcher::forward().

◆ doExecute()

bool Action::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against context c.

Reimplemented from Cutelyst::Component.

Reimplemented in Cutelyst::ActionChain, Cutelyst::ActionREST, and Cutelyst::RenderView.

Definition at line 137 of file action.cpp.

References Action(), Cutelyst::Context::detach(), Cutelyst::Context::detached(), Cutelyst::Context::request, and Cutelyst::Context::setState().

Referenced by Cutelyst::ActionREST::doExecute(), and Cutelyst::RenderView::doExecute().

◆ match()

bool Action::match ( int numberOfArgs ) const

nodiscardvirtualnoexcept

Check Args attribute, and makes sure number of args matches the setting. Always returns true if Args is omitted.

Definition at line 99 of file action.cpp.

References Action(), and numberOfArgs().

◆ matchCaptures()

bool Action::matchCaptures ( int numberOfCaptures ) const

nodiscardvirtualnoexcept

Can be implemented by action class and action role authors. If the method exists, then it will be called with the request context and an array reference of the captures for this action.

Returning true from this method causes the chain match to continue, returning false makes the chain not match (and alternate, less preferred chains will be attempted).

Definition at line 109 of file action.cpp.

References Action(), and numberOfCaptures().

◆ modifiers()

Component::Modifiers Action::modifiers ( ) const

overridevirtual

Always returns Component::OnlyExecute.

Reimplemented from Cutelyst::Component.

Definition at line 23 of file action.cpp.

Referenced by ~Action().

◆ ns()

QString Action::ns ( ) const

nodiscardnoexcept

Returns the private namespace this action lives in.

Definition at line 119 of file action.cpp.

References Action().

◆ numberOfArgs()

qint8 Action::numberOfArgs ( ) const

nodiscardvirtual

Returns the number of args this action expects. This is 0 if the action doesn’t take any arguments and undef if it will take any number of arguments.

Definition at line 125 of file action.cpp.

References Action().

Referenced by Cutelyst::DispatchTypePath::list(), match(), and Cutelyst::DispatchTypePath::match().

◆ numberOfCaptures()

qint8 Action::numberOfCaptures ( ) const

nodiscardvirtual

Returns the number of captures this action expects for Chained actions.

Reimplemented in Cutelyst::ActionChain.

Definition at line 131 of file action.cpp.

References Action().

Referenced by Cutelyst::ActionChain::doExecute(), Cutelyst::DispatchTypeChained::list(), matchCaptures(), Cutelyst::Context::uriFor(), and Cutelyst::DispatchTypeChained::uriForAction().

◆ setAttributes()

void Action::setAttributes ( const ParamsMultiMap & attributes )

Defines the action’s attibutes that were defined using the C_ATTR macro on Controller’s method declaration.

Definition at line 81 of file action.cpp.

References Action(), and attributes().

Referenced by Cutelyst::ActionChain::ActionChain(), and Cutelyst::DispatchTypeChained::registerAction().

◆ setController()

void Action::setController ( Controller * controller )

protected

Sets the controller which this action belongs to.

Definition at line 41 of file action.cpp.

References Action(), and controller().

Referenced by Cutelyst::ActionChain::ActionChain().

◆ setMethod()

void Action::setMethod ( const QMetaMethod & method )

protected

Sets the method to be invoked by this action.

Definition at line 28 of file action.cpp.

References Action().

◆ setupAction()

void Action::setupAction	(	const QVariantHash &	args,
		Application *	app )

protected

Called by dispatcher to setup the action.

Definition at line 47 of file action.cpp.

References Action(), attributes(), and Cutelyst::Component::init().

Referenced by Cutelyst::ActionChain::ActionChain().

Friends And Related Symbol Documentation

◆ ControllerPrivate

friend class ControllerPrivate

friend

Definition at line 128 of file action.h.

◆ Dispatcher

friend class Dispatcher

friend

Definition at line 127 of file action.h.

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Action() [1/2]

◆ ~Action()

◆ Action() [2/2]

Member Function Documentation

◆ attribute()

◆ attributes()

◆ className()

◆ controller()

◆ dispatch()

◆ doExecute()

◆ match()

◆ matchCaptures()

◆ modifiers()

◆ ns()

◆ numberOfArgs()

◆ numberOfCaptures()

◆ setAttributes()

◆ setController()

◆ setMethod()

◆ setupAction()

Friends And Related Symbol Documentation

◆ ControllerPrivate

◆ Dispatcher