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)

ActionList	chain () const

virtual qint8	numberOfCaptures () const override

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

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

QMap< QString, QString >	attributes () const

QString	className () const

Controller *	controller () const

bool	dispatch (Context *c)

virtual bool	match (int numberOfArgs) const

virtual bool	matchCaptures (int numberOfCaptures) const

virtual Modifiers	modifiers () const override

QString	ns () const

virtual qint8	numberOfArgs () const

void	setAttributes (const QMap< QString, QString > &attributes)

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

bool	execute (Context *c)

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

QString	name () const

QString	reverse () const

void	setName (const QString &name)

void	setReverse (const QString &reverse)

Protected Member Functions
virtual bool	doExecute (Context *c) override

Protected Member Functions inherited from Cutelyst::Action
	Action (ActionPrivate ptr, QObject parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.

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)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.

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 36 of file actionchain.h.

Constructor & Destructor Documentation

◆ ActionChain()

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

explicit

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

Definition at line 25 of file actionchain.cpp.

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

Member Function Documentation

◆ chain()

ActionList ActionChain::chain ( ) const

The action chain

Returns: a list of Cutelyst::Action objects encapsulated by this chain.

Definition at line 49 of file actionchain.cpp.

Referenced by ActionChain(), and doExecute().

◆ doExecute()

bool ActionChain::doExecute ( Context * c )

overrideprotectedvirtual

Execute this action against

Reimplemented from Cutelyst::Action.

Definition at line 61 of file actionchain.cpp.

References Cutelyst::Request::captures(), chain(), and Cutelyst::Request::setArguments().

◆ numberOfCaptures()

qint8 ActionChain::numberOfCaptures ( ) const

overridevirtual

Reimplemented from Action::numberOfCaptures()

Reimplemented from Cutelyst::Action.

Definition at line 55 of file actionchain.cpp.

Public Member Functions

Protected Member Functions