ilButtonBase Class Reference

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

Inheritance diagram for ilButtonBase:

Collaboration diagram for ilButtonBase:

Public Member Functions
	__clone ()
	getType ()
	setId (?string $a_value)
	getId ()
	setCaption (string $a_value, bool $a_is_lng_id=true)
	getCaption (bool $a_translate=true)
	setPrimary (bool $a_value)
	isPrimary ()
	setOmitPreventDoubleSubmission (bool $a_value)
	Toggle double submission prevention status. More...
	getOmitPreventDoubleSubmission ()
	setOnClick (string $a_value)
	getOnClick ()
	setDisabled (bool $a_value)
	isDisabled ()
	addCSSClass (string $a_value)
	getCSSClasses ()
	applyDefaultCss (?bool $apply_default_css=null)
	render ()
	getToolbarHTML ()
	Get input item HTML to be inserted into ilToolbarGUI. More...

Static Public Member Functions
static	getInstance ()

Data Fields
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2
const	TYPE_SPLIT = 3
const	TYPE_BUTTON = 4

Protected Member Functions
	__construct (int $a_type)
	setType (int $a_value)
	gatherCssClasses ()
	renderAttributesHelper (array $a_attr)
	renderAttributes (?array $a_additional_attr=null)
	Render current HTML attributes. More...
	prepareRender ()

Protected Attributes
ilLanguage	$lng
int	$type = 0
string	$id = ""
string	$caption = ""
bool	$caption_is_lng_id = false
bool	$primary = false
bool	$omit_prevent_double_submission = false
string	$onclick = ""
int	$acc_key = 0
bool	$disabled = false
array	$css = array()
bool	$apply_default_css = true

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 Button GUI

Author

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

Deprecated:

10 Use KS Buttons instead

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

Constructor & Destructor Documentation

__construct()

ilButtonBase::__construct ( int  $a_type )

protected

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

References $DIC, ILIAS\Repository\lng(), 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

(

)

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

References getInstance(), null, and setId().

    {
        $this->setId(null);
    }

Here is the call graph for this function:

addCSSClass()

ilButtonBase::addCSSClass

(

string

$a_value

)

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

Referenced by prepareRender().

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

Here is the caller graph for this function:

applyDefaultCss()

ilButtonBase::applyDefaultCss

(

?bool

$apply_default_css = null

)

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

References $apply_default_css, null, and render().

Referenced by prepareRender().

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

        $this->apply_default_css = $apply_default_css;
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

gatherCssClasses()

ilButtonBase::gatherCssClasses ( )

protected

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

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

Referenced by renderAttributes().

                                         : string
    {
        $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:

getCaption()

ilButtonBase::getCaption

(

bool

$a_translate = true

)

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

References $caption, $lng, and ilLanguage\txt().

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

                                                        : string
    {
        $lng = $this->lng;

        $caption = $this->caption;

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

        return $caption;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCSSClasses()

ilButtonBase::getCSSClasses

(

)

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

References $css.

Referenced by gatherCssClasses().

                                   : array
    {
        return $this->css;
    }

Here is the caller graph for this function:

getId()

ilButtonBase::getId

(

)

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

References $id.

Referenced by renderAttributes().

                           : ?string
    {
        return $this->id;
    }

Here is the caller graph for this function:

getInstance()

static ilButtonBase::getInstance ( )

staticabstract

Referenced by __clone().

Here is the caller graph for this function:

getOmitPreventDoubleSubmission()

ilButtonBase::getOmitPreventDoubleSubmission

(

)

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

References $omit_prevent_double_submission.

Referenced by gatherCssClasses().

                                                    : bool
    {
        return $this->omit_prevent_double_submission;
    }

Here is the caller graph for this function:

getOnClick()

ilButtonBase::getOnClick

(

)

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

References $onclick.

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

                                : string
    {
        return $this->onclick;
    }

Here is the caller graph for this function:

getToolbarHTML()

ilButtonBase::getToolbarHTML

(

)

Get input item HTML to be inserted into ilToolbarGUI.

Implements ilToolbarItem.

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

References render().

                                    : string
    {
        return $this->render();
    }

Here is the call graph for this function:

getType()

ilButtonBase::getType

(

)

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

References $type.

                             : int
    {
        return $this->type;
    }

isDisabled()

ilButtonBase::isDisabled

(

)

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

References $disabled.

Referenced by renderAttributes().

                                : bool
    {
        return $this->disabled;
    }

Here is the caller graph for this function:

isPrimary()

ilButtonBase::isPrimary

(

)

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

References $primary.

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

                               : bool
    {
        return $this->primary;
    }

Here is the caller graph for this function:

prepareRender()

ilButtonBase::prepareRender ( )

protected

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

References addCSSClass(), and applyDefaultCss().

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

                                      : void
    {
        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

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.

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

References gatherCssClasses(), getId(), getOnClick(), isDisabled(), and renderAttributesHelper().

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

                                                                         : string
    {
        $attr = array();
        $attr["id"] = $this->getId();
        $attr["class"] = $this->gatherCssClasses();
        $attr["onclick"] = $this->getOnClick();

        if ($this->isDisabled()) {
            $attr["disabled"] = "disabled";
        }

        if (count($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

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

References $res.

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

                                                            : string
    {
        $res = array();

        foreach ($a_attr as $id => $value) {
            if (trim((string) $value)) {
                $res[] = strtolower(trim($id)) . '="' . $value . '"';
            }
        }

        if (count($res)) {
            return " " . implode(" ", $res);
        }
        return "";
    }

Here is the caller graph for this function:

setCaption()

ilButtonBase::setCaption	(	string	$a_value,
		bool	$a_is_lng_id = true
	)

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

                                                                         : void
    {
        $this->caption = $a_value;
        $this->caption_is_lng_id = $a_is_lng_id;
    }

setDisabled()

ilButtonBase::setDisabled

(

bool

$a_value

)

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

References ILIAS\UI\examples\Input\Field\Checkbox\disabled().

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

Here is the call graph for this function:

setId()

ilButtonBase::setId

(

?string

$a_value

)

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

Referenced by __clone().

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

Here is the caller graph for this function:

setOmitPreventDoubleSubmission()

ilButtonBase::setOmitPreventDoubleSubmission

(

bool

$a_value

)

Toggle double submission prevention status.

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

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

setOnClick()

ilButtonBase::setOnClick

(

string

$a_value

)

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

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

setPrimary()

ilButtonBase::setPrimary

(

bool

$a_value

)

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

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

setType()

ilButtonBase::setType ( int  $a_value )

protected

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

Referenced by __construct().

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

Here is the caller graph for this function:

Field Documentation

$acc_key

int ilButtonBase::$acc_key = 0

protected

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

$apply_default_css

bool ilButtonBase::$apply_default_css = true

protected

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

Referenced by applyDefaultCss().

$caption

string ilButtonBase::$caption = ""

protected

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

Referenced by getCaption().

$caption_is_lng_id

bool ilButtonBase::$caption_is_lng_id = false

protected

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

$css

array ilButtonBase::$css = array()

protected

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

Referenced by getCSSClasses().

$disabled

bool ilButtonBase::$disabled = false

protected

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

Referenced by isDisabled().

$id

string ilButtonBase::$id = ""

protected

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

Referenced by getId().

$lng

ilLanguage ilButtonBase::$lng

protected

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

Referenced by getCaption().

$omit_prevent_double_submission

bool ilButtonBase::$omit_prevent_double_submission = false

protected

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

Referenced by getOmitPreventDoubleSubmission().

$onclick

string ilButtonBase::$onclick = ""

protected

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

Referenced by getOnClick().

$primary

bool ilButtonBase::$primary = false

protected

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

Referenced by isPrimary().

$type

int ilButtonBase::$type = 0

protected

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

Referenced by getType().

TYPE_BUTTON

const ilButtonBase::TYPE_BUTTON = 4

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

TYPE_LINK

const ilButtonBase::TYPE_LINK = 2

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

TYPE_SPLIT

const ilButtonBase::TYPE_SPLIT = 3

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

TYPE_SUBMIT

const ilButtonBase::TYPE_SUBMIT = 1

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

---

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

• components/ILIAS/UIComponent/Button/classes/class.ilButtonBase.php