HTML_Progress_UI::getProgressAttributes

returns general attributes list of the progress bar

Synopsis

require_once 'HTML/Progress/UI.php';

mixed HTML_Progress_UI::getProgressAttributes( bool $asString = FALSE)

Description

This method is used to retrieve main attributes of progress meter.

Ouput can be an array or a string depending of the $asString parameter value. Default behavior will return an associative array.

Parameter

boolean $asString: whether to return the attributes list as string.

Throws

Possible PEAR_Error values
Error level Error code Error message Solution

exception HTML_PROGRESS_ERROR_INVALID_INPUT invalid input, parameter #1 "$asString" was expecting "boolean" Fixed the cast of parameter

Note

( HTML_Progress >= 1.0 )

This function can not be called statically.

See

HTML_Progress_UI::setProgressAttributes

Example

Example below will show you the main attributes list of a progress meter in two formats: array (default) and string.

<?php
require_once 'HTML/Progress.php';
 
$bar = new HTML_Progress();
$ui =& $bar->getUI();
 
print '<pre>';
var_dump($ui->getProgressAttributes());
var_dump($ui->getProgressAttributes(true));
print '</pre>';
?>