ProgressBar/Adapter/JsPush.php

Show: PublicProtectedPrivateinherited
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 license@zend.com 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

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

>VPropertyprotectedstring $_finishMethodName
Name of the JavaScript method to call on finish
Details
Type
string
>VPropertyprotectedarray $_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  
>VPropertyprotectedstring $_updateMethodName = 'Zend_ProgressBar_Update'
Name of the JavaScript method to call on update
Default value'Zend_ProgressBar_Update'Details
Type
string

Methods

methodpublic__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
NameTypeDescription
$optionsnull | array | \Zend_Config
methodprotected_outputData(string $data) : void

Outputs given data the user agent.

This split-off is required for unit-testing.

Parameters
NameTypeDescription
$datastring
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
NameTypeDescription
$currentfloat

Current progress value

$maxfloat

Max progress value

$percentfloat

Current percent value

$timeTakeninteger

Taken time in seconds

$timeRemaininginteger

Remaining time in seconds

$textstring

Status text

methodpublicsetConfig(\Zend_Config $config) : \Zend_ProgressBar_Adapter
inherited

Set options via a Zend_Config instance

Inherited from: \Zend_ProgressBar_Adapter::setConfig()
Parameters
NameTypeDescription
$config\Zend_Config
Returns
TypeDescription
\Zend_ProgressBar_Adapter
methodpublicsetFinishMethodName(string $methodName) : \Zend_ProgressBar_Adapter_JsPush

Set the finish method name

Parameters
NameTypeDescription
$methodNamestring
Returns
TypeDescription
\Zend_ProgressBar_Adapter_JsPush
methodpublicsetOptions(array $options) : \Zend_ProgressBar_Adapter
inherited

Set options via an array

Inherited from: \Zend_ProgressBar_Adapter::setOptions()
Parameters
NameTypeDescription
$optionsarray
Returns
TypeDescription
\Zend_ProgressBar_Adapter
methodpublicsetUpdateMethodName(string $methodName) : \Zend_ProgressBar_Adapter_JsPush

Set the update method name

Parameters
NameTypeDescription
$methodNamestring
Returns
TypeDescription
\Zend_ProgressBar_Adapter_JsPush
Documentation was generated by phpDocumentor 2.0.0a12.