51Degrees Pipeline for PHP

fiftyone\pipeline\core\HttpRequest Class Reference

Detailed Description

A read-only view of a web request, held in Evidence under server.http-request.

It has no setters, and each getter returns a copy of its array.

Public Member Functions

 __construct (array $headers, array $cookies, array $query, array $session, string $clientIp, string $protocol, string $method, string $path)
 getHeaders ()
 Every header, including Cookie, by lower case name.
 getCookies ()
 getQuery ()
 getSession ()
 getClientIp ()
 getProtocol ()
 The request's own protocol, http or https, from the HTTPS server value or the X-Forwarded-Proto header.
 getMethod ()
 getPath ()
 The path of the request line as sent, with no decoding.

Constructor & Destructor Documentation

◆ __construct()

fiftyone\pipeline\core\HttpRequest::__construct ( array $headers,
array $cookies,
array $query,
array $session,
string $clientIp,
string $protocol,
string $method,
string $path )
Parameters
array<string,string>$headers Header values by lower case name
array<string,mixed>$cookies
array<string,mixed>$query
array<string,mixed>$session

Member Function Documentation

◆ getCookies()

fiftyone\pipeline\core\HttpRequest::getCookies ( )
Returns
array<string, mixed>

◆ getHeaders()

fiftyone\pipeline\core\HttpRequest::getHeaders ( )

Every header, including Cookie, by lower case name.

Returns
array<string, string>

◆ getProtocol()

fiftyone\pipeline\core\HttpRequest::getProtocol ( )

The request's own protocol, http or https, from the HTTPS server value or the X-Forwarded-Proto header.

The Referer does not change it.

◆ getQuery()

fiftyone\pipeline\core\HttpRequest::getQuery ( )
Returns
array<string, mixed>

◆ getSession()

fiftyone\pipeline\core\HttpRequest::getSession ( )
Returns
array<string, mixed>