Cutelyst::Action Class Reference

This class represents a Cutelyst Action. More...

#include <Cutelyst/Action>

Inheritance diagram for Cutelyst::Action:

Public Member Functions
	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
virtual qint8	numberOfCaptures () 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
	Action (ActionPrivate *ptr, QObject *parent=nullptr)
	A derived class using pimpl should call this constructor, to reduce the number of memory allocations.
virtual 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)
	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)

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 Cutelyst::Controller using it's introspections 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 Cutelyst::Dispatcher for more information on how actions are dispatched.

Definition at line 47 of file action.h.

Constructor & Destructor Documentation

Action()

Action::Action ( QObject *  parent = nullptr )

explicit

Constructs a Action object with the given parent.

Definition at line 25 of file action.cpp.

Member Function Documentation

attribute()

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

Returns the value attribute by it's name, if not found dafault value is returned.

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

Definition at line 85 of file action.cpp.

References Cutelyst::Component::name().

Referenced by Cutelyst::DispatchTypeChained::expandAction().

attributes()

QMap< QString, QString > Action::attributes

(

)

const

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 79 of file action.cpp.

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

className()

QString Action::className

(

)

const

Returns the name of the component where this action is defined

Definition at line 97 of file action.cpp.

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

controller()

Controller * Action::controller

(

)

const

Returns the controller where this action is defined

Definition at line 103 of file action.cpp.

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

dispatch()

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

inline

Dispatch this action against a context

Definition at line 94 of file action.h.

References Cutelyst::Context::execute().

Referenced by Cutelyst::Dispatcher::forward().

doExecute()

bool Action::doExecute ( Context *  c )

overrideprotectedvirtual

Execute this action against

Reimplemented from Cutelyst::Component.

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

Definition at line 147 of file action.cpp.

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

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

match()

bool Action::match ( int  numberOfArgs ) const

virtual

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

Definition at line 109 of file action.cpp.

References numberOfArgs().

matchCaptures()

bool Action::matchCaptures ( int  numberOfCaptures ) const

virtual

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.

Returns

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 119 of file action.cpp.

References numberOfCaptures().

modifiers()

Component::Modifiers Action::modifiers ( ) const

overridevirtual

Reimplement to return custom Modifiers, default is None

Reimplemented from Cutelyst::Component.

Definition at line 33 of file action.cpp.

ns()

QString Action::ns

(

)

const

Returns the private namespace this action lives in.

Definition at line 129 of file action.cpp.

numberOfArgs()

qint8 Action::numberOfArgs ( ) const

virtual

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 135 of file action.cpp.

Referenced by match().

numberOfCaptures()

qint8 Action::numberOfCaptures ( ) const

virtual

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

Reimplemented in Cutelyst::ActionChain.

Definition at line 141 of file action.cpp.

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

setAttributes()

void Action::setAttributes

(

const QMap< QString, QString > &

attributes

)

Defines the Actions attibutes that were defined using the C_ATTR macro on Controller's method declaration.

Definition at line 91 of file action.cpp.

References attributes().

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

setController()

void Action::setController ( Controller *  controller )

protected

The controller which this action belongs to

Definition at line 51 of file action.cpp.

References controller().

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

setMethod()

void Action::setMethod ( const QMetaMethod &  method )

protected

The method to be invoked by this Action

Definition at line 38 of file action.cpp.

setupAction()

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

protected

Called by dispatcher to setup the Action

Definition at line 57 of file action.cpp.

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

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