The Cutelyst Context. More...

#include <Cutelyst/Context>

Inheritance diagram for Cutelyst::Context:

Public Slots
void	finalize ()
	finalize the request right away this is automatically called at the end of the actions chain

Public Member Functions
	Context (Application *app)
	Constructs a new DUMMY Context object that is child of Application This currently is experimental to allow non network events (such as database notification) to be able to use our infrastructure.

Action *	action () const noexcept

QString	actionName () const noexcept

Application *	app () const noexcept

void	attachAsync ()
	attachAsync More...

QVariant	config (const QString &key, const QVariant &defaultValue={}) const

QVariantMap	config () const noexcept

Controller *	controller () const noexcept

Controller *	controller (const QString &name) const

QString	controllerName () const

View *	customView () const noexcept

void	detach (Action *action=nullptr)

void	detachAsync () noexcept

bool	detached () const noexcept

Dispatcher *	dispatcher () const noexcept

Engine *	engine () const noexcept

bool	error () const noexcept
	Returns true if an error was set.

void	error (const QString &error)
	Sets an error string and try to stop.

QStringList	errors () const noexcept
	Returns a list of errors that were defined.

bool	execute (Component *code)

bool	forward (Component *component)

bool	forward (const QString &action)

Action *	getAction (const QString &action, const QString &ns={}) const

QVector< Action * >	getActions (const QString &action, const QString &ns={}) const

QLocale	locale () const noexcept

QString	ns () const noexcept

template<typename T >
T	plugin ()
	Returns the registered plugin that casts to the template type `T`.

QVector< Plugin * >	plugins () const

QString	qtTrId (const char *id, int n=-1) const

Request *	req () const noexcept

Request *	request () const noexcept

Response *	res () const noexcept

Response *	response () const noexcept

bool	setCustomView (const QString &name)

void	setLocale (const QLocale &locale)

void	setStash (const QString &key, const QVariant &value)

void	setStash (const QString &key, const ParamsMultiMap &map)

void	setState (bool state) noexcept
	Sets the state of the current executed action, setting to false will make the dispatcher skip non processed actions.

QStack< Component * >	stack () const noexcept

void	stash (const QVariantHash &unite)

QVariantHash &	stash ()

QVariant	stash (const QString &key) const

QVariant	stash (const QString &key, const QVariant &defaultValue) const

bool	stashRemove (const QString &key)

QVariant	stashTake (const QString &key)

bool	state () const noexcept

QString	translate (const char context, const char sourceText, const char *disambiguation=nullptr, int n=-1) const

QUrl	uriFor (const QString &path=QString(), const QStringList &args=QStringList(), const ParamsMultiMap &queryValues=ParamsMultiMap()) const

QUrl	uriFor (const QString &path, const ParamsMultiMap &queryValues) const

QUrl	uriFor (Action *action, const QStringList &captures=QStringList(), const QStringList &args=QStringList(), const ParamsMultiMap &queryValues=ParamsMultiMap()) const

QUrl	uriFor (Action *action, const ParamsMultiMap &queryValues) const

QUrl	uriForAction (const QString &path, const QStringList &captures=QStringList(), const QStringList &args=QStringList(), const ParamsMultiMap &queryValues=ParamsMultiMap()) const

QUrl	uriForAction (const QString &path, const ParamsMultiMap &queryValues) const

View *	view (const QString &name) const

View *	view (QStringView name={}) const

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 QObject receiver, const char method) const const

bool	disconnect (const char signal, 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 (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

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

Protected Member Functions
	Context (ContextPrivate *priv)
	Constructs a new Context object using private implementation.

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
Action	action

QString	actionName

QVariantMap	config

Controller	controller

QString	controllerName

QString	namespace

QString	ns

Request	req

Request	request

bool	state

Properties inherited from QObject
	objectName

Friends
class	Action

class	ActionChain

class	Application

class	Async

class	Controller

class	DispatchType

class	Engine

class	Plugin

Additional Inherited Members
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, 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, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

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

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

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

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

bool	disconnect (const QMetaObject::Connection &connection)

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

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This is the context class that glues Request and Response plus some helper methods.

Definition at line 38 of file context.h.

Member Function Documentation

◆ action()

Action* Cutelyst::Context::action ( ) const

noexcept

Returns a pointer to the current action

Referenced by attachAsync(), detach(), forward(), getAction(), getActions(), uriFor(), and uriForAction().

◆ actionName()

QString Cutelyst::Context::actionName ( ) const

noexcept

Returns the private name of the current action

◆ app()

Application * Context::app ( ) const

noexcept

Returns the application instance. See Cutelyst::Application

Definition at line 90 of file context.cpp.

Referenced by Context().

◆ attachAsync()

void Context::attachAsync ( )

The scoped

See also: Async class can make handlying async requests easier.

Reattaches to the remaining actions

Definition at line 361 of file context.cpp.

References action(), execute(), finalize(), and QObject::Q_EMIT().

◆ config() [1/2]

QVariant Context::config	(	const QString &	key,
		const QVariant &	defaultValue = `{}`
	)		const

Returns a configuration value for key with an optional default value

Definition at line 478 of file context.cpp.

◆ config() [2/2]

QVariantMap Cutelyst::Context::config ( ) const

noexcept

Returns a configuration mapping for all configuration read

◆ controller() [1/2]

Controller* Cutelyst::Context::controller ( ) const

noexcept

Returns the current controller

◆ controller() [2/2]

Controller * Context::controller ( const QString & name ) const

Returns the controller by name, or nullptr if the controller is not found

Definition at line 156 of file context.cpp.

◆ controllerName()

QString Cutelyst::Context::controllerName ( ) const

The current controller name

◆ customView()

View * Context::customView ( ) const

noexcept

Returns the view set to be used for rendering this request, if one is set by setView() or nullptr if none was set

Definition at line 162 of file context.cpp.

Referenced by Cutelyst::RenderView::doExecute().

◆ detach()

void Context::detach ( Action * action = nullptr )

The same as forward(action)

When called with no arguments it escapes the processing chain entirely.

Definition at line 345 of file context.cpp.

References action().

Referenced by Cutelyst::RoleACL::aroundExecute(), Cutelyst::Action::doExecute(), Cutelyst::LangSelect::fromPath(), and Cutelyst::LangSelect::fromUrlQuery().

◆ detachAsync()

void Context::detachAsync ( )

noexcept

Detaches the processing chain telling the Engine that the request is not finished yet.

The scoped

See also: Async class can make handlying async requests easier.

It's often useful to call async API's, while convenient the use of QEventLoop will only work for the first request or lead to a crash due stacking of calls.

This method, tells the Engine that this request is not finished yet, making it return to the event loop to process other requests or the task that was created prior to calling this.

Once done call attachAsync() in order to process the remaining of the action chain.

Definition at line 355 of file context.cpp.

◆ detached()

bool Context::detached ( ) const

noexcept

Returns true if the last executed Action requested that the processing be escaped.

Definition at line 339 of file context.cpp.

Referenced by Cutelyst::Action::doExecute().

◆ dispatcher()

Dispatcher * Context::dispatcher ( ) const

noexcept

Returns the dispatcher instance. See Cutelyst::Dispatcher

Definition at line 138 of file context.cpp.

◆ engine()

Engine * Context::engine ( ) const

noexcept

Returns the engine instance. See Cutelyst::Engine

Definition at line 84 of file context.cpp.

◆ execute()

bool Context::execute ( Component * code )

Execute an action. Errors are available via error().

Definition at line 429 of file context.cpp.

References QString::arg(), error(), Cutelyst::Component::execute(), QString::isEmpty(), Cutelyst::Component::name(), QString::number(), Cutelyst::Component::reverse(), and setState().

Referenced by attachAsync(), Cutelyst::Action::dispatch(), and Cutelyst::Dispatcher::forward().

◆ forward() [1/2]

bool Context::forward ( Component * component )

This is one way of calling another action (method) in the same or a different controller. You can also use directly call another method to the same or a different controller.

The main difference is that 'forward' uses some of the Cutelyst request cycle overhead, including debugging, which may be useful to you. On the other hand, there are some complications to using 'forward', restrictions on values returned from 'forward', and it may not handle errors as you prefer. Whether you use 'forward' or not is up to you; it is not considered superior to the other ways to call a method.

forward calls Component::execute.

Keep in mind that the End() method used is that of the caller action. So a c->detach() inside a forwarded action would run the End() method from the original action requested.

Definition at line 399 of file context.cpp.

References action().

Referenced by Cutelyst::RenderView::doExecute().

◆ forward() [2/2]

bool Context::forward ( const QString & action )

This is one way of calling another action (method) in the same or a different controller. You can also use directly call another method to the same or a different controller.

The main difference is that 'forward' uses some of the Cutelyst request cycle overhead, including debugging, which may be useful to you. On the other hand, there are some complications to using 'forward', restrictions on values returned from 'forward', and it may not handle errors as you prefer. Whether you use 'forward' or not is up to you; it is not considered superior to the other ways to call a method.

forward calls another action, by its private name.

Keep in mind that the End() method used is that of the caller action. So a c->detach() inside a forwarded action would run the End() method from the original action requested.

Definition at line 405 of file context.cpp.

References action().

◆ getAction()

Action * Context::getAction	(	const QString &	action,
		const QString &	ns = `{}`
	)		const

Gets an action in a given namespace.

Definition at line 411 of file context.cpp.

References action(), and ns().

◆ getActions()

QVector< Action * > Context::getActions	(	const QString &	action,
		const QString &	ns = `{}`
	)		const

Gets all actions of a given name in a namespace and all parent namespaces.

Definition at line 417 of file context.cpp.

References action(), and ns().

◆ locale()

QLocale Context::locale ( ) const

noexcept

Returns the current locale to be used when processing Views or translating user messages.

If not explicity set by setLocale it will use the QLocale::setDefault(), or QLocale::system() if not set.

Definition at line 466 of file context.cpp.

◆ ns()

QString Cutelyst::Context::ns ( ) const

noexcept

Returns the namespace of the current action. i.e. the URI prefix corresponding to the controller of the current action. For example: // a class named FooBar which inherits Controller c->ns(); // returns 'foo/bar'

Referenced by getAction(), and getActions().

◆ plugins()

QVector< Cutelyst::Plugin * > Context::plugins ( ) const

Returns all registered plugins

Definition at line 423 of file context.cpp.

◆ qtTrId()

QString Cutelyst::Context::qtTrId	(	const char *	id,
		int	n = `-1`
	)		const

inline

Finds and returns a translated string.

Returns a translated string identified by id. If no matching string is found, the id itself is returned. This can be used similar to Qt’s global qtTrId() function.

If n >= 0, all occurences of %n in the resulting string are replaced with a decimal representation of n. In addition, appending n’s value, the translation may vary.

Meta data and comments can be passed as documented for QObject::tr(). In addition, it is possible to supply a source string template like that:

//% <C string>

or

% <C string>

Example:

void MyController::index(Context *c)
{
     //% "%n fooish bar(s) found.\n"
     //% "Do you want to continue?"
     c->res()->setBody(c->qtTrId("my-app-translation-id", n));
}

Creating QM files suitable for use with this function requires passing the -idbased option to the lrelease tool.

Since: Cutelyst 3.9.0

Definition at line 588 of file context.h.

◆ req()

Request* Cutelyst::Context::req ( ) const

noexcept

Short for request()

Referenced by Context().

◆ request()

Request* Cutelyst::Context::request ( ) const

noexcept

Returns the current Request object containing information about the client request Request

◆ res()

Response * Context::res ( ) const

noexcept

Returns the current Cutelyst::Response object, see there for details.

Definition at line 102 of file context.cpp.

Referenced by Cutelyst::RenderView::doExecute(), Cutelyst::LangSelect::fromPath(), Cutelyst::CuteleeView::render(), and Cutelyst::GrantleeView::render().

◆ response()

Response * Context::response ( ) const

noexcept

Returns the current Cutelyst::Response object, see there for details.

Definition at line 96 of file context.cpp.

Referenced by Cutelyst::EngineRequest::finalizeBody(), Cutelyst::EngineRequest::finalizeCookies(), Cutelyst::EngineRequest::finalizeError(), Cutelyst::EngineRequest::finalizeHeaders(), and Cutelyst::ViewJson::render().

◆ setCustomView()

bool Context::setCustomView ( const QString & name )

Defines the view to be used to render the request, it must be previously be registered by Cutelyst::Application.

Action classes like RenderView will use this value to overwrite their settings.

Returns true if a view with the given name was found

Definition at line 180 of file context.cpp.

◆ setLocale()

void Context::setLocale ( const QLocale & locale )

Defines the current locale to be used when processing Views or translating user messages.

Setting a locale on a web application can be done in many ways, so it's up to the developer to decide which one to use.

For example it's possible to try to guess the user locale with the request header Accept-Language, and or use the chained dispatcher to first match the locale as in "example.com/pt-br/some_action", and or store the locale into a cookie or session.

Be sure to set it as soon as possible so that all content can be properly localized.

Definition at line 472 of file context.cpp.

References locale().

Referenced by Cutelyst::LangSelect::fromPath().

◆ setStash() [1/2]

void Context::setStash	(	const QString &	key,
		const QVariant &	value
	)

A convenient method to set a single value to the stash

Definition at line 217 of file context.cpp.

Referenced by Cutelyst::SessionStoreFile::deleteSessionData(), Cutelyst::MemcachedSessionStore::deleteSessionData(), Cutelyst::Session::deleteValue(), Cutelyst::Session::deleteValues(), Cutelyst::CSRFProtection::getToken(), Cutelyst::ValidatorFileSize::inputPattern(), Cutelyst::StatusMessage::load(), Cutelyst::ViewEmailTemplate::render(), Cutelyst::GrantleeView::render(), Cutelyst::CuteleeView::render(), Cutelyst::Session::setValue(), Cutelyst::SessionStoreFile::storeSessionData(), Cutelyst::MemcachedSessionStore::storeSessionData(), and Cutelyst::Validator::validate().

◆ setStash() [2/2]

void Context::setStash	(	const QString &	key,
		const ParamsMultiMap &	map
	)

A convenient method to set a single ParamsMultiMap to the stash

Definition at line 223 of file context.cpp.

References QVariant::fromValue().

◆ stack()

QStack< Component * > Context::stack ( ) const

noexcept

Returns the internal execution stack (actions that are currently executing).

Definition at line 229 of file context.cpp.

◆ stash() [1/4]

void Context::stash ( const QVariantHash & unite )

You can set hash keys by passing arguments, that will be united with the stash, which may be used to store data and pass it between components during a request.

The stash is automatically sent to the view. The stash is cleared at the end of a request; it cannot be used for persistent storage (for this you must use a session; see Cutelyst::Plugin::Session for a complete system integrated with Cutelyst).

If a given key is present it will be replaced

c->stash({
             {"foo", 10},
             {"bar", QStringLiteral("my stash value")}
           });

Definition at line 566 of file context.cpp.

Referenced by Cutelyst::CSRFProtection::checkPassed(), Cutelyst::ValidatorRule::defaultValue(), Cutelyst::Session::deleteReason(), Cutelyst::Session::deleteValue(), Cutelyst::Session::deleteValues(), Cutelyst::Session::expires(), Cutelyst::CSRFProtection::getToken(), Cutelyst::Session::id(), Cutelyst::ViewEmailTemplate::render(), Cutelyst::ClearSilver::render(), Cutelyst::ViewJson::render(), Cutelyst::GrantleeView::render(), Cutelyst::CuteleeView::render(), Cutelyst::ViewEmail::render(), Cutelyst::Session::setValue(), Cutelyst::Authentication::user(), Cutelyst::Authentication::userExists(), Cutelyst::Authentication::userInRealm(), Cutelyst::ValidatorIn::validate(), Cutelyst::ValidatorRequiredIfStash::validate(), Cutelyst::ValidatorRequiredUnlessStash::validate(), Cutelyst::ValidatorPwQuality::validate(), and Cutelyst::Session::value().

◆ stash() [2/4]

QVariantHash & Context::stash ( )

Returns a QVariantHash reference to the stash, which may be used to store data and pass it between components during a request.

The stash is automatically sent to the view. The stash is cleared at the end of a request; it cannot be used for persistent storage (for this you must use a session; see Cutelyst::Plugin::Session for a complete system integrated with Cutelyst).

Definition at line 187 of file context.cpp.

◆ stash() [3/4]

QVariant Context::stash ( const QString & key ) const

A convenient method to retrieve a single value from the stash

Definition at line 193 of file context.cpp.

◆ stash() [4/4]

QVariant Context::stash	(	const QString &	key,
		const QVariant &	defaultValue
	)		const

A convenient method to retrieve a single value with a default value from the stash

Definition at line 199 of file context.cpp.

◆ stashRemove()

bool Context::stashRemove ( const QString & key )

Removes the item that has the key from the stash. Returns true if any item was removed removed.

Definition at line 211 of file context.cpp.

◆ stashTake()

QVariant Context::stashTake ( const QString & key )

Removes the item with the key from the stash and returns the value associated with it. If the item does not exist in the stash, the function simply returns a default-constructed value. If you don't use the return value, stashRemove() is more efficient.

Definition at line 205 of file context.cpp.

◆ state()

bool Cutelyst::Context::state ( ) const

noexcept

Contains the return value of the last executed action.

◆ translate()

QString Context::translate	(	const char *	context,
		const char *	sourceText,
		const char *	disambiguation = `nullptr`,
		int	n = `-1`
	)		const

Translates the sourceText for the given context into the language defined by locale().

See Application::addTranslator() for information about installation of translators. Internally this function will use QTranslator::translate().

void MyController::index(Context *c)
{
     c->res()->setBody(c->translate("MyController", "You are on the index page."));
}

Definition at line 490 of file context.cpp.

◆ uriFor() [1/4]

QUrl Context::uriFor	(	const QString &	path = `QString()`,
		const QStringList &	args = `QStringList()`,
		const ParamsMultiMap &	queryValues = `ParamsMultiMap()`
	)		const

Constructs an absolute QUrl object based on the application root, the provided path, and the additional arguments and query parameters provided. When used as a string, provides a textual URI.

The first argument is taken as a public URI path relative c->ns (if it doesn't begin with a forward slash) or relative to the application root (if it does). It is then merged with c->request()->base() any args are appended as additional path components; and any queryValues> are appended as "?foo=bar" parameters.

Definition at line 235 of file context.cpp.

References QUrlQuery::addQueryItem(), QString::compare(), QMultiMap::constBegin(), QMultiMap::constEnd(), QUrl::DecodedMode, QString::isEmpty(), QMultiMap::isEmpty(), QList::isEmpty(), QStringList::join(), QString::prepend(), QUrl::setPath(), QUrl::setQuery(), QMultiMap::size(), and QString::startsWith().

Referenced by uriFor(), and uriForAction().

◆ uriFor() [2/4]

QUrl Cutelyst::Context::uriFor	(	const QString &	path,
		const ParamsMultiMap &	queryValues
	)		const

inline

Constructs an absolute QUrl object based on the application root, the provided path, and the additional arguments and query parameters provided. When used as a string, provides a textual URI.

The first argument is taken as a public URI path relative c->ns (if it doesn't begin with a forward slash) or relative to the application root (if it does). It is then merged with c->request()->base() and any queryValues> are appended as "?foo=bar" parameters.

Definition at line 573 of file context.h.

◆ uriFor() [3/4]

QUrl Context::uriFor	(	Action *	action,
		const QStringList &	captures = `QStringList()`,
		const QStringList &	args = `QStringList()`,
		const ParamsMultiMap &	queryValues = `ParamsMultiMap()`
	)		const

Constructs an absolute QUrl object based on the application root, the provided path, and the additional arguments and query parameters provided. When used as a string, provides a textual URI.

If no arguments are provided, the URI for the current action is returned. To return the current action and also provide args, use c->uriFor(c->action(), args).

Definition at line 283 of file context.cpp.

References action(), QList::append(), QString::isEmpty(), Cutelyst::Action::numberOfCaptures(), QList::size(), QList::takeFirst(), and uriFor().

◆ uriFor() [4/4]

QUrl Cutelyst::Context::uriFor	(	Action *	action,
		const ParamsMultiMap &	queryValues
	)		const

inline

Constructs an absolute QUrl object based on the application root, the provided path, and the additional arguments and query parameters provided. When used as a string, provides a textual URI.

Definition at line 578 of file context.h.

◆ uriForAction() [1/2]

QUrl Context::uriForAction	(	const QString &	path,
		const QStringList &	captures = `QStringList()`,
		const QStringList &	args = `QStringList()`,
		const ParamsMultiMap &	queryValues = `ParamsMultiMap()`
	)		const

A private path to the Cutelyst action you want to create a URI for.

This is a shortcut for calling c->dispatcher()->getActionByPath(path) and passing the resulting action and the remaining arguments to c->uri_for.

Note that although the path looks like a URI that dispatches to the wanted action, it is not a URI, but an internal path to that action.

For example, if the action looks like:

class Users : public Cutelyst::Controller
{
public:
  C_ATTR(lst, :Path(the-list))
  void lst(Context *c);
};

You can use: c->uriForAction('/users/lst'); and it will create the URI /users/the-list.

Definition at line 321 of file context.cpp.

References action(), and uriFor().

◆ uriForAction() [2/2]

QUrl Cutelyst::Context::uriForAction	(	const QString &	path,
		const ParamsMultiMap &	queryValues
	)		const

inline

A convenience method for the uriForAction() without the arguments parameter

Definition at line 583 of file context.h.

◆ view() [1/2]

View * Context::view ( const QString & name ) const

Returns the view with name name or nullptr if not found

Definition at line 168 of file context.cpp.

◆ view() [2/2]

View * Context::view ( QStringView name = {} ) const

Returns the view with name name or nullptr if not found

Definition at line 174 of file context.cpp.

Public Slots

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ action()

◆ actionName()

◆ app()

◆ attachAsync()

◆ config() [1/2]

◆ config() [2/2]

◆ controller() [1/2]

◆ controller() [2/2]

◆ controllerName()

◆ customView()

◆ detach()

◆ detachAsync()

◆ detached()

◆ dispatcher()

◆ engine()

◆ execute()

◆ forward() [1/2]

◆ forward() [2/2]

◆ getAction()

◆ getActions()

◆ locale()

◆ ns()

◆ plugins()

◆ qtTrId()

◆ req()

◆ request()

◆ res()

◆ response()

◆ setCustomView()

◆ setLocale()

◆ setStash() [1/2]

◆ setStash() [2/2]

◆ stack()

◆ stash() [1/4]

◆ stash() [2/4]

◆ stash() [3/4]

◆ stash() [4/4]

◆ stashRemove()

◆ stashTake()

◆ state()

◆ translate()

◆ uriFor() [1/4]

◆ uriFor() [2/4]

◆ uriFor() [3/4]

◆ uriFor() [4/4]

◆ uriForAction() [1/2]

◆ uriForAction() [2/2]

◆ view() [1/2]

◆ view() [2/2]