Inheritance diagram for ilPathGUI:

Collaboration diagram for ilPathGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	getPath (int $a_startnode, int $a_endnode)
	get path More...

	enableTextOnly (bool $a_status)
	render path as text only More...

	textOnly ()

	enableHideLeaf (bool $a_status)
	Hide leaf node in path. More...

	hideLeaf ()

	setUseImages (bool $a_status)

	getUseImages ()
	get use images More...

	enableDisplayCut (bool $a_status)
	Display a cut with "...". More...

	displayCut ()
	Display a cut with "...". More...

Protected Member Functions
	getHTML ()
	get html More...

	buildTitle (int $a_obj_id)

	buildLink (int $ref_id, string $type)

	getPathIds ()

Protected Attributes
ilLanguage	$lng

ilTree	$tree

ilCtrlInterface	$ctrl

ilObjectDefinition	$objectDefinition

ILIAS Refinery Factory	$refinery

Private Attributes
int	$startnode

int	$endnode

bool	$textOnly = true

bool	$useImages = false

bool	$hide_leaf = true

bool	$display_cut = false

Detailed Description

Definition at line 21 of file class.ilPathGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPathGUI::__construct ( )

Constructor.

Reimplemented in ilSessionClassificationPathGUI.

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

    {
        global $DIC;
 
        $this->startnode = (int) ROOT_FOLDER_ID;
        $this->endnode = (int) ROOT_FOLDER_ID;
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC['ilCtrl'];
        $this->objectDefinition = $DIC['objDefinition'];
        $this->refinery = $DIC->refinery();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\objectDefinition(), ILIAS\Repository\refinery(), and ROOT_FOLDER_ID.

Here is the call graph for this function:

Member Function Documentation

◆ buildLink()

ilPathGUI::buildLink	(	int	$ref_id,
		string	$type
	)

protected

Definition at line 224 of file class.ilPathGUI.php.

                                                           : string
    {
        if ($this->objectDefinition->isAdministrationObject($type)) {
            $current_parameters = $this->ctrl->getParameterArrayByClass(ilAdministrationGUI::class);
            $this->ctrl->setParameterByClass(ilAdministrationGUI::class, 'ref_id', $ref_id);
            $link = $this->ctrl->getLinkTargetByClass(ilAdministrationGUI::class, 'jump');
            $this->ctrl->clearParameterByClass(ilAdministrationGUI::class, 'ref_id');
            if (isset($current_parameters['ref_id'])) {
                $this->ctrl->setParameterByClass(ilAdministrationGUI::class, 'ref_id', $current_parameters['ref_id']);
            }
            return $link;
        }
        return $this->refinery->encode()->htmlAttributeValue()->transform(
            ilLink::_getLink($ref_id, $type)
        );
    }

References $ref_id, ILIAS\Repository\ctrl(), ILIAS\Repository\objectDefinition(), and ILIAS\Repository\refinery().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

ilPathGUI::buildTitle ( int $a_obj_id )

protected

Reimplemented in ilSessionClassificationPathGUI.

Definition at line 215 of file class.ilPathGUI.php.

                                                : string
    {
        $type = ilObject::_lookupType($a_obj_id);
        if ($this->objectDefinition->isAdministrationObject($type)) {
            return $this->lng->txt('obj_' . $type);
        }
        return ilObject::_lookupTitle($a_obj_id);
    }

References ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\lng(), and ILIAS\Repository\objectDefinition().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayCut()

ilPathGUI::displayCut ( )

Display a cut with "...".

Definition at line 120 of file class.ilPathGUI.php.

                                : bool
    {
        return $this->display_cut;
    }

References $display_cut.

Referenced by getHTML().

Here is the caller graph for this function:

◆ enableDisplayCut()

ilPathGUI::enableDisplayCut ( bool $a_status )

Display a cut with "...".

Definition at line 112 of file class.ilPathGUI.php.

                                                    : void
    {
        $this->display_cut = $a_status;
    }

◆ enableHideLeaf()

ilPathGUI::enableHideLeaf ( bool $a_status )

Hide leaf node in path.

Definition at line 85 of file class.ilPathGUI.php.

                                                  : void
    {
        $this->hide_leaf = $a_status;
    }

Referenced by ilSessionClassificationPathGUI\getPathIds().

Here is the caller graph for this function:

◆ enableTextOnly()

ilPathGUI::enableTextOnly ( bool $a_status )

render path as text only

Parameters

bool $a_text_only path as text only true/false

Returns: void

Definition at line 72 of file class.ilPathGUI.php.

                                                  : void
    {
        $this->textOnly = $a_status;
    }

References textOnly().

Here is the call graph for this function:

◆ getHTML()

ilPathGUI::getHTML ( )

protected

get html

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

                                : string
    {
        if ($this->textOnly()) {
            $tpl = new ilTemplate('tpl.locator_text_only.html', true, true, "components/ILIAS/Locator");
 
            $first = true;
 
            // Display cut
            if ($this->displayCut() && $this->startnode != ROOT_FOLDER_ID) {
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', "...");
                $tpl->parseCurrentBlock();
 
                $first = false;
            }
 
            foreach ($this->getPathIds() as $ref_id) {
                $obj_id = ilObject::_lookupObjId($ref_id);
                $title = $this->buildTitle($obj_id);
 
                if ($first) {
                    if ($ref_id == ROOT_FOLDER_ID) {
                        $title = $this->lng->txt('repository');
                    }
                } else {
                    $tpl->touchBlock('locator_separator_prefix');
                }
 
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', $title);
                $tpl->parseCurrentBlock();
                $first = false;
            }
            return $tpl->get();
        } else {
            // With images and links
 
            $tpl = new ilTemplate('tpl.locator.html', true, true, 'components/ILIAS/Locator');
 
            $first = true;
 
            // Display cut
            if ($this->displayCut() && $this->startnode != ROOT_FOLDER_ID) {
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', "...");
                $tpl->parseCurrentBlock();
 
                $first = false;
            }
 
            foreach ($this->getPathIds() as $ref_id) {
                $obj_id = ilObject::_lookupObjId($ref_id);
                $title = $this->buildTitle($obj_id);
                $type = ilObject::_lookupType($obj_id);
 
                if ($first) {
                    if ($ref_id == ROOT_FOLDER_ID) {
                        $title = $this->lng->txt('repository');
                    }
                } else {
                    $tpl->touchBlock('locator_separator_prefix');
                }
                if ($this->getUseImages()) {
                    $tpl->setCurrentBlock('locator_img');
                    $tpl->setVariable('IMG_SRC', ilObject::_getIcon($obj_id, "small", $type));
                    $tpl->setVariable('IMG_ALT', $this->lng->txt('obj_' . $type));
                    $tpl->parseCurrentBlock();
                }
 
                if (!$this->tree->isDeleted($ref_id)) {
                    $tpl->setCurrentBlock('locator_item');
                    $tpl->setVariable('LINK_ITEM', $this->buildLink($ref_id, $type));
                    $tpl->setVariable('ITEM', $title);
                    $tpl->parseCurrentBlock();
                } else {
                    $tpl->setCurrentBlock('locator_item');
                    $tpl->setVariable('ITEM_READ_ONLY', $title);
                    $tpl->parseCurrentBlock();
                }
 
                $first = false;
            }
            $tpl->setVariable("TXT_BREADCRUMBS", $this->lng->txt("breadcrumb_navigation"));
            return $tpl->get();
        }
    }

References $ref_id, ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupType(), buildLink(), buildTitle(), displayCut(), getPathIds(), getUseImages(), ILIAS\Repository\lng(), ROOT_FOLDER_ID, and textOnly().

Referenced by getPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPath()

ilPathGUI::getPath	(	int	$a_startnode,
		int	$a_endnode
	)

get path

Parameters

int	$a_startnode	ref_id of startnode
int	$a_endnode	ref_id of endnode

Returns: string html

Definition at line 59 of file class.ilPathGUI.php.

                                                             : string
    {
        $this->startnode = $a_startnode;
        $this->endnode = $a_endnode;
 
        return $this->getHTML();
    }

References getHTML().

Here is the call graph for this function:

◆ getPathIds()

ilPathGUI::getPathIds ( )

protected

Returns: int[]

Reimplemented in ilSessionClassificationPathGUI.

Definition at line 244 of file class.ilPathGUI.php.

                                   : array
    {
        $path = $this->tree->getPathId($this->endnode, $this->startnode);
        if ($this->hideLeaf() && count($path)) {
            unset($path[count($path) - 1]);
        }
        return $path;
    }

References $path, and hideLeaf().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUseImages()

ilPathGUI::getUseImages ( )

get use images

Returns: bool

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

                                  : bool
    {
        return $this->useImages;
    }

References $useImages.

Referenced by getHTML().

Here is the caller graph for this function:

◆ hideLeaf()

ilPathGUI::hideLeaf ( )

Definition at line 90 of file class.ilPathGUI.php.

                              : bool
    {
        return $this->hide_leaf;
    }

References $hide_leaf.

Referenced by getPathIds().

Here is the caller graph for this function:

◆ setUseImages()

ilPathGUI::setUseImages ( bool $a_status )

Definition at line 95 of file class.ilPathGUI.php.

                                                : void
    {
        $this->useImages = $a_status;
    }

◆ textOnly()

ilPathGUI::textOnly ( )

Definition at line 77 of file class.ilPathGUI.php.

                              : bool
    {
        return $this->textOnly;
    }

References $textOnly.

Referenced by enableTextOnly(), and getHTML().

Here is the caller graph for this function:

Field Documentation

◆ $ctrl

ilCtrlInterface ilPathGUI::$ctrl

protected

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

◆ $display_cut

bool ilPathGUI::$display_cut = false

private

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

Referenced by displayCut().

◆ $endnode

int ilPathGUI::$endnode

private

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

◆ $hide_leaf

bool ilPathGUI::$hide_leaf = true

private

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

Referenced by hideLeaf().

◆ $lng

ilLanguage ilPathGUI::$lng

protected

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

◆ $objectDefinition

ilObjectDefinition ilPathGUI::$objectDefinition

protected

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

◆ $refinery

ILIAS Refinery Factory ilPathGUI::$refinery

protected

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

◆ $startnode

int ilPathGUI::$startnode

private

Definition at line 23 of file class.ilPathGUI.php.

◆ $textOnly

bool ilPathGUI::$textOnly = true

private

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

Referenced by textOnly().

◆ $tree

ilTree ilPathGUI::$tree

protected

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

◆ $useImages

bool ilPathGUI::$useImages = false

private

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

Referenced by getUseImages().

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

components/ILIAS/Tree/classes/class.ilPathGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildLink()

◆ buildTitle()

◆ displayCut()

◆ enableDisplayCut()

◆ enableHideLeaf()

◆ enableTextOnly()

◆ getHTML()

◆ getPath()

◆ getPathIds()

◆ getUseImages()

◆ hideLeaf()

◆ setUseImages()

◆ textOnly()

Field Documentation

◆ $ctrl

◆ $display_cut

◆ $endnode

◆ $hide_leaf

◆ $lng

◆ $objectDefinition

◆ $refinery

◆ $startnode

◆ $textOnly

◆ $tree

◆ $useImages