ilLSPlayer Class Reference

Implementation of KioskMode Player. More...

Collaboration diagram for ilLSPlayer:

Public Member Functions
	__construct (ilLSLearnerItemsQueries $ls_items, LSControlBuilder $control_builder, LSUrlBuilder $url_builder, ilLSCurriculumBuilder $curriculum_builder, ilLSViewFactory $view_factory, ilKioskPageRenderer $renderer, Factory $ui_factory, ScreenContext $current_context, Refinery\Factory $refinery)
	play (RequestWrapper $get)
	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'

Protected Member Functions
	getCurrentItem (array $items)
	updateViewState (ILIAS\KioskMode\State $state, ILIAS\KioskMode\View $view, RequestWrapper $get)
	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)

Protected Attributes
ilLSLearnerItemsQueries	$ls_items
LSControlBuilder	$control_builder
LSUrlBuilder	$url_builder
ilLSCurriculumBuilder	$curriculum_builder
ilLSViewFactory	$view_factory
ilKioskPageRenderer	$page_renderer
Factory	$ui_factory
ScreenContext	$current_context
Refinery Factory	$refinery

Detailed Description

Implementation of KioskMode Player.

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

Constructor & Destructor Documentation

__construct()

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

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

References $control_builder, $current_context, $curriculum_builder, $ls_items, $refinery, $ui_factory, $url_builder, $view_factory, and ILIAS\Repository\refinery().

      {
        $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;
        $this->refinery = $refinery;
    }

Here is the call graph for this function:

Member Function Documentation

buildDefaultControls()

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

protected

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

References $control_builder, 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 252 of file class.ilLSPlayer.php.

References $index, and $ref_id.

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 207 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(
                fn ($item) => $item->getRefId(),
                array_values($this->ls_items->getItems())
            );
            if (in_array($current_item_ref_id, $valid_ref_ids)) {
                list(, $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 326 of file class.ilLSPlayer.php.

References getCurrentItem().

                                                    : int
    {
        $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 239 of file class.ilLSPlayer.php.

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

Referenced by buildDefaultControls(), and play().

                                                                                             : LSLearnerItem
    {
        list($position) = $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

(

RequestWrapper

$get

)

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

References $control_builder, $current_context, $panel, $param, ILIAS\GlobalScreen\ScreenContext\ScreenContext\addAdditionalData(), buildDefaultControls(), findItemByRefId(), getCurrentItem(), getNextItem(), ILIAS\HTTP\Wrapper\RequestWrapper\has(), ILIAS\Repository\refinery(), renderComponentView(), ILIAS\HTTP\Wrapper\RequestWrapper\retrieve(), and updateViewState().

                                             : ?string
    {
        //init state and current item
        $items = $this->ls_items->getItems();

        if (count($items) === 0) {
            return null;
        }

        $current_item = $this->getCurrentItem($items);

        while ($current_item->getAvailability() !== 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);
        //reload items after update viewState
        $items = $this->ls_items->getItems();

        $current_item_ref_id = $current_item->getRefId();
        //now, digest parameter:
        $command = null;
        if ($get->has(self::PARAM_LSO_COMMAND)) {
            $command = $get->retrieve(self::PARAM_LSO_COMMAND, $this->refinery->kindlyTo()->string());
        }
        $param = null;
        if ($get->has(self::PARAM_LSO_PARAMETER)) {
            $param = $get->retrieve(self::PARAM_LSO_PARAMETER, $this->refinery->kindlyTo()->int());
        }

        switch ($command) {
            case self::LSO_CMD_SUSPEND:
            case self::LSO_CMD_FINISH:
                $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() !== Step::AVAILABLE) {
                    $next_item = $current_item;
                }
                break;
            case self::LSO_CMD_GOTO:
                list(, $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(
            '',
            $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(
            $control_builder,
            $obj_title,
            $icon,
            $content
        );

        $metabar_controls = [
            'exit' => $control_builder->getExitControl()
        ];

        $curriculum_slate = $this->page_renderer->buildCurriculumSlate(
            $this->curriculum_builder
                ->getLearnerCurriculum(true)
                ->withActive($item_position)
        );
        $mainbar_controls = [
            'curriculum' => $curriculum_slate
        ];

        $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 null;
    }

Here is the call graph for this function:

renderComponentView()

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

protected

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

Referenced by play().

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

Here is the caller graph for this function:

updateViewState()

ilLSPlayer::updateViewState ( ILIAS\KioskMode\State  $state, ILIAS\KioskMode\View  $view, RequestWrapper  $get  )

protected

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

References $param, ILIAS\HTTP\Wrapper\RequestWrapper\has(), ILIAS\Repository\refinery(), and ILIAS\HTTP\Wrapper\RequestWrapper\retrieve().

Referenced by play().

     : ILIAS\KioskMode\State {
        if ($get->has(self::PARAM_LSO_COMMAND) && $get->has(self::PARAM_LSO_PARAMETER)) {
            $command = $get->retrieve(self::PARAM_LSO_COMMAND, $this->refinery->kindlyTo()->string());
            $param = $get->retrieve(self::PARAM_LSO_PARAMETER, $this->refinery->kindlyTo()->int());
            $state = $view->updateGet($state, $command, $param);
        }
        return $state;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$control_builder

LSControlBuilder ilLSPlayer::$control_builder

protected

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

Referenced by __construct(), buildDefaultControls(), and play().

$current_context

ScreenContext ilLSPlayer::$current_context

protected

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

Referenced by __construct(), and play().

$curriculum_builder

ilLSCurriculumBuilder ilLSPlayer::$curriculum_builder

protected

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

Referenced by __construct().

$ls_items

ilLSLearnerItemsQueries ilLSPlayer::$ls_items

protected

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

Referenced by __construct().

$page_renderer

ilKioskPageRenderer ilLSPlayer::$page_renderer

protected

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

$refinery

Refinery Factory ilLSPlayer::$refinery

protected

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

Referenced by __construct().

$ui_factory

Factory ilLSPlayer::$ui_factory

protected

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

Referenced by __construct().

$url_builder

LSUrlBuilder ilLSPlayer::$url_builder

protected

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

Referenced by __construct().

$view_factory

ilLSViewFactory ilLSPlayer::$view_factory

protected

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

Referenced by __construct().

GS_DATA_LS_CONTENT

const ilLSPlayer::GS_DATA_LS_CONTENT = 'ls_content'

Definition at line 43 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 42 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 44 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 45 of file class.ilLSPlayer.php.

Referenced by ilLSViewLayoutProvider\getPageBuilderDecorator().

LSO_CMD_FINISH

const ilLSPlayer::LSO_CMD_FINISH = 'lsofinish'

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

Referenced by LSControlBuilder\exit().

LSO_CMD_GOTO

const ilLSPlayer::LSO_CMD_GOTO = 'lsogoto'

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

Referenced by ilLSLocalDI\init().

LSO_CMD_NEXT

const ilLSPlayer::LSO_CMD_NEXT = 'lsonext'

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

LSO_CMD_SUSPEND

const ilLSPlayer::LSO_CMD_SUSPEND = 'lsosuspend'

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

PARAM_LSO_COMMAND

const ilLSPlayer::PARAM_LSO_COMMAND = 'lsocmd'

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

PARAM_LSO_PARAMETER

const ilLSPlayer::PARAM_LSO_PARAMETER = 'lsov'

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

---

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

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