Holds a chain of Cutelyst actions. More...

#include <Cutelyst/ActionChain>

Inheritance diagram for Cutelyst::ActionChain:

[legend]

Public Member Functions
	ActionChain (const ActionList &chain, QObject *parent=nullptr)

virtual	~ActionChain () override=default

ActionList	chain () const noexcept

qint8	numberOfCaptures () const noexcept override

Public Member Functions inherited from Cutelyst::Action
	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

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
bool	doExecute (Context *c) override

Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate ptr, QObject parent=nullptr)

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)

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

Detailed Description

This class represents a chain of Cutelyst actions. It behaves exactly like the action at the end of the chain except on dispatch it will execute all the actions in the chain in order.

Definition at line 25 of file actionchain.h.

Constructor & Destructor Documentation

◆ ActionChain()

ActionChain::ActionChain	(	const ActionList &	chain,
		QObject *	parent = nullptr )

explicit

Constructs a new ActionChain object with the given chain and parent.

Definition at line 11 of file actionchain.cpp.

References Cutelyst::Action::Action(), ActionChain(), chain(), Cutelyst::Action::setAttributes(), Cutelyst::Action::setController(), Cutelyst::Component::setName(), Cutelyst::Component::setReverse(), and Cutelyst::Action::setupAction().

Referenced by ActionChain(), chain(), doExecute(), and numberOfCaptures().

◆ ~ActionChain()

virtual Cutelyst::ActionChain::~ActionChain ( )

overridevirtualdefault

Destroys the ActionChain object.

References chain(), doExecute(), and numberOfCaptures().

Member Function Documentation

◆ chain()

ActionList ActionChain::chain ( ) const

nodiscardnoexcept

Returns a list of Action objects encapsulated by this chain.

Definition at line 36 of file actionchain.cpp.

References ActionChain().

Referenced by ActionChain(), ~ActionChain(), and doExecute().

◆ doExecute()

bool ActionChain::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against context c.

Reimplemented from Cutelyst::Action.

Definition at line 48 of file actionchain.cpp.

References Cutelyst::Action::Action(), ActionChain(), Cutelyst::Request::captures(), chain(), Cutelyst::Action::dispatch(), Cutelyst::Action::numberOfCaptures(), Cutelyst::Context::request, and Cutelyst::Request::setArguments().

Referenced by ~ActionChain().

◆ numberOfCaptures()

qint8 ActionChain::numberOfCaptures ( ) const

overridevirtualnoexcept

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