PHP Класс PHPDaemon\HTTPRequest\Generic

Автор: Vasily Zorin ([email protected])
Наследование: extends PHPDaemon\Request\Generic, use trait PHPDaemon\Traits\DeferredEventHandlers, use trait PHPDaemon\Traits\Sessions
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$htr State
$hvaltr Replacement pairs for processing some header values in parse_str()
$keepalive Keepalive?
$responseLength Current response length

Защищенные свойства (Protected)

Свойство Тип Описание
$codes Status codes
$contentLength Content length from header() method
$contype Content type parameters
$cookieNum Number of outgoing cookie-headers
$frozenInput Frozen input?
$headers Outgoing headers
$headers_sent Headers sent?
$headers_sent_file File name where output started in the file and line variables
$headers_sent_line Line number where output started in the file and line variables
$sendfp File pointer to send output (X-Sendfile)

Открытые методы

Метод Описание
checkIfReady ( ) : boolean Called to check if Request is ready
chunked ( ) : void Use chunked encoding
combinedOut ( string $s ) : boolean Outputs data with headers (split by \r\n\r\n)
ensureSentHeaders ( ) : boolean Ensure that headers are sent
firstDeferredEventUsed ( ) : void Called when first deferred event used
getUploadMaxSize ( ) : integer Upload maximum file size
getUploadTempDir ( ) : string Returns path to directory of temporary upload files
header ( string $s, boolean $replace = true, integer $code = false ) : boolean Send the header
headersList ( ) : array Return current list of headers
headersSent ( &$file, &$line ) : boolean Checks if headers have been sent
isUploadedFile ( string $path ) : boolean Tells whether the file was uploaded via HTTP POST
moveUploadedFile ( string $filename, string $dest ) : boolean Moves an uploaded file to a new location
onParsedParams ( ) : void Called when request's headers parsed
onSleep ( ) : void Called when the request starts sleep
onUploadFileChunk ( Input $in, boolean $last = false ) : void Called when chunk of incoming file has arrived
onUploadFileStart ( Input $in ) : void Called when file upload started
onWakeup ( ) : void Called when the request wakes up
out ( string $s, boolean $flush = true ) : boolean Output some data
parseSize ( string $value ) : integer Converts human-readable representation of size to number of bytes
parseStr ( string $s, &$var, boolean $header = false ) : void Replacement for default parse_str(), it supoorts UCS-2 like this: %uXXXX
postPrepare ( ) : void Prepares the request body
readBodyFile ( ) : boolean Read request body from the file given in REQUEST_BODY_FILE parameter
removeHeader ( string $s ) : void Removes a header
sendfile ( string $path, callable $cb, integer $pri = EIO_PRI_DEFAULT ) : boolean Output whole contents of file
setcookie ( string $name, string $value = '', integer $maxage, string $path = '', string $domain = '', boolean $secure = false, boolean $HTTPOnly = false ) : void Set the cookie
status ( integer $code = 200 ) : boolean Send HTTP-status

Защищенные методы

Метод Описание
freezeInput ( ) : void Freeze input
getCookieStr ( string $name ) : string Get cookie by name
parseParams ( ) : void Parses GET-query string and other request's headers
postFinishHandler ( callable $cb = null ) : void Called after request finish
preinit ( object $req ) : void Preparing before init
unfreezeInput ( ) : void Unfreeze input

Описание методов

checkIfReady() публичный Метод

Called to check if Request is ready
public checkIfReady ( ) : boolean
Результат boolean Ready?

chunked() публичный Метод

Use chunked encoding
public chunked ( ) : void
Результат void

combinedOut() публичный Метод

Outputs data with headers (split by \r\n\r\n)
public combinedOut ( string $s ) : boolean
$s string Data
Результат boolean Success

ensureSentHeaders() публичный Метод

Ensure that headers are sent
public ensureSentHeaders ( ) : boolean
Результат boolean Were already sent?

firstDeferredEventUsed() публичный Метод

Called when first deferred event used
public firstDeferredEventUsed ( ) : void
Результат void

freezeInput() защищенный Метод

Freeze input
protected freezeInput ( ) : void
Результат void

getCookieStr() защищенный Метод

Get cookie by name
protected getCookieStr ( string $name ) : string
$name string Name of cookie
Результат string Contents

getUploadMaxSize() публичный Метод

Upload maximum file size
public getUploadMaxSize ( ) : integer
Результат integer

getUploadTempDir() публичный Метод

Returns path to directory of temporary upload files
public getUploadTempDir ( ) : string
Результат string

header() публичный Метод

Send the header
public header ( string $s, boolean $replace = true, integer $code = false ) : boolean
$s string Header. Example: 'Location: http://php.net/'
$replace boolean Optional. Replace?
$code integer Optional. HTTP response code
Результат boolean Success

headersList() публичный Метод

Return current list of headers
public headersList ( ) : array
Результат array Headers

headersSent() публичный Метод

Checks if headers have been sent
public headersSent ( &$file, &$line ) : boolean
Результат boolean Success

isUploadedFile() публичный Метод

Tells whether the file was uploaded via HTTP POST
public isUploadedFile ( string $path ) : boolean
$path string The filename being checked
Результат boolean Whether if this is uploaded file

moveUploadedFile() публичный Метод

Moves an uploaded file to a new location
public moveUploadedFile ( string $filename, string $dest ) : boolean
$filename string The filename of the uploaded file
$dest string The destination of the moved file
Результат boolean Success

onParsedParams() публичный Метод

Called when request's headers parsed
public onParsedParams ( ) : void
Результат void

onSleep() публичный Метод

Called when the request starts sleep
public onSleep ( ) : void
Результат void

onUploadFileChunk() публичный Метод

Called when chunk of incoming file has arrived
public onUploadFileChunk ( Input $in, boolean $last = false ) : void
$in Input Input buffer
$last boolean Last?
Результат void

onUploadFileStart() публичный Метод

Called when file upload started
public onUploadFileStart ( Input $in ) : void
$in Input Input buffer
Результат void

onWakeup() публичный Метод

Called when the request wakes up
public onWakeup ( ) : void
Результат void

out() публичный Метод

Output some data
public out ( string $s, boolean $flush = true ) : boolean
$s string String to out
$flush boolean ob_flush?
Результат boolean Success

parseParams() защищенный Метод

Parses GET-query string and other request's headers
protected parseParams ( ) : void
Результат void

parseSize() публичный статический Метод

Converts human-readable representation of size to number of bytes
public static parseSize ( string $value ) : integer
$value string String of size
Результат integer

parseStr() публичный статический Метод

Replacement for default parse_str(), it supoorts UCS-2 like this: %uXXXX
public static parseStr ( string $s, &$var, boolean $header = false ) : void
$s string String to parse
$header boolean Header-style string
Результат void

postFinishHandler() защищенный Метод

Called after request finish
protected postFinishHandler ( callable $cb = null ) : void
$cb callable Callback
Результат void

postPrepare() публичный Метод

Prepares the request body
public postPrepare ( ) : void
Результат void

preinit() защищенный Метод

Preparing before init
protected preinit ( object $req ) : void
$req object Source request
Результат void

readBodyFile() публичный Метод

Read request body from the file given in REQUEST_BODY_FILE parameter
public readBodyFile ( ) : boolean
Результат boolean Success

removeHeader() публичный Метод

Removes a header
public removeHeader ( string $s ) : void
$s string Header name. Example: 'Location'
Результат void

sendfile() публичный Метод

Output whole contents of file
public sendfile ( string $path, callable $cb, integer $pri = EIO_PRI_DEFAULT ) : boolean
$path string Path
$cb callable Callback
$pri integer Priority
Результат boolean Success

setcookie() публичный Метод

Set the cookie
public setcookie ( string $name, string $value = '', integer $maxage, string $path = '', string $domain = '', boolean $secure = false, boolean $HTTPOnly = false ) : void
$name string Name of cookie
$value string Value
$maxage integer Optional. Max-Age. Default is 0
$path string Optional. Path. Default is empty string
$domain string Optional. Domain. Default is empty string
$secure boolean Optional. Secure. Default is false
$HTTPOnly boolean Optional. HTTPOnly. Default is false
Результат void

status() публичный Метод

Send HTTP-status
public status ( integer $code = 200 ) : boolean
$code integer Code
Результат boolean Success

unfreezeInput() защищенный Метод

Unfreeze input
protected unfreezeInput ( ) : void
Результат void

Описание свойств

$codes защищенное статическое свойство

Status codes
protected static $codes

$contentLength защищенное свойство

Content length from header() method
protected $contentLength

$contype защищенное свойство

Content type parameters
protected $contype

$cookieNum защищенное свойство

Number of outgoing cookie-headers
protected $cookieNum

$frozenInput защищенное свойство

Frozen input?
protected $frozenInput

$headers защищенное свойство

Outgoing headers
protected $headers

$headers_sent защищенное свойство

Headers sent?
protected $headers_sent

$headers_sent_file защищенное свойство

File name where output started in the file and line variables
protected $headers_sent_file

$headers_sent_line защищенное свойство

Line number where output started in the file and line variables
protected $headers_sent_line

$htr публичное статическое свойство

State
public static $htr

$hvaltr публичное статическое свойство

Replacement pairs for processing some header values in parse_str()
public static $hvaltr

$keepalive публичное свойство

Keepalive?
public $keepalive

$responseLength публичное свойство

Current response length
public $responseLength

$sendfp защищенное свойство

File pointer to send output (X-Sendfile)
protected $sendfp