ProgressBar/Adapter.php

Show:

inherited

Classes
- \Zend_ProgressBar_Adapter

Table of Contents

Zend Framework

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: Adapter.php 25024 2012-07-30 15:08:15Z rob $

\Zend_ProgressBar_Adapter
jump to top

Package: Zend\ProgressBar

Abstract class for Zend_ProgressBar_Adapters

Children: \Zend_ProgressBar_Adapter_JsPull; \Zend_ProgressBar_Adapter_Console; \Zend_ProgressBar_Adapter_JsPush
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

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

Option keys to skip when calling setOptions()

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

Type: array

Methods

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

Create a new adapter

$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

finish() : void

abstract

Called when the progress is explicitly finished

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

abstract

Notify the adapter about an update

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

Set options via a Zend_Config instance

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_ProgressBar_Adapter

setOptions(array $options) : \Zend_ProgressBar_Adapter

Set options via an array

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_ProgressBar_Adapter

ProgressBar/Adapter.php

\Zend_ProgressBar_Adapterjump to top

Properties

Methods

\Zend_ProgressBar_Adapter
jump to top