Zend Framework
Back to top  

Zend\ProgressBar\Adapter\JsPush offers a simple method for updating a progressbar in a browser.

 Methods

Create a new adapter

__construct(array | \Traversable $options) 
Inherited

$options may be either be an array or a Zend\Config object which specifies adapter related options.

inherited_from \Zend\ProgressBar\Adapter\AbstractAdapter::__construct()

Parameters

$options

array\Traversable

Defined by Zend\ProgressBar\Adapter\AbstractAdapter

finish() : void

Defined by Zend\ProgressBar\Adapter\AbstractAdapter

notify(float $current, float $max, float $percent, int $timeTaken, int $timeRemaining, string $text) : void

Parameters

$current

float

Current progress value

$max

float

Max progress value

$percent

float

Current percent value

$timeTaken

int

Taken time in seconds

$timeRemaining

int

Remaining time in seconds

$text

string

Status text

Set the finish method name

setFinishMethodName(string $methodName) : \Zend\ProgressBar\Adapter\JsPush

Parameters

$methodName

string

Returns

\Zend\ProgressBar\Adapter\JsPush

Set options via an array

setOptions(array $options) : \Zend\ProgressBar\Adapter\AbstractAdapter
Inherited

inherited_from \Zend\ProgressBar\Adapter\AbstractAdapter::setOptions()

Parameters

$options

array

Returns

\Zend\ProgressBar\Adapter\AbstractAdapter

Set the update method name

setUpdateMethodName(string $methodName) : \Zend\ProgressBar\Adapter\JsPush

Parameters

$methodName

string

Returns

\Zend\ProgressBar\Adapter\JsPush

Outputs given data the user agent.

_outputData(string $data) : void

This split-off is required for unit-testing.

Parameters

$data

string

 Properties

 

Name of the JavaScript method to call on finish

$finishMethodName : string

 

Option keys to skip when calling setOptions()

$skipOptions : array
Inherited

inherited_from \Zend\ProgressBar\Adapter\AbstractAdapter::$$skipOptions
 

Name of the JavaScript method to call on update

$updateMethodName : string