Zend Framework API Documentation » \Zend_ProgressBar_Adapter

Zend_ProgressBar_Adapter_JsPush offers a simple method for updating a progressbar in a browser.

category	Zend
package	Zend_ProgressBar
uses
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License
inherited_from	\Zend_ProgressBar_Adapter

Methods

Create a new adapter

__construct(null|array|\Zend_Config $options = null)

Inherited

$options may be either be an array or a Zend_Config object which specifies adapter related options.

Parameters

$options

nullarray\Zend_Config

Defined by Zend_ProgressBar_Adapter_Interface

finish() : void

inherited_from	\Zend_ProgressBar_Adapter::finish()

Called when the progress is explicitly finished

finish() : void

Inherited

Defined by Zend_ProgressBar_Adapter_Interface

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

inherited_from	\Zend_ProgressBar_Adapter::notify()

Parameters

$current

float

Current progress value

$max

float

Max progress value

$percent

float

Current percent value

$timeTaken

integer

Taken time in seconds

$timeRemaining

integer

Remaining time in seconds

$text

string

Status text

Notify the adapter about an update

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

Inherited

Parameters

$current

float

Current progress value

$max

float

Max progress value

$percent

float

Current percent value

$timeTaken

integer

Taken time in seconds

$timeRemaining

integer

Remaining time in seconds

$text

string

Status text

Set options via a Zend_Config instance

setConfig(\Zend_Config $config) : \Zend_ProgressBar_Adapter

Inherited

Parameters

$config

\Zend_Config

Returns

\Zend_ProgressBar_Adapter

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

Inherited

Parameters

$options

array

Returns

\Zend_ProgressBar_Adapter

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

Default

Option keys to skip when calling setOptions()

$_skipOptions : array

Default

array('options', 'config')

Name of the JavaScript method to call on update

$_updateMethodName : string

Default

'Zend_ProgressBar_Update'