Cutelyst  1.11.0
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
Cutelyst::Component Class Reference

The Cutelyst Component base class. More...

#include <Cutelyst/Component>

Inheritance diagram for Cutelyst::Component:
Inheritance graph
[legend]

Public Types

enum  Modifier {
  None, OnlyExecute, BeforeExecute, AroundExecute,
  AfterExecute
}
 

Public Member Functions

 Component (QObject *parent=nullptr)
 
bool execute (Context *c)
 
virtual bool init (Application *application, const QVariantHash &args)
 
virtual Modifiers modifiers () const
 
QString name () const
 
QString reverse () const
 
void setName (const QString &name)
 
void setReverse (const QString &reverse)
 

Protected Member Functions

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

Friends

class Controller
 

Detailed Description

This is the base class of a Cutelyst component

Definition at line 38 of file component.h.

Member Enumeration Documentation

This value defines which kind of modifiers should be executed

Definition at line 45 of file component.h.

Constructor & Destructor Documentation

Component::Component ( QObject *  parent = nullptr)
explicit

This is the base class for many Cutelyst objects, prividing access to name and reverse for actions, and modifiers to customize execution.

Definition at line 24 of file component.cpp.

Member Function Documentation

bool Component::afterExecute ( Context c)
protectedvirtual

Reimplement this if you want to do processing after doExecute

Definition at line 115 of file component.cpp.

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

Call this to install before, around and after roles

Definition at line 127 of file component.cpp.

Referenced by Cutelyst::Controller::_DISPATCH().

bool Component::aroundExecute ( Context c,
QStack< Component * >  stack 
)
protectedvirtual

Reimplement this if you want to do processing around doExecute, you must call doExecute yourself then

Reimplemented in Cutelyst::RoleACL.

Definition at line 97 of file component.cpp.

References aroundExecute(), and doExecute().

Referenced by Cutelyst::RoleACL::aroundExecute(), aroundExecute(), and execute().

bool Component::beforeExecute ( Context c)
protectedvirtual

Reimplement this if you want to do processing before doExecute

Definition at line 91 of file component.cpp.

bool Component::dispatcherReady ( const Dispatcher dispatch,
Controller controller 
)
protectedvirtual

Called by dispatcher once it's done preparing actions

Subclasses might want to implement this to cache special actions, such as special methods for REST actions

Reimplemented in Cutelyst::RoleACL.

Definition at line 148 of file component.cpp.

bool Component::doExecute ( Context c)
protectedvirtual

Reimplement this for the main processing

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

Definition at line 121 of file component.cpp.

Referenced by aroundExecute(), and execute().

bool Component::execute ( Context c)

Executes this component agains the Context

Definition at line 58 of file component.cpp.

References aroundExecute(), and doExecute().

Referenced by Cutelyst::Context::execute().

bool Component::init ( Cutelyst::Application application,
const QVariantHash &  args 
)
virtual

A Does class is always attached to an action, if this method returns false the application will fail to start. Often useful if the user misconfigured the settings

Reimplemented in Cutelyst::RoleACL, and Cutelyst::RenderView.

Definition at line 51 of file component.cpp.

Referenced by Cutelyst::Controller::_DISPATCH(), Cutelyst::RenderView::init(), and Cutelyst::Action::setupAction().

Component::Modifiers Component::modifiers ( ) const
virtual

Reimplement to return custom Modifiers, default is None

Reimplemented in Cutelyst::Action, Cutelyst::View, and Cutelyst::RoleACL.

Definition at line 34 of file component.cpp.

QString Component::name ( ) const
QString Cutelyst::Component::reverse ( ) const
inline
void Component::setName ( const QString &  name)
void Cutelyst::Component::setReverse ( const QString &  reverse)
inline

Defines the private name of this Component.

Definition at line 144 of file component.h.

Referenced by Cutelyst::Controller::_DISPATCH(), Cutelyst::ActionChain::ActionChain(), and Cutelyst::Application::setup().