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.

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

       {
         $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();
     }

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.

References $id, $url, ilMediaCastSettings\_getInstance(), ilObject\getId(), ilObjMediaObject\getMediaItem(), ilObjMediaObject\getStandardSrc(), ILIAS\Repository\int(), and null.

Referenced by getComponent().

      : ?\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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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.

References audio(), ilObjMediaObject\getMediaItem(), image(), null, and video().

Referenced by renderComponent().

                                            : 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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ image()

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

Exceptions

ilCtrlException

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

References $id, $url, ilMediaCastSettings\_getInstance(), ilObject\getId(), ilObjMediaObject\getMediaItem(), ilObjMediaObject\getStandardSrc(), ilObject\getTitle(), ILIAS\Repository\int(), and null.

Referenced by getComponent().

      : ?\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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderComponent()

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

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

References getComponent().

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

Here is the call graph for this function:

◆ saveCompletion()

ilMediaObjectsPlayerWrapperGUI::saveCompletion ( )

protected

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

References $ref_id.

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

◆ video()

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

Exceptions

ilCtrlException

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

References $id, $url, ilMediaCastSettings\_getInstance(), ilObject\getId(), ilObjMediaObject\getMediaItem(), ilObjMediaObject\getStandardSrc(), ILIAS\Repository\int(), and null.

Referenced by getComponent().

      : ?\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;
     }