ilPermanentLinkGUI Class Reference

Class for permanent links. More...

Collaboration diagram for ilPermanentLinkGUI:

Public Member Functions
	__construct ($a_type, $a_id, $a_append="", $a_target="")
	Example: type = "wiki", id (ref_id) = "234", append = "_Start_Page". More...
	setIncludePermanentLinkText ($a_includepermanentlinktext)
	Set Include permanent link text. More...
	getIncludePermanentLinkText ()
	Get Include permanent link text. More...
	setType ($a_type)
	Set Type. More...
	getType ()
	Get Type. More...
	setId ($a_id)
	Set Id. More...
	getId ()
	Get Id. More...
	setAppend ($a_append)
	Set Append. More...
	getAppend ()
	Get Append. More...
	setTarget ($a_target)
	Set Target. More...
	getTarget ()
	Get Target. More...
	setTitle ($a_val)
	Set title. More...
	getTitle ()
	Get title. More...
	setAlignCenter ($a_val)
	Set center alignment. More...
	getAlignCenter ()
	Get center alignment. More...
	getHTML ()
	Get HTML for link. More...

Protected Attributes
	$lng
	$ctrl
	$obj_data_cache
	$align_center = true

Detailed Description

Class for permanent links.

Version

$Id$

@ilCtrl_Calls ilPermanentLinkGUI: ilNoteGUI, ilColumnGUI, ilPublicUserProfileGUI

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

Constructor & Destructor Documentation

__construct()

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

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

Definition at line 39 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, setAppend(), setId(), setIncludePermanentLinkText(), setTarget(), and setType().

Here is the call graph for this function:

Member Function Documentation

getAlignCenter()

ilPermanentLinkGUI::getAlignCenter

(

)

Get center alignment.

Returns

boolean align the link at center

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

    {
        return $this->align_center;
    }

References $align_center.

Referenced by getHTML().

Here is the caller graph for this function:

getAppend()

ilPermanentLinkGUI::getAppend

(

)

Get Append.

Returns

string Append

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

    {
        return $this->append;
    }

Referenced by getHTML().

Here is the caller graph for this function:

getHTML()

ilPermanentLinkGUI::getHTML

(

)

Get HTML for link.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilObjDataCache = $this->obj_data_cache;
        
        $tpl = new ilTemplate(
            "tpl.permanent_link.html",
            true,
            true,
            "Services/PermanentLink"
        );
        
        include_once('./Services/Link/classes/class.ilLink.php');
        $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($this->getId());
            $title = $ilObjDataCache->lookupTitle($obj_id);
        }
 
        $tpl->setVariable("TXT_BOOKMARK_DEFAULT", $title);
 
        $tpl->setVariable("LINK", $href);
        
        if ($this->getAlignCenter()) {
            $tpl->setVariable("ALIGN", "center");
        } else {
            $tpl->setVariable("ALIGN", "left");
        }
        
        if ($this->getTarget() != "") {
            $tpl->setVariable("TARGET", 'target="' . $this->getTarget() . '"');
        }
 
        return $tpl->get();
    }

References $ctrl, $lng, $obj_data_cache, $tpl, ilLink\_getStaticLink(), getAlignCenter(), getAppend(), getId(), getIncludePermanentLinkText(), getTarget(), getTitle(), and getType().

Here is the call graph for this function:

getId()

ilPermanentLinkGUI::getId

(

)

Get Id.

Returns

string Id

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

    {
        return $this->id;
    }

Referenced by getHTML().

Here is the caller graph for this function:

getIncludePermanentLinkText()

ilPermanentLinkGUI::getIncludePermanentLinkText

(

)

Get Include permanent link text.

Returns

boolean Include permanent link text

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

    {
        return $this->includepermanentlinktext;
    }

Referenced by getHTML().

Here is the caller graph for this function:

getTarget()

ilPermanentLinkGUI::getTarget

(

)

Get Target.

Returns

string Target

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

    {
        return $this->target;
    }

Referenced by getHTML().

Here is the caller graph for this function:

getTitle()

ilPermanentLinkGUI::getTitle

(

)

Get title.

Returns

string title

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

    {
        return $this->title;
    }

Referenced by getHTML().

Here is the caller graph for this function:

getType()

ilPermanentLinkGUI::getType

(

)

Get Type.

Returns

string Type

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

    {
        return $this->type;
    }

References $type.

Referenced by getHTML().

Here is the caller graph for this function:

setAlignCenter()

ilPermanentLinkGUI::setAlignCenter

(

$a_val

)

Set center alignment.

Parameters

boolean

align the link at center

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

    {
        $this->align_center = $a_val;
    }

setAppend()

ilPermanentLinkGUI::setAppend

(

$a_append

)

Set Append.

Parameters

string

$a_append

Append

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

    {
        $this->append = $a_append;
    }

Referenced by __construct().

Here is the caller graph for this function:

setId()

ilPermanentLinkGUI::setId

(

$a_id

)

Set Id.

Parameters

string

$a_id

Id

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

    {
        $this->id = $a_id;
    }

Referenced by __construct().

Here is the caller graph for this function:

setIncludePermanentLinkText()

ilPermanentLinkGUI::setIncludePermanentLinkText

(

$a_includepermanentlinktext

)

Set Include permanent link text.

Parameters

boolean

$a_includepermanentlinktext

Include permanent link text

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

    {
        $this->includepermanentlinktext = $a_includepermanentlinktext;
    }

Referenced by __construct().

Here is the caller graph for this function:

setTarget()

ilPermanentLinkGUI::setTarget

(

$a_target

)

Set Target.

Parameters

string

$a_target

Target

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

    {
        $this->target = $a_target;
    }

Referenced by __construct().

Here is the caller graph for this function:

setTitle()

ilPermanentLinkGUI::setTitle

(

$a_val

)

Set title.

Parameters

string

title

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

    {
        $this->title = $a_val;
    }

setType()

ilPermanentLinkGUI::setType

(

$a_type

)

Set Type.

Parameters

string

$a_type

Type

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

    {
        $this->type = $a_type;
    }

Referenced by __construct().

Here is the caller graph for this function:

Field Documentation

$align_center

ilPermanentLinkGUI::$align_center = true

protected

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

Referenced by getAlignCenter().

$ctrl

ilPermanentLinkGUI::$ctrl

protected

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

Referenced by getHTML().

$lng

ilPermanentLinkGUI::$lng

protected

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

Referenced by getHTML().

$obj_data_cache

ilPermanentLinkGUI::$obj_data_cache

protected

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

Referenced by getHTML().

---

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

• Services/PermanentLink/classes/class.ilPermanentLinkGUI.php