Zend_ProgressBar_Adapter_JsPush Class Reference

Inheritance diagram for Zend_ProgressBar_Adapter_JsPush:

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

Protected Member Functions
	_outputData ($data)

Protected Attributes
	$_updateMethodName = 'Zend_ProgressBar_Update'
	$_finishMethodName
Protected Attributes inherited from Zend_ProgressBar_Adapter
	$_skipOptions

Detailed Description

Definition at line 40 of file JsPush.php.

Member Function Documentation

_outputData()

_outputData (   $data )

protected

Outputs given data the user agent.

This split-off is required for unit-testing.

Parameters

string

$data

Returns

void

Definition at line 138 of file JsPush.php.

    {
        // 1024 padding is required for Safari, while 256 padding is required
        // for Internet Explorer. The <br /> is required so Safari actually
        // executes the <script />
        echo str_pad($data . '<br />', 1024, ' ', STR_PAD_RIGHT) . "\n";

        flush();
        ob_flush();
    }

finish()

finish

(

)

Defined by Zend_ProgressBar_Adapter_Interface

Returns

void

Definition at line 117 of file JsPush.php.

    {
        if ($this->_finishMethodName === null) {
            return;
        }

        $data = '<script type="text/javascript">'
              . 'parent.' . $this->_finishMethodName . '();'
              . '</script>';

        $this->_outputData($data);
    }

notify()

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

Defined by Zend_ProgressBar_Adapter_Interface

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

Definition at line 93 of file JsPush.php.

    {
        $arguments = array(
            'current'       => $current,
            'max'           => $max,
            'percent'       => ($percent * 100),
            'timeTaken'     => $timeTaken,
            'timeRemaining' => $timeRemaining,
            'text'          => $text
        );

        $data = '<script type="text/javascript">'
              . 'parent.' . $this->_updateMethodName . '(' . Zend_Json::encode($arguments) . ');'
              . '</script>';

        // Output the data
        $this->_outputData($data);
    }

setFinishMethodName()

setFinishMethodName

(

$methodName

)

Set the finish method name

Parameters

string

$methodName

Returns

Zend_ProgressBar_Adapter_JsPush

Definition at line 75 of file JsPush.php.

    {
        $this->_finishMethodName = $methodName;

        return $this;
    }

setUpdateMethodName()

setUpdateMethodName

(

$methodName

)

Set the update method name

Parameters

string

$methodName

Returns

Zend_ProgressBar_Adapter_JsPush

Definition at line 62 of file JsPush.php.

    {
        $this->_updateMethodName = $methodName;

        return $this;
    }

Field Documentation

$_finishMethodName

$_finishMethodName

protected

Definition at line 54 of file JsPush.php.

$_updateMethodName

$_updateMethodName = 'Zend_ProgressBar_Update'

protected

Definition at line 47 of file JsPush.php.

---

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

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