ilMediaObjectsPlayerWrapperGUI Class Reference

Collaboration diagram for ilMediaObjectsPlayerWrapperGUI:

Public Member Functions
	__construct (InternalDomainService $domain_service, InternalGUIService $gui_service)
	executeCommand ()
	renderComponent (ilObjMediaObject $mob, int $tracking_container_ref_id=0)
	getComponent (ilObjMediaObject $mob, int $tracking_container_ref_id=0)
	audio (ilObjMediaObject $mob, int $tracking_container_ref_id=0)
	image (ilObjMediaObject $mob, int $tracking_container_ref_id=0)
	video (ilObjMediaObject $mob, int $tracking_container_ref_id=0)

Protected Member Functions
	saveCompletion ()

Protected Attributes
ILIAS MediaObjects Tracking TrackingManager	$tracking
ILIAS MediaObjects Player PlayerGUIRequest	$request
ILIAS MediaObjects MediaType MediaTypeManager	$media_type
InternalGUIService	$gui
InternalDomainService	$domain

Detailed Description

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilMediaObjectsPlayerWrapperGUI::__construct	(	InternalDomainService	$domain_service,
		InternalGUIService	$gui_service
	)

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

      {
        $this->gui = $gui_service;
        $this->domain = $domain_service;
        $this->media_type = $this->domain->mediaType();
        $this->request = $gui_service->player()->request();
        $this->tracking = $this->domain->tracking();
    }

References ILIAS\MediaObjects\InternalDomainService\mediaType(), and ILIAS\MediaObjects\InternalGUIService\player().

Here is the call graph for this function:

Member Function Documentation

audio()

ilMediaObjectsPlayerWrapperGUI::audio	(	ilObjMediaObject	$mob,
		int	$tracking_container_ref_id = 0
	)

Exceptions

ilCtrlException

Definition at line 101 of file class.ilMediaObjectsPlayerWrapperGUI.php.

     : ?\ILIAS\UI\Component\Player\Audio {
        $main_tpl = $this->gui->ui()->mainTemplate();
 
        $ctrl = $this->gui->ctrl();
 
        $med = $mob->getMediaItem("Standard");
 
        if (is_null($med) || !$this->media_type->isAudio($med->getFormat())) {
            return null;
        }
        $resource = $mob->getStandardSrc();
        $audio = $this->gui->ui()->factory()->player()->audio(
            $resource,
            ""
        );
 
        if ($tracking_container_ref_id > 0) {
            // @todo: make this a media object general setting
            $mcst_settings = ilMediaCastSettings::_getInstance();
            $treshold = (int) $mcst_settings->getVideoCompletionThreshold();
 
            $main_tpl->addJavaScript("assets/js/MediaObjectsCompletion.js");
            $ctrl->setParameter($this, "mob_tracking_ref_id", $tracking_container_ref_id);
            $ctrl->setParameter($this, "mob_tracking_mob_id", $mob->getId());
            $url = $ctrl->getLinkTarget($this, "saveCompletion");
            $audio = $audio->withAdditionalOnLoadCode(function ($id) use ($url, $treshold) {
                $js = <<<EOT
                document.getElementById('$id').dataset.mobCompletionCallback = '$url';
                document.getElementById('$id').dataset.mobCompletionThreshold = '$treshold';
                il.MediaObjectsCompletion.init();
EOT;
                return $js;
            });
        }
        return $audio;
    }

executeCommand()

ilMediaObjectsPlayerWrapperGUI::executeCommand

(

)

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

                                    : void
    {
        $ctrl = $this->gui->ctrl();
 
        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd();
 
        switch ($next_class) {
            default:
                if (in_array($cmd, array("saveCompletion"))) {
                    $this->$cmd();
                }
        }
    }

getComponent()

ilMediaObjectsPlayerWrapperGUI::getComponent	(	ilObjMediaObject	$mob,
		int	$tracking_container_ref_id = 0
	)

Definition at line 71 of file class.ilMediaObjectsPlayerWrapperGUI.php.

     : ILIAS\UI\Component\Component {
        $med = $mob->getMediaItem("Standard");
        $comp = null;
        if (!is_null($med)) {
            if ($this->media_type->isAudio($med->getFormat())) {
                $comp = $this->audio(
                    $mob,
                    $tracking_container_ref_id
                );
            } elseif ($this->media_type->isVideo($med->getFormat())) {
                $comp = $this->video(
                    $mob,
                    $tracking_container_ref_id
                );
            } elseif ($this->media_type->isImage($med->getFormat())) {
                $comp = $this->image(
                    $mob,
                    $tracking_container_ref_id
                );
            }
        }
        return $comp;
    }

image()

ilMediaObjectsPlayerWrapperGUI::image	(	ilObjMediaObject	$mob,
		int	$tracking_container_ref_id = 0
	)

Exceptions

ilCtrlException

Definition at line 144 of file class.ilMediaObjectsPlayerWrapperGUI.php.

     : ?\ILIAS\UI\Component\Image\Image {
        $main_tpl = $this->gui->ui()->mainTemplate();
 
        $ctrl = $this->gui->ctrl();
 
        $med = $mob->getMediaItem("Standard");
 
        if (is_null($med) || !$this->media_type->isImage($med->getFormat())) {
            return null;
        }
 
        $source = $mob->getStandardSrc();
 
        $image = $this->gui->ui()->factory()->image()->responsive($source, $mob->getTitle());
 
        if ($tracking_container_ref_id > 0) {
            // @todo: make this a media object general setting
            $mcst_settings = ilMediaCastSettings::_getInstance();
            $treshold = (int) $mcst_settings->getVideoCompletionThreshold();
 
            $main_tpl->addJavaScript("assets/js/MediaObjectsCompletion.js");
            $ctrl->setParameter($this, "mob_tracking_ref_id", $tracking_container_ref_id);
            $ctrl->setParameter($this, "mob_tracking_mob_id", $mob->getId());
            $url = $ctrl->getLinkTarget($this, "saveCompletion");
            $audio = $image->withAdditionalOnLoadCode(function ($id) use ($url, $treshold) {
                $js = <<<EOT
                document.getElementById('$id').dataset.mobCompletionCallback = '$url';
                document.getElementById('$id').dataset.mobCompletionThreshold = '$treshold';
                il.MediaObjectsCompletion.init();
EOT;
                return $js;
            });
        }
        return $image;
    }

renderComponent()

ilMediaObjectsPlayerWrapperGUI::renderComponent	(	ilObjMediaObject	$mob,
		int	$tracking_container_ref_id = 0
	)

Definition at line 61 of file class.ilMediaObjectsPlayerWrapperGUI.php.

     : string {
        $comp = $this->getComponent($mob, $tracking_container_ref_id);
        if ($comp) {
            return $this->gui->ui()->renderer()->render($comp);
        }
        return "";
    }

saveCompletion()

ilMediaObjectsPlayerWrapperGUI::saveCompletion ( )

protected

Definition at line 228 of file class.ilMediaObjectsPlayerWrapperGUI.php.

                                       : void
    {
        $ref_id = $this->request->getTrackingRefId();
        $mob_id = $this->request->getTrackingMobId();
        $this->tracking->saveCompletion($mob_id, $ref_id);
    }

References $ref_id.

video()

ilMediaObjectsPlayerWrapperGUI::video	(	ilObjMediaObject	$mob,
		int	$tracking_container_ref_id = 0
	)

Exceptions

ilCtrlException

Definition at line 186 of file class.ilMediaObjectsPlayerWrapperGUI.php.

     : ?\ILIAS\UI\Component\Player\Video {
        $main_tpl = $this->gui->ui()->mainTemplate();
 
        $ctrl = $this->gui->ctrl();
 
        $med = $mob->getMediaItem("Standard");
 
        if (is_null($med) || !$this->media_type->isVideo($med->getFormat())) {
            return null;
        }
 
        $source = $mob->getStandardSrc();
 
        $video = $this->gui->ui()->factory()->player()->video(
            $source,
            ""
        );
 
        if ($tracking_container_ref_id > 0) {
            // @todo: make this a media object general setting
            $mcst_settings = ilMediaCastSettings::_getInstance();
            $treshold = (int) $mcst_settings->getVideoCompletionThreshold();
 
            $main_tpl->addJavaScript("assets/js/MediaObjectsCompletion.js");
            $ctrl->setParameter($this, "mob_tracking_ref_id", $tracking_container_ref_id);
            $ctrl->setParameter($this, "mob_tracking_mob_id", $mob->getId());
            $url = $ctrl->getLinkTarget($this, "saveCompletion");
            $audio = $video->withAdditionalOnLoadCode(function ($id) use ($url, $treshold) {
                $js = <<<EOT
                document.getElementById('$id').dataset.mobCompletionCallback = '$url';
                document.getElementById('$id').dataset.mobCompletionThreshold = '$treshold';
                il.MediaObjectsCompletion.init();
EOT;
                return $js;
            });
        }
        return $video;
    }

Field Documentation

$domain

InternalDomainService ilMediaObjectsPlayerWrapperGUI::$domain

protected

Definition at line 33 of file class.ilMediaObjectsPlayerWrapperGUI.php.

$gui

InternalGUIService ilMediaObjectsPlayerWrapperGUI::$gui

protected

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

$media_type

ILIAS MediaObjects MediaType MediaTypeManager ilMediaObjectsPlayerWrapperGUI::$media_type

protected

Definition at line 31 of file class.ilMediaObjectsPlayerWrapperGUI.php.

$request

ILIAS MediaObjects Player PlayerGUIRequest ilMediaObjectsPlayerWrapperGUI::$request

protected

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

$tracking

ILIAS MediaObjects Tracking TrackingManager ilMediaObjectsPlayerWrapperGUI::$tracking

protected

Definition at line 29 of file class.ilMediaObjectsPlayerWrapperGUI.php.

---

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

• components/ILIAS/MediaObjects/Player/class.ilMediaObjectsPlayerWrapperGUI.php