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

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

Inheritance diagram for Cutelyst::ViewJson:

[legend]

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)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QObject
typedef	QObjectList

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)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Properties inherited from QObject
	objectName

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 15 of file viewjson.cpp.

Member Function Documentation

◆ exposeStashMode()

ViewJson::ExposeMode ViewJson::exposeStashMode ( ) const

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

Definition at line 45 of file viewjson.cpp.

◆ outputFormat()

ViewJson::JsonFormat ViewJson::outputFormat ( ) const

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

Definition at line 20 of file viewjson.cpp.

References Compact, QJsonDocument::Compact, Indented, and QJsonDocument::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 84 of file viewjson.cpp.

References All, Cutelyst::Headers::contains(), QJsonValue::fromVariant(), QJsonObject::fromVariantHash(), QRegularExpressionMatch::hasMatch(), Cutelyst::Request::headers(), QJsonObject::insert(), QString::insert(), QRegularExpression::match(), RegularExpression, Cutelyst::Context::request, Cutelyst::Context::response(), Cutelyst::Response::setContentType(), Cutelyst::Response::setHeader(), Cutelyst::Context::stash(), String, StringList, and QJsonDocument::toJson().

◆ 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 65 of file viewjson.cpp.

References 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 51 of file viewjson.cpp.

References 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 58 of file viewjson.cpp.

References StringList.

◆ setOutputFormat()

void ViewJson::setOutputFormat ( JsonFormat format )

Defines the output format of JSON.

Definition at line 33 of file viewjson.cpp.

References Compact, QJsonDocument::Compact, Indented, and QJsonDocument::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 72 of file viewjson.cpp.

◆ xJsonHeader()

bool ViewJson::xJsonHeader ( ) const

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

Definition at line 78 of file viewjson.cpp.

Public Types

Public Member Functions

Additional Inherited Members