API Documentation

Zend/ProgressBar/Adapter/JsPull.php

Show: inherited
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: JsPull.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_ProgressBar_Adapter_JsPull

Package: Zend\ProgressBar

Zend_ProgressBar_Adapter_JsPull 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
\Zend_ProgressBar_Adapter_Interface  

Properties

Propertyprotectedboolean  $_exitAfterSend= 'true'

Wether to exit after json data send or not

Default valuetrueDetails
Type
boolean

Methods

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

methodpublicsetExitAfterSend( boolean $exitAfterSend ) : \Zend_ProgressBar_Adapter_JsPull

Set wether to exit after json data send or not

Parameters
Name Type Description
$exitAfterSend boolean
Returns
Type Description
\Zend_ProgressBar_Adapter_JsPull
Documentation was generated by DocBlox 0.15.1.