Inheritance diagram for ilButtonBase:

Collaboration diagram for ilButtonBase:

Public Member Functions
	__clone ()
	Clone instance. More...

	getType ()
	Get button type. More...

	setId ($a_value)
	Set id. More...

	getId ()
	Get id. More...

	setCaption ($a_value, $a_is_lng_id=true)
	Set caption. More...

	getCaption ($a_translate=true)
	Get caption. More...

	setPrimary ($a_value)
	Toggle primary status. More...

	isPrimary ()
	Get primary status. More...

	setOmitPreventDoubleSubmission ($a_value)
	Toggle double submission prevention status. More...

	getOmitPreventDoubleSubmission ()
	Get double submission prevention status. More...

	setOnClick ($a_value)
	Set onclick. More...

	getOnClick ()
	Get onclick. More...

	setAccessKey ($a_value)
	Set access key. More...

	getAccessKey ()
	Get access key. More...

	setDisabled ($a_value)
	Toggle disabled status. More...

	isDisabled ()
	Get disabled status. More...

	addCSSClass ($a_value)
	Add CSS class. More...

	getCSSClasses ()
	Get CSS class(es) More...

	applyDefaultCss ($apply_default_css=null)

	render ()
	Render HTML. More...

	getToolbarHTML ()

	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

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

Data Fields
const	TYPE_SUBMIT = 1

const	TYPE_LINK = 2

const	TYPE_SPLIT = 3

const	TYPE_BUTTON = 4

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

	setType ($a_value)
	Set button type. More...

	gatherCssClasses ()
	Gather all active CSS classes. More...

	renderAttributesHelper (array $a_attr)
	Render HTML node attributes. More...

	renderAttributes (array $a_additional_attr=null)
	Render current HTML attributes. More...

	prepareRender ()
	Prepare render More...

Protected Attributes
	$type

	$id

	$caption

	$caption_is_lng_id

	$primary

	$omit_prevent_double_submission

	$onclick

	$acc_key

	$disabled

	$css = array()

	$apply_default_css = true

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilButtonBase::__construct ( $a_type )

protected

Constructor.

Parameters

int $a_type

Returns: self

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

        {
                $this->setType($a_type);
        }

References setType().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilButtonBase::__clone ( )

Clone instance.

Definition at line 50 of file class.ilButtonBase.php.

        {
                $this->setId(null);
        }

References setId().

Here is the call graph for this function:

◆ addCSSClass()

ilButtonBase::addCSSClass ( $a_value )

Add CSS class.

Parameters

string $a_value

Definition at line 245 of file class.ilButtonBase.php.

        {
                $this->css[] = $a_value;
        }

Referenced by prepareRender().

Here is the caller graph for this function:

◆ applyDefaultCss()

ilButtonBase::applyDefaultCss ( $apply_default_css = null )

Parameters

boolean | null $apply_default_css

Returns: boolean|void

Definition at line 357 of file class.ilButtonBase.php.

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

References $apply_default_css.

Referenced by prepareRender().

Here is the caller graph for this function:

◆ gatherCssClasses()

ilButtonBase::gatherCssClasses ( )

protected

Gather all active CSS classes.

Returns: string

Definition at line 270 of file class.ilButtonBase.php.

        {
                $css = array_unique($this->getCSSClasses());
        
                if($this->isPrimary())
                {
                        $css[] = "btn-primary";
                }
                if($this->getOmitPreventDoubleSubmission())
                {
                        $css[] = "omitPreventDoubleSubmission";
                }
                
                return implode(" ", $css);
        }

References $css, getCSSClasses(), getOmitPreventDoubleSubmission(), and isPrimary().

Referenced by renderAttributes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAccessKey()

ilButtonBase::getAccessKey ( )

Get access key.

Returns: string

Definition at line 215 of file class.ilButtonBase.php.

        {
                return $this->acc_key;
        }

References $acc_key.

Referenced by renderAttributes().

Here is the caller graph for this function:

◆ getCaption()

ilButtonBase::getCaption ( $a_translate = true )

Get caption.

Parameters

bool $a_translate

Returns: string

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

        {
                global $lng;
                
                $caption = $this->caption;
                
                if($this->caption_is_lng_id &&
                        (bool)$a_translate)
                {
                        $caption = $lng->txt($caption);
                }
        
                return $caption;
        }

References $caption, and $lng.

Referenced by ilButton\render(), ilSubmitButton\render(), and ilImageLinkButton\renderCaption().

Here is the caller graph for this function:

◆ getCSSClasses()

ilButtonBase::getCSSClasses ( )

Get CSS class(es)

Returns: array

Definition at line 255 of file class.ilButtonBase.php.

        {
                return $this->css;
        }               

References $css.

Referenced by gatherCssClasses().

Here is the caller graph for this function:

◆ getId()

ilButtonBase::getId ( )

Get id.

Returns: string

Definition at line 102 of file class.ilButtonBase.php.

        {
                return $this->id;
        }

References $id.

Referenced by renderAttributes().

Here is the caller graph for this function:

◆ getInstance()

static ilButtonBase::getInstance ( )

staticabstract

Factory.

Returns: self

Reimplemented in ilDataCollectionLinkButton, ilTestPlayerNavButton, ilButton, ilImageLinkButton, ilLinkButton, ilSubmitButton, and ilSplitButtonGUI.

◆ getOmitPreventDoubleSubmission()

ilButtonBase::getOmitPreventDoubleSubmission ( )

Get double submission prevention status.

Returns: bool

Definition at line 175 of file class.ilButtonBase.php.

        {
                return $this->omit_prevent_double_submission;
        }

References $omit_prevent_double_submission.

Referenced by gatherCssClasses().

Here is the caller graph for this function:

◆ getOnClick()

ilButtonBase::getOnClick ( )

Get onclick.

Returns: string

Definition at line 195 of file class.ilButtonBase.php.

        {
                return $this->onclick;
        }

References $onclick.

Referenced by renderAttributes().

Here is the caller graph for this function:

◆ getToolbarHTML()

ilButtonBase::getToolbarHTML ( )

Returns: string

Implements ilToolbarItem.

Definition at line 378 of file class.ilButtonBase.php.

        {
                return $this->render();
        }

References render().

Here is the call graph for this function:

◆ getType()

ilButtonBase::getType ( )

Get button type.

Returns: int

Definition at line 82 of file class.ilButtonBase.php.

        {
                return $this->type;
        }

References $type.

◆ isDisabled()

ilButtonBase::isDisabled ( )

Get disabled status.

Returns: bool

Definition at line 235 of file class.ilButtonBase.php.

        {
                return $this->disabled;
        }

References $disabled.

Referenced by renderAttributes().

Here is the caller graph for this function:

◆ isPrimary()

ilButtonBase::isPrimary ( )

Get primary status.

Returns: bool

Definition at line 155 of file class.ilButtonBase.php.

        {
                return $this->primary;
        }

References $primary.

Referenced by ilToolbarGUI\addButtonInstance(), gatherCssClasses(), and ilSplitButtonGUI\render().

Here is the caller graph for this function:

◆ prepareRender()

ilButtonBase::prepareRender ( )

protected

Prepare render

Reimplemented in ilDataCollectionLinkButton, and ilImageLinkButton.

Definition at line 344 of file class.ilButtonBase.php.

        {               
                if($this->applyDefaultCss())
                {
                        $this->addCSSClass("btn");
                        $this->addCSSClass("btn-default");
                }
        }

References addCSSClass(), and applyDefaultCss().

Referenced by ilTestPlayerNavButton\render(), ilButton\render(), ilLinkButton\render(), and ilSubmitButton\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilButtonBase::render ( )

abstract

Render HTML.

Returns: string

Reimplemented in ilDataCollectionLinkButton, ilTestPlayerNavButton, ilButton, ilLinkButton, ilSubmitButton, and ilSplitButtonGUI.

Referenced by getToolbarHTML().

Here is the caller graph for this function:

◆ renderAttributes()

ilButtonBase::renderAttributes ( array $a_additional_attr = null )

protected

Render current HTML attributes.

Parameters

array $a_additional_attr

Returns: string

Reimplemented in ilLinkButton.

Definition at line 315 of file class.ilButtonBase.php.

        {               
                $attr = array();
                $attr["id"] = $this->getId();
                $attr["class"] = $this->gatherCssClasses();
                $attr["onclick"] = $this->getOnClick();                         
                
                if($this->getAccessKey())
                {
                        include_once("./Services/Accessibility/classes/class.ilAccessKey.php");
                        $attr["accesskey"] = ilAccessKey::getKey($this->getAccessKey());
                }
                
                if($this->isDisabled())
                {
                        $attr["disabled"] = "disabled";
                }
                
                if(sizeof($a_additional_attr))
                {
                        $attr = array_merge($attr, $a_additional_attr);
                }
                
                return $this->renderAttributesHelper($attr);
        }

References gatherCssClasses(), getAccessKey(), getId(), ilAccessKey\getKey(), getOnClick(), isDisabled(), and renderAttributesHelper().

Referenced by ilButton\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderAttributesHelper()

ilButtonBase::renderAttributesHelper ( array $a_attr )

protected

Render HTML node attributes.

Returns: string

Definition at line 291 of file class.ilButtonBase.php.

        {
                $res = array();
                
                foreach($a_attr as $id => $value)
                {
                        if(trim($value))
                        {
                                $res[] = strtolower(trim($id)).'="'.$value.'"';
                        }
                }
                
                if(sizeof($res))
                {
                        return " ".implode(" ", $res);
                }
        }               

References $id, and $res.

Referenced by renderAttributes().

Here is the caller graph for this function:

◆ setAccessKey()

ilButtonBase::setAccessKey ( $a_value )

Set access key.

Parameters

string $a_value

Definition at line 205 of file class.ilButtonBase.php.

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

◆ setCaption()

ilButtonBase::setCaption	(	$a_value,
		$a_is_lng_id = `true`
	)

Set caption.

Parameters

string	$a_value
bool	$a_is_lng_id

Definition at line 113 of file class.ilButtonBase.php.

        {
                $this->caption = $a_value;
                $this->caption_is_lng_id = (bool)$a_is_lng_id;
        }

◆ setDisabled()

ilButtonBase::setDisabled ( $a_value )

Toggle disabled status.

Parameters

bool $a_value

Definition at line 225 of file class.ilButtonBase.php.

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

◆ setId()

ilButtonBase::setId ( $a_value )

Set id.

Parameters

string $a_value

Definition at line 92 of file class.ilButtonBase.php.

        {
                $this->id = $a_value;
        }

Referenced by __clone().

Here is the caller graph for this function:

◆ setOmitPreventDoubleSubmission()

ilButtonBase::setOmitPreventDoubleSubmission ( $a_value )

Toggle double submission prevention status.

Parameters

bool $a_value

Definition at line 165 of file class.ilButtonBase.php.

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

◆ setOnClick()

ilButtonBase::setOnClick ( $a_value )

Set onclick.

Parameters

string $a_value

Definition at line 185 of file class.ilButtonBase.php.

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

◆ setPrimary()

ilButtonBase::setPrimary ( $a_value )

Toggle primary status.

Parameters

bool $a_value

Definition at line 145 of file class.ilButtonBase.php.

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

◆ setType()

ilButtonBase::setType ( $a_value )

protected

Set button type.

Parameters

int $a_value

Definition at line 72 of file class.ilButtonBase.php.

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

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $acc_key

ilButtonBase::$acc_key

protected

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

Referenced by getAccessKey().

◆ $apply_default_css

ilButtonBase::$apply_default_css = true

protected

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

Referenced by applyDefaultCss().

◆ $caption

ilButtonBase::$caption

protected

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

Referenced by getCaption().

◆ $caption_is_lng_id

ilButtonBase::$caption_is_lng_id

protected

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

◆ $css

ilButtonBase::$css = array()

protected

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

Referenced by gatherCssClasses(), and getCSSClasses().

◆ $disabled

ilButtonBase::$disabled

protected

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

Referenced by isDisabled().

◆ $id

ilButtonBase::$id

protected

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

Referenced by getId(), and renderAttributesHelper().

◆ $omit_prevent_double_submission

ilButtonBase::$omit_prevent_double_submission

protected

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

Referenced by getOmitPreventDoubleSubmission().

◆ $onclick

ilButtonBase::$onclick

protected

Definition at line 21 of file class.ilButtonBase.php.

Referenced by getOnClick().

◆ $primary

ilButtonBase::$primary

protected

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

Referenced by isPrimary().

◆ $type

ilButtonBase::$type

protected

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

Referenced by getType().

◆ TYPE_BUTTON

const ilButtonBase::TYPE_BUTTON = 4

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

Referenced by ilButton\getInstance().

◆ TYPE_LINK

const ilButtonBase::TYPE_LINK = 2

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

Referenced by ilTestPlayerNavButton\getInstance(), ilImageLinkButton\getInstance(), and ilLinkButton\getInstance().

◆ TYPE_SPLIT

const ilButtonBase::TYPE_SPLIT = 3

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

Referenced by ilSplitButtonGUI\getInstance().

◆ TYPE_SUBMIT

const ilButtonBase::TYPE_SUBMIT = 1

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

Referenced by ilSubmitButton\getInstance().

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

Services/UIComponent/Button/classes/class.ilButtonBase.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __clone()

◆ addCSSClass()

◆ applyDefaultCss()

◆ gatherCssClasses()

◆ getAccessKey()

◆ getCaption()

◆ getCSSClasses()

◆ getId()

◆ getInstance()

◆ getOmitPreventDoubleSubmission()

◆ getOnClick()

◆ getToolbarHTML()

◆ getType()

◆ isDisabled()

◆ isPrimary()

◆ prepareRender()

◆ render()

◆ renderAttributes()

◆ renderAttributesHelper()

◆ setAccessKey()

◆ setCaption()

◆ setDisabled()

◆ setId()

◆ setOmitPreventDoubleSubmission()

◆ setOnClick()

◆ setPrimary()

◆ setType()

Field Documentation

◆ $acc_key

◆ $apply_default_css

◆ $caption

◆ $caption_is_lng_id

◆ $css

◆ $disabled

◆ $id

◆ $omit_prevent_double_submission

◆ $onclick

◆ $primary

◆ $type

◆ TYPE_BUTTON

◆ TYPE_LINK

◆ TYPE_SPLIT

◆ TYPE_SUBMIT