Collaboration diagram for ilProgressBar:

Public Member Functions
	setType ($a_value)
	Set type (currently unwanted) More...

	setMin ($a_value)
	Set minimum value. More...

	setMax ($a_value)
	Set maximum value. More...

	setCaption ($a_value)
	Set Caption. More...

	setShowCaption ($a_value)
	Toggle show caption status. More...

	setStriped ($a_value)
	Toggle striped layout. More...

	setAnimated ($a_value)
	Toggle animated layout. More...

	setCurrent ($a_value)
	Set current value. More...

	setAsyncStatusUrl ($a_target)

	setAsynStatusTimeout ($a_timeout)

	setId ($a_id)

	render ()
	Render. More...

Static Public Member Functions
static	getInstance ()
	Factory. More...

Data Fields
const	TYPE_INFO = 1

const	TYPE_SUCCESS = 2

const	TYPE_WARNING = 3

const	TYPE_DANGER = 4

Protected Member Functions
	__construct ()
	Constructor. More...

Protected Attributes
	$min

	$max

	$current

	$show_caption

	$type

	$caption

	$striped

	$animated

	$ajax_url = ''

	$ajax_timeout = 5

	$unique_id = ''

Detailed Description

Definition at line 11 of file class.ilProgressBar.php.

Constructor & Destructor Documentation

◆ __construct()

ilProgressBar::__construct ( )

protected

Constructor.

Returns: self

Definition at line 37 of file class.ilProgressBar.php.

References setMax(), setMin(), setShowCaption(), setStriped(), and setType().

     {
         $this->setMin(0);
         $this->setMax(100);
         $this->setShowCaption(true);
         $this->setType(self::TYPE_INFO);
         $this->setStriped(true);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getInstance()

static ilProgressBar::getInstance ( )

static

Factory.

Returns: ilProgressBar

Definition at line 51 of file class.ilProgressBar.php.

Referenced by ilSearchResultPresentation\appendRelevance(), ilObjectCopyProgressTableGUI\fillRow(), ilSearchResultTableGUI\fillRow(), ilPollBlockGUI\fillRow(), ilRepositoryObjectSearchResultTableGUI\getRelevanceHTML(), ilRepositoryUserResultTableGUI\getRelevanceHTML(), ilObjWikiGUI\getUserHTMLExportProgressObject(), ilObjectListGUI\insertRelevance(), ilSurveyExecutionGUI\outSurveyPage(), and ilSubItemListGUI\parseRelevance().

     {
         return new self();
     }

Here is the caller graph for this function:

◆ render()

ilProgressBar::render ( )

Render.

Returns: string

Definition at line 173 of file class.ilProgressBar.php.

References $tpl, array, and ilUtil\getImagePath().

     {
         $tpl = new ilTemplate("tpl.il_progress.html", true, true, "Services/UIComponent/ProgressBar");
         
         $tpl->setVariable("MIN", $this->min);
         $tpl->setVariable("MAX", $this->max);
         $tpl->setVariable("CURRENT_INT", round($this->current));
         $tpl->setVariable("CURRENT", round($this->current));
         $tpl->setVariable("CAPTION", $this->caption);
         
         $map = array(
             self::TYPE_INFO => "info"
             ,self::TYPE_SUCCESS => "success"
             ,self::TYPE_WARNING => "warning"
             ,self::TYPE_DANGER => "danger"
         );
         $css = array("progress-bar-" . $map[$this->type]);
         
         if ($this->striped) {
             $css[] = "progress-bar-striped";
         }
         
         if ($this->animated) {
             $css[] = "active";
         }
         
         $tpl->setVariable("CSS", implode(" ", $css));
         
         if (!$this->show_caption) {
             $tpl->touchBlock("hide_caption_in_bl");
             $tpl->touchBlock("hide_caption_out_bl");
         }
         
         if (strlen($this->ajax_url) and $this->ajax_timeout) {
             $tpl->setCurrentBlock('async_status');
             $tpl->setVariable('ASYNC_STATUS_ID', $this->unique_id);
             $tpl->setVariable('ICON_OK', ilUtil::getImagePath('icon_ok.svg'));
             $tpl->setVariable('AJAX_URL', $this->ajax_url);
             $tpl->setVariable('AJAX_TIMEOUT', 1000 * (int) $this->ajax_timeout);
             $tpl->parseCurrentBlock();
         }
         
         $tpl->setVariable('PROGRESS_ID', $this->unique_id);
         
         return $tpl->get();
     }

Here is the call graph for this function:

◆ setAnimated()

ilProgressBar::setAnimated ( $a_value )

Toggle animated layout.

Parameters

bool $a_value

Definition at line 134 of file class.ilProgressBar.php.

     {
         $this->animated = (bool) $a_value;
     }

◆ setAsyncStatusUrl()

ilProgressBar::setAsyncStatusUrl ( $a_target )

Definition at line 149 of file class.ilProgressBar.php.

     {
         $this->ajax_url = $a_target;
     }

◆ setAsynStatusTimeout()

ilProgressBar::setAsynStatusTimeout ( $a_timeout )

Definition at line 154 of file class.ilProgressBar.php.

     {
         $this->async_timeout = $a_timeout;
     }

◆ setCaption()

ilProgressBar::setCaption ( $a_value )

Set Caption.

Parameters

string $a_value

Definition at line 104 of file class.ilProgressBar.php.

     {
         $this->caption = trim($a_value);
     }

◆ setCurrent()

ilProgressBar::setCurrent ( $a_value )

Set current value.

Parameters

int | float $a_value

Definition at line 144 of file class.ilProgressBar.php.

     {
         $this->current = abs($a_value);
     }

◆ setId()

ilProgressBar::setId ( $a_id )

Definition at line 159 of file class.ilProgressBar.php.

     {
         $this->unique_id = $a_id;
     }

◆ setMax()

ilProgressBar::setMax ( $a_value )

Set maximum value.

Parameters

int $a_value

Definition at line 94 of file class.ilProgressBar.php.

Referenced by __construct().

     {
         $this->max = abs((int) $a_value);
     }

Here is the caller graph for this function:

◆ setMin()

ilProgressBar::setMin ( $a_value )

Set minimum value.

Parameters

int $a_value

Definition at line 84 of file class.ilProgressBar.php.

Referenced by __construct().

     {
         $this->min = abs((int) $a_value);
     }

Here is the caller graph for this function:

◆ setShowCaption()

ilProgressBar::setShowCaption ( $a_value )

Toggle show caption status.

Parameters

bool $a_value

Definition at line 114 of file class.ilProgressBar.php.

Referenced by __construct().

     {
         $this->show_caption = (bool) $a_value;
     }

Here is the caller graph for this function:

◆ setStriped()

ilProgressBar::setStriped ( $a_value )

Toggle striped layout.

Parameters

bool $a_value

Definition at line 124 of file class.ilProgressBar.php.

Referenced by __construct().

     {
         $this->striped = (bool) $a_value;
     }

Here is the caller graph for this function:

◆ setType()

ilProgressBar::setType ( $a_value )

Set type (currently unwanted)

Parameters

int $a_value

Definition at line 66 of file class.ilProgressBar.php.

References $valid, and array.

Referenced by __construct().

     {
         $valid = array(
             self::TYPE_INFO
             ,self::TYPE_SUCCESS
             ,self::TYPE_WARNING
             ,self::TYPE_DANGER
         );
         if (in_array($a_value, $valid)) {
             $this->type = $a_value;
         }
     }

Here is the caller graph for this function:

Field Documentation

◆ $ajax_timeout

ilProgressBar::$ajax_timeout = 5

protected

Definition at line 24 of file class.ilProgressBar.php.

◆ $ajax_url

ilProgressBar::$ajax_url = ''

protected

Definition at line 23 of file class.ilProgressBar.php.

◆ $animated

ilProgressBar::$animated

protected

Definition at line 20 of file class.ilProgressBar.php.

◆ $caption

ilProgressBar::$caption

protected

Definition at line 18 of file class.ilProgressBar.php.

◆ $current

ilProgressBar::$current

protected

Definition at line 15 of file class.ilProgressBar.php.

◆ $max

ilProgressBar::$max

protected

Definition at line 14 of file class.ilProgressBar.php.

◆ $min

ilProgressBar::$min

protected

Definition at line 13 of file class.ilProgressBar.php.

◆ $show_caption

ilProgressBar::$show_caption

protected

Definition at line 16 of file class.ilProgressBar.php.

◆ $striped

ilProgressBar::$striped

protected

Definition at line 19 of file class.ilProgressBar.php.

◆ $type

ilProgressBar::$type

protected

Definition at line 17 of file class.ilProgressBar.php.

◆ $unique_id

ilProgressBar::$unique_id = ''

protected

Definition at line 25 of file class.ilProgressBar.php.

◆ TYPE_DANGER

const ilProgressBar::TYPE_DANGER = 4

Definition at line 30 of file class.ilProgressBar.php.

◆ TYPE_INFO

const ilProgressBar::TYPE_INFO = 1

Definition at line 27 of file class.ilProgressBar.php.

◆ TYPE_SUCCESS

const ilProgressBar::TYPE_SUCCESS = 2

Definition at line 28 of file class.ilProgressBar.php.

Referenced by ilObjectCopyProgressTableGUI\fillRow().

◆ TYPE_WARNING

const ilProgressBar::TYPE_WARNING = 3

Definition at line 29 of file class.ilProgressBar.php.

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

Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInstance()

◆ render()

◆ setAnimated()

◆ setAsyncStatusUrl()

◆ setAsynStatusTimeout()

◆ setCaption()

◆ setCurrent()

◆ setId()

◆ setMax()

◆ setMin()

◆ setShowCaption()

◆ setStriped()

◆ setType()

Field Documentation

◆ $ajax_timeout

◆ $ajax_url

◆ $animated

◆ $caption

◆ $current

◆ $max

◆ $min

◆ $show_caption

◆ $striped

◆ $type

◆ $unique_id

◆ TYPE_DANGER

◆ TYPE_INFO

◆ TYPE_SUCCESS

◆ TYPE_WARNING