Cutelyst  1.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Cutelyst::StatusMessage Class Reference
Inheritance diagram for Cutelyst::StatusMessage:
Inheritance graph
[legend]

Public Member Functions

 StatusMessage (Application *parent)
 
QString errorMgStashKey () const
 
QString sessionPrefix () const
 
void setErrorMgStashKey (const QString &errorMgStashKey)
 
void setSessionPrefix (const QString &sessionPrefix)
 
void setStatusMsgStashKey (const QString &statusMsgStashKey)
 
void setTokenParam (const QString &tokenParam)
 
QString statusMsgStashKey () const
 
QString tokenParam () const
 
- Public Member Functions inherited from Cutelyst::Plugin
 Plugin (Application *parent)
 

Static Public Member Functions

static QString error (Context *c, const QString &msg)
 
static ParamsMultiMap errorQuery (Context *c, const QString &msg, ParamsMultiMap query=ParamsMultiMap())
 
static void load (Context *c)
 
static Q_DECL_DEPRECATED QString setError (Context *c, const QString &msg)
 
static Q_DECL_DEPRECATED QString setStatus (Context *c, const QString &msg)
 
static QString status (Context *c, const QString &msg)
 
static ParamsMultiMap statusQuery (Context *c, const QString &msg, ParamsMultiMap query=ParamsMultiMap())
 

Protected Member Functions

virtual bool setup (Application *app) override
 

Detailed Description

Definition at line 29 of file statusmessage.h.

Constructor & Destructor Documentation

Cutelyst::StatusMessage::StatusMessage ( Application parent)

Constructs a new status message object with the given Application parent.

Member Function Documentation

static QString Cutelyst::StatusMessage::error ( Context c,
const QString &  msg 
)
static

Saves an error message returning the generated message id (mid)

QString Cutelyst::StatusMessage::errorMgStashKey ( ) const

Returns the name of the stash key where error messages are loaded when load() is called.

static ParamsMultiMap Cutelyst::StatusMessage::errorQuery ( Context c,
const QString &  msg,
ParamsMultiMap  query = ParamsMultiMap() 
)
static

Saves an error message returning query parameters with the generated message id (mid) and it's token

static void Cutelyst::StatusMessage::load ( Context c)
static

Load both messages that match the token param (mid=###) into the stash for display by the view.

QString Cutelyst::StatusMessage::sessionPrefix ( ) const

Returns the key prefix inside Session where messages will be stored.

static Q_DECL_DEPRECATED QString Cutelyst::StatusMessage::setError ( Context c,
const QString &  msg 
)
static

DEPRECATED

See also
error Saves an error message returning the generated message id (mid)
void Cutelyst::StatusMessage::setErrorMgStashKey ( const QString &  errorMgStashKey)

Sets the name of the stash key where error messages are loaded when load() is called. Defaults to error_msg.

void Cutelyst::StatusMessage::setSessionPrefix ( const QString &  sessionPrefix)

Sets the key prefix inside Session where messages will be stored. Defaults to "status_msg".

static Q_DECL_DEPRECATED QString Cutelyst::StatusMessage::setStatus ( Context c,
const QString &  msg 
)
static

DEPRECATED

See also
status Saves a status message returning the generated message id (mid)
void Cutelyst::StatusMessage::setStatusMsgStashKey ( const QString &  statusMsgStashKey)

Sets the name of the stash key where "success" status messages are loaded when load() is called. Defaults to status_msg.

void Cutelyst::StatusMessage::setTokenParam ( const QString &  tokenParam)

Sets the name of the URL param that holds the token on the page where you want to retrieve/display the status message. Defaults to "mid".

virtual bool Cutelyst::StatusMessage::setup ( Application app)
overrideprotectedvirtual

Reimplemented from Plugin::setup().

Reimplemented from Cutelyst::Plugin.

static QString Cutelyst::StatusMessage::status ( Context c,
const QString &  msg 
)
static

Saves a status message returning the generated message id (mid)

QString Cutelyst::StatusMessage::statusMsgStashKey ( ) const

Returns the name of the stash key where "success" status messages are loaded when load() is called. Defaults to status_msg.

static ParamsMultiMap Cutelyst::StatusMessage::statusQuery ( Context c,
const QString &  msg,
ParamsMultiMap  query = ParamsMultiMap() 
)
static

Saves an status message returning query parameters with the generated message id (mid) and it's token

QString Cutelyst::StatusMessage::tokenParam ( ) const

Returns the name of the URL param that holds the token on the page where you want to retrieve/display the status message.