Documentation

HTTPResponse
in package

Table of Contents

BODY_COMMAND  = 4
BODY_FILE  = 2
BODY_STREAM  = 3
BODY_STRING  = 1
CHUNK_EOL  = " "
CONTENT_ENCODING_GZIP  = 'gzip'
CONTENT_ENCODING_RAW  = 'identity'
STATUS_BAD_REQUEST  = 400
STATUS_GONE  = 410
STATUS_HTTP_VERSION_NOT_SUPPORTED  = 505
STATUS_INTERNAL_SERVER_ERROR  = 500
STATUS_METHOD_NOT_ALLOWED  = 405
STATUS_MOVED_PERMANENTLY  = 301
STATUS_MULTIPLE_CHOICES  = 300
STATUS_NO_CONTENT  = 204
STATUS_NOT_FOUND  = 404
STATUS_NOT_IMPLEMENTED  = 501
STATUS_NOT_MODIFIED  = 304
STATUS_OK  = 200
STATUS_PARTIAL_CONTENT  = 206
STATUS_PERMANENT_REDIRECT  = 308
STATUS_PRECONDITION_FAILED  = 412
STATUS_REQUESTED_RANGE_NOT_SATISFIABLE  = 416
STATUS_SEE_OTHER  = 303
STATUS_TEMPORARY_REDIRECT  = 307
STATUS_UNAUTHORIZED  = 401
TRANSFER_ENCODING_CHUNKED  = 'chunked'
TRANSFER_ENCODING_RAW  = 'identity'
$includeBody  : mixed
$body  : mixed
$bodyLength  : mixed
$bodyType  : mixed
$charset  : mixed
$contentEncoding  : mixed
$contentEncodingList  : mixed
$fileDisposition  : mixed
$fileExt  : mixed
$fileName  : mixed
$headerList  : mixed
$httpConfig  : mixed
$httpStatusCodes  : mixed
$ifModifiedSince  : mixed
$ifNoneMatch  : mixed
$language  : mixed
$method  : mixed
$mime  : mixed
$protocolMajorVersion  : mixed
$protocolMinorVersion  : mixed
$protocolName  : mixed
$rangeEnd  : mixed
$rangeStart  : mixed
$status  : mixed
$supportedContentEncodings  : mixed
$supportedNegotiations  : mixed
$supportedTransferEncodings  : mixed
$transferEncoding  : mixed
$transferEncodingList  : mixed
__construct()  : mixed
addHeader()  : mixed
addNegotiation()  : mixed
addTrackingInfo()  : mixed
cacheDurations()  : CascadingDictionary
calcEtag()  : string
getBody()  : mixed
getDocument()  : mixed
getDocumentElement()  : mixed
getHeader()  : mixed
getStatus()  : mixed
inventCacheDuration()  : int
removeHeader()  : mixed
removeNegotiation()  : mixed
send()  : mixed
setBody()  : mixed
setCommand()  : mixed
setContentEncoding()  : mixed
setDocument()  : mixed
setDownload()  : mixed
setEtag()  : mixed
setExceptionContext()  : mixed
setFile()  : mixed
setFileExt()  : mixed
setFileName()  : mixed
setHttpConfig()  : mixed
setLanguage()  : mixed
setLastModified()  : mixed
setMethod()  : mixed
setMoved()  : mixed
setRange()  : mixed
setRedirect()  : mixed
setRequest()  : mixed
setStatus()  : mixed
setStream()  : mixed
bodyHasChanged()  : mixed
sendBody()  : mixed
sendBodyChunk()  : mixed
sendBodyEnd()  : mixed
sendHeaderList()  : mixed

Constants

CONTENT_ENCODING_GZIP

public mixed CONTENT_ENCODING_GZIP = 'gzip'

CONTENT_ENCODING_RAW

public mixed CONTENT_ENCODING_RAW = 'identity'

STATUS_BAD_REQUEST

public mixed STATUS_BAD_REQUEST = 400

STATUS_HTTP_VERSION_NOT_SUPPORTED

public mixed STATUS_HTTP_VERSION_NOT_SUPPORTED = 505

STATUS_INTERNAL_SERVER_ERROR

public mixed STATUS_INTERNAL_SERVER_ERROR = 500

STATUS_METHOD_NOT_ALLOWED

public mixed STATUS_METHOD_NOT_ALLOWED = 405

STATUS_MOVED_PERMANENTLY

public mixed STATUS_MOVED_PERMANENTLY = 301

STATUS_MULTIPLE_CHOICES

public mixed STATUS_MULTIPLE_CHOICES = 300

STATUS_NOT_IMPLEMENTED

public mixed STATUS_NOT_IMPLEMENTED = 501

STATUS_NOT_MODIFIED

public mixed STATUS_NOT_MODIFIED = 304

STATUS_PARTIAL_CONTENT

public mixed STATUS_PARTIAL_CONTENT = 206

STATUS_PERMANENT_REDIRECT

public mixed STATUS_PERMANENT_REDIRECT = 308

STATUS_PRECONDITION_FAILED

public mixed STATUS_PRECONDITION_FAILED = 412

STATUS_REQUESTED_RANGE_NOT_SATISFIABLE

public mixed STATUS_REQUESTED_RANGE_NOT_SATISFIABLE = 416

STATUS_TEMPORARY_REDIRECT

public mixed STATUS_TEMPORARY_REDIRECT = 307

STATUS_UNAUTHORIZED

public mixed STATUS_UNAUTHORIZED = 401

TRANSFER_ENCODING_CHUNKED

public mixed TRANSFER_ENCODING_CHUNKED = 'chunked'

TRANSFER_ENCODING_RAW

public mixed TRANSFER_ENCODING_RAW = 'identity'

Properties

$contentEncodingList

protected mixed $contentEncodingList

$httpConfig

protected static mixed $httpConfig = [ 'date-format' => 'D, d M Y H:i:s \G\M\T', 'doc-timestamp' => false, // "rendering took X seconds and Y MB" 'cache-duration' => 0, // max-age, Sekunden 'input-size' => 1 * SlothsoftCoreIOMemory::ONE_MEGABYTE, // maximum $env['RESPONSE_INPUT'] size 'download-size' => 10 * SlothsoftCoreIOMemory::ONE_MEGABYTE, // if above, force download 'file-size' => 16 * SlothsoftCoreIOMemory::ONE_MEGABYTE, // maximum setFile-load 'seek-size' => 1 * SlothsoftCoreIOMemory::ONE_MEGABYTE, // maximum fseek 'chunk-size' => 256 * SlothsoftCoreIOMemory::ONE_KILOBYTE, // transfer-encoding 'gzip-level' => 9, ]

$httpStatusCodes

protected static mixed $httpStatusCodes = [self::STATUS_OK => 'OK', self::STATUS_NO_CONTENT => 'No Content', self::STATUS_PARTIAL_CONTENT => 'Partial Content', self::STATUS_MULTIPLE_CHOICES => 'Multiple Choices', self::STATUS_MOVED_PERMANENTLY => 'Moved Permanently', self::STATUS_SEE_OTHER => 'See Other', self::STATUS_NOT_MODIFIED => 'Not Modified', self::STATUS_TEMPORARY_REDIRECT => 'Temporary Redirect', self::STATUS_PERMANENT_REDIRECT => 'Permanent Redirect', self::STATUS_BAD_REQUEST => 'Bad Request', self::STATUS_UNAUTHORIZED => 'Unauthorized', self::STATUS_NOT_FOUND => 'Not Found', self::STATUS_METHOD_NOT_ALLOWED => 'Method Not Allowed', self::STATUS_GONE => 'Gone', self::STATUS_PRECONDITION_FAILED => 'Precondition Failed', self::STATUS_REQUESTED_RANGE_NOT_SATISFIABLE => 'Requested Range Not Satisfiable', self::STATUS_INTERNAL_SERVER_ERROR => 'Internal Server Error', self::STATUS_NOT_IMPLEMENTED => 'Not Implemented', self::STATUS_HTTP_VERSION_NOT_SUPPORTED => 'HTTP Version Not Supported']

$protocolMajorVersion

protected mixed $protocolMajorVersion

$protocolMinorVersion

protected mixed $protocolMinorVersion

$supportedContentEncodings

protected mixed $supportedContentEncodings = [self::CONTENT_ENCODING_RAW, self::CONTENT_ENCODING_GZIP]

$supportedNegotiations

protected mixed $supportedNegotiations

$supportedTransferEncodings

protected mixed $supportedTransferEncodings = [self::TRANSFER_ENCODING_RAW, self::TRANSFER_ENCODING_CHUNKED]

$transferEncodingList

protected mixed $transferEncodingList

Methods

__construct()

public __construct() : mixed
Return values
mixed —

addHeader()

public addHeader(mixed $key, mixed $val[, mixed $param = null ]) : mixed
Parameters
$key : mixed
$val : mixed
$param : mixed = null
Return values
mixed —

addNegotiation()

public addNegotiation(mixed $negotiation) : mixed
Parameters
$negotiation : mixed
Return values
mixed —

addTrackingInfo()

public addTrackingInfo(array<string|int, mixed> &$env) : mixed
Parameters
$env : array<string|int, mixed>
Return values
mixed —

cacheDurations()

public static cacheDurations() : CascadingDictionary
Return values
CascadingDictionary —

calcEtag()

public static calcEtag(mixed $data) : string
Parameters
$data : mixed
Return values
string —

getBody()

public getBody() : mixed
Return values
mixed —

getDocument()

public getDocument() : mixed
Return values
mixed —

getDocumentElement()

public getDocumentElement(DOMDocument $targetDoc) : mixed
Parameters
$targetDoc : DOMDocument
Return values
mixed —

getHeader()

public getHeader(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

getStatus()

public getStatus() : mixed
Return values
mixed —

inventCacheDuration()

public static inventCacheDuration(string $mimeType) : int
Parameters
$mimeType : string
Return values
int —

removeHeader()

public removeHeader(mixed $key) : mixed
Parameters
$key : mixed
Return values
mixed —

removeNegotiation()

public removeNegotiation(mixed $negotiation) : mixed
Parameters
$negotiation : mixed
Return values
mixed —

setBody()

public setBody(mixed $data) : mixed
Parameters
$data : mixed
Return values
mixed —

setContentEncoding()

public setContentEncoding(string $contentEncoding) : mixed
Parameters
$contentEncoding : string
Return values
mixed —

setDocument()

public setDocument(DOMDocument $doc) : mixed
Parameters
$doc : DOMDocument
Return values
mixed —

setDownload()

public setDownload(mixed $isDownload) : mixed
Parameters
$isDownload : mixed
Return values
mixed —

setEtag()

public setEtag(mixed $etag[, mixed $isStrong = true ]) : mixed
Parameters
$etag : mixed
$isStrong : mixed = true
Return values
mixed —

setFile()

public setFile(mixed $filePath[, mixed $fileName = null ]) : mixed
Parameters
$filePath : mixed
$fileName : mixed = null
Return values
mixed —

setFileExt()

public setFileExt(mixed $fileExt[, mixed $guessMime = false ]) : mixed
Parameters
$fileExt : mixed
$guessMime : mixed = false
Return values
mixed —

setFileName()

public setFileName(mixed $fileName) : mixed
Parameters
$fileName : mixed
Return values
mixed —

setHttpConfig()

public static setHttpConfig(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>
Return values
mixed —

setLanguage()

public setLanguage(mixed $language) : mixed
Parameters
$language : mixed
Return values
mixed —

setLastModified()

public setLastModified([mixed $time = null ][, mixed $isStrong = true ]) : mixed
Parameters
$time : mixed = null
$isStrong : mixed = true
Return values
mixed —

setMethod()

public setMethod(mixed $method) : mixed
Parameters
$method : mixed
Return values
mixed —

setMoved()

public setMoved(mixed $uri[, mixed $permanent = false ]) : mixed
Parameters
$uri : mixed
$permanent : mixed = false
Return values
mixed —

setRange()

public setRange(string $range) : mixed
Parameters
$range : string
Return values
mixed —

setRedirect()

public setRedirect(mixed $uri[, mixed $permanent = false ][, mixed $forceGET = false ]) : mixed
Parameters
$uri : mixed
$permanent : mixed = false
$forceGET : mixed = false
Return values
mixed —

setStatus()

public setStatus(mixed $code[, mixed $message = '' ]) : mixed
Parameters
$code : mixed
$message : mixed = ''
Return values
mixed —

setStream()

public setStream(HTTPStream $stream) : mixed
Parameters
$stream : HTTPStream
Return values
mixed —

bodyHasChanged()

protected bodyHasChanged() : mixed
Return values
mixed —

sendBody()

protected sendBody() : mixed
Return values
mixed —

sendBodyChunk()

protected sendBodyChunk(mixed $chunk) : mixed
Parameters
$chunk : mixed
Return values
mixed —

sendBodyEnd()

protected sendBodyEnd() : mixed
Return values
mixed —

sendHeaderList()

protected sendHeaderList() : mixed
Return values
mixed —

Search results