HumHub Documentation (unofficial)

RequestContext
in package

FinalYes

Contains contextual information alongside a request.

Tags
author

Jérémy Derussé jeremy@derusse.com

Table of Contents

Constants

AVAILABLE_OPTIONS  = ['region' => true, 'operation' => true, 'expirationDate' => true, 'currentDate' => true, 'exceptionMapping' => true, 'usesEndpointDiscovery' => true, 'requiresEndpointDiscovery' => true]

Properties

$currentDate  : DateTimeImmutable|null
$exceptionMapping  : array<string, HttpException>>
$expirationDate  : DateTimeImmutable|null
$operation  : string|null
$region  : string|null
$requiresEndpointDiscovery  : bool
$usesEndpointDiscovery  : bool

Methods

__construct()  : mixed
getCurrentDate()  : DateTimeImmutable|null
getExceptionMapping()  : array<string, HttpException>>
getExpirationDate()  : DateTimeImmutable|null
getOperation()  : string|null
getRegion()  : string|null
requiresEndpointDiscovery()  : bool
usesEndpointDiscovery()  : bool

Constants

AVAILABLE_OPTIONS

public mixed AVAILABLE_OPTIONS = ['region' => true, 'operation' => true, 'expirationDate' => true, 'currentDate' => true, 'exceptionMapping' => true, 'usesEndpointDiscovery' => true, 'requiresEndpointDiscovery' => true]

Properties

$exceptionMapping

private array<string, HttpException>> $exceptionMapping = []

$requiresEndpointDiscovery

private bool $requiresEndpointDiscovery = false

$usesEndpointDiscovery

private bool $usesEndpointDiscovery = false

Methods

__construct()

public __construct([HttpException>>, usesEndpointDiscovery?: bool, requiresEndpointDiscovery?: bool} $options = [] ]) : mixed
Parameters
$options : HttpException>>, usesEndpointDiscovery?: bool, requiresEndpointDiscovery?: bool} = []

getCurrentDate()

public getCurrentDate() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getExceptionMapping()

public getExceptionMapping() : array<string, HttpException>>
Return values
array<string, HttpException>>

getExpirationDate()

public getExpirationDate() : DateTimeImmutable|null
Return values
DateTimeImmutable|null

getOperation()

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

getRegion()

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

requiresEndpointDiscovery()

public requiresEndpointDiscovery() : bool
Return values
bool

usesEndpointDiscovery()

public usesEndpointDiscovery() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results