This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilProgressBar:

Public Member Functions
	setType (int $a_value)

	setMin (int $a_value)

	setMax (int $a_value)

	setCaption (string $a_value)

	setShowCaption (bool $a_value)

	setStriped (bool $a_value)

	setAnimated (bool $a_value)

	setCurrent (float $a_value)

	setAsyncStatusUrl (string $a_target)

	setAsynStatusTimeout (int $a_timeout)

	setId (string $a_id)

	render ()

Static Public Member Functions
static	getInstance ()

Data Fields
const	TYPE_INFO = 1

const	TYPE_SUCCESS = 2

const	TYPE_WARNING = 3

const	TYPE_DANGER = 4

Protected Member Functions
	__construct ()

Protected Attributes
ilGlobalTemplateInterface	$main_tpl

int	$min = 0

int	$max = 0

int	$current = 0

bool	$show_caption = false

int	$type = 0

string	$caption = ""

bool	$striped = false

bool	$animated = false

string	$ajax_url = ''

int	$ajax_timeout = 5

string	$unique_id = ''

int	$async_timeout = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Progress bar GUI

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilProgressBar::__construct ( )

protected

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

    {
        global $DIC;
 
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $this->setMin(0);
        $this->setMax(100);
        $this->setShowCaption(true);
        $this->setType(self::TYPE_INFO);
        $this->setStriped(true);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getInstance()

static ilProgressBar::getInstance ( )

static

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

                                        : self
    {
        return new self();
    }

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

Here is the caller graph for this function:

◆ render()

ilProgressBar::render ( )

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

                            : string
    {
        $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 ($this->ajax_url !== '' && $this->ajax_timeout) {
            $this->main_tpl->addJavaScript("Services/UIComponent/ProgressBar/js/progress_bar.js");
            $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 * $this->ajax_timeout);
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable('PROGRESS_ID', $this->unique_id);
 
        return $tpl->get();
    }

References $tpl, and ilUtil\getImagePath().

Here is the call graph for this function:

◆ setAnimated()

ilProgressBar::setAnimated ( bool $a_value )

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

                                              : void
    {
        $this->animated = $a_value;
    }

◆ setAsyncStatusUrl()

ilProgressBar::setAsyncStatusUrl ( string $a_target )

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

                                                       : void
    {
        $this->ajax_url = $a_target;
    }

◆ setAsynStatusTimeout()

ilProgressBar::setAsynStatusTimeout ( int $a_timeout )

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

                                                        : void
    {
        $this->async_timeout = $a_timeout;
    }

◆ setCaption()

ilProgressBar::setCaption ( string $a_value )

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

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

◆ setCurrent()

ilProgressBar::setCurrent ( float $a_value )

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

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

◆ setId()

ilProgressBar::setId ( string $a_id )

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

                                       : void
    {
        $this->unique_id = $a_id;
    }

◆ setMax()

ilProgressBar::setMax ( int $a_value )

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setMin()

ilProgressBar::setMin ( int $a_value )

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setShowCaption()

ilProgressBar::setShowCaption ( bool $a_value )

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

                                                 : void
    {
        $this->show_caption = $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setStriped()

ilProgressBar::setStriped ( bool $a_value )

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

                                             : void
    {
        $this->striped = $a_value;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setType()

ilProgressBar::setType ( int $a_value )

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

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

References $valid.

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $ajax_timeout

int ilProgressBar::$ajax_timeout = 5

protected

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

◆ $ajax_url

string ilProgressBar::$ajax_url = ''

protected

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

◆ $animated

bool ilProgressBar::$animated = false

protected

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

◆ $async_timeout

int ilProgressBar::$async_timeout = 0

protected

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

◆ $caption

string ilProgressBar::$caption = ""

protected

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

◆ $current

int ilProgressBar::$current = 0

protected

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

◆ $main_tpl

ilGlobalTemplateInterface ilProgressBar::$main_tpl

protected

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

◆ $max

int ilProgressBar::$max = 0

protected

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

◆ $min

int ilProgressBar::$min = 0

protected

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

◆ $show_caption

bool ilProgressBar::$show_caption = false

protected

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

◆ $striped

bool ilProgressBar::$striped = false

protected

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

◆ $type

int ilProgressBar::$type = 0

protected

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

◆ $unique_id

string ilProgressBar::$unique_id = ''

protected

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

◆ TYPE_DANGER

const ilProgressBar::TYPE_DANGER = 4

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

◆ TYPE_INFO

const ilProgressBar::TYPE_INFO = 1

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

◆ TYPE_SUCCESS

const ilProgressBar::TYPE_SUCCESS = 2

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

Referenced by ilObjectCopyProgressTableGUI\fillRow().

◆ TYPE_WARNING

const ilProgressBar::TYPE_WARNING = 3

Definition at line 27 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

◆ $async_timeout

◆ $caption

◆ $current

◆ $main_tpl

◆ $max

◆ $min

◆ $show_caption

◆ $striped

◆ $type

◆ $unique_id

◆ TYPE_DANGER

◆ TYPE_INFO

◆ TYPE_SUCCESS

◆ TYPE_WARNING