Implementation of KioskMode Player. More...

Collaboration diagram for ilLSPlayer:

Public Member Functions
	__construct (string $lso_title, ilLSLearnerItemsQueries $ls_items, LSControlBuilder $control_builder, LSUrlBuilder $url_builder, ilLSCurriculumBuilder $curriculum_builder, ilLSViewFactory $view_factory, ilKioskPageRenderer $renderer, ILIAS\UI\Factory $ui_factory, ScreenContext $current_context)

	play (array $get, array $post=null)

	getCurrentItemLearningProgress ()

Data Fields
const	PARAM_LSO_COMMAND = 'lsocmd'

const	PARAM_LSO_PARAMETER = 'lsov'

const	LSO_CMD_NEXT = 'lsonext'

const	LSO_CMD_GOTO = 'lsogoto'

const	LSO_CMD_SUSPEND = 'lsosuspend'

const	LSO_CMD_FINISH = 'lsofinish'

const	GS_DATA_LS_KIOSK_MODE = 'ls_kiosk_mode'

const	GS_DATA_LS_CONTENT = 'ls_content'

const	GS_DATA_LS_MAINBARCONTROLS = 'ls_mainbar_controls'

const	GS_DATA_LS_METABARCONTROLS = 'ls_metabar_controls'

const	RET_EXIT = 'EXIT::'

const	RET_NOITEMS = 'NOITEMS'

Protected Member Functions
	getCurrentItem (array $items)

	updateViewState (ILIAS\KioskMode\State $state, ILIAS\KioskMode\View $view, array $get, array $post=null)

	getNextItem (array $items, LSLearnerItem $current_item, int $direction)
	$direction is either -1 or 1; More...

	findItemByRefId (array $items, int $ref_id)

	buildDefaultControls (LSControlBuilder $control_builder, LSLearnerItem $item, int $item_position, array $items)

	renderComponentView ( $state, ILIAS\KioskMode\View $view)

Detailed Description

Implementation of KioskMode Player.

Author: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 12 of file class.ilLSPlayer.php.

Constructor & Destructor Documentation

◆ __construct()

ilLSPlayer::__construct	(	string	$lso_title,
		ilLSLearnerItemsQueries	$ls_items,
		LSControlBuilder	$control_builder,
		LSUrlBuilder	$url_builder,
		ilLSCurriculumBuilder	$curriculum_builder,
		ilLSViewFactory	$view_factory,
		ilKioskPageRenderer	$renderer,
		ILIAS\UI\Factory	$ui_factory,
		ScreenContext	$current_context
	)

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

       {
         $this->lso_title = $lso_title;
         $this->ls_items = $ls_items;
         $this->control_builder = $control_builder;
         $this->url_builder = $url_builder;
         $this->curriculum_builder = $curriculum_builder;
         $this->view_factory = $view_factory;
         $this->page_renderer = $renderer;
         $this->ui_factory = $ui_factory;
         $this->current_context = $current_context;
     }

Member Function Documentation

◆ buildDefaultControls()

ilLSPlayer::buildDefaultControls	(	LSControlBuilder	$control_builder,
		LSLearnerItem	$item,
		int	$item_position,
		array	$items
	)

protected

Definition at line 230 of file class.ilLSPlayer.php.

References LSControlBuilder\exit(), LSControlBuilder\getExitControl(), LSControlBuilder\getNextControl(), getNextItem(), LSControlBuilder\getPreviousControl(), LSControlBuilder\next(), and LSControlBuilder\previous().

Referenced by play().

       : ControlBuilder {
         $is_first = $item_position === 0;
         $is_last = $item_position === count($items) - 1;
 
         if (!$control_builder->getExitControl()) {
             $cmd = self::LSO_CMD_SUSPEND;
             if ($is_last) {
                 $cmd = self::LSO_CMD_FINISH;
             }
             $control_builder = $control_builder->exit($cmd);
         }
 
         if (!$control_builder->getPreviousControl()) {
             $direction_prev = -1;
             $cmd = ''; //disables control
 
             if (!$is_first) {
                 $available = $this->getNextItem($items, $item, $direction_prev)
                     ->getAvailability() === Step::AVAILABLE;
 
                 if ($available) {
                     $cmd = self::LSO_CMD_NEXT;
                 }
             }
 
             $control_builder = $control_builder
                 ->previous($cmd, $direction_prev);
         }
 
         if (!$control_builder->getNextControl()) {
             $direction_next = 1;
             $cmd = '';
             if (!$is_last) {
                 $available = $this->getNextItem($items, $item, $direction_next)
                     ->getAvailability() === Step::AVAILABLE;
 
                 if ($available) {
                     $cmd = self::LSO_CMD_NEXT;
                 }
             }
 
             $control_builder = $control_builder
                 ->next($cmd, $direction_next);
         }
 
         return $control_builder;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findItemByRefId()

ilLSPlayer::findItemByRefId	(	array	$items,
		int	$ref_id
	)

protected

Returns: array <int, LSLearnerItem> position=>item

Definition at line 220 of file class.ilLSPlayer.php.

References $index.

Referenced by getCurrentItem(), getNextItem(), and play().

                                                                   : array
     {
         foreach ($items as $index => $item) {
             if ($item->getRefId() === $ref_id) {
                 return [$index, $item];
             }
         }
         throw new \Exception("This is not a valid item.", 1);
     }

Here is the caller graph for this function:

◆ getCurrentItem()

ilLSPlayer::getCurrentItem ( array $items )

protected

Parameters

array LSLearnerItem[]

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

References findItemByRefId().

Referenced by getCurrentItemLearningProgress(), and play().

                                                     : LSLearnerItem
     {
         $current_item = $items[0];
         $current_item_ref_id = $this->ls_items->getCurrentItemRefId();
         if ($current_item_ref_id !== 0) {
             $valid_ref_ids = array_map(
                 function ($item) {
                     return $item->getRefId();
                 },
                 array_values($this->ls_items->getItems())
             );
             if (in_array($current_item_ref_id, $valid_ref_ids)) {
                 list($position, $current_item) = $this->findItemByRefId($items, $current_item_ref_id);
             }
         }
         return $current_item;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentItemLearningProgress()

ilLSPlayer::getCurrentItemLearningProgress ( )

Definition at line 297 of file class.ilLSPlayer.php.

References getCurrentItem().

     {
         $item = $this->getCurrentItem($this->ls_items->getItems());
         return $item->getLearningProgressStatus();
     }

Here is the call graph for this function:

◆ getNextItem()

ilLSPlayer::getNextItem	(	array	$items,
		LSLearnerItem	$current_item,
		int	$direction
	)

protected

$direction is either -1 or 1;

Definition at line 207 of file class.ilLSPlayer.php.

References findItemByRefId(), and LSItem\getRefId().

Referenced by buildDefaultControls(), and play().

                                                                                               : LSLearnerItem
     {
         list($position, $item) = $this->findItemByRefId($items, $current_item->getRefId());
         $next = $position + $direction;
         if ($next >= 0 && $next < count($items)) {
             return $items[$next];
         }
         return $current_item;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ play()

ilLSPlayer::play	(	array	$get,
		array	$post = `null`
	)

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

References $_GET, $panel, $param, ILIAS\UI\Component\Listing\Workflow\Step\AVAILABLE, buildDefaultControls(), findItemByRefId(), getCurrentItem(), getNextItem(), renderComponentView(), and updateViewState().

     {
         //init state and current item
         $items = $this->ls_items->getItems();
         if (count($items) === 0) {
             return self::RET_NOITEMS;
         }
         $current_item = $this->getCurrentItem($items);
 
         while ($current_item->getAvailability() !== \ILIAS\UI\Component\Listing\Workflow\Step::AVAILABLE) {
             $prev_item = $this->getNextItem($items, $current_item, -1);
             if ($prev_item === $current_item) {
                 throw new \Exception("Cannot view first LSO-item", 1);
             }
             $current_item = $prev_item;
         }
 
         $view = $this->view_factory->getViewFor($current_item);
         $state = $this->ls_items->getStateFor($current_item, $view);
         $state = $this->updateViewState($state, $view, $get, $post);
         $items = $this->ls_items->getItems(); //reload items after update viewState
 
         $current_item_ref_id = $current_item->getRefId();
         //now, digest parameter:
         $command = $_GET[self::PARAM_LSO_COMMAND];
         $param = (int) $_GET[self::PARAM_LSO_PARAMETER];
 
         switch ($command) {
             case self::LSO_CMD_SUSPEND:
             case self::LSO_CMD_FINISH:
                 //store state and exit
                 $this->ls_items->storeState($state, $current_item_ref_id, $current_item_ref_id);
                 return 'EXIT::' . $command;
             case self::LSO_CMD_NEXT:
                 $next_item = $this->getNextItem($items, $current_item, $param);
                 if ($next_item->getAvailability() !== \ILIAS\UI\Component\Listing\Workflow\Step::AVAILABLE) {
                     $next_item = $current_item;
                 }
                 break;
             case self::LSO_CMD_GOTO:
                 list($position, $next_item) = $this->findItemByRefId($items, $param);
                 break;
             default: //view-internal / unknown command
                 $next_item = $current_item;
         }
         //write State to DB
         $this->ls_items->storeState($state, $current_item_ref_id, $next_item->getRefId());
 
         //get proper view
         if ($next_item != $current_item) {
             $view = $this->view_factory->getViewFor($next_item);
             $state = $this->ls_items->getStateFor($next_item, $view);
         }
 
         //content
         $obj_title = $next_item->getTitle();
         $icon = $this->ui_factory->symbol()->icon()
             ->standard($next_item->getType(), $next_item->getType(), 'medium');
 
         $content = $this->renderComponentView($state, $view);
 
         $panel = $this->ui_factory->panel()->standard(
             '', //panel_title
             $content
         );
         $content = [$panel];
 
         $items = $this->ls_items->getItems(); //reload items after renderComponentView content
 
         //get position
         list($item_position, $item) = $this->findItemByRefId($items, $next_item->getRefId());
 
         //have the view build controls
         $control_builder = $this->control_builder;
         $view->buildControls($state, $control_builder);
 
         //amend controls not set by the view
         $control_builder = $this->buildDefaultControls($control_builder, $item, $item_position, $items);
 
         $rendered_body = $this->page_renderer->render(
             $this->lso_title,
             $control_builder,
             $obj_title,
             $icon,
             $content
         );
 
         $metabar_controls = [
             'exit' => $control_builder->getExitControl()
         ];
 
         //curriculum
         $curriculum_slate = $this->page_renderer->buildCurriculumSlate(
             $this->curriculum_builder
                 ->getLearnerCurriculum(true)
                 ->withActive($item_position)
         );
         $mainbar_controls = [
             'curriculum' => $curriculum_slate
         ];
 
         //ToC
         $toc = $control_builder->getToc();
         if ($toc) {
             $toc_slate = $this->page_renderer->buildToCSlate($toc, $icon);
             $mainbar_controls['toc'] = $toc_slate;
         }
 
         $cc = $this->current_context;
         $cc->addAdditionalData(self::GS_DATA_LS_KIOSK_MODE, true);
         $cc->addAdditionalData(self::GS_DATA_LS_METABARCONTROLS, $metabar_controls);
         $cc->addAdditionalData(self::GS_DATA_LS_MAINBARCONTROLS, $mainbar_controls);
         $cc->addAdditionalData(self::GS_DATA_LS_CONTENT, $rendered_body);
         return;
     }

Here is the call graph for this function:

◆ renderComponentView()

ilLSPlayer::renderComponentView	(		$state,
		ILIAS\KioskMode\View	$view
	)

protected

Definition at line 283 of file class.ilLSPlayer.php.

Referenced by play().

       {
         $component = $view->render(
             $state,
             $this->ui_factory,
             $this->url_builder,
             []
         );
         return $component;
     }

Here is the caller graph for this function:

◆ updateViewState()

ilLSPlayer::updateViewState	(	ILIAS\KioskMode\State	$state,
		ILIAS\KioskMode\View	$view,
		array	$get,
		array	$post = `null`
	)

protected

Definition at line 189 of file class.ilLSPlayer.php.

References $_GET, and $param.

Referenced by play().

       : ILIAS\KioskMode\State {
         //get view internal command
         $command = $_GET[self::PARAM_LSO_COMMAND];
         $param = (int) $_GET[self::PARAM_LSO_PARAMETER];
         if (!is_null($command)) {
             $state = $view->updateGet($state, $command, $param);
         }
         return $state;
     }

Here is the caller graph for this function:

Field Documentation

◆ GS_DATA_LS_CONTENT

const ilLSPlayer::GS_DATA_LS_CONTENT = 'ls_content'

Definition at line 23 of file class.ilLSPlayer.php.

Referenced by ilLSViewLayoutProvider\getContentModification().

◆ GS_DATA_LS_KIOSK_MODE

const ilLSPlayer::GS_DATA_LS_KIOSK_MODE = 'ls_kiosk_mode'

Definition at line 22 of file class.ilLSPlayer.php.

Referenced by ilLSViewLayoutProvider\isKioskModeEnabled().

◆ GS_DATA_LS_MAINBARCONTROLS

const ilLSPlayer::GS_DATA_LS_MAINBARCONTROLS = 'ls_mainbar_controls'

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

Referenced by ilLSViewLayoutProvider\getMainBarModification().

◆ GS_DATA_LS_METABARCONTROLS

const ilLSPlayer::GS_DATA_LS_METABARCONTROLS = 'ls_metabar_controls'

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

Referenced by ilLSViewLayoutProvider\getMetaBarModification().

◆ LSO_CMD_FINISH

const ilLSPlayer::LSO_CMD_FINISH = 'lsofinish'

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

Referenced by LSControlBuilder\exit(), and ilObjLearningSequenceLearnerGUI\play().

◆ LSO_CMD_GOTO

const ilLSPlayer::LSO_CMD_GOTO = 'lsogoto'

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

Referenced by ilLSLocalDI\init().

◆ LSO_CMD_NEXT

const ilLSPlayer::LSO_CMD_NEXT = 'lsonext'

Definition at line 17 of file class.ilLSPlayer.php.

◆ LSO_CMD_SUSPEND

const ilLSPlayer::LSO_CMD_SUSPEND = 'lsosuspend'

Definition at line 19 of file class.ilLSPlayer.php.

Referenced by ilObjLearningSequenceLearnerGUI\play().

◆ PARAM_LSO_COMMAND

const ilLSPlayer::PARAM_LSO_COMMAND = 'lsocmd'

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

◆ PARAM_LSO_PARAMETER

const ilLSPlayer::PARAM_LSO_PARAMETER = 'lsov'

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

◆ RET_EXIT

const ilLSPlayer::RET_EXIT = 'EXIT::'

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

Referenced by ilObjLearningSequenceLearnerGUI\play().

◆ RET_NOITEMS

const ilLSPlayer::RET_NOITEMS = 'NOITEMS'

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

Referenced by ilObjLearningSequenceLearnerGUI\play().

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

Modules/LearningSequence/classes/Player/class.ilLSPlayer.php

Public Member Functions

Data Fields

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildDefaultControls()

◆ findItemByRefId()

◆ getCurrentItem()

◆ getCurrentItemLearningProgress()

◆ getNextItem()

◆ play()

◆ renderComponentView()

◆ updateViewState()

Field Documentation

◆ GS_DATA_LS_CONTENT

◆ GS_DATA_LS_KIOSK_MODE

◆ GS_DATA_LS_MAINBARCONTROLS

◆ GS_DATA_LS_METABARCONTROLS

◆ LSO_CMD_FINISH

◆ LSO_CMD_GOTO

◆ LSO_CMD_NEXT

◆ LSO_CMD_SUSPEND

◆ PARAM_LSO_COMMAND

◆ PARAM_LSO_PARAMETER

◆ RET_EXIT

◆ RET_NOITEMS