ProgressBar/Adapter/JsPush.php

Show:

inherited

Classes
- \Zend_ProgressBar_Adapter_JsPush

Table of Contents

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to [email protected] so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_ProgressBar
Version: $Id: JsPush.php 25024 2012-07-30 15:08:15Z rob $

\Zend_ProgressBar_Adapter_JsPush
jump to top

Package: Zend\ProgressBar

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

Parent(s): \Zend_ProgressBar_Adapter
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Uses: \global\Zend_ProgressBar_Adapter_Interface

Properties

string $_finishMethodName =

Name of the JavaScript method to call on finish

Details

Type: string

array $_skipOptions = array('options', 'config')

inherited

Option keys to skip when calling setOptions()

Inherited from: \Zend_ProgressBar_Adapter::$$_skipOptions

Default valuearray('options', 'config')Details

Type: array
Inherited_from: \Zend_ProgressBar_Adapter::$$_skipOptions

string $_updateMethodName = 'Zend_ProgressBar_Update'

Name of the JavaScript method to call on update

Default value'Zend_ProgressBar_Update'Details

Type: string

Methods

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

inherited

Create a new adapter

Inherited from: \Zend_ProgressBar_Adapter::__construct()

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

Parameters

Name	Type	Description
$options	null \| array \| \Zend_Config

_outputData(string $data) : void

Outputs given data the user agent.

This split-off is required for unit-testing.

Parameters

Name	Type	Description
$data	string

finish() : void

Defined by Zend_ProgressBar_Adapter_Interface

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

Defined by Zend_ProgressBar_Adapter_Interface

Parameters

Name	Type	Description
$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

setConfig(\Zend_Config $config) : \Zend_ProgressBar_Adapter

inherited

Set options via a Zend_Config instance

Inherited from: \Zend_ProgressBar_Adapter::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_ProgressBar_Adapter

setFinishMethodName(string $methodName) : \Zend_ProgressBar_Adapter_JsPush

Set the finish method name

Parameters

Name	Type	Description
$methodName	string

Returns

Type	Description
\Zend_ProgressBar_Adapter_JsPush

setOptions(array $options) : \Zend_ProgressBar_Adapter

inherited

Set options via an array

Inherited from: \Zend_ProgressBar_Adapter::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_ProgressBar_Adapter

setUpdateMethodName(string $methodName) : \Zend_ProgressBar_Adapter_JsPush

Set the update method name

Parameters

Name	Type	Description
$methodName	string

Returns

Type	Description
\Zend_ProgressBar_Adapter_JsPush

ProgressBar/Adapter/JsPush.php

\Zend_ProgressBar_Adapter_JsPushjump to top

Properties

Methods

\Zend_ProgressBar_Adapter_JsPush
jump to top