Cutelyst  1.5.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Cutelyst::ActionChain Class Reference

Holds a chain of Cutelyst Actions. More...

#include <Cutelyst/ActionChain>

Inheritance diagram for Cutelyst::ActionChain:
Inheritance graph
[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
 
Controllercontroller () 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
 name More...
 
QString reverse () const
 name More...
 
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
void setController (Controller *controller)
 
void setMethod (const QMetaMethod &method)
 
void setupAction (const QVariantHash &args, Application *app)
 
- Protected Member Functions inherited from Cutelyst::Component
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)
 

Protected Attributes

ActionChainPrivate * d_ptr
 
- Protected Attributes inherited from Cutelyst::Action
ActionPrivate * d_ptr
 
- Protected Attributes inherited from Cutelyst::Component
ComponentPrivate * d_ptr
 

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

Member Function Documentation

ActionList Cutelyst::ActionChain::chain ( ) const

The action chain

Returns
a list of Cutelyst::Action objects encapsulated by this chain.
virtual bool Cutelyst::ActionChain::doExecute ( Context c)
overrideprotectedvirtual

Execute this action against

Reimplemented from Cutelyst::Action.

virtual qint8 Cutelyst::ActionChain::numberOfCaptures ( ) const
overridevirtual

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

Reimplemented from Cutelyst::Action.