Reference

Search

Text

KirbyText
Markdown

Templates

Field methods
Helpers

Panel

Blueprints
Presets
Fields
Sections
Icons
Samples

Objects

$asset
$file
$files
$kirby
$language
$languages
$page
$pages
$pagination
$request
$session
$site
$user
$users

Router

Patterns
Response types

System

Options
Urls
Roots
Validators

Plugins

Extensions
Hooks
Core components
UI Kit
Panel internals

API

Authentication
Languages
Pages
Roles
Site
System
Translations
Users

Tools

A
Cookie
Data
Dir
Escape
F
Header
Html
I18n
Mime
$query
Server
Str
Tpl
Url
V
Xml

Advanced

All classes
Aliases

new Request()
Creates a new Request object You can either pass your own request data via the $options array or use the data from the incoming request.
$request->auth()
Returns the Auth object if authentication is set
$request->body()
Returns the Body object
$request->cli()
Checks if the request has been made from the command line
$request->csrf()
Returns a CSRF token if stored in a header or the query
$request->data()
Returns the request input as array
$request->detectRequestMethod()
Detect the request method from various options: given method, query string, server vars
$request->domain()
Returns the domain
$request->file()
Fetches a single file array from the Files object by key
$request->files()
Returns the Files object
$request->get()
Returns any data field from the request if it exists
$request->header()
Returns a header by key if it exists
$request->headers()
Return all headers with polyfill for missing getallheaders function
$request->is()
Checks if the given method name matches the name of the request method.
$request->method()
Returns the request method
$request->params()
Shortcut to the Params object
$request->path()
Shortcut to the Path object
$request->query()
Returns the Query object
$request->ssl()
Checks for a valid SSL connection
$request->url()
Returns the current Uri object.

$request->cli()

Checks if the request has been made from the command line

$request->cli(): bool

Return type

bool

Source code

kirby/src/Http/Request.php#L186