Alpha ZealPHP is early-stage and under active development. APIs may change between minor versions until v1.0. Feedback and bug reports welcome on GitHub.
Esc
API Index — Namespaces, Packages, Reports, Indices

Request extends Request
in package

Table of Contents

Properties

$cookie  : array<string, string>|null
$files  : array<string, mixed>|null
$get  : array<string, mixed>|null
$header  : array<string, string>|null
$parent  : Request
$post  : array<string, mixed>|null
$server  : array<string, mixed>|null
$tmpfiles  : array<string, mixed>|null

Methods

__call()  : mixed
Forward method calls to the underlying OpenSwoole request.
__construct()  : mixed
__get()  : mixed
Proxy property reads to the underlying OpenSwoole request.
__set()  : mixed
Proxy property writes to the underlying OpenSwoole request.
create()  : bool
getContent()  : string|false
getData()  : string|false
getHeader()  : array<string, string>|false
getMethod()  : array<string, string>|false
htmxCurrentUrl()  : string|null
Returns the HX-Current-URL browser URL, or null if absent.
htmxPrompt()  : string|null
Returns the HX-Prompt user response string, or null if absent.
htmxTarget()  : string|null
Returns the HX-Target element id, or null if absent.
htmxTrigger()  : string|null
Returns the HX-Trigger element id, or null if absent.
htmxTriggerName()  : string|null
Returns the HX-Trigger-Name element name, or null if absent.
isBoosted()  : bool
Returns true when the request was issued via hx-boost.
isCompleted()  : bool
isHistoryRestoreRequest()  : bool
Returns true when the request is a history-restoration miss.
isHtmx()  : bool
Returns true when the request carries HX-Request: true.
parse()  : bool
rawContent()  : string|null

Properties

$cookie

public array<string, string>|null $cookie

$files

public array<string, mixed>|null $files

$get

public array<string, mixed>|null $get

$header

public array<string, string>|null $header

$post

public array<string, mixed>|null $post

$server

public array<string, mixed>|null $server

$tmpfiles

public array<string, mixed>|null $tmpfiles

Methods

__call()

Forward method calls to the underlying OpenSwoole request.

public __call(string $name, array<int, mixed> $arguments) : mixed
Parameters
$name : string
$arguments : array<int, mixed>

__construct()

public __construct(Request $request) : mixed
Parameters
$request : Request

__get()

Proxy property reads to the underlying OpenSwoole request.

public & __get(string $name) : mixed
Parameters
$name : string

__set()

Proxy property writes to the underlying OpenSwoole request.

public __set(string $name, mixed $value) : mixed
Parameters
$name : string
$value : mixed

create()

public create([array<string, mixed> $settings = = '[]' ]) : bool
Parameters
$settings : array<string, mixed> = = '[]'
Return values
bool

getContent()

public getContent() : string|false
Return values
string|false

getData()

public getData() : string|false
Return values
string|false

getHeader()

public getHeader() : array<string, string>|false
Return values
array<string, string>|false

getMethod()

public getMethod() : array<string, string>|false
Return values
array<string, string>|false

htmxCurrentUrl()

Returns the HX-Current-URL browser URL, or null if absent.

public htmxCurrentUrl() : string|null
Return values
string|null

htmxPrompt()

Returns the HX-Prompt user response string, or null if absent.

public htmxPrompt() : string|null
Return values
string|null

htmxTarget()

Returns the HX-Target element id, or null if absent.

public htmxTarget() : string|null
Return values
string|null

htmxTrigger()

Returns the HX-Trigger element id, or null if absent.

public htmxTrigger() : string|null
Return values
string|null

htmxTriggerName()

Returns the HX-Trigger-Name element name, or null if absent.

public htmxTriggerName() : string|null
Return values
string|null

isBoosted()

Returns true when the request was issued via hx-boost.

public isBoosted() : bool
Return values
bool

isCompleted()

public isCompleted() : bool
Return values
bool

isHistoryRestoreRequest()

Returns true when the request is a history-restoration miss.

public isHistoryRestoreRequest() : bool
Return values
bool

isHtmx()

Returns true when the request carries HX-Request: true.

public isHtmx() : bool
Return values
bool

parse()

public parse(string $data) : bool
Parameters
$data : string
Return values
bool

rawContent()

public rawContent() : string|null
Return values
string|null
On this page