Zend_ProgressBar_Adapter Class Reference

Inheritance diagram for Zend_ProgressBar_Adapter:

Public Member Functions
	__construct ($options=null)
	setConfig (Zend_Config $config)
	setOptions (array $options)
	notify ($current, $max, $percent, $timeTaken, $timeRemaining, $text)
	finish ()

Protected Attributes
	$_skipOptions

Detailed Description

Definition at line 30 of file Adapter.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = null

)

Create a new adapter

$options may be either be an array or a Zend_Config object which specifies adapter related options.

Parameters

null | array | Zend_Config

$options

Definition at line 50 of file Adapter.php.

    {
        if (is_array($options)) {
            $this->setOptions($options);
        } elseif ($options instanceof Zend_Config) {
            $this->setConfig($options);
        }
    }

Member Function Documentation

finish()

finish ( )

abstract

Called when the progress is explicitly finished

Returns

void

notify()

notify (   $current,   $max,   $percent,   $timeTaken,   $timeRemaining,   $text  )

abstract

Notify the adapter about an update

Parameters

float	$current	Current progress value
float	$max	Max progress value
float	$percent	Current percent value
integer	$timeTaken	Taken time in seconds
integer	$timeRemaining	Remaining time in seconds
string	$text	Status text

Returns

void

setConfig()

setConfig

(

Zend_Config

$config

)

Set options via a Zend_Config instance

Parameters

Zend_Config

$config

Returns

Zend_ProgressBar_Adapter

Definition at line 65 of file Adapter.php.

    {
        $this->setOptions($config->toArray());

        return $this;
    }

setOptions()

setOptions

(

array

$options

)

Set options via an array

Parameters

array

$options

Returns

Zend_ProgressBar_Adapter

Definition at line 78 of file Adapter.php.

    {
        foreach ($options as $key => $value) {
            if (in_array(strtolower($key), $this->_skipOptions)) {
                continue;
            }

            $method = 'set' . ucfirst($key);
            if (method_exists($this, $method)) {
                $this->$method($value);
            }
        }

        return $this;
    }

Field Documentation

$_skipOptions

$_skipOptions

protected

Initial value:

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

Definition at line 37 of file Adapter.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/ProgressBar/Adapter.php