ilLegacyKioskModeView Class Reference

Class ilLegacyKioskModeView. More...

Inheritance diagram for ilLegacyKioskModeView:

Collaboration diagram for ilLegacyKioskModeView:

Public Member Functions
	__construct (ilObject $object, ilLanguage $lng, ilAccess $access)
	buildInitialState (State $empty_state)
	@inheritDoc More...
	buildControls (State $state, ControlBuilder $builder)
	@inheritDoc More...
	updateGet (State $state, string $command, int $param=null)
	@inheritDoc More...
	updatePost (State $state, string $command, array $post)
	@inheritDoc More...
	render (State $state, Factory $factory, URLBuilder $url_builder, array $post=null)
	@inheritDoc More...
Public Member Functions inherited from ILIAS\KioskMode\View
	buildInitialState (State $empty_state)
	Build an initial state based on the Provided empty state. More...
	buildControls (State $state, ControlBuilder $builder)
	Construct the controls for the view based on the current state. More...
	updateGet (State $state, string $command, int $parameter=null)
	Update the state based on the provided command. More...
	updatePost (State $state, string $command, array $post)
	Update the state and the object based on the provided command and post-data. More...
	render (State $state, UI\Factory $factory, URLBuilder $url_builder, array $post=null)
	Render a state using the ui-factory and URLs from the builder. More...

Data Fields
const	GET_VIEW_CMD_FROM_LIST_GUI_FOR = ['sahs']

Protected Member Functions
	getObjectTitle ()
	setObject (\ilObject $object)
	@inheritDoc More...
	hasPermissionToAccessKioskMode ()
	@inheritDoc More...

Protected Attributes
	$object

Private Member Functions
	getMetadata (int $obj_id, string $type)
	debugBuildAllControls (ControlBuilder $builder)
	getTitleByType (string $type)

Detailed Description

Class ilLegacyKioskModeView.

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

Constructor & Destructor Documentation

__construct()

ilLegacyKioskModeView::__construct	(	ilObject	$object,
		ilLanguage	$lng,
		ilAccess	$access
	)

Definition at line 20 of file class.ilLegacyKioskModeView.php.

      {
        $this->object = $object;
        $this->lng = $lng;
        $this->access = $access;
    }

References $lng, and $object.

Member Function Documentation

buildControls()

ilLegacyKioskModeView::buildControls	(	State	$state,
		ControlBuilder	$builder
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 63 of file class.ilLegacyKioskModeView.php.

                                                                         : ControlBuilder
    {
        if (!$builder instanceof LSControlBuilder) {
            throw new LogicException("The Legacy Mode in the Learning Sequence requires an LSControlBuilder explicitely.", 1);
        }
 
        $ref_id = $this->object->getRefId();
        $type = $this->object->getType();
 
        $label = sprintf(
            $this->lng->txt('lso_start_item'),
            $this->getTitleByType($type)
        );
 
        $url = \ilLink::_getStaticLink(
            $ref_id,
            $type,
            true,
            false
        );
 
        if (in_array($type, self::GET_VIEW_CMD_FROM_LIST_GUI_FOR)) {
            $obj_id = $this->object->getId();
            $item_list_gui = \ilObjectListGUIFactory::_getListGUIByType($type);
            $item_list_gui->initItem($ref_id, $obj_id, $type);
            $view_link = $item_list_gui->getCommandLink('view');
            $view_link = str_replace('&', '&', $view_link);
            $view_link = ILIAS_HTTP_PATH . '/' . $view_link;
            $url = $view_link;
        }
 
        $builder->start($label, $url, 0);
 
        //              return $this->debugBuildAllControls($builder);
        return $builder;
    }

References $builder, $type, $url, ilObjectListGUIFactory\_getListGUIByType(), ilLink\_getStaticLink(), and ILIAS_HTTP_PATH.

Here is the call graph for this function:

buildInitialState()

ilLegacyKioskModeView::buildInitialState

(

State

$empty_state

)

@inheritDoc

Implements ILIAS\KioskMode\View.

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

                                                          : State
    {
        return $empty_state;
    }

debugBuildAllControls()

ilLegacyKioskModeView::debugBuildAllControls ( ControlBuilder  $builder )

private

Definition at line 171 of file class.ilLegacyKioskModeView.php.

                                                                    : ControlBuilder
    {
        $builder
 
        ->tableOfContent($this->getObjectTitle(), 'kommando', 666)
            ->node('node1')
                ->item('item1.1', 1)
                ->item('item1.2', 11)
                ->end()
            ->item('item2', 111)
            ->node('node3', 1111)
                ->item('item3.1', 2)
                ->node('node3.2')
                    ->item('item3.2.1', 122)
                ->end()
            ->end()
            ->end()
 
        ->locator('locator_cmd')
            ->item('item 1', 1)
            ->item('item 2', 2)
            ->item('item 3', 3)
            ->end()
 
        ->done('cmd', 1)
        ->next('cmd', 1)
        ->previous('', 1)
        //->exit('cmd', 1)
        ->generic('cmd 1', 'x', 1)
        ->generic('cmd 2', 'x', 2)
        //->toggle('toggle', 'cmd_on', 'cmd_off')
        ->mode('modecmd', ['m1', 'm2', 'm3'])
        ;
 
        return $builder;
    }

References $builder.

getMetadata()

ilLegacyKioskModeView::getMetadata ( int  $obj_id, string  $type  )

private

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

                                                            : array
    {
        $md = new ilMD($obj_id, 0, $type);
        $meta_data = [];
 
        $section = $md->getGeneral();
        if (!$section) {
            return [];
        }
 
        $meta_data['language'] = [];
        foreach ($section->getLanguageIds() as $id) {
            $meta_data['language'][] = $section->getLanguage($id)->getLanguageCode();
        }
        $meta_data['keywords'] = [];
        foreach ($section->getKeywordIds() as $id) {
            $meta_data['keywords'][] = $section->getKeyword($id)->getKeyword();
        }
 
        $md_flat = [];
        foreach ($meta_data as $md_label => $values) {
            if (count($values) > 0) {
                $md_flat[$this->lng->txt($md_label)] = implode(', ', $values);
            }
        }
        return $md_flat;
    }

References $section, and $type.

getObjectTitle()

ilLegacyKioskModeView::getObjectTitle ( )

protected

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

                                        : string
    {
        return $this->object->getTitle();
    }

getTitleByType()

ilLegacyKioskModeView::getTitleByType ( string  $type )

private

Definition at line 208 of file class.ilLegacyKioskModeView.php.

                                                  : string
    {
        return $this->lng->txt("obj_" . $type);
    }

References $type.

hasPermissionToAccessKioskMode()

ilLegacyKioskModeView::hasPermissionToAccessKioskMode ( )

protected

@inheritDoc

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

                                                        : bool
    {
        return true;
        //return $this->access->checkAccess('read', '', $this->contentPageObject->getRefId());
    }

render()

ilLegacyKioskModeView::render	(	State	$state,
		Factory	$factory,
		URLBuilder	$url_builder,
		array	$post = null
	)

@inheritDoc

Definition at line 119 of file class.ilLegacyKioskModeView.php.

      : Component {
        $obj_type = $this->object->getType();
        $obj_type_txt = $this->lng->txt('obj_' . $obj_type);
        $icon = $factory->symbol()->icon()->standard($obj_type, $obj_type_txt, 'large');
        $md = $this->getMetadata((int) $this->object->getId(), $obj_type);
        $props = array_merge(
            [$this->lng->txt('obj_type') => $obj_type_txt],
            $this->getMetadata((int) $this->object->getId(), $obj_type)
        );
 
        $info = $factory->item()->standard($this->object->getTitle())
            ->withLeadIcon($icon)
            ->withDescription($this->object->getDescription())
            ->withProperties($props);
 
        return $info;
    }

setObject()

ilLegacyKioskModeView::setObject ( \ilObject  $object )

protected

@inheritDoc

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

    {
        $this->object = $object;
    }

References $object.

updateGet()

ilLegacyKioskModeView::updateGet	(	State	$state,
		string	$command,
		int	$param = null
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

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

                                                                                : State
    {
        return $state;
    }

updatePost()

ilLegacyKioskModeView::updatePost	(	State	$state,
		string	$command,
		array	$post
	)

@inheritDoc

Implements ILIAS\KioskMode\View.

Definition at line 111 of file class.ilLegacyKioskModeView.php.

                                                                           : State
    {
        return $state;
    }

Field Documentation

$object

ilLegacyKioskModeView::$object

protected

Definition at line 18 of file class.ilLegacyKioskModeView.php.

Referenced by __construct(), and setObject().

GET_VIEW_CMD_FROM_LIST_GUI_FOR

const ilLegacyKioskModeView::GET_VIEW_CMD_FROM_LIST_GUI_FOR = ['sahs']

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

---

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

• Modules/LearningSequence/classes/Player/class.ilLegacyKioskModeView.php