Zend_ProgressBar Class Reference

Public Member Functions
	__construct (Zend_ProgressBar_Adapter $adapter, $min=0, $max=100, $persistenceNamespace=null)
	getAdapter ()
	update ($value=null, $text=null)
	next ($diff=1, $text=null)
	finish ()

Protected Attributes
	$_min
	$_max
	$_current
	$_startTime
	$_statusText = null
	$_adapter
	$_persistenceNamespace = null

Detailed Description

Definition at line 28 of file ProgressBar.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Zend_ProgressBar_Adapter	$adapter,
			$min = 0,
			$max = 100,
			$persistenceNamespace = null
	)

Create a new progressbar backend.

Parameters

Zend_ProgressBar_Adapter	$adapter
float	$min
float	$max
string	$persistenceNamespace

Exceptions

Zend_ProgressBar_Exception

When $min is greater than $max

Definition at line 88 of file ProgressBar.php.

    {
        // Check min/max values and set them
        if ($min > $max) {
            #require_once 'Zend/ProgressBar/Exception.php';
            throw new Zend_ProgressBar_Exception('$max must be greater than $min');
        }

        $this->_min     = (float) $min;
        $this->_max     = (float) $max;
        $this->_current = (float) $min;

        // See if we have to open a session namespace
        if ($persistenceNamespace !== null) {
            #require_once 'Zend/Session/Namespace.php';

            $this->_persistenceNamespace = new Zend_Session_Namespace($persistenceNamespace);
        }

        // Set adapter
        $this->_adapter = $adapter;

        // Track the start time
        $this->_startTime = time();

        // See If a persistenceNamespace exists and handle accordingly
        if ($this->_persistenceNamespace !== null) {
            if (isset($this->_persistenceNamespace->isSet)) {
                $this->_startTime  = $this->_persistenceNamespace->startTime;
                $this->_current    = $this->_persistenceNamespace->current;
                $this->_statusText = $this->_persistenceNamespace->statusText;
            } else {
                $this->_persistenceNamespace->isSet      = true;
                $this->_persistenceNamespace->startTime  = $this->_startTime;
                $this->_persistenceNamespace->current    = $this->_current;
                $this->_persistenceNamespace->statusText = $this->_statusText;
            }
        } else {
            $this->update();
        }
    }

Member Function Documentation

finish()

finish

(

)

Call the adapters finish() behaviour

Returns

void

Definition at line 201 of file ProgressBar.php.

    {
        if ($this->_persistenceNamespace !== null) {
            unset($this->_persistenceNamespace->isSet);
        }

        $this->_adapter->finish();
    }

getAdapter()

getAdapter

(

)

Get the current adapter

Returns

Zend_ProgressBar_Adapter

Definition at line 135 of file ProgressBar.php.

    {
        return $this->_adapter;
    }

next()

next	(		$diff = 1,
			$text = null
	)

Update the progressbar to the next value

Parameters

string

$text

Returns

void

Definition at line 191 of file ProgressBar.php.

    {
        $this->update(max($this->_min, min($this->_max, $this->_current + $diff)), $text);
    }

update()

update	(		$value = null,
			$text = null
	)

Update the progressbar

Parameters

float	$value
string	$text

Returns

void

Definition at line 147 of file ProgressBar.php.

    {
        // Update value if given
        if ($value !== null) {
            $this->_current = min($this->_max, max($this->_min, $value));
        }

        // Update text if given
        if ($text !== null) {
            $this->_statusText = $text;
        }

        // See if we have to update a namespace
        if ($this->_persistenceNamespace !== null) {
            $this->_persistenceNamespace->current    = $this->_current;
            $this->_persistenceNamespace->statusText = $this->_statusText;
        }

        // Calculate percent
        if ($this->_min === $this->_max) {
            $percent = false;
        } else {
            $percent = (float) ($this->_current - $this->_min) / ($this->_max - $this->_min);
        }

        // Calculate ETA
        $timeTaken = time() - $this->_startTime;

        if ($percent === .0 || $percent === false) {
            $timeRemaining = null;
        } else {
            $timeRemaining = round(((1 / $percent) * $timeTaken) - $timeTaken);
        }

        // Poll the adapter
        $this->_adapter->notify($this->_current, $this->_max, $percent, $timeTaken, $timeRemaining, $this->_statusText);
    }

Field Documentation

$_adapter

$_adapter

protected

Definition at line 70 of file ProgressBar.php.

$_current

$_current

protected

Definition at line 49 of file ProgressBar.php.

$_max

$_max

protected

Definition at line 42 of file ProgressBar.php.

$_min

$_min

protected

Definition at line 35 of file ProgressBar.php.

$_persistenceNamespace

$_persistenceNamespace = null

protected

Definition at line 77 of file ProgressBar.php.

$_startTime

$_startTime

protected

Definition at line 56 of file ProgressBar.php.

$_statusText

$_statusText = null

protected

Definition at line 63 of file ProgressBar.php.

---

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

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