Creates a path for a start and endnode. More...

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)

	getPathIds ()

Protected Attributes
ilLanguage	$lng

ilTree	$tree

ilObjectDefinition	$objectDefinition

Private Attributes
int	$startnode

int	$endnode

bool	$textOnly = true

bool	$useImages = false

bool	$hide_leaf = true

bool	$display_cut = false

Detailed Description

Creates a path for a start and endnode.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilPathGUI::__construct ( )

Constructor.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ buildTitle()

ilPathGUI::buildTitle ( int $a_obj_id )

protected

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

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

Referenced by getHTML().

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

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 127 of file class.ilPathGUI.php.

References $display_cut.

Referenced by getHTML().

                                 : bool
     {
         return $this->display_cut;
     }

Here is the caller graph for this function:

◆ enableDisplayCut()

ilPathGUI::enableDisplayCut ( bool $a_status )

Display a cut with "...".

Definition at line 119 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 92 of file class.ilPathGUI.php.

Referenced by ilSessionClassificationPathGUI\getPathIds().

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

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 79 of file class.ilPathGUI.php.

References textOnly().

Referenced by ilObjectCopyCourseGroupSelectionTableGUI\customizePath(), and ilObjectListGUI\insertPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHTML()

ilPathGUI::getHTML ( )

protected

get html

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

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

Referenced by getPath().

                                 : string
     {
         if ($this->textOnly()) {
             $tpl = new ilTemplate('tpl.locator_text_only.html', true, true, "Services/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, 'Services/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', ilLink::_getLink($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();
         }
     }

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 66 of file class.ilPathGUI.php.

References getHTML().

Referenced by ilObjectListGUI\insertPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPathIds()

ilPathGUI::getPathIds ( )

protected

Returns: int[]

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

References $path, and hideLeaf().

Referenced by getHTML().

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

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 111 of file class.ilPathGUI.php.

References $useImages.

Referenced by getHTML().

                                   : bool
     {
         return $this->useImages;
     }

Here is the caller graph for this function:

◆ hideLeaf()

ilPathGUI::hideLeaf ( )

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

References $hide_leaf.

Referenced by getPathIds().

                               : bool
     {
         return $this->hide_leaf;
     }

Here is the caller graph for this function:

◆ setUseImages()

ilPathGUI::setUseImages ( bool $a_status )

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

Referenced by ilObjectCopyCourseGroupSelectionTableGUI\customizePath(), and ilObjectListGUI\insertPath().

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

Here is the caller graph for this function:

◆ textOnly()

ilPathGUI::textOnly ( )

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

References $textOnly.

Referenced by enableTextOnly(), and getHTML().

                               : bool
     {
         return $this->textOnly;
     }

Here is the caller graph for this function:

Field Documentation

◆ $display_cut

bool ilPathGUI::$display_cut = false

private

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

Referenced by displayCut().

◆ $endnode

int ilPathGUI::$endnode

private

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

◆ $hide_leaf

bool ilPathGUI::$hide_leaf = true

private

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

Referenced by hideLeaf().

◆ $lng

ilLanguage ilPathGUI::$lng

protected

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

◆ $objectDefinition

ilObjectDefinition ilPathGUI::$objectDefinition

protected

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

◆ $startnode

int ilPathGUI::$startnode

private

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

◆ $textOnly

bool ilPathGUI::$textOnly = true

private

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

Referenced by textOnly().

◆ $tree

ilTree ilPathGUI::$tree

protected

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

◆ $useImages

bool ilPathGUI::$useImages = false

private

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

Referenced by getUseImages().

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

Services/Tree/classes/class.ilPathGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildTitle()

◆ displayCut()

◆ enableDisplayCut()

◆ enableHideLeaf()

◆ enableTextOnly()

◆ getHTML()

◆ getPath()

◆ getPathIds()

◆ getUseImages()

◆ hideLeaf()

◆ setUseImages()

◆ textOnly()

Field Documentation

◆ $display_cut

◆ $endnode

◆ $hide_leaf

◆ $lng

◆ $objectDefinition

◆ $startnode

◆ $textOnly

◆ $tree

◆ $useImages