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

Collaboration diagram for ilPathGUI:

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

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

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

	textOnly ()
	show text only More...

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

	hideLeaf ()

	setUseImages ($a_status)
	set use images More...

	getUseImages ()
	get use images More...

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

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

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

	getPathIds ()

Protected Attributes
	$lng = null

	$tree = null

Private Attributes
	$startnode = ROOT_FOLDER_ID

	$endnode = ROOT_FOLDER_ID

	$textOnly = true

	$useImages = false

	$hide_leaf = true

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

Constructor & Destructor Documentation

◆ __construct()

ilPathGUI::__construct ( )

Constructor.

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

    {
        global $tree,$lng;
        
        $this->tree = $tree;
        $this->lng = $lng;
    }

References $lng, and $tree.

Member Function Documentation

◆ displayCut()

ilPathGUI::displayCut ( )

Display a cut with "...".

Returns: bool

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

    {
        return $this->display_cut;
    }

References $display_cut.

Referenced by getHTML().

Here is the caller graph for this function:

◆ enableDisplayCut()

ilPathGUI::enableDisplayCut ( $a_status )

Display a cut with "...".

Parameters

$a_status bool

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

    {
        $this->display_cut = $a_status;
    }

◆ enableHideLeaf()

ilPathGUI::enableHideLeaf ( $a_status )

Hide leaf node in path.

Parameters

type $a_status

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

    {
        $this->hide_leaf = $a_status;
    }

◆ enableTextOnly()

ilPathGUI::enableTextOnly ( $a_status )

render path as text only

Parameters

bool $a_text_only path as text only true/false

Returns

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

    {
        $this->textOnly = $a_status;
    }

References textOnly().

Here is the call graph for this function:

◆ getHTML()

ilPathGUI::getHTML ( )

protected

get html

Returns

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

    {
        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 = ilObject::_lookupTitle($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
            include_once './Services/Link/classes/class.ilLink.php';
            
            $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 = ilObject::_lookupTitle($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', ilUtil::getTypeIconPath($type, $obj_id));
                    $tpl->setVariable('IMG_ALT', $this->lng->txt('obj_' . $type));
                    $tpl->parseCurrentBlock();
                }
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('LINK_ITEM', ilLink::_getLink($ref_id, $type));
                $tpl->setVariable('ITEM', $title);
                $tpl->parseCurrentBlock();
                $first = false;
            }
            return $tpl->get();
        }
    }

References $title, $tpl, $type, ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), displayCut(), getPathIds(), ilUtil\getTypeIconPath(), getUseImages(), and textOnly().

Referenced by getPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPath()

ilPathGUI::getPath	(	$a_startnode,
		$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 63 of file class.ilPathGUI.php.

    {
        $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

Parameters

return

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

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

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

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

    {
        return $this->useImages;
    }

References $useImages.

Referenced by getHTML().

Here is the caller graph for this function:

◆ hideLeaf()

ilPathGUI::hideLeaf ( )

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

    {
        return $this->hide_leaf;
    }

References $hide_leaf.

Referenced by getPathIds().

Here is the caller graph for this function:

◆ setUseImages()

ilPathGUI::setUseImages ( $a_status )

set use images

Parameters

bool

Returns

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

    {
        $this->useImages = $a_status;
    }

◆ textOnly()

ilPathGUI::textOnly ( )

show text only

Returns

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

    {
        return $this->textOnly;
    }

References $textOnly.

Referenced by enableTextOnly(), and getHTML().

Here is the caller graph for this function:

Field Documentation

◆ $display_cut

ilPathGUI::$display_cut = false

private

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

Referenced by displayCut().

◆ $endnode

ilPathGUI::$endnode = ROOT_FOLDER_ID

private

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

◆ $hide_leaf

ilPathGUI::$hide_leaf = true

private

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

Referenced by hideLeaf().

◆ $lng

ilPathGUI::$lng = null

protected

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

Referenced by __construct().

◆ $startnode

ilPathGUI::$startnode = ROOT_FOLDER_ID

private

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

◆ $textOnly

ilPathGUI::$textOnly = true

private

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

Referenced by textOnly().

◆ $tree

ilPathGUI::$tree = null

protected

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

Referenced by __construct().

◆ $useImages

ilPathGUI::$useImages = false

private

Definition at line 39 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

◆ displayCut()

◆ enableDisplayCut()

◆ enableHideLeaf()

◆ enableTextOnly()

◆ getHTML()

◆ getPath()

◆ getPathIds()

◆ getUseImages()

◆ hideLeaf()

◆ setUseImages()

◆ textOnly()

Field Documentation

◆ $display_cut

◆ $endnode

◆ $hide_leaf

◆ $lng

◆ $startnode

◆ $textOnly

◆ $tree

◆ $useImages