This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilNestedList:

Public Member Functions
	__construct ()

	setItemClass (string $a_val)

	getItemClass ()

	setListClass (string $a_val, int $a_depth=0)

	getListClass (int $a_depth=0)

	addListNode (string $a_content, string $a_id, $a_parent=0)

	setAutoNumbering (bool $a_val)

	getAutoNumbering ()

	getNumbers ()

	getHTML ()

	renderNode ( $a_id, ilTemplate $tpl, int $depth, array &$nr)

	listItemStart (ilTemplate $tpl)

	listItemEnd (ilTemplate $tpl)

	listStart (ilTemplate $tpl, int $depth)

	listEnd (ilTemplate $tpl)

Protected Attributes
string	$item_class = "il_Explorer"

array	$list_class = array()

bool	$auto_numbering = false

array	$nr = array()

array	$nodes = []

array	$childs = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Nested List

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

Deprecated:: 10

Definition at line 25 of file class.ilNestedList.php.

Constructor & Destructor Documentation

◆ __construct()

ilNestedList::__construct ( )

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

     {
         $this->list_class[0] = "il_Explorer";
         $this->childs[0] = array();
     }

Member Function Documentation

◆ addListNode()

ilNestedList::addListNode	(	string	$a_content,
		string	$a_id,
			$a_parent = `0`
	)

Definition at line 62 of file class.ilNestedList.php.

      : void {
         $this->nodes[$a_id] = $a_content;
         $this->childs[$a_parent][] = $a_id;
     }

◆ getAutoNumbering()

ilNestedList::getAutoNumbering ( )

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

References $auto_numbering.

Referenced by renderNode().

                                       : bool
     {
         return $this->auto_numbering;
     }

Here is the caller graph for this function:

◆ getHTML()

ilNestedList::getHTML ( )

Definition at line 86 of file class.ilNestedList.php.

References listEnd(), listStart(), and renderNode().

                              : string
     {
         $tpl = new ilTemplate("tpl.nested_list.html", true, true, "components/ILIAS/UIComponent/NestedList");
 
         $nr = array();
         $depth = 1;
         if (isset($this->childs[0]) && count($this->childs[0]) > 0) {
             $this->listStart($tpl, $depth);
             foreach ($this->childs[0] as $child) {
                 $this->renderNode($child, $tpl, $depth, $nr);
             }
             $this->listEnd($tpl);
         }
 
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getItemClass()

ilNestedList::getItemClass ( )

Definition at line 46 of file class.ilNestedList.php.

References $item_class.

Referenced by listItemStart().

                                   : string
     {
         return $this->item_class;
     }

Here is the caller graph for this function:

◆ getListClass()

ilNestedList::getListClass ( int $a_depth = 0 )

Definition at line 57 of file class.ilNestedList.php.

Referenced by listStart().

                                                   : string
     {
         return $this->list_class[$a_depth] ?? "";
     }

Here is the caller graph for this function:

◆ getNumbers()

ilNestedList::getNumbers ( )

Definition at line 81 of file class.ilNestedList.php.

References $nr.

                                 : array
     {
         return $this->nr;
     }

◆ listEnd()

ilNestedList::listEnd ( ilTemplate $tpl )

Definition at line 179 of file class.ilNestedList.php.

References ilTemplate\touchBlock().

Referenced by getHTML(), and renderNode().

                                             : void
     {
         //echo "<br>listEnd";
         $tpl->touchBlock("list_end");
         $tpl->touchBlock("tag");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listItemEnd()

ilNestedList::listItemEnd ( ilTemplate $tpl )

Definition at line 155 of file class.ilNestedList.php.

References ilTemplate\touchBlock().

Referenced by renderNode().

                                                 : void
     {
         $tpl->touchBlock("list_item_end");
         $tpl->touchBlock("tag");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listItemStart()

ilNestedList::listItemStart ( ilTemplate $tpl )

Definition at line 143 of file class.ilNestedList.php.

References getItemClass(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by renderNode().

                                                   : void
     {
         if ($this->getItemClass() !== "") {
             $tpl->setCurrentBlock("list_item_start");
             $tpl->setVariable("LI_CLASS", ' class="' . $this->getItemClass() . '" ');
             $tpl->parseCurrentBlock();
         } else {
             $tpl->touchBlock("list_item_start");
         }
         $tpl->touchBlock("tag");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listStart()

ilNestedList::listStart	(	ilTemplate	$tpl,
		int	$depth
	)

Definition at line 161 of file class.ilNestedList.php.

References getListClass(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by getHTML(), and renderNode().

                                                           : void
     {
         //echo "<br>listStart";
 
         $class = ($this->getListClass($depth) !== "")
             ? $this->getListClass($depth)
             : $this->getListClass();
         //echo "-$class-";
         if ($class !== "") {
             $tpl->setCurrentBlock("list_start");
             $tpl->setVariable("UL_CLASS", ' class="' . $class . '" ');
             $tpl->parseCurrentBlock();
         } else {
             $tpl->touchBlock("list_start");
         }
         $tpl->touchBlock("tag");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderNode()

ilNestedList::renderNode	(		$a_id,
		ilTemplate	$tpl,
		int	$depth,
		array &	$nr
	)

Definition at line 103 of file class.ilNestedList.php.

References getAutoNumbering(), listEnd(), listItemEnd(), listItemStart(), listStart(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), and ilTemplate\touchBlock().

Referenced by getHTML().

      : void {
         if (!isset($nr[$depth])) {
             $nr[$depth] = 1;
         } else {
             $nr[$depth]++;
         }
 
         $nr_str = $sep = "";
         if ($this->getAutoNumbering()) {
             for ($i = 1; $i <= $depth; $i++) {
                 $nr_str .= $sep . $nr[$i];
                 $sep = ".";
             }
         }
 
         $this->listItemStart($tpl);
         $tpl->setCurrentBlock("content");
         $tpl->setVariable("CONTENT", $nr_str . " " . $this->nodes[$a_id]);
         $this->nr[$a_id] = $nr_str;
         //echo "<br>".$this->nodes[$a_id];
         $tpl->parseCurrentBlock();
         $tpl->touchBlock("tag");
 
         if (isset($this->childs[$a_id]) && count($this->childs[$a_id]) > 0) {
             $this->listStart($tpl, $depth + 1);
             foreach ($this->childs[$a_id] as $child) {
                 $this->renderNode($child, $tpl, $depth + 1, $nr);
             }
             $this->listEnd($tpl);
         }
         unset($nr[$depth + 1]);
 
         $this->listItemEnd($tpl);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoNumbering()

ilNestedList::setAutoNumbering ( bool $a_val )

Definition at line 71 of file class.ilNestedList.php.

                                                  : void
     {
         $this->auto_numbering = $a_val;
     }

◆ setItemClass()

ilNestedList::setItemClass ( string $a_val )

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

                                                : void
     {
         $this->item_class = $a_val;
     }

◆ setListClass()

ilNestedList::setListClass	(	string	$a_val,
		int	$a_depth = `0`
	)

Definition at line 52 of file class.ilNestedList.php.

                                                                  : void
     {
         $this->list_class[$a_depth] = $a_val;
     }

Field Documentation

◆ $auto_numbering

bool ilNestedList::$auto_numbering = false

protected

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

Referenced by getAutoNumbering().

◆ $childs

array ilNestedList::$childs = []

protected

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

◆ $item_class

string ilNestedList::$item_class = "il_Explorer"

protected

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

Referenced by getItemClass().

◆ $list_class

array ilNestedList::$list_class = array()

protected

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

◆ $nodes

array ilNestedList::$nodes = []

protected

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

◆ $nr

array ilNestedList::$nr = array()

protected

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

Referenced by getNumbers().

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

components/ILIAS/UIComponent/NestedList/classes/class.ilNestedList.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addListNode()

◆ getAutoNumbering()

◆ getHTML()

◆ getItemClass()

◆ getListClass()

◆ getNumbers()

◆ listEnd()

◆ listItemEnd()

◆ listItemStart()

◆ listStart()

◆ renderNode()

◆ setAutoNumbering()

◆ setItemClass()

◆ setListClass()

Field Documentation

◆ $auto_numbering

◆ $childs

◆ $item_class

◆ $list_class

◆ $nodes

◆ $nr