API Documentation

ProgressBar/Adapter/JsPush.php

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_ProgressBar  
version
$Id: JsPush.php 23953 2011-05-03 05:47:39Z ralph $  

\Zend_ProgressBar_Adapter_JsPush

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

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

Properties

Propertyprotectedstring  $_finishMethodName= ''

Name of the JavaScript method to call on finish

Details
Type
string
Propertyprotectedstring  $_updateMethodName= 'Zend_ProgressBar_Update'

Name of the JavaScript method to call on update

Default valueZend_ProgressBar_UpdateDetails
Type
string

Methods

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

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
methodprotected_outputData( string $data ) : void

Outputs given data the user agent.

This split-off is required for unit-testing.

Parameters
Name Type Description
$data string
methodpublicfinish( ) : void

Defined by Zend_ProgressBar_Adapter_Interface

methodpublicnotify( 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
methodpublicsetConfig( \Zend_Config $config ) : \Zend_ProgressBar_Adapter

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
methodpublicsetFinishMethodName( string $methodName ) : \Zend_ProgressBar_Adapter_JsPush

Set the finish method name

Parameters
Name Type Description
$methodName string
Returns
Type Description
\Zend_ProgressBar_Adapter_JsPush
methodpublicsetOptions( array $options ) : \Zend_ProgressBar_Adapter

Set options via an array

Inherited from: \Zend_ProgressBar_Adapter::setOptions()
Parameters
Name Type Description
$options array
Returns
Type Description
\Zend_ProgressBar_Adapter
methodpublicsetUpdateMethodName( string $methodName ) : \Zend_ProgressBar_Adapter_JsPush

Set the update method name

Parameters
Name Type Description
$methodName string
Returns
Type Description
\Zend_ProgressBar_Adapter_JsPush
Documentation was generated by DocBlox 0.13.3.