Inheritance diagram for ilDataCollectionLinkButton:

Collaboration diagram for ilDataCollectionLinkButton:

Public Member Functions
	isUseWrapper ()

	setUseWrapper ($useWrapper)

	prepareRender ()
	Prepare render More...

	render ()
	Render HTML. More...

	addAttribute ($key, $value, $wrapper=false)

	removeAttribute ($key, $wrapper=false)

	getAttribute ($key, $wrapper=false)

Public Member Functions inherited from ilLinkButton
	setUrl ($a_value)
	Set URL. More...

	getUrl ()
	Get URL. More...

	setTarget ($a_value)
	Set target. More...

	getTarget ()
	Get target. More...

	render ()
	Render HTML. More...

Public Member Functions inherited from ilButtonBase
	__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...

static	getInstance ()
	Factory. More...

static	getInstance ()
	Factory. More...

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

getGroupKey ($wrapper)

Protected Member Functions inherited from ilLinkButton

renderCaption ()

Prepare caption for render. More...

renderAttributes (array $a_additional_attr=null)

Render current HTML attributes.

Parameters

array $a_additional_attr

Returns: string

More...

Protected Member Functions inherited from ilButtonBase

__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
	$attributes

	$useWrapper = false

Protected Attributes inherited from ilLinkButton
	$url

	$target

Protected Attributes inherited from ilButtonBase
	$type

	$id

	$caption

	$caption_is_lng_id

	$primary

	$omit_prevent_double_submission

	$onclick

	$acc_key

	$disabled

	$css = array()

	$apply_default_css = true

Detailed Description

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 7 of file class.ilDataCollectionLinkButton.php.

Member Function Documentation

◆ addAttribute()

ilDataCollectionLinkButton::addAttribute	(	$key,
		$value,
		$wrapper = `false`
	)

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

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

References getGroupKey().

Referenced by prepareRender().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttribute()

ilDataCollectionLinkButton::getAttribute	(	$key,
		$wrapper = `false`
	)

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

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

References getGroupKey().

Here is the call graph for this function:

◆ getGroupKey()

ilDataCollectionLinkButton::getGroupKey ( $wrapper )

protected

Definition at line 77 of file class.ilDataCollectionLinkButton.php.

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

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

Here is the caller graph for this function:

◆ getInstance()

static ilDataCollectionLinkButton::getInstance ( )

static

Factory.

Returns: self

Reimplemented from ilLinkButton.

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

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

References TYPE_DATACOLLECTION_LINK.

◆ isUseWrapper()

ilDataCollectionLinkButton::isUseWrapper ( )

Returns: boolean

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

    {
        return $this->useWrapper;
    }

References $useWrapper.

◆ prepareRender()

ilDataCollectionLinkButton::prepareRender ( )

Prepare render

Reimplemented from ilButtonBase.

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

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

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

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAttribute()

ilDataCollectionLinkButton::removeAttribute	(	$key,
		$wrapper = `false`
	)

Definition at line 62 of file class.ilDataCollectionLinkButton.php.

                                                            {
        if(isset($this->attributes[$this->getGroupKey($wrapper)][$key])) {
            unset($this->attributes[$this->getGroupKey($wrapper)][$key]);
            return true;
        }
        return false;
    }

References getGroupKey().

Here is the call graph for this function:

◆ render()

ilDataCollectionLinkButton::render ( )

Render HTML.

Returns: string

Reimplemented from ilLinkButton.

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

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

References prepareRender(), and ilLinkButton\renderCaption().

Here is the call graph for this function:

◆ setUseWrapper()

ilDataCollectionLinkButton::setUseWrapper ( $useWrapper )

Parameters

boolean $useWrapper

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

    {
        $this->useWrapper = $useWrapper;
    }

References $useWrapper.

Field Documentation

◆ $attributes

ilDataCollectionLinkButton::$attributes

protected

Definition at line 10 of file class.ilDataCollectionLinkButton.php.

◆ $useWrapper

ilDataCollectionLinkButton::$useWrapper = false

protected

Definition at line 12 of file class.ilDataCollectionLinkButton.php.

Referenced by isUseWrapper(), and setUseWrapper().

◆ TYPE_DATACOLLECTION_LINK

const ilDataCollectionLinkButton::TYPE_DATACOLLECTION_LINK = 99

Definition at line 8 of file class.ilDataCollectionLinkButton.php.

Referenced by getInstance().

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

Modules/DataCollection/classes/class.ilDataCollectionLinkButton.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addAttribute()

◆ getAttribute()

◆ getGroupKey()

◆ getInstance()

◆ isUseWrapper()

◆ prepareRender()

◆ removeAttribute()

◆ render()

◆ setUseWrapper()

Field Documentation

◆ $attributes

◆ $useWrapper

◆ TYPE_DATACOLLECTION_LINK