Cutelyst::ViewJson Class Reference

A view that returns stash data in JSON format. More...

#include <Cutelyst/Plugins/View/JSON/viewjson.h>

Inheritance diagram for Cutelyst::ViewJson:

Public Types
enum	ExposeMode { All , String , StringList , RegularExpression }
enum	JsonFormat { Indented , Compact }
Public Types inherited from Cutelyst::Component
enum	Modifier {   None , OnlyExecute , BeforeExecute , AroundExecute ,   AfterExecute }

Public Member Functions
	ViewJson (QObject *parent, const QString &name=QString())
ExposeMode	exposeStashMode () const
JsonFormat	outputFormat () const
QByteArray	render (Context *c) const final
void	setExposeStash (const QRegularExpression &re)
void	setExposeStash (const QString &key)
void	setExposeStash (const QStringList &keys)
void	setOutputFormat (JsonFormat format)
void	setXJsonHeader (bool enable)
bool	xJsonHeader () const
Public Member Functions inherited from Cutelyst::View
	View (QObject *parent, const QString &name)
virtual	~View () override=default
Modifiers	modifiers () const override
void	setMinimalSizeToDeflate (qint32 minSize=-1)
Public Member Functions inherited from Cutelyst::Component
	Component (QObject *parent=nullptr)
virtual	~Component () override
bool	execute (Context *c)
virtual bool	init (Application *application, const QVariantHash &args)
QString	name () const noexcept
QString	reverse () const noexcept
void	setName (const QString &name)
void	setReverse (const QString &reverse)

Additional Inherited Members
Protected Member Functions inherited from Cutelyst::View
	View (ViewPrivate *d, QObject *parent, const QString &name)
Protected Member Functions inherited from Cutelyst::Component
	Component (ComponentPrivate *d, QObject *parent=nullptr)
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)

Detailed Description

The ViewJson is a view handler that returns Context::stash() data in JSON format. You can limit the exposed stash data by setting the setExposeStash() method to a single key, a list of keys or a regular expression matching specific keys. By default, the complete stash content will be put into the created JSON object. This view also automatically sets the Content-Type HTTP response header to "application/json".

Definition at line 25 of file viewjson.h.

Member Enumeration Documentation

ExposeMode

enum Cutelyst::ViewJson::ExposeMode

This value defines which kind of exposition was defined

Enumerator
All	The complete stash will be put into the JSON object. (the default)
String	Only the content of a single stash key will be put into the JSON object.
StringList	Only the content of the stash keys in the list of keys will be put into the JSON object.
RegularExpression	Only the content of the stash keys that match the regular expression will be put into the JSON object.

Definition at line 57 of file viewjson.h.

JsonFormat

enum Cutelyst::ViewJson::JsonFormat

This value defines the format of the JSON byte array produced when rendering the view.

Enumerator
Indented	The output will be indented
Compact	The output will be compact saving space (the default)

Definition at line 39 of file viewjson.h.

Constructor & Destructor Documentation

ViewJson()

ViewJson::ViewJson ( QObject * parent, const QString & name = QString() )

explicit

Constructs a new ViewJson with the given parent and name.

The name can be used to specify different views that can be called either dynamically by Context::setCustomView() or with the :View() argument of the RenderView action.

Definition at line 16 of file viewjson.cpp.

References Cutelyst::View::View(), and Cutelyst::Component::name().

Referenced by exposeStashMode(), outputFormat(), render(), setExposeStash(), setExposeStash(), setExposeStash(), setOutputFormat(), setXJsonHeader(), and xJsonHeader().

Member Function Documentation

exposeStashMode()

ViewJson::ExposeMode ViewJson::exposeStashMode ( ) const

nodiscard

Returns the expose mode of the stash keys, defaults to everything (ViewJson::All).

Definition at line 46 of file viewjson.cpp.

References ViewJson().

outputFormat()

ViewJson::JsonFormat ViewJson::outputFormat ( ) const

nodiscard

Returns the output format of JSON, defaults to ViewJson::Compact.

Definition at line 21 of file viewjson.cpp.

References ViewJson(), Compact, and Indented.

render()

QByteArray ViewJson::render ( Context * c ) const

finalvirtual

All subclasses must reimplement this when doing it's rendering. If an error (c->error()) is not set c->response()->body() is defined with the returned value, this is useful if the view is not meant to be used as a body.

Implements Cutelyst::View.

Definition at line 85 of file viewjson.cpp.

References ViewJson(), All, Cutelyst::Headers::contains(), Cutelyst::Request::headers(), RegularExpression, Cutelyst::Context::request, Cutelyst::Context::response(), Cutelyst::Response::setContentType(), Cutelyst::Response::setHeader(), Cutelyst::Context::stash(), String, and StringList.

setExposeStash() [1/3]

void ViewJson::setExposeStash

(

const QRegularExpression &

re

)

Specify which stash keys are exposed as a JSON response, this will change exposeStashMode() to ViewJson::RegularExpression. Only keys that match the regular expression re will be exposed to the JSON response.

Definition at line 66 of file viewjson.cpp.

References ViewJson(), and RegularExpression.

setExposeStash() [2/3]

void ViewJson::setExposeStash

(

const QString &

key

)

Specify which stash key is exposed as a JSON response, this will change exposeStashMode() to ViewJson::String. Only the content of this single key will be exposed to the JSON response.

Definition at line 52 of file viewjson.cpp.

References ViewJson(), and String.

setExposeStash() [3/3]

void ViewJson::setExposeStash

(

const QStringList &

keys

)

Specify which stash keys are exposed as a JSON response, this will change exposeStashMode() to ViewJson::StringList. Only content of stash keys that are found in the list of keys will be exposed to the JSON response.

Definition at line 59 of file viewjson.cpp.

References ViewJson(), and StringList.

setOutputFormat()

void ViewJson::setOutputFormat

(

JsonFormat

format

)

Defines the output format of JSON.

Definition at line 34 of file viewjson.cpp.

References ViewJson(), Compact, and Indented.

setXJsonHeader()

void ViewJson::setXJsonHeader

(

bool

enable

)

By default this plugin does NOT set X-JSON header if the requested client is a Prototype.js with X-JSON support. By setting enable to true, you can opt-out this behavior so that you do not need to do eval() by your own.

Definition at line 73 of file viewjson.cpp.

References ViewJson().

xJsonHeader()

bool ViewJson::xJsonHeader ( ) const

nodiscard

Returns true if the X-JSON header should be sent.

Definition at line 79 of file viewjson.cpp.

References ViewJson().