ilLSPlayer Class Reference

Implementation of KioskMode Player. More...

Collaboration diagram for ilLSPlayer:

Public Member Functions
	__construct (int $lso_ref_id, string $lso_title, int $usr_id, array $items, ilLSStateDB $state_db, LSControlBuilder $control_builder, LSUrlBuilder $url_builder, ilLSCurriculumBuilder $curriculum_builder, ilLSViewFactory $view_factory, ilKioskPageRenderer $renderer, ILIAS\UI\Factory $ui_factory)
	render (array $get, array $post=null)

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'

Protected Member Functions
	storeState (ILIAS\KioskMode\State $state, int $state_item_ref_id, int $current_item_ref_id)
	updateViewState (ILIAS\KioskMode\State $state, ILIAS\KioskMode\View $view, array $get, array $post=null)
	getNextItem (LSLearnerItem $current_item, int $direction)
	$direction is either -1 or 1; More...
	findItemByRefId (int $ref_id)
	buildDefaultControls (LSControlBuilder $control_builder, LSLearnerItem $item, int $item_position)
	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 13 of file class.ilLSPlayer.php.

Constructor & Destructor Documentation

__construct()

ilLSPlayer::__construct	(	int	$lso_ref_id,
		string	$lso_title,
		int	$usr_id,
		array	$items,
		ilLSStateDB	$state_db,
		LSControlBuilder	$control_builder,
		LSUrlBuilder	$url_builder,
		ilLSCurriculumBuilder	$curriculum_builder,
		ilLSViewFactory	$view_factory,
		ilKioskPageRenderer	$renderer,
		ILIAS\UI\Factory	$ui_factory
	)

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

      {
        $this->lso_ref_id = $lso_ref_id;
        $this->lso_title = $lso_title;
        $this->usr_id = $usr_id;
        $this->items = $items;
        $this->state_db = $state_db;
        $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;
    }

Member Function Documentation

buildDefaultControls()

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

protected

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

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

Referenced by render().

      : ControlBuilder {
        $is_first = $item_position === 0;
        $is_last = $item_position === count($this->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($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($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 ( int  $ref_id )

protected

Returns

array <int, LSLearnerItem> position=>item

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

References $index.

Referenced by getNextItem(), and render().

                                                    : array
    {
        foreach ($this->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:

getNextItem()

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

protected

$direction is either -1 or 1;

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

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

Referenced by buildDefaultControls(), and render().

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

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilLSPlayer::render	(	array	$get,
		array	$post = null
	)

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

References $_GET, $post, $state, ILIAS\UI\Component\Listing\Workflow\Step\AVAILABLE, buildDefaultControls(), findItemByRefId(), getNextItem(), renderComponentView(), storeState(), and updateViewState().

    {
        //init state and current item
        $stored = $this->state_db->getCurrentItemsFor(
            $this->lso_ref_id,
            [$this->usr_id]
        );

        $current_item = $this->items[0];
        $current_item_ref_id = $current_item->getRefId();

        if (count($stored) > 0 ||
            $stored[$this->usr_id] > -1 //returns -1 if there is no current item
        ) {
            $current_item_ref_id = $stored[$this->usr_id];

            //maybe item is not available?
            $valid_ref_ids = array_map(
                function ($item) {
                    return $item->getRefId();
                },
                array_values($this->items)
            );

            if (in_array($current_item_ref_id, $valid_ref_ids)) {
                list($position, $current_item) = $this->findItemByRefId($current_item_ref_id);
            }
        }

        $command = $_GET[self::PARAM_LSO_COMMAND];
        $param = (int) $_GET[self::PARAM_LSO_PARAMETER];

        while ($current_item->getAvailability() !== \ILIAS\UI\Component\Listing\Workflow\Step::AVAILABLE) {
            $prev_item = $this->getNextItem($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 = $current_item->getState();
        $state = $this->updateViewState($state, $view, $get, $post);

        switch ($command) {
            case self::LSO_CMD_SUSPEND:
            case self::LSO_CMD_FINISH:
                //store state and exit
                $this->storeState($state, $current_item_ref_id, $current_item_ref_id);
                return 'EXIT::' . $command;
            case self::LSO_CMD_NEXT:
                $next_item = $this->getNextItem($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($param);
                break;
            default:
                $next_item = $current_item;
        }
        //write State to DB
        $this->storeState($state, $current_item_ref_id, $next_item->getRefId());

        //get proper view
        if ($next_item !== $current_item) {
            $view = $this->view_factory->getViewFor($next_item);
        }
        //get position
        list($item_position, $item) = $this->findItemByRefId($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
        $this->buildDefaultControls($control_builder, $item, $item_position);

        //content
        $obj_title = $next_item->getTitle();
        $icon = $this->ui_factory->icon()
            ->standard($next_item->getType(), $next_item->getType(), 'medium');

        $curriculum = $this->curriculum_builder->getLearnerCurriculum(true)
            ->withActive($item_position);

        $content = $this->renderComponentView($state, $view);
        $panel = $this->ui_factory->panel()->standard(
            '', //panel_title
            $content
        );
        $content = [$panel];

        return $this->page_renderer->render(
            $this->lso_title,
            $control_builder,
            $obj_title,
            $icon,
            $content,
            $curriculum
        );
    }

Here is the call graph for this function:

renderComponentView()

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

protected

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

References $state.

Referenced by render().

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

Here is the caller graph for this function:

storeState()

ilLSPlayer::storeState ( ILIAS\KioskMode\State  $state, int  $state_item_ref_id, int  $current_item_ref_id  )

protected

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

Referenced by render().

      {
        $this->state_db->updateState(
            $this->lso_ref_id,
            $this->usr_id,
            $state_item_ref_id,
            $state,
            $current_item_ref_id
        );
    }

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 166 of file class.ilLSPlayer.php.

References $_GET, and $state.

Referenced by render().

      : 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);
        }
        //$state = $view->updatePOST($state, $command, $post);
        return $state;
    }

Here is the caller graph for this function:

Field Documentation

LSO_CMD_FINISH

const ilLSPlayer::LSO_CMD_FINISH = 'lsofinish'

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

Referenced by LSControlBuilder\exit().

LSO_CMD_GOTO

const ilLSPlayer::LSO_CMD_GOTO = 'lsogoto'

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

Referenced by ilObjLearningSequence\getCurriculumBuilder().

LSO_CMD_NEXT

const ilLSPlayer::LSO_CMD_NEXT = 'lsonext'

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

LSO_CMD_SUSPEND

const ilLSPlayer::LSO_CMD_SUSPEND = 'lsosuspend'

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

PARAM_LSO_COMMAND

const ilLSPlayer::PARAM_LSO_COMMAND = 'lsocmd'

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

PARAM_LSO_PARAMETER

const ilLSPlayer::PARAM_LSO_PARAMETER = 'lsov'

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

---

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

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