Progress Bar Upload Handler for the UploadProgress extension

 Methods

__construct()

__construct(array | \Traversable $options) 
Inherited

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::__construct()

Parameters

$options

array\Traversable

Optional options

Exceptions

\Zend\ProgressBar\Exception\InvalidArgumentException

getProgress()

getProgress(string $id) : array
Inherited

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::getProgress()

Parameters

$id

string

Returns

array

getProgressAdapter()

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

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::getProgressAdapter()

Returns

getSessionNamespace()

getSessionNamespace() : string
Inherited

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::getSessionNamespace()

Returns

string

Checks for the UploadProgress extension

isUploadProgressAvailable() : bool

Returns

bool

Set options for a upload handler.

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

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

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\ProgressBar\Exception\InvalidArgumentException

Returns

setSessionNamespace()

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

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::setSessionNamespace()

Parameters

$sessionNamespace

string

Returns

getUploadProgress()

getUploadProgress(string $id) : array | bool

Parameters

$id

string

Exceptions

\Zend\ProgressBar\Exception\PhpEnvironmentException

Returns

arraybool

Returns the formatted size

toByteString(int $size) : string
Inherited

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::toByteString()

Parameters

$size

int

Returns

string

 Properties

 

$progressAdapter

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

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::$$progressAdapter
 

$sessionNamespace

$sessionNamespace : string
Inherited

inherited_from \Zend\ProgressBar\Upload\AbstractUploadHandler::$$sessionNamespace