PHP Класс PHPDaemon\HTTPRequest\Input

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

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

Свойство Тип Описание
$curPart Current Part

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

Свойство Тип Описание
$EOF EOF
$boundary Boundary
$curChunkSize Size of current upload chunk
$curPartDisp Content dispostion of current Part
$frozen Frozen
$maxFileSize Maximum file size from multi-part query
$readed Readed
$req Related Request
$state (self::STATE_*) State of multi-part processor

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

Метод Описание
freeze ( boolean $at_front = false ) : void Freeze input
getChunkString ( ) : string Get current upload chunk as string
isEof ( ) : boolean Is EOF?
isFrozen ( ) : boolean Is frozen?
log ( string $msg ) : void Log
look ( integer $n, integer $o ) : string Read from buffer without draining
parseMultipart ( ) : void Parses multipart
readFromBuffer ( EventBuffer $buf ) : integer Moves $n bytes from input buffer to arbitrary buffer
readFromString ( string $chunk, boolean $final = true ) : void Append string to input buffer
sendEOF ( ) : void Send EOF
setBoundary ( string $boundary ) : void Set boundary
setRequest ( Generic $req ) : void Set request
unfreeze ( boolean $at_front = false ) : void Unfreeze input
writeChunkToFd ( mixed $fd, callable $cb = null ) : boolean Write current upload chunk to file descriptor

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

Метод Описание
onEOF ( ) : void onEOF
onRead ( ) : void onRead

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

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

Freeze input
public freeze ( boolean $at_front = false ) : void
$at_front boolean At front. Default is true. If the front of a buffer is frozen, operations that drain data from the front of the buffer, or that prepend data to the buffer, will fail until it is unfrozen. If the back a buffer is frozen, operations that append data from the buffer will fail until it is unfrozen
Результат void

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

Get current upload chunk as string
public getChunkString ( ) : string
Результат string Chunk body

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

Is EOF?
public isEof ( ) : boolean
Результат boolean

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

Is frozen?
public isFrozen ( ) : boolean
Результат boolean

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

Log
public log ( string $msg ) : void
$msg string Message
Результат void

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

Read from buffer without draining
public look ( integer $n, integer $o ) : string
$n integer Number of bytes to read
$o integer Offset
Результат string

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

onEOF
protected onEOF ( ) : void
Результат void

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

onRead
protected onRead ( ) : void
Результат void

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

Parses multipart
public parseMultipart ( ) : void
Результат void

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

Moves $n bytes from input buffer to arbitrary buffer
public readFromBuffer ( EventBuffer $buf ) : integer
$buf EventBuffer Source nuffer
Результат integer

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

Append string to input buffer
public readFromString ( string $chunk, boolean $final = true ) : void
$chunk string Piece of request input
$final boolean Final call is THIS SEQUENCE of calls (not mandatory final in request)?
Результат void

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

Send EOF
public sendEOF ( ) : void
Результат void

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

Set boundary
public setBoundary ( string $boundary ) : void
$boundary string Boundary
Результат void

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

Set request
public setRequest ( Generic $req ) : void
$req Generic Request
Результат void

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

Unfreeze input
public unfreeze ( boolean $at_front = false ) : void
$at_front boolean At front. Default is true. If the front of a buffer is frozen, operations that drain data from the front of the buffer, or that prepend data to the buffer, will fail until it is unfrozen. If the back a buffer is frozen, operations that append data from the buffer will fail until it is unfrozen
Результат void

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

Write current upload chunk to file descriptor
public writeChunkToFd ( mixed $fd, callable $cb = null ) : boolean
$fd mixed File destriptor
$cb callable Callback
Результат boolean Success

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

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

EOF
protected $EOF

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

Boundary
protected $boundary

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

Size of current upload chunk
protected $curChunkSize

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

Current Part
public $curPart

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

Content dispostion of current Part
protected $curPartDisp

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

Frozen
protected $frozen

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

Maximum file size from multi-part query
protected $maxFileSize

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

Readed
protected $readed

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

Related Request
protected $req

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

(self::STATE_*) State of multi-part processor
protected $state