LSTOCBuilder Class Reference

Class LSTOCBuilder. More...

Inheritance diagram for LSTOCBuilder:

Collaboration diagram for LSTOCBuilder:

Public Member Functions
	__construct ($parent, string $command, string $label='', ?int $parameter=null, $state=null)
	LSControlBuilder|LSTOCBuilder $parent. More...
	toJSON ()
	end ()
	Finish building the TOC. Returns ControlBuilder|TOCBuilder depending on the nesting level. More...
	node (string $label, ?int $parameter=null, ?int $lp=null)
	Build a sub tree in the TOC.If a parameter is provided, the node in the TOC can be accessed itself.The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content. Parameters mixed $state one of the LP_ constants from TOCBuilder More...
	item (string $label, int $parameter, $state=null, bool $current=false)
	Build an entry in the TOC.The parameter will be appended to the command when updating the state.The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content. Parameters mixed $state one of the LP_ constants from TOCBuilder bool $current is this the currently active item? More...
	end ()
	Finish building the TOC. More...
	node (string $label, ?int $parameter=null, ?int $lp=null)
	Build a sub tree in the TOC. More...
	item (string $label, int $parameter, $state=null, bool $current=false)
	Build an entry in the TOC. More...

Protected Attributes
array	$structure
	$parent
string	$command

Additional Inherited Members
Data Fields inherited from ILIAS\KioskMode\TOCBuilder
const	LP_NOT_STARTED = 0
const	LP_IN_PROGRESS = 1
const	LP_COMPLETED = 2
const	LP_FAILED = 3

Detailed Description

Class LSTOCBuilder.

Definition at line 26 of file LSTOCBuilder.php.

Constructor & Destructor Documentation

__construct()

LSTOCBuilder::__construct	(		$parent,
		string	$command,
		string	$label = '',
		?int	$parameter = null,
			$state = null
	)

LSControlBuilder|LSTOCBuilder $parent.

Definition at line 43 of file LSTOCBuilder.php.

    {
        $this->structure = [
            'label' => $label,
            'command' => $command,
            'parameter' => $parameter,
            'state' => $state,
            'childs' => []
        ];
        $this->parent = $parent;
        $this->command = $command;
    }

References $command, and $parent.

Member Function Documentation

end()

LSTOCBuilder::end

(

)

Finish building the TOC.

Returns

ControlBuilder|TOCBuilder depending on the nesting level.

Implements ILIAS\KioskMode\TOCBuilder.

Definition at line 64 of file LSTOCBuilder.php.

    {
        if ($this->parent instanceof LSTOCBuilder) {
            $this->parent->structure['childs'][] = $this->structure;
        }
        return $this->parent;
    }

References $parent, and $structure.

item()

LSTOCBuilder::item	(	string	$label,
		int	$parameter,
			$state = null,
		bool	$current = false
	)

Build an entry in the TOC.The parameter will be appended to the command when updating the state.The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Parameters

mixed	$state	one of the LP_ constants from TOCBuilder
bool	$current	is this the currently active item?

Implements ILIAS\KioskMode\TOCBuilder.

Definition at line 85 of file LSTOCBuilder.php.

                                                                                             : TOCBuilder
    {
        $item = [
            'label' => $label,
            'command' => $this->command,
            'parameter' => $parameter,
            'state' => $state,
            'current' => $current
        ];
        $this->structure['childs'][] = $item;
        return $this;
    }

References $command.

Referenced by ilLMTOCExplorerGUI\renderLSTocNode().

Here is the caller graph for this function:

node()

LSTOCBuilder::node	(	string	$label,
		?int	$parameter = null,
		?int	$lp = null
	)

Build a sub tree in the TOC.If a parameter is provided, the node in the TOC can be accessed itself.The $parameter can be used to pass additional information to View::updateGet if required, e.g. about a chapter in the content.

Parameters

mixed

$state

one of the LP_ constants from TOCBuilder

Implements ILIAS\KioskMode\TOCBuilder.

Definition at line 75 of file LSTOCBuilder.php.

                                                                                : TOCBuilder
    {
        //build node
        $toc = new LSTOCBuilder($this, $this->command, $label, $parameter, $lp);
        return $toc;
    }

Referenced by ilLMTOCExplorerGUI\renderLSTocNode().

Here is the caller graph for this function:

toJSON()

LSTOCBuilder::toJSON

(

)

Definition at line 56 of file LSTOCBuilder.php.

                            : string
    {
        return json_encode($this->structure);
    }

Referenced by ilKioskPageRenderer\buildToCSlate().

Here is the caller graph for this function:

Field Documentation

$command

string LSTOCBuilder::$command

protected

Definition at line 38 of file LSTOCBuilder.php.

Referenced by __construct(), and item().

$parent

LSTOCBuilder::$parent

protected

Definition at line 36 of file LSTOCBuilder.php.

Referenced by __construct(), and end().

$structure

array LSTOCBuilder::$structure

protected

Definition at line 31 of file LSTOCBuilder.php.

Referenced by end().

---

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

• components/ILIAS/LearningSequence/classes/Player/LSTOCBuilder.php