Zend Framework
Back to top  

Abstract class for Upload Progress Handlers

 Methods

__construct() 

__construct(array | \Traversable $options) 

Parameters

$options

array\Traversable

Optional options

Exceptions

\Zend\ProgressBar\Exception\InvalidArgumentException

getProgress() 

getProgress(string $id) : array

Parameters

$id

string

Returns

array

getProgressAdapter() 

getProgressAdapter() : \Zend\ProgressBar\Adapter\AbstractAdapter | \Zend\ProgressBar\ProgressBar

Returns

\Zend\ProgressBar\Adapter\AbstractAdapter\Zend\ProgressBar\ProgressBar

getSessionNamespace() 

getSessionNamespace() : string

Returns

string

Set options for a upload handler.

setOptions(array | \Traversable $options) : \Zend\ProgressBar\Upload\AbstractUploadHandler

Accepted options are: - session_namespace: session namespace for upload progress - progress_adapter: progressbar adapter to use for updating progress

Parameters

$options

array\Traversable

Exceptions

\Zend\ProgressBar\Exception\InvalidArgumentException

Returns

\Zend\ProgressBar\Upload\AbstractUploadHandler

setProgressAdapter() 

setProgressAdapter(\Zend\ProgressBar\Adapter\AbstractAdapter | \Zend\ProgressBar\ProgressBar $progressAdapter) : \Zend\ProgressBar\Upload\AbstractUploadHandler | \Zend\ProgressBar\Upload\UploadHandlerInterface

Parameters

$progressAdapter

\Zend\ProgressBar\Adapter\AbstractAdapter\Zend\ProgressBar\ProgressBar

Returns

\Zend\ProgressBar\Upload\AbstractUploadHandler\Zend\ProgressBar\Upload\UploadHandlerInterface

setSessionNamespace() 

setSessionNamespace(string $sessionNamespace) : \Zend\ProgressBar\Upload\AbstractUploadHandler | \Zend\ProgressBar\Upload\UploadHandlerInterface

Parameters

$sessionNamespace

string

Returns

\Zend\ProgressBar\Upload\AbstractUploadHandler\Zend\ProgressBar\Upload\UploadHandlerInterface

getUploadProgress() 

getUploadProgress(string $id) : array | bool

Parameters

$id

string

Returns

arraybool

Returns the formatted size

toByteString(int $size) : string

Parameters

$size

int

Returns

string

 Properties

 

$progressAdapter

$progressAdapter : \Zend\ProgressBar\Adapter\AbstractAdapter | \Zend\ProgressBar\ProgressBar

 

$sessionNamespace

$sessionNamespace : string