ilLinkButton Class Reference

Inheritance diagram for ilLinkButton:

Collaboration diagram for ilLinkButton:

Public Member Functions
	setUrl ($a_value)
	Set URL.
	getUrl ()
	Get URL.
	setTarget ($a_value)
	Set target.
	getTarget ()
	Get target.
	render ()
	Render HTML.
Public Member Functions inherited from ilButton
	__clone ()
	Clone instance.
	getType ()
	Get button type.
	setId ($a_value)
	Set id.
	getId ()
	Get id.
	setCaption ($a_value, $a_is_lng_id=true)
	Set caption.
	getCaption ($a_translate=true)
	Get caption.
	setPrimary ($a_value)
	Toggle primary status.
	isPrimary ()
	Get primary status.
	setOmitPreventDoubleSubmission ($a_value)
	Toggle double submission prevention status.
	getOmitPreventDoubleSubmission ()
	Get double submission prevention status.
	setOnClick ($a_value)
	Set onclick.
	getOnClick ()
	Get onclick.
	setAccessKey ($a_value)
	Set access key.
	getAccessKey ()
	Get access key.
	setDisabled ($a_value)
	Toggle disabled status.
	isDisabled ()
	Get disabled status.
	addCSSClass ($a_value)
	Add CSS class.
	getCSSClasses ()
	Get CSS class(es)

Static Public Member Functions
static	getInstance ()
	Factory.

Protected Member Functions
	renderCaption ()
	Prepare caption for render.
Protected Member Functions inherited from ilButton
	__construct ($a_type)
	Constructor.
	setType ($a_value)
	Set button type.
	gatherCssClasses ()
	Gather all active CSS classes.
	renderAttributesHelper (array $a_attr)
	Render HTML node attributes.
	renderAttributes (array $a_additional_attr=null)
	Render current HTML attributes.
	prepareRender ()
	Prepare render.

Protected Attributes
	$url
	$target
Protected Attributes inherited from ilButton
	$type
	$id
	$caption
	$caption_is_lng_id
	$primary
	$omit_prevent_double_submission
	$onclick
	$acc_key
	$disabled
	$css = array()

Additional Inherited Members
Data Fields inherited from ilButton
const	TYPE_SUBMIT = 1
const	TYPE_LINK = 2

Detailed Description

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

Member Function Documentation

static ilLinkButton::getInstance ( )

static

Factory.

Returns

self

Reimplemented from ilButton.

Reimplemented in ilDataCollectionLinkButton, and ilImageLinkButton.

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

References ilButton\TYPE_LINK.

Referenced by ilCourseContentGUI\__showTimingsPanel(), ilTestResultsToolbarGUI\build(), ilObjTestGUI\buildPageViewToolbar(), ilPageObjectGUI\edit(), ilSurveyEvaluationGUI\evaluationuser(), ilObjSurveyGUI\exportObject(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilPublicSubmissionsTableGUI\fillRow(), ilBibliographicSetting\getButton(), ilObjPortfolioGUI\getExerciseInfo(), ilObjBlogGUI\getExerciseInfo(), ilExAssignmentGUI\getOverviewBody(), ilObjSurveyGUI\infoScreen(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilObjFileGUI\infoScreenForward(), ilAccountCodesGUI\listCodes(), ilOrgUnitTypeGUI\listTypes(), ilObjFileBasedLMGUI\outputInfoScreen(), ilSurveyPhrasesGUI\phrases(), ilObjTestGUI\populateDeleteDynamicTestResultsButton(), ilObjPortfolioTemplateGUI\preview(), ilSurveyEditorGUI\printViewObject(), ilSurveyEditorGUI\questionsObject(), ilExplorerSelectInputGUI\render(), ilObjectAddNewItemGUI\render(), ilDataCollectionRecordViewGUI\renderRecord(), ilSurveyPageGUI\renderToolbar(), ilSurveyExecutionGUI\runShowFinishedPage(), ilPortfolioRepositoryGUI\show(), ilObjExerciseGUI\showMultiFeedbackObject(), ilNewsForContextBlockGUI\showNews(), ilAdvancedMDSettingsGUI\showRecords(), ilFileSystemGUI\uploadFile(), ilEditClipboardGUI\view(), ilObjPortfolioBaseGUI\view(), ilObjUserFolderGUI\viewObject(), and ilSurveyExecutionGUI\viewUserResults().

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

Here is the caller graph for this function:

ilLinkButton::getTarget

(

)

Get target.

Returns

string

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

References $target.

Referenced by ilDataCollectionLinkButton\prepareRender(), and render().

        {
                return $this->target;
        }

Here is the caller graph for this function:

ilLinkButton::getUrl

(

)

Get URL.

Returns

string

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

References $url.

Referenced by ilDataCollectionLinkButton\prepareRender(), and render().

        {
                return $this->url;
        }

Here is the caller graph for this function:

ilLinkButton::render

(

)

Render HTML.

Returns

string

Reimplemented from ilButton.

Reimplemented in ilDataCollectionLinkButton.

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

References getTarget(), getUrl(), ilButton\prepareRender(), and renderCaption().

        {                               
                $this->prepareRender();
                
                $attr = array();
                $attr["href"] = $this->getUrl() ? $this->getUrl() : "#";
                $attr["target"] = $this->getTarget();
                
                return '<a'.$this->renderAttributes($attr).'>'.
                        $this->renderCaption().'</a>';
        }               

Here is the call graph for this function:

ilLinkButton::renderCaption ( )

protected

Prepare caption for render.

Returns

string

Reimplemented in ilImageLinkButton.

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

Referenced by ilDataCollectionLinkButton\render(), and render().

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

Here is the caller graph for this function:

ilLinkButton::setTarget

(

$a_value

)

Set target.

Parameters

string

$a_value

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

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

ilLinkButton::setUrl

(

$a_value

)

Set URL.

Parameters

string

$a_value

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

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

Field Documentation

ilLinkButton::$target

protected

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

Referenced by getTarget().

ilLinkButton::$url

protected

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

Referenced by getUrl().

---

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

• Services/UIComponent/Button/classes/class.ilLinkButton.php