ProgressBar/Adapter.php
- 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: Adapter.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_ProgressBar_Adapter
Description
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 license@zend.com so we can send you a copy immediately.
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
- Properties
- $_skipOptions
- Methods
- __construct
- setConfig
- setOptions
- notify
- finish
Description
Abstract class for Zend_ProgressBar_Adapters
Properties
$_skipOptions
array $_skipOptions = 'array'Option keys to skip when calling setOptions()
Details
- $_skipOptions
- array
- visibility
- protected
- default
- array
- final
- false
- static
- false
Methods
__construct
__construct(
null|array|Zend_Config $options
=
null
)
:
Create a new adapter
$options may be either be an array or a Zend_Config object which specifies adapter related options.
Arguments
- $options
- nullarrayZend_Config
Details
- visibility
- public
- final
- false
- static
- false
finish
finish(
)
:
voidCalled when the progress is explicitly finished
Details
- visibility
- public
- final
- false
- static
- false
notify
notify(
float $current, float $max, float $percent, integer $timeTaken, integer $timeRemaining, string $text
)
:
voidNotify the adapter about an update
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
setConfig
setConfig(
Zend_Config $config
)
:
Zend_ProgressBar_AdapterSet options via a Zend_Config instance
Arguments
- $config
- Zend_Config
Output
Details
- visibility
- public
- final
- false
- static
- false
setOptions
setOptions(
array $options
)
:
Zend_ProgressBar_AdapterSet options via an array
Arguments
- $options
- array
Output
Details
- visibility
- public
- final
- false
- static
- false