This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPermanentLinkGUI:

Public Member Functions
	__construct (string $a_type, int $a_id, string $a_append="", string $a_target="")
	Example: type = "wiki", id (ref_id) = "234", append = "_Start_Page". More...

	setIncludePermanentLinkText (bool $a_includepermanentlinktext)
	Set Include permanent link text. More...

	getIncludePermanentLinkText ()
	Include permanent link text. More...

	setType (string $a_type)

	getType ()

	setId (string $a_id)

	getId ()

	setAppend (string $a_append)

	getAppend ()

	setTarget (string $a_target)

	getTarget ()

	setTitle (string $a_val)

	getTitle ()

	getHTML ()

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilObjectDataCache	$obj_data_cache

bool	$align_center = true

bool	$includepermanentlinktext = false

string	$type = ""

string	$id = ""

string	$append = ""

string	$target = ""

string	$title = ""

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 Class for permanent links

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPermanentLinkGUI: ilNoteGUI, ilColumnGUI, ilPublicUserProfileGUI

Definition at line 24 of file class.ilPermanentLinkGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPermanentLinkGUI::__construct	(	string	$a_type,
		int	$a_id,
		string	$a_append = `""`,
		string	$a_target = `""`
	)

Example: type = "wiki", id (ref_id) = "234", append = "_Start_Page".

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

      {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->obj_data_cache = $DIC["ilObjDataCache"];
        $this->setType($a_type);
        $this->setId($a_id);
        $this->setAppend($a_append);
        $this->setIncludePermanentLinkText(true);
        $this->setTarget($a_target);
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), setAppend(), setId(), setIncludePermanentLinkText(), setTarget(), and setType().

Here is the call graph for this function:

Member Function Documentation

◆ getAppend()

ilPermanentLinkGUI::getAppend ( )

Definition at line 99 of file class.ilPermanentLinkGUI.php.

                               : string
    {
        return $this->append;
    }

References $append.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilPermanentLinkGUI::getHTML ( )

Definition at line 124 of file class.ilPermanentLinkGUI.php.

                             : string
    {
        $lng = $this->lng;
        $ilObjDataCache = $this->obj_data_cache;
 
        $tpl = new ilTemplate(
            "tpl.permanent_link.html",
            true,
            true,
            "Services/PermanentLink"
        );
 
        $href = ilLink::_getStaticLink(
            $this->getId(),
            $this->getType(),
            true,
            $this->getAppend()
        );
        if ($this->getIncludePermanentLinkText()) {
            $tpl->setVariable("TXT_PERMA", $lng->txt("perma_link") . ":");
        }
 
        $title = '';
 
        if ($this->getTitle() != "") {
            $title = $this->getTitle();
        } elseif (is_numeric($this->getId())) {
            $obj_id = $ilObjDataCache->lookupObjId((int) $this->getId());
            $title = $ilObjDataCache->lookupTitle($obj_id);
        }
 
        $tpl->setVariable("TXT_BOOKMARK_DEFAULT", $title);
 
        $tpl->setVariable("LINK", $href);
 
        $tpl->setVariable("ALIGN", "left");
 
        if ($this->getTarget() != "") {
            $tpl->setVariable("TARGET", 'target="' . $this->getTarget() . '"');
        }
 
        return $tpl->get();
    }

References $lng, $obj_data_cache, $title, $tpl, ilLink\_getStaticLink(), getAppend(), getId(), getIncludePermanentLinkText(), getTarget(), getTitle(), getType(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getId()

ilPermanentLinkGUI::getId ( )

Definition at line 89 of file class.ilPermanentLinkGUI.php.

                           : string
    {
        return $this->id;
    }

References $id.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getIncludePermanentLinkText()

ilPermanentLinkGUI::getIncludePermanentLinkText ( )

Include permanent link text.

Definition at line 69 of file class.ilPermanentLinkGUI.php.

                                                 : bool
    {
        return $this->includepermanentlinktext;
    }

References $includepermanentlinktext.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getTarget()

ilPermanentLinkGUI::getTarget ( )

Definition at line 109 of file class.ilPermanentLinkGUI.php.

                               : string
    {
        return $this->target;
    }

References $target.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getTitle()

ilPermanentLinkGUI::getTitle ( )

Definition at line 119 of file class.ilPermanentLinkGUI.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getType()

ilPermanentLinkGUI::getType ( )

Definition at line 79 of file class.ilPermanentLinkGUI.php.

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by getHTML().

Here is the caller graph for this function:

◆ setAppend()

ilPermanentLinkGUI::setAppend ( string $a_append )

Definition at line 94 of file class.ilPermanentLinkGUI.php.

                                               : void
    {
        $this->append = $a_append;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setId()

ilPermanentLinkGUI::setId ( string $a_id )

Definition at line 84 of file class.ilPermanentLinkGUI.php.

                                       : void
    {
        $this->id = $a_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setIncludePermanentLinkText()

ilPermanentLinkGUI::setIncludePermanentLinkText ( bool $a_includepermanentlinktext )

Set Include permanent link text.

Definition at line 61 of file class.ilPermanentLinkGUI.php.

                                                                                 : void
    {
        $this->includepermanentlinktext = $a_includepermanentlinktext;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setTarget()

ilPermanentLinkGUI::setTarget ( string $a_target )

Definition at line 104 of file class.ilPermanentLinkGUI.php.

                                               : void
    {
        $this->target = $a_target;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setTitle()

ilPermanentLinkGUI::setTitle ( string $a_val )

Definition at line 114 of file class.ilPermanentLinkGUI.php.

                                           : void
    {
        $this->title = $a_val;
    }

◆ setType()

ilPermanentLinkGUI::setType ( string $a_type )

Definition at line 74 of file class.ilPermanentLinkGUI.php.

                                           : void
    {
        $this->type = $a_type;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

◆ $align_center

bool ilPermanentLinkGUI::$align_center = true

protected

Definition at line 29 of file class.ilPermanentLinkGUI.php.

◆ $append

string ilPermanentLinkGUI::$append = ""

protected

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

Referenced by getAppend().

◆ $ctrl

ilCtrl ilPermanentLinkGUI::$ctrl

protected

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

◆ $id

string ilPermanentLinkGUI::$id = ""

protected

Definition at line 32 of file class.ilPermanentLinkGUI.php.

Referenced by getId().

◆ $includepermanentlinktext

bool ilPermanentLinkGUI::$includepermanentlinktext = false

protected

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

Referenced by getIncludePermanentLinkText().

◆ $lng

ilLanguage ilPermanentLinkGUI::$lng

protected

Definition at line 26 of file class.ilPermanentLinkGUI.php.

Referenced by getHTML().

◆ $obj_data_cache

ilObjectDataCache ilPermanentLinkGUI::$obj_data_cache

protected

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

Referenced by getHTML().

◆ $target

string ilPermanentLinkGUI::$target = ""

protected

Definition at line 34 of file class.ilPermanentLinkGUI.php.

Referenced by getTarget().

◆ $title

string ilPermanentLinkGUI::$title = ""

protected

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

Referenced by getHTML(), and getTitle().

◆ $type

string ilPermanentLinkGUI::$type = ""

protected

Definition at line 31 of file class.ilPermanentLinkGUI.php.

Referenced by getType().

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

Services/PermanentLink/classes/class.ilPermanentLinkGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAppend()

◆ getHTML()

◆ getId()

◆ getIncludePermanentLinkText()

◆ getTarget()

◆ getTitle()

◆ getType()

◆ setAppend()

◆ setId()

◆ setIncludePermanentLinkText()

◆ setTarget()

◆ setTitle()

◆ setType()

Field Documentation

◆ $align_center

◆ $append

◆ $ctrl

◆ $id

◆ $includepermanentlinktext

◆ $lng

◆ $obj_data_cache

◆ $target

◆ $title

◆ $type