ilProgressBar Class Reference

Collaboration diagram for ilProgressBar:

Public Member Functions
	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...
	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...
	setType ($a_value)
	Set type (currently unwanted) More...

Protected Attributes
	$min
	$max
	$current
	$show_caption
	$type
	$caption
	$striped
	$animated

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilProgressBar::__construct ( )

protected

Constructor.

Returns

self

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

self

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

Referenced by ilSearchResultPresentation\appendRelevance(), ilSearchResultTableGUI\fillRow(), ilPollBlockGUI\fillRow(), ilRepositoryUserResultTableGUI\getRelevanceHTML(), 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 155 of file class.ilProgressBar.php.

References $tpl.

        {
                $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");
                }
                
                return $tpl->get();
        }

setAnimated()

ilProgressBar::setAnimated

(

$a_value

)

Toggle animated layout.

Parameters

bool

$a_value

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

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

setCaption()

ilProgressBar::setCaption

(

$a_value

)

Set Caption.

Parameters

string

$a_value

Definition at line 100 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 140 of file class.ilProgressBar.php.

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

setMax()

ilProgressBar::setMax

(

$a_value

)

Set maximum value.

Parameters

int

$a_value

Definition at line 90 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 80 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 110 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 120 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 )

protected

Set type (currently unwanted)

Parameters

int

$a_value

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

References $valid.

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

$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.

TYPE_DANGER

const ilProgressBar::TYPE_DANGER = 4

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

TYPE_INFO

const ilProgressBar::TYPE_INFO = 1

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

TYPE_SUCCESS

const ilProgressBar::TYPE_SUCCESS = 2

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

TYPE_WARNING

const ilProgressBar::TYPE_WARNING = 3

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

---

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

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