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 ()

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

	$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 47 of file class.ilButtonBase.php.

References $a_type, $DIC, and setType().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->setType($a_type);
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilButtonBase::__clone ( )

Clone instance.

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

References getInstance(), and setId().

     {
         $this->setId(null);
     }

Here is the call graph for this function:

◆ addCSSClass()

ilButtonBase::addCSSClass ( $a_value )

Add CSS class.

Parameters

string $a_value

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

Referenced by ilAssFileUploadFileTableDeleteButton\__construct(), and prepareRender().

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

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 355 of file class.ilButtonBase.php.

References $apply_default_css, and render().

Referenced by prepareRender().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherCssClasses()

ilButtonBase::gatherCssClasses ( )

protected

Gather all active CSS classes.

Returns: string

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

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

Referenced by renderAttributes().

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

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 222 of file class.ilButtonBase.php.

References $acc_key.

Referenced by renderAttributes().

     {
         return $this->acc_key;
     }

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 133 of file class.ilButtonBase.php.

References $caption, and $lng.

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

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

Here is the caller graph for this function:

◆ getCSSClasses()

ilButtonBase::getCSSClasses ( )

Get CSS class(es)

Returns: array

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

References $css.

Referenced by gatherCssClasses().

     {
         return $this->css;
     }

Here is the caller graph for this function:

◆ getId()

ilButtonBase::getId ( )

Get id.

Returns: string

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

References $id.

Referenced by renderAttributes().

     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilButtonBase::getInstance ( )

staticabstract

Factory.

Returns: self

Referenced by __clone().

Here is the caller graph for this function:

◆ getOmitPreventDoubleSubmission()

ilButtonBase::getOmitPreventDoubleSubmission ( )

Get double submission prevention status.

Returns: bool

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

References $omit_prevent_double_submission.

Referenced by gatherCssClasses().

     {
         return $this->omit_prevent_double_submission;
     }

Here is the caller graph for this function:

◆ getOnClick()

ilButtonBase::getOnClick ( )

Get onclick.

Returns: string

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

References $onclick.

Referenced by ilJsLinkButton\render(), and renderAttributes().

     {
         return $this->onclick;
     }

Here is the caller graph for this function:

◆ getToolbarHTML()

ilButtonBase::getToolbarHTML ( )

Returns: string

Implements ilToolbarItem.

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

References render().

     {
         return $this->render();
     }

Here is the call graph for this function:

◆ getType()

ilButtonBase::getType ( )

Get button type.

Returns: int

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

References $type.

     {
         return $this->type;
     }

◆ isDisabled()

ilButtonBase::isDisabled ( )

Get disabled status.

Returns: bool

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

References $disabled.

Referenced by renderAttributes().

     {
         return $this->disabled;
     }

Here is the caller graph for this function:

◆ isPrimary()

ilButtonBase::isPrimary ( )

Get primary status.

Returns: bool

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

References $primary.

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

     {
         return $this->primary;
     }

Here is the caller graph for this function:

◆ prepareRender()

ilButtonBase::prepareRender ( )

protected

Prepare render.

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

References addCSSClass(), and applyDefaultCss().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ilButtonBase::render ( )

abstract

Render HTML.

Returns: string

Referenced by applyDefaultCss(), and 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

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

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

Referenced by ilJsLinkButton\render(), ilSubmitButton\render(), and ilButton\render().

     {
         $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);
     }

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 296 of file class.ilButtonBase.php.

References $id, and $res.

Referenced by ilDclLinkButton\render(), renderAttributes(), and ilImageLinkButton\renderCaption().

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

Here is the caller graph for this function:

◆ setAccessKey()

ilButtonBase::setAccessKey ( $a_value )

Set access key.

Parameters

string $a_value

Definition at line 212 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 121 of file class.ilButtonBase.php.

Referenced by ilAssFileUploadFileTableReuseButton\__construct(), and ilAssFileUploadFileTableDeleteButton\__construct().

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

Here is the caller graph for this function:

◆ setDisabled()

ilButtonBase::setDisabled ( $a_value )

Toggle disabled status.

Parameters

bool $a_value

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

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

◆ setId()

ilButtonBase::setId ( $a_value )

Set id.

Parameters

string $a_value

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

Referenced by __clone().

     {
         $this->id = $a_value;
     }

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 172 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 192 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 152 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 80 of file class.ilButtonBase.php.

Referenced by __construct().

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

Here is the caller graph for this function:

Field Documentation

◆ $acc_key

ilButtonBase::$acc_key

protected

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

Referenced by getAccessKey().

◆ $apply_default_css

ilButtonBase::$apply_default_css = true

protected

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

Referenced by applyDefaultCss().

◆ $caption

ilButtonBase::$caption

protected

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

Referenced by getCaption(), and ilTestPlayerNavButton\renderCaption().

◆ $caption_is_lng_id

ilButtonBase::$caption_is_lng_id

protected

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

◆ $css

ilButtonBase::$css = array()

protected

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

Referenced by gatherCssClasses(), and getCSSClasses().

◆ $disabled

ilButtonBase::$disabled

protected

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

Referenced by isDisabled().

◆ $id

ilButtonBase::$id

protected

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

Referenced by getId(), and renderAttributesHelper().

◆ $lng

ilButtonBase::$lng

protected

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

Referenced by getCaption().

◆ $omit_prevent_double_submission

ilButtonBase::$omit_prevent_double_submission

protected

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

Referenced by getOmitPreventDoubleSubmission().

◆ $onclick

ilButtonBase::$onclick

protected

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

Referenced by getOnClick().

◆ $primary

ilButtonBase::$primary

protected

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

Referenced by isPrimary().

◆ $type

ilButtonBase::$type

protected

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

Referenced by ilAssFileUploadFileTableReuseButton\__construct(), ilAssFileUploadFileTableDeleteButton\__construct(), and getType().

◆ TYPE_BUTTON

const ilButtonBase::TYPE_BUTTON = 4

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

◆ TYPE_LINK

const ilButtonBase::TYPE_LINK = 2

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

◆ TYPE_SPLIT

const ilButtonBase::TYPE_SPLIT = 3

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

◆ TYPE_SUBMIT

const ilButtonBase::TYPE_SUBMIT = 1

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

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

◆ $lng

◆ $omit_prevent_double_submission

◆ $onclick

◆ $primary

◆ $type

◆ TYPE_BUTTON

◆ TYPE_LINK

◆ TYPE_SPLIT

◆ TYPE_SUBMIT