ilLinkButton 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 ilLinkButton:

Collaboration diagram for ilLinkButton:

Public Member Functions
	setUrl (string $a_value)
	getUrl ()
	setTarget (string $a_value)
	getTarget ()
	render ()
Public Member Functions inherited from ilButtonBase
	__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 ()
Static Public Member Functions inherited from ilButtonBase
static	getInstance ()

Protected Member Functions
	renderCaption ()
	renderAttributes (?array $a_additional_attr=null)
Protected Member Functions inherited from ilButtonBase
	__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
string	$url = ""
string	$target = ""
Protected Attributes inherited from ilButtonBase
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

Additional Inherited Members
Data Fields inherited from ilButtonBase
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2
const	TYPE_SPLIT = 3
const	TYPE_BUTTON = 4

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 Link 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:

9 Use KS Buttons instead

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

Member Function Documentation

getInstance()

static ilLinkButton::getInstance ( )

static

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

Referenced by ilToolbarGUI\applyAutoStickyToSingleElement(), ilObjSAHSLearningModule\getViewButton(), ilExplorerSelectInputGUI\render(), and ILIAS\Containter\Content\ObjectiveRenderer\renderProgressMeter().

                                        : self
    {
        return new self(self::TYPE_LINK);
    }

Here is the caller graph for this function:

getTarget()

ilLinkButton::getTarget

(

)

Definition at line 55 of file class.ilLinkButton.php.

References $target.

Referenced by render(), and renderAttributes().

                               : string
    {
        return $this->target;
    }

Here is the caller graph for this function:

getUrl()

ilLinkButton::getUrl

(

)

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

References $url.

Referenced by render().

                            : string
    {
        return $this->url;
    }

Here is the caller graph for this function:

render()

ilLinkButton::render

(

)

Definition at line 87 of file class.ilLinkButton.php.

References getTarget(), getUrl(), ilButtonBase\prepareRender(), renderAttributes(), and renderCaption().

                            : string
    {
        $this->prepareRender();

        $attr = array();
        $attr["href"] = $this->getUrl() ?: "#";
        $attr["target"] = $this->getTarget();

        return '<a' . $this->renderAttributes($attr) . '>' .
            $this->renderCaption() . '</a>';
    }

Here is the call graph for this function:

renderAttributes()

ilLinkButton::renderAttributes ( ?array  $a_additional_attr = null )

protected

Definition at line 70 of file class.ilLinkButton.php.

References getTarget().

Referenced by render().

                                                                         : string
    {
        if ('_blank' === $this->getTarget()) {
            $relAttrVal = 'noopener';

            if (isset($a_additional_attr['rel'])) {
                if (strpos($a_additional_attr['rel'], $relAttrVal) === false) {
                    $a_additional_attr['rel'] .= ' ' . $relAttrVal;
                }
            } else {
                $a_additional_attr['rel'] = $relAttrVal;
            }
        }

        return parent::renderAttributes($a_additional_attr);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

renderCaption()

ilLinkButton::renderCaption ( )

protected

Definition at line 65 of file class.ilLinkButton.php.

References ilButtonBase\getCaption().

Referenced by render().

                                      : string
    {
        return ' ' . $this->getCaption() . ' ';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTarget()

ilLinkButton::setTarget

(

string

$a_value

)

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

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

setUrl()

ilLinkButton::setUrl

(

string

$a_value

)

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

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

Field Documentation

$target

string ilLinkButton::$target = ""

protected

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

Referenced by getTarget().

$url

string ilLinkButton::$url = ""

protected

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

Referenced by getUrl().

---

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

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