ilLinkButton Class Reference

Inheritance diagram for ilLinkButton:

Collaboration diagram for ilLinkButton:

Public Member Functions
	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...

Protected Member Functions
	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
	$url
	$target
Protected Attributes inherited from ilButtonBase
	$lng
	$type
	$id
	$caption
	$caption_is_lng_id
	$primary
	$omit_prevent_double_submission
	$onclick
	$acc_key
	$disabled
	$css = array()
	$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

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

Member Function Documentation

getInstance()

static ilLinkButton::getInstance ( )

static

Factory.

Returns

self

Reimplemented from ilButtonBase.

Reimplemented in ilDclLinkButton, ilTestPlayerNavButton, and ilImageLinkButton.

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

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

References ilButtonBase\TYPE_LINK.

Referenced by ilParticipantsTestResultsGUI\addDeleteAllTestResultsButton(), ilTestParticipantsGUI\addFinishAllPassesButton(), ilExAssignmentGUI\addPublicSubmissions(), ilTestParticipantsGUI\addUserSearchControls(), ilToolbarGUI\applyAutoStickyToSingleElement(), ilTestResultsToolbarGUI\build(), ilTestPlayerConfirmationModal\buildModalButtonInstance(), ilObjStudyProgrammeSettingsGUI\buildModalHeading(), ilObjTestGUI\buildPageViewToolbar(), ilTestQuestionsTableGUI\buildQuestionRemoveButton(), ilTestSubmissionReviewGUI\buildToolbar(), ilObjPDFGenerationGUI\configForm(), ilTestEvaluationGUI\detailedEvaluation(), ilSystemStyleOverviewGUI\edit(), ilSurveyEvaluationGUI\evaluation(), ilSurveyEvaluationGUI\evaluationuser(), ilStudyProgrammeRepositorySearchGUI\fillAutoCompleteToolbar(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), ilPortfolioPageTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilPublicSubmissionsTableGUI\fillRow(), ilBiblLibraryPresentationGUI\getButton(), ilObjForumGUI\getContent(), ilObjBlogGUI\getHTML(), ilAppointmentPresentationGUI\getHTML(), ilExPeerReviewGUI\getOverviewContent(), ilExSubmissionFileGUI\getOverviewContent(), ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmissionTextGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), assImagemapQuestionGUI\getPreviousSolutionConfirmationCheckboxHtml(), ilObjStudyProgrammeTreeGUI\getToolbar(), ilObjSAHSLearningModule\getViewButton(), ilBiblLibraryGUI\index(), ilFileVersionsGUI\index(), ilOrgUnitPositionGUI\index(), ilMMSubItemGUI\index(), ilMMTopItemGUI\index(), ilObjSurveyGUI\infoScreen(), ilObjFileGUI\infoScreenForward(), ilObjPortfolioTemplateGUI\infoScreenForward(), ilWorkflowEngineDefinitionsGUI\initToolbar(), ilAccountCodesGUI\listCodes(), ilObjLanguageFolderGUI\listDeprecatedObject(), ilDclFieldListGUI\listFields(), ilSamlSettingsGUI\listIdps(), ilSurveyParticipantsGUI\listParticipantsObject(), ilDclTableListGUI\listTables(), ilOrgUnitTypeGUI\listTypes(), ilStudyProgrammeTypeGUI\listTypes(), ilObjFileBasedLMGUI\outputInfoScreen(), ilSurveyPhrasesGUI\phrases(), ilTestInfoScreenToolbarGUI\populateDeleteDynamicTestResultsButton(), ilTestPlayerAbstractGUI\populateDiscardSolutionModal(), ilTestPlayerAbstractGUI\populateInstantResponseModal(), ilTestPlayerAbstractGUI\populateNavWhenChangedModal(), ilObjPortfolioTemplateGUI\preview(), ilSurveyEditorGUI\printViewObject(), ilSurveyEditorGUI\questionsObject(), ilObjQuestionPoolGUI\questionsObject(), ilExplorerSelectInputGUI\render(), ilObjBlogGUI\render(), ilObjectAddNewItemGUI\render(), ilObjForumGUI\renderDraftContent(), ilTestQuestionNavigationGUI\renderJsLinkedButton(), ilTestQuestionNavigationGUI\renderLinkButton(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), ilObjForumGUI\renderPostContent(), ilContainerObjectiveGUI\renderProgressBar(), ilDclDetailedViewGUI\renderRecord(), ilObjForumGUI\renderSplitButton(), ilSurveyPageGUI\renderToolbar(), ilSurveyExecutionGUI\runShowFinishedPage(), ilDclTableViewGUI\show(), ilPortfolioRepositoryGUI\show(), ilNewsTimelineGUI\show(), ilSystemStyleDocumentationGUI\show(), ilTestResultsGUI\showCmd(), ilObjBibliographicGUI\showContent(), ilTermsOfServiceDocumentGUI\showDocuments(), ilPersonalProfileGUI\showExportImport(), ilObjMailGUI\showExternalSettingsFormObject(), ilObjSessionGUI\showJoinRequestButton(), ilMailingListsGUI\showMailingLists(), ilMailingListsGUI\showMembersList(), ilExerciseManagementGUI\showMultiFeedbackObject(), ilNewsForContextBlockGUI\showNews(), ilTestPlayerDynamicQuestionSetGUI\showQuestionSelectionCmd(), ilAdvancedMDSettingsGUI\showRecords(), ilMailTemplateGUI\showTemplates(), ilFileSystemGUI\uploadFile(), ilObjPortfolioBaseGUI\view(), ilEditClipboardGUI\view(), ilObjUserFolderGUI\viewObject(), ilObjLanguageFolderGUI\viewObject(), and ilSurveyExecutionGUI\viewUserResults().

Here is the caller graph for this function:

getTarget()

ilLinkButton::getTarget

(

)

Get target.

Returns

string

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

    {
        return $this->target;
    }

References $target.

Referenced by ilDclLinkButton\prepareRender(), ilTestPlayerNavButton\render(), render(), and renderAttributes().

Here is the caller graph for this function:

getUrl()

ilLinkButton::getUrl

(

)

Get URL.

Returns

string

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

    {
        return $this->url;
    }

References $url.

Referenced by ilDclLinkButton\prepareRender(), ilTestPlayerNavButton\render(), and render().

Here is the caller graph for this function:

render()

ilLinkButton::render

(

)

Render HTML.

Returns

string

Reimplemented from ilButtonBase.

Reimplemented in ilDclLinkButton, and ilTestPlayerNavButton.

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

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

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

Here is the call graph for this function:

renderAttributes()

ilLinkButton::renderAttributes ( array  $a_additional_attr = null )

protected

Render current HTML attributes.

Parameters

array

$a_additional_attr

Returns

string

Reimplemented from ilButtonBase.

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

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

References getTarget().

Referenced by ilDclLinkButton\render(), ilTestPlayerNavButton\render(), and render().

Here is the call graph for this function:

Here is the caller graph for this function:

renderCaption()

ilLinkButton::renderCaption ( )

protected

Prepare caption for render.

Returns

string

Reimplemented in ilTestPlayerNavButton, and ilImageLinkButton.

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

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

References ilButtonBase\getCaption().

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

Here is the call graph for this function:

Here is the caller graph for this function:

setTarget()

ilLinkButton::setTarget

(

$a_value

)

Set target.

Parameters

string

$a_value

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

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

setUrl()

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

$target

ilLinkButton::$target

protected

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

Referenced by getTarget().

$url

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