Documentation

IApiRequest extends IRequest
in

Tags
author

Ramone Burrell ramone@ramoneburrell.com

since

Version 0.1.0

Table of Contents

Constants

METHOD_CONNECT  = 'CONNECT'
METHOD_DELETE  = 'DELETE'
METHOD_GET  = 'GET'
METHOD_HEAD  = 'HEAD'
METHOD_OPTIONS  = 'OPTIONS'
METHOD_POST  = 'POST'
METHOD_PUT  = 'PUT'
METHOD_TRACE  = 'TRACE'

Methods

getApiKey()  : string|null
Gets the API key that was sent along with this request as the header X_API_KEY
getBody()  : string|null
Gets the body of the message. String if it has been set / initialized, null otherwise.
getHeader()  : mixed
getMethod()  : string
Retrieves the HTTP method of the request.
getParameter()  : mixed
Gets the value of a parameter that was sent in this request
getParameters()  : array<string|int, mixed>
getUri()  : string
Retrieves the URI of the request.
isExternal()  : bool
isInternal()  : bool
setBody()  : mixed
Sets the body of the message.

Constants

Methods

getApiKey()

Gets the API key that was sent along with this request as the header X_API_KEY

public getApiKey() : string|null
Return values
string|null —

The API key if it was sent with this request, null otherwise

getBody()

Gets the body of the message. String if it has been set / initialized, null otherwise.

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

getHeader()

public getHeader(string $header_name) : mixed
Parameters
$header_name : string

getMethod()

Retrieves the HTTP method of the request.

public getMethod() : string
Return values
string

getParameter()

Gets the value of a parameter that was sent in this request

public getParameter(string $paramater) : mixed
Parameters
$paramater : string

getParameters()

public getParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUri()

Retrieves the URI of the request.

public getUri() : string
Return values
string

setBody()

Sets the body of the message.

public setBody(string $body) : mixed
Parameters
$body : string 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results