Nested List. More...

Collaboration diagram for ilNestedList:

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

	setItemClass ($a_val)
	Set li class. More...

	getItemClass ()
	Get li class. More...

	setListClass ($a_val, $a_depth=0)
	Set list class. More...

	getListClass ($a_depth=0)
	Get list class. More...

	addListNode ($a_content, $a_id, $a_parent=0)
	Add list node. More...

	setAutoNumbering ($a_val)
	Set auto numbering. More...

	getAutoNumbering ()
	Get auto numbering. More...

	getNumbers ()
	Get numbers. More...

	getHTML ()
	Get HTML. More...

	renderNode ($a_id, $tpl, $depth, &$nr)
	Render node. More...

	listItemStart ($tpl)
	List item start. More...

	listItemEnd ($tpl)
	List item end. More...

	listStart ($tpl, $depth)
	List start. More...

	listEnd ($tpl)
	List end. More...

Protected Attributes
	$item_class = "il_Explorer"

	$list_class = array()

	$auto_numbering = false

	$nr = array()

Detailed Description

Nested List.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ __constructor()

ilNestedList::__constructor ( )

Constructor.

Parameters

return

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

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

◆ addListNode()

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

Add list node.

Parameters

return

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

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

◆ getAutoNumbering()

ilNestedList::getAutoNumbering ( )

Get auto numbering.

Returns: bool auto numbering

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

        {
                return $this->auto_numbering;
        }

References $auto_numbering.

Referenced by renderNode().

Here is the caller graph for this function:

◆ getHTML()

ilNestedList::getHTML ( )

Get HTML.

Parameters

return

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

        {
                $tpl = new ilTemplate("tpl.nested_list.html", true, true, "Services/UIComponent/NestedList");
 
                $nr = array();
                $depth = 1;
                if (is_array($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();
        }

References $nr, $tpl, listEnd(), listStart(), and renderNode().

Here is the call graph for this function:

◆ getItemClass()

ilNestedList::getItemClass ( )

Get li class.

Returns: string li class

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

        {
                return $this->item_class;
        }

References $item_class.

Referenced by listItemStart().

Here is the caller graph for this function:

◆ getListClass()

ilNestedList::getListClass ( $a_depth = 0 )

Get list class.

Returns: string list class

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

        {
                return $this->list_class[$a_depth];
        }

Referenced by listStart().

Here is the caller graph for this function:

◆ getNumbers()

ilNestedList::getNumbers ( )

Get numbers.

Returns: array number array

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

        {
                return $this->nr;
        }

References $nr.

◆ listEnd()

ilNestedList::listEnd ( $tpl )

List end.

Parameters

return

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

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

References $tpl.

Referenced by getHTML(), and renderNode().

Here is the caller graph for this function:

◆ listItemEnd()

ilNestedList::listItemEnd ( $tpl )

List item end.

Parameters

return

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

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

References $tpl.

Referenced by renderNode().

Here is the caller graph for this function:

◆ listItemStart()

ilNestedList::listItemStart ( $tpl )

List item start.

Parameters

return

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

        {
                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");
        }

References $tpl, and getItemClass().

Referenced by renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listStart()

ilNestedList::listStart	(	$tpl,
		$depth
	)

List start.

Parameters

return

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

        {
//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");
        }

References $tpl, and getListClass().

Referenced by getHTML(), and renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderNode()

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

Render node.

Parameters

return

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

        {
                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 (is_array($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);
        }

References $nr, $tpl, getAutoNumbering(), listEnd(), listItemEnd(), listItemStart(), listStart(), and renderNode().

Referenced by getHTML(), and renderNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoNumbering()

ilNestedList::setAutoNumbering ( $a_val )

Set auto numbering.

Parameters

bool $a_val auto numbering

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

        {
                $this->auto_numbering = $a_val;
        }

◆ setItemClass()

ilNestedList::setItemClass ( $a_val )

Set li class.

Parameters

string li class

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

        {
                $this->item_class = $a_val;
        }

◆ setListClass()

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

Set list class.

Parameters

string list class

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

        {
//var_dump($a_val);
                $this->list_class[$a_depth] = $a_val;
        }

Field Documentation

◆ $auto_numbering

ilNestedList::$auto_numbering = false

protected

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

Referenced by getAutoNumbering().

◆ $item_class

ilNestedList::$item_class = "il_Explorer"

protected

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

Referenced by getItemClass().

◆ $list_class

ilNestedList::$list_class = array()

protected

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

◆ $nr

ilNestedList::$nr = array()

protected

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

Referenced by getHTML(), getNumbers(), and renderNode().

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

Services/UIComponent/NestedList/classes/class.ilNestedList.php

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ __constructor()

◆ addListNode()

◆ getAutoNumbering()

◆ getHTML()

◆ getItemClass()

◆ getListClass()

◆ getNumbers()

◆ listEnd()

◆ listItemEnd()

◆ listItemStart()

◆ listStart()

◆ renderNode()

◆ setAutoNumbering()

◆ setItemClass()

◆ setListClass()

Field Documentation

◆ $auto_numbering

◆ $item_class

◆ $list_class

◆ $nr