API Documentation

ProgressBar/Adapter/JsPush.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_ProgressBar
version
$Id: JsPush.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_ProgressBar_Adapter_JsPush

Description

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.

Zend_ProgressBar_Adapter_JsPush
jump to top

Extends from
Zend_ProgressBar_Adapter
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_ProgressBar
uses
Zend_ProgressBar_Adapter_Interface
Properties
$_updateMethodName
$_finishMethodName
Methods
setUpdateMethodName
setFinishMethodName
notify
finish
_outputData

Description

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

Properties

$_finishMethodName
jump to class

string $_finishMethodName = ''

Name of the JavaScript method to call on finish

Details

$_finishMethodName
string
visibility
protected
default
final
false
static
false

$_updateMethodName
jump to class

string $_updateMethodName = 'Zend_ProgressBar_Update'

Name of the JavaScript method to call on update

Details

$_updateMethodName
string
visibility
protected
default
Zend_ProgressBar_Update
final
false
static
false

Methods

_outputData
jump to class

_outputData( string $data ) : void

Outputs given data the user agent.

This split-off is required for unit-testing.

Arguments
$data
string
Details
visibility
protected
final
false
static
false

finish
jump to class

finish( ) : void

Defined by Zend_ProgressBar_Adapter_Interface

Details
visibility
public
final
false
static
false

notify
jump to class

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

Defined by Zend_ProgressBar_Adapter_Interface

Arguments
$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
Details
visibility
public
final
false
static
false

setFinishMethodName
jump to class

setFinishMethodName( string $methodName ) : Zend_ProgressBar_Adapter_JsPush

Set the finish method name

Arguments
$methodName
string
Output
Zend_ProgressBar_Adapter_JsPush
Details
visibility
public
final
false
static
false

setUpdateMethodName
jump to class

setUpdateMethodName( string $methodName ) : Zend_ProgressBar_Adapter_JsPush

Set the update method name

Arguments
$methodName
string
Output
Zend_ProgressBar_Adapter_JsPush
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.