PHP Class Flow\Request

Inheritance: implements flow\RequestInterface
Show file Open project: flowjs/flow-php-server Class Usage Examples

Protected Properties

Property Type Description
$file array File
$params array Request parameters

Public Methods

Method Description
__construct ( array | null $params = null, array | null $file = null ) Constructor
getCurrentChunkNumber ( ) : integer | null Get current uploaded chunk number, starts with 1
getCurrentChunkSize ( ) : integer | null Get current uploaded chunk size
getDefaultChunkSize ( ) : integer | null Get default chunk size
getFile ( ) : array | null Return $_FILES request
getFileName ( ) : string | null Get uploaded file name
getIdentifier ( ) : string | null Get file unique identifier
getParam ( string $name ) : string | integer | null Get parameter value
getRelativePath ( ) : string | null Get file relative path
getTotalChunks ( ) : integer | null Get total chunks number
getTotalSize ( ) : integer | null Get total file size in bytes
isFustyFlowRequest ( ) : boolean Checks if request is formed by fusty flow

Method Details

__construct() public method

Constructor
public __construct ( array | null $params = null, array | null $file = null )
$params array | null
$file array | null

getCurrentChunkNumber() public method

Get current uploaded chunk number, starts with 1
public getCurrentChunkNumber ( ) : integer | null
return integer | null

getCurrentChunkSize() public method

Get current uploaded chunk size
public getCurrentChunkSize ( ) : integer | null
return integer | null

getDefaultChunkSize() public method

Get default chunk size
public getDefaultChunkSize ( ) : integer | null
return integer | null

getFile() public method

Return $_FILES request
public getFile ( ) : array | null
return array | null

getFileName() public method

Get uploaded file name
public getFileName ( ) : string | null
return string | null

getIdentifier() public method

Get file unique identifier
public getIdentifier ( ) : string | null
return string | null

getParam() public method

Get parameter value
public getParam ( string $name ) : string | integer | null
$name string
return string | integer | null

getRelativePath() public method

Get file relative path
public getRelativePath ( ) : string | null
return string | null

getTotalChunks() public method

Get total chunks number
public getTotalChunks ( ) : integer | null
return integer | null

getTotalSize() public method

Get total file size in bytes
public getTotalSize ( ) : integer | null
return integer | null

isFustyFlowRequest() public method

Checks if request is formed by fusty flow
public isFustyFlowRequest ( ) : boolean
return boolean

Property Details

$file protected property

File
protected array $file
return array

$params protected property

Request parameters
protected array $params
return array