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

Collaboration diagram for ilDclLinkButton:

Public Member Functions
	isUseWrapper ()
	setUseWrapper (bool $useWrapper)
	render ()
	addAttribute (string $key, string $value, bool $wrapper=false)
	removeAttribute (string $key, $wrapper=false)
	getAttribute (string $key, bool $wrapper=false)
Public Member Functions inherited from ilLinkButton
	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 ilLinkButton
static	getInstance ()
Static Public Member Functions inherited from ilButtonBase
static	getInstance ()

Data Fields
const	TYPE_DATACOLLECTION_LINK = 99
Data Fields inherited from ilButtonBase
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2
const	TYPE_SPLIT = 3
const	TYPE_BUTTON = 4

Protected Member Functions
	prepareRender ()
	getGroupKey ($wrapper)
Protected Member Functions inherited from ilLinkButton
	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
array	$attributes
bool	$useWrapper = false
Protected Attributes inherited from ilLinkButton
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

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

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

Member Function Documentation

addAttribute()

ilDclLinkButton::addAttribute	(	string	$key,
		string	$value,
		bool	$wrapper = false
	)

Definition at line 66 of file class.ilDclLinkButton.php.

References ILIAS\LTI\ToolProvider\$key, and getGroupKey().

Referenced by prepareRender().

                                                                                   : void
    {
        $this->attributes[$this->getGroupKey($wrapper)][$key] = $value;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAttribute()

ilDclLinkButton::getAttribute	(	string	$key,
		bool	$wrapper = false
	)

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

References ILIAS\LTI\ToolProvider\$key, and getGroupKey().

                                                                    : ?string
    {
        if (isset($this->attributes[$this->getGroupKey($wrapper)][$key])) {
            return $this->attributes[$this->getGroupKey($wrapper)][$key];
        }

        return null;
    }

Here is the call graph for this function:

getGroupKey()

ilDclLinkButton::getGroupKey (   $wrapper )

protected

Definition at line 91 of file class.ilDclLinkButton.php.

Referenced by addAttribute(), getAttribute(), and removeAttribute().

                                            : string
    {
        return ($wrapper) ? 'wrapper' : 'default';
    }

Here is the caller graph for this function:

getInstance()

static ilDclLinkButton::getInstance ( )

static

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

Referenced by ilDclTableViewTableGUI\buildAction().

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

Here is the caller graph for this function:

isUseWrapper()

ilDclLinkButton::isUseWrapper

(

)

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

References $useWrapper.

                                  : bool
    {
        return $this->useWrapper;
    }

prepareRender()

ilDclLinkButton::prepareRender ( )

protected

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

References addAttribute(), ilLinkButton\getTarget(), and ilLinkButton\getUrl().

Referenced by render().

                                      : void
    {
        parent::prepareRender();

        $this->addAttribute('href', ($this->getUrl() ?: "#"));
        $this->addAttribute('target', $this->getTarget());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeAttribute()

ilDclLinkButton::removeAttribute	(	string	$key,
			$wrapper = false
	)

Definition at line 71 of file class.ilDclLinkButton.php.

References getGroupKey().

                                                                  : bool
    {
        if (isset($this->attributes[$this->getGroupKey($wrapper)][$key])) {
            unset($this->attributes[$this->getGroupKey($wrapper)][$key]);

            return true;
        }

        return false;
    }

Here is the call graph for this function:

render()

ilDclLinkButton::render

(

)

Definition at line 48 of file class.ilDclLinkButton.php.

References prepareRender(), ilLinkButton\renderAttributes(), ilButtonBase\renderAttributesHelper(), and ilLinkButton\renderCaption().

                            : string
    {
        $this->prepareRender();

        $output = '';
        if ($this->useWrapper) {
            $output .= '<div' . $this->renderAttributesHelper($this->attributes['wrapper']) . '>';
        }

        $output .= '<a' . $this->renderAttributes($this->attributes['default']) . '>' . $this->renderCaption() . '</a>';

        if ($this->useWrapper) {
            $output .= '</div>';
        }

        return $output;
    }

Here is the call graph for this function:

setUseWrapper()

ilDclLinkButton::setUseWrapper

(

bool

$useWrapper

)

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

References $useWrapper.

                                                   : void
    {
        $this->useWrapper = $useWrapper;
    }

Field Documentation

$attributes

array ilDclLinkButton::$attributes

protected

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

$useWrapper

bool ilDclLinkButton::$useWrapper = false

protected

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

Referenced by isUseWrapper(), and setUseWrapper().

TYPE_DATACOLLECTION_LINK

const ilDclLinkButton::TYPE_DATACOLLECTION_LINK = 99

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

---

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

• Modules/DataCollection/classes/Helpers/class.ilDclLinkButton.php