Collaboration diagram for ILIAS\MediaCast\Presentation\VideoViewGUI:

Public Member Functions
	__construct (\ilObjMediaCast $obj, \ilGlobalTemplateInterface $tpl=null, string $rss_link="")

	setCompletedCallback (string $completed_callback)

	setAutoplayCallback (string $autoplay_callback)

	renderMainColumn ()

	renderToolbar ()

	renderSideColumn ()

	render ()

	show ()

Protected Member Functions
	getAutoplay ()

Protected Attributes
string	$rss_link

ilToolbarGUI	$toolbar

ilGlobalTemplateInterface	$main_tpl

ilObjMediaCast	$media_cast

ilGlobalTemplateInterface	$tpl

ILIAS DI UIServices	$ui

ilLanguage	$lng

ilObjUser	$user

string	$completed_callback = ""

string	$autoplay_callback = ""

VideoSequence	$video_sequence

string	$video_wrapper_id = "mcst_video"

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MediaCast\Presentation\VideoViewGUI::__construct	(	\ilObjMediaCast	$obj,
		\ilGlobalTemplateInterface	$tpl = `null`,
		string	$rss_link = `""`
	)

Definition at line 44 of file class.VideoViewGUI.php.

References $DIC, ILIAS\MediaCast\Presentation\VideoViewGUI\$rss_link, ILIAS\MediaCast\Presentation\VideoViewGUI\$tpl, ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         $this->ui = $DIC->ui();
         $this->rss_link = $rss_link;
         $this->lng = $DIC->language();
         $this->media_cast = $obj;
         $this->tpl = $tpl;
         $this->video_sequence = new VideoSequence($this->media_cast);
         $this->user = $DIC->user();
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->toolbar = $DIC->toolbar();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAutoplay()

ILIAS\MediaCast\Presentation\VideoViewGUI::getAutoplay ( )

protected

Definition at line 151 of file class.VideoViewGUI.php.

References ilObjMediaCast\AUTOPLAY_ACT, ilObjMediaCast\AUTOPLAY_NO, and ILIAS\Repository\user().

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

                                     : bool
     {
         $video_cnt = count($this->video_sequence->getVideos());
         if ($video_cnt <= 1) {
             return false;
         }
         $autoplay = ($this->user->existsPref("mcst_autoplay"))
             ? (bool) $this->user->getPref("mcst_autoplay")
             : ($this->media_cast->getAutoplayMode() == \ilObjMediaCast::AUTOPLAY_ACT);
         if ($this->media_cast->getAutoplayMode() == \ilObjMediaCast::AUTOPLAY_NO) {
             $autoplay = false;
         }
         return $autoplay;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ render()

ILIAS\MediaCast\Presentation\VideoViewGUI::render ( )

Exceptions

Definition at line 293 of file class.VideoViewGUI.php.

References ilMediaPlayerGUI\initJavascript(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderMainColumn(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn().

                             : string
     {
         // this is current only to include the resize mechanism when
         // the main menu is changed, so that the player is resized, too
         \ilMediaPlayerGUI::initJavascript();
         $tpl = new \ilTemplate("tpl.video_cast_layout.html", true, true, "Modules/MediaCast/Presentation");
         $side_column = $this->renderSideColumn();
 
 
         if ($side_column != "") {
             $tpl->setCurrentBlock("with_side_column");
             $tpl->setVariable("SIDE", $side_column);
         } else {
             $tpl->setCurrentBlock("video_only");
         }
         $tpl->setVariable("MAIN", $this->renderMainColumn());
         $tpl->parseCurrentBlock();
         return $tpl->get();
     }

Here is the call graph for this function:

◆ renderMainColumn()

ILIAS\MediaCast\Presentation\VideoViewGUI::renderMainColumn ( )

Exceptions

Definition at line 75 of file class.VideoViewGUI.php.

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\render(), and ILIAS\MediaCast\Presentation\VideoViewGUI\show().

                                       : string
     {
         if (count($this->video_sequence->getVideos()) == 0) {
             return "";
         }
 
         $widget = new VideoWidgetGUI($this->tpl, "mcst_video");
         $widget->setVideo($this->video_sequence->getFirst());
         return $widget->render();
     }

Here is the caller graph for this function:

◆ renderSideColumn()

ILIAS\MediaCast\Presentation\VideoViewGUI::renderSideColumn ( )

Definition at line 166 of file class.VideoViewGUI.php.

References Vendor\Package\$b, $factory, $id, ILIAS\MediaCast\Presentation\VideoViewGUI\$lng, $panel, $preview, ilMediaCastSettings\_getInstance(), ilChangeEvent\_lookupReadEvents(), ILIAS\MediaCast\Presentation\VideoViewGUI\getAutoplay(), ILIAS\Repository\ui(), ILIAS\Repository\user(), and ILIAS\UI\Implementation\Component\withOnLoadCode().

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\render(), and ILIAS\MediaCast\Presentation\VideoViewGUI\show().

                                       : string
     {
         $mcst_settings = \ilMediaCastSettings::_getInstance();
 
         $autoplay = $this->getAutoplay();
 
         $lng = $this->lng;
         $tpl = new \ilTemplate("tpl.video_cast_side.html", true, true, "Modules/MediaCast/Presentation");
 
         $factory = $this->ui->factory();
         $renderer = $this->ui->renderer();
 
         // items
         $items = [];
         $has_items = false;
 
         $panel_items = [];
 
         foreach ($this->video_sequence->getVideos() as $video) {
             $has_items = true;
             $preview = new VideoPreviewGUI(
                 $video->getPreviewPic(),
                 "il.VideoPlaylist.toggleItem('mcst_playlist', '" . $video->getId() . "');",
                 $video->getPlayingTime()
             );
             $completed = false;
 
             $re = \ilChangeEvent::_lookupReadEvents($video->getId(), $this->user->getId());
             if (count($re) > 0) {
                 if ($re[0]["read_count"] > 0) {
                     $completed = true;
                 }
             }
 
             $b = $factory->button()->shy($video->getTitle(), "")->withOnLoadCode(function ($id) use ($video) {
                 return
                     "$(\"#$id\").click(function() { il.VideoPlaylist.toggleItem('mcst_playlist', '" . $video->getId() . "'); return false;});";
             });
 
             $items[] = [
                 "id" => $video->getId(),
                 "resource" => $video->getResource(),
                 "preview" => $preview->render(),
                 "preview_pic" => $video->getPreviewPic(),
                 "title" => $video->getTitle(),
                 "linked_title" => $renderer->renderAsync($b),
                 "mime" => $video->getMime(),
                 "poster" => $video->getPreviewPic(),
                 "description" => nl2br($video->getDescription()),
                 "completed" => $completed,
                 "duration" => $video->getDuration()
             ];
         }
 
         $panel = $factory->panel()->secondary()->listing(
             "Videos",
             []
         );
         $panel_html = $renderer->render($panel);
         $panel_html = str_replace(
             '<div class="panel-body">',
             '<div class="panel-body"><div id="mcst_playlist"></div>',
             $panel_html,
         );
 
         $tpl->setVariable("PANEL", $panel_html);
         // previous items / next items links
         if ($has_items) {
             $tpl->setVariable(
                 "PREV",
                 $renderer->render(
                     $factory->button()->standard($lng->txt("mcst_prev_items"), "")->withOnLoadCode(
                         function ($id) {
                             return
                                 "$(\"#$id\").click(function() { il.VideoPlaylist.previousItems('mcst_playlist'); return false;});";
                         }
                     )
                 )
             );
             $tpl->setVariable(
                 "NEXT",
                 $renderer->render(
                     $factory->button()->standard($lng->txt("mcst_next_items"), "")->withOnLoadCode(
                         function ($id) {
                             return
                                 "$(\"#$id\").click(function() { il.VideoPlaylist.nextItems('mcst_playlist'); return false;});";
                         }
                     )
                 )
             );
 
             $item_tpl = new \ilTemplate("tpl.playlist_item.html", true, true, "Modules/MediaCast/Video");
             $item_tpl->setVariable("TITLE", " ");
             $item_content = str_replace("\n", "", $item_tpl->get());
 
             $item = $factory->item()->standard("#video-title#")
                     ->withLeadImage(
                         $factory->image()->responsive("#img-src#", "#img-alt#")
                     );
 
             $item_content = $renderer->render($item);
             $item_content = str_replace("\n", "", $item_content);
 
             $init_videos = $this->media_cast->getNumberInitialVideos() > 0
                 ? $this->media_cast->getNumberInitialVideos()
                 : 1;
 
             $this->tpl->addOnLoadCode(
                 "il.VideoPlaylist.init('mcst_playlist', 'mcst_video', " . json_encode(
                     $items
                 ) . ", '$item_content', " . ($autoplay ? "true" : "false") . ", " .
                 (int) $init_videos . ", '" . $this->completed_callback . "', '" . $this->autoplay_callback . "', " . ((int) $mcst_settings->getVideoCompletionThreshold()) . ");"
             );
 
             if (count($items) === 1) {
                 return " ";
             }
 
             return $tpl->get();
         }
 
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderToolbar()

ILIAS\MediaCast\Presentation\VideoViewGUI::renderToolbar ( )

Definition at line 86 of file class.VideoViewGUI.php.

References Vendor\Package\$f, $factory, $id, ILIAS\MediaCast\Presentation\VideoViewGUI\$lng, ILIAS\MediaCast\Presentation\VideoViewGUI\$rss_link, ILIAS\MediaCast\Presentation\VideoViewGUI\$toolbar, ilMediaCastSettings\_getInstance(), ilObjMediaCast\AUTOPLAY_NO, ILIAS\MediaCast\Presentation\VideoViewGUI\getAutoplay(), and ILIAS\Repository\ui().

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\show().

                                    : void
     {
         $toolbar = $this->toolbar;
         $lng = $this->lng;
 
         $video_cnt = count($this->video_sequence->getVideos());
 
         $mcst_settings = \ilMediaCastSettings::_getInstance();
 
         $autoplay = $this->getAutoplay();
 
         $factory = $this->ui->factory();
         $renderer = $this->ui->renderer();
 
         if ($video_cnt > 1) {
             $back = $factory->button()->standard(
                 "<span class=\"glyphicon glyphicon-chevron-left \" aria-hidden=\"true\"></span>",
                 ""
             )
                             ->withOnLoadCode(function ($id) {
                                 return
                                     "$(\"#$id\").click(function() { il.VideoWidget.previous(\"" . $this->video_wrapper_id . "\"); return false;});";
                             });
             $next = $factory->button()->standard(
                 "<span class=\"glyphicon glyphicon-chevron-right \" aria-hidden=\"true\"></span>",
                 ""
             )
                             ->withOnLoadCode(function ($id) {
                                 return
                                     "$(\"#$id\").click(function() { il.VideoWidget.next(\"" . $this->video_wrapper_id . "\"); return false;});";
                             });
 
             $toolbar->addComponent($back);
             $toolbar->addComponent($next);
         }
 
         // autoplay
         if ($this->media_cast->getAutoplayMode() !== \ilObjMediaCast::AUTOPLAY_NO && $video_cnt > 1) {
             $toolbar->addSeparator();
             $s = new SignalGenerator();
             $autoplay_on = $s->create();
             $autoplay_off = $s->create();
             $button = $factory->button()->toggle($lng->txt("mcst_autoplay"), $autoplay_on, $autoplay_off, $autoplay);
             $toolbar->addComponent($button);
             $this->main_tpl->addOnLoadCode("
                 $(document).on('" . $autoplay_on . "', function (event, signalData) {
                     il.VideoPlaylist.autoplay('mcst_playlist', true);
                 });
                 $(document).on('" . $autoplay_off . "', function (event, signalData) {
                     il.VideoPlaylist.autoplay('mcst_playlist', false);
                 });");
         }
 
         if ($video_cnt > 0 && $this->rss_link !== "") {
             $f = $this->ui->factory();
             $actions = [
                 $f->link()->standard(
                     $lng->txt("mcst_webfeed"),
                     $this->rss_link
                 )->withOpenInNewViewport(true)
             ];
             $toolbar->addComponent($f->dropdown()->standard($actions));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoplayCallback()

ILIAS\MediaCast\Presentation\VideoViewGUI::setAutoplayCallback ( string $autoplay_callback )

Definition at line 67 of file class.VideoViewGUI.php.

References ILIAS\MediaCast\Presentation\VideoViewGUI\$autoplay_callback.

                                                                   : void
     {
         $this->autoplay_callback = $autoplay_callback;
     }

◆ setCompletedCallback()

ILIAS\MediaCast\Presentation\VideoViewGUI::setCompletedCallback ( string $completed_callback )

Definition at line 62 of file class.VideoViewGUI.php.

References ILIAS\MediaCast\Presentation\VideoViewGUI\$completed_callback.

                                                                     : void
     {
         $this->completed_callback = $completed_callback;
     }

◆ show()

ILIAS\MediaCast\Presentation\VideoViewGUI::show ( )

Definition at line 313 of file class.VideoViewGUI.php.

References ILIAS\MediaCast\Presentation\VideoViewGUI\renderMainColumn(), ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

                           : void
     {
         if (is_object($this->tpl)) {
             $this->renderToolbar();
             $this->tpl->setContent($this->renderMainColumn());
             $this->tpl->setRightContent($this->renderSideColumn());
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $autoplay_callback

string ILIAS\MediaCast\Presentation\VideoViewGUI::$autoplay_callback = ""

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\setAutoplayCallback().

◆ $completed_callback

string ILIAS\MediaCast\Presentation\VideoViewGUI::$completed_callback = ""

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\setCompletedCallback().

◆ $lng

ilLanguage ILIAS\MediaCast\Presentation\VideoViewGUI::$lng

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\renderSideColumn(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

◆ $main_tpl

ilGlobalTemplateInterface ILIAS\MediaCast\Presentation\VideoViewGUI::$main_tpl

protected

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

◆ $media_cast

ilObjMediaCast ILIAS\MediaCast\Presentation\VideoViewGUI::$media_cast

protected

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

◆ $rss_link

string ILIAS\MediaCast\Presentation\VideoViewGUI::$rss_link

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\__construct(), and ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

◆ $toolbar

ilToolbarGUI ILIAS\MediaCast\Presentation\VideoViewGUI::$toolbar

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\renderToolbar().

◆ $tpl

ilGlobalTemplateInterface ILIAS\MediaCast\Presentation\VideoViewGUI::$tpl

protected

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

Referenced by ILIAS\MediaCast\Presentation\VideoViewGUI\__construct().

◆ $ui

ILIAS DI UIServices ILIAS\MediaCast\Presentation\VideoViewGUI::$ui

protected

Definition at line 36 of file class.VideoViewGUI.php.

◆ $user

ilObjUser ILIAS\MediaCast\Presentation\VideoViewGUI::$user

protected

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

◆ $video_sequence

VideoSequence ILIAS\MediaCast\Presentation\VideoViewGUI::$video_sequence

protected

Definition at line 41 of file class.VideoViewGUI.php.

◆ $video_wrapper_id

string ILIAS\MediaCast\Presentation\VideoViewGUI::$video_wrapper_id = "mcst_video"

protected

Definition at line 42 of file class.VideoViewGUI.php.

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

Modules/MediaCast/Presentation/class.VideoViewGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAutoplay()

◆ render()

◆ renderMainColumn()

◆ renderSideColumn()

◆ renderToolbar()

◆ setAutoplayCallback()

◆ setCompletedCallback()

◆ show()

Field Documentation

◆ $autoplay_callback

◆ $completed_callback

◆ $lng

◆ $main_tpl

◆ $media_cast

◆ $rss_link

◆ $toolbar

◆ $tpl

◆ $ui

◆ $user

◆ $video_sequence

◆ $video_wrapper_id