ILIAS\Repository\Link\LinkAdapterGUI Class Reference

Collaboration diagram for ILIAS\Repository\Link\LinkAdapterGUI:

Public Member Functions
	__construct (string $caption, string $href, bool $new_viewport=false)
	emphasised ()
	primary ()
	toToolbar (bool $sticky=false, ?\ilToolbarGUI $toolbar=null)
	render ()

Protected Member Functions
	getStandardLink ()
	getLink ()

Protected Attributes
const	TYPE_STD = 0
const	TYPE_EMPH = 1
const	TYPE_PRIM = 2
ilToolbarGUI	$toolbar
ILIAS DI UIServices	$ui
string	$caption = ""
string	$href = ""
bool	$new_viewport = false
int	$type = self::TYPE_STD

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ILIAS\Repository\Link\LinkAdapterGUI::__construct	(	string	$caption,
		string	$href,
		bool	$new_viewport = false
	)

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

References ILIAS\Repository\Link\LinkAdapterGUI\$caption, $DIC, ILIAS\Repository\Link\LinkAdapterGUI\$href, ILIAS\Repository\Link\LinkAdapterGUI\$new_viewport, ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

      {
        global $DIC;

        $this->caption = $caption;
        $this->href = $href;
        $this->new_viewport = $new_viewport;
        $this->ui = $DIC->ui();
        $this->toolbar = $DIC->toolbar();
    }

Here is the call graph for this function:

Member Function Documentation

emphasised()

ILIAS\Repository\Link\LinkAdapterGUI::emphasised

(

)

Definition at line 54 of file class.LinkAdapterGUI.php.

                                : self
    {
        $this->type = self::TYPE_EMPH;
        return $this;
    }

getLink()

ILIAS\Repository\Link\LinkAdapterGUI::getLink ( )

protected

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

References ILIAS\Repository\Link\LinkAdapterGUI\getStandardLink().

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\render(), and ILIAS\Repository\Link\LinkAdapterGUI\toToolbar().

                                : \ILIAS\UI\Component\Link\Link
    {
        return $this->getStandardLink();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStandardLink()

ILIAS\Repository\Link\LinkAdapterGUI::getStandardLink ( )

protected

Definition at line 66 of file class.LinkAdapterGUI.php.

References ILIAS\Repository\ui().

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\getLink().

                                        : \ILIAS\UI\Component\Link\Link
    {
        $link = $this->ui->factory()->link()->standard(
            $this->caption,
            $this->href
        );
        if ($this->new_viewport) {
            $link = $link->withOpenInNewViewport(true);
        }
        return $link;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

primary()

ILIAS\Repository\Link\LinkAdapterGUI::primary

(

)

Definition at line 60 of file class.LinkAdapterGUI.php.

                             : self
    {
        $this->type = self::TYPE_PRIM;
        return $this;
    }

render()

ILIAS\Repository\Link\LinkAdapterGUI::render

(

)

Definition at line 96 of file class.LinkAdapterGUI.php.

References ILIAS\Repository\Link\LinkAdapterGUI\getLink(), and ILIAS\Repository\ui().

                            : string
    {
        return $this->ui->renderer()->render($this->getLink());
    }

Here is the call graph for this function:

toToolbar()

ILIAS\Repository\Link\LinkAdapterGUI::toToolbar	(	bool	$sticky = false,
		?\ilToolbarGUI	$toolbar = null
	)

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

References ILIAS\Repository\Link\LinkAdapterGUI\$toolbar, ilToolbarGUI\addStickyItem(), and ILIAS\Repository\Link\LinkAdapterGUI\getLink().

                                                                                   : void
    {
        $link = $this->getLink();
        if (is_null($toolbar)) {
            $toolbar = $this->toolbar;
        }
        if ($sticky) {
            $toolbar->addStickyItem($link);
        } else {
            $toolbar->addComponent($link);
        }
    }

Here is the call graph for this function:

Field Documentation

$caption

string ILIAS\Repository\Link\LinkAdapterGUI::$caption = ""

protected

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

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\__construct().

$href

string ILIAS\Repository\Link\LinkAdapterGUI::$href = ""

protected

Definition at line 36 of file class.LinkAdapterGUI.php.

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\__construct().

$new_viewport

bool ILIAS\Repository\Link\LinkAdapterGUI::$new_viewport = false

protected

Definition at line 37 of file class.LinkAdapterGUI.php.

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\__construct().

$toolbar

ilToolbarGUI ILIAS\Repository\Link\LinkAdapterGUI::$toolbar

protected

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

Referenced by ILIAS\Repository\Link\LinkAdapterGUI\toToolbar().

$type

int ILIAS\Repository\Link\LinkAdapterGUI::$type = self::TYPE_STD

protected

Definition at line 38 of file class.LinkAdapterGUI.php.

$ui

ILIAS DI UIServices ILIAS\Repository\Link\LinkAdapterGUI::$ui

protected

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

TYPE_EMPH

const ILIAS\Repository\Link\LinkAdapterGUI::TYPE_EMPH = 1

protected

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

TYPE_PRIM

const ILIAS\Repository\Link\LinkAdapterGUI::TYPE_PRIM = 2

protected

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

TYPE_STD

const ILIAS\Repository\Link\LinkAdapterGUI::TYPE_STD = 0

protected

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

---

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

• components/ILIAS/Repository/Service/Link/class.LinkAdapterGUI.php