McstImageGalleryGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for McstImageGalleryGUI:

Public Member Functions
	__construct (\ilObjMediaCast $obj, $tpl=null, string $rss_link="")
	executeCommand ()
	getHTML ()
	setCompletedCallback (string $completed_callback)

Protected Member Functions
	downloadAll ()

Protected Attributes
ILIAS MediaObjects MediaType MediaTypeManager	$media_types
ILIAS MediaCast InternalGUIService	$gui
ILIAS MediaCast MediaCastManager	$mc_manager
ILIAS MediaCast InternalDomainService	$domain
string	$completed_callback
string	$rss_link
ilObjMediaCast	$media_cast
ilGlobalTemplateInterface	$tpl
ILIAS DI UIServices	$ui
ilLanguage	$lng
ilObjUser	$user
ilCtrl	$ctrl
ilToolbarGUI	$toolbar
ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Image gallery GUI for mediacasts

Author

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

Definition at line 24 of file class.McstImageGalleryGUI.php.

Constructor & Destructor Documentation

__construct()

McstImageGalleryGUI::__construct	(	\ilObjMediaCast	$obj,
			$tpl = null,
		string	$rss_link = ""
	)

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

References $DIC, $rss_link, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), 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->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->media_types = $DIC->mediaObjects()->internal()->domain()->mediaType();
        $this->mc_manager = $DIC->mediaCast()->internal()->domain()->mediaCast($this->media_cast);
        $this->gui = $DIC->mediaCast()->internal()->gui();
        $this->domain = $DIC->mediaCast()->internal()->domain();
    }

Here is the call graph for this function:

Member Function Documentation

downloadAll()

McstImageGalleryGUI::downloadAll ( )

protected

Definition at line 240 of file class.McstImageGalleryGUI.php.

References $user, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), and ILIAS\Repository\lng().

                                    : void
    {
        if (!$this->media_cast->getDownloadable() ||
            !$this->access->checkAccess('read', '', $this->media_cast->getRefId())) {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('permission_denied'),
                true
            );
            $this->ctrl->redirectByClass(ilObjMediaCastGUI::class);
        }

        $user = $this->user;
        $download_task = new \ILIAS\MediaCast\BackgroundTasks\DownloadAllBackgroundTask(
            (int) $user->getId(),
            (int) $this->media_cast->getRefId(),
            (int) $this->media_cast->getId()
        );

        if ($download_task->run()) {
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('mcst_download_started_bg'),
                true
            );
        }

        $this->ctrl->redirectByClass("ilobjmediacastgui", "showContent");
    }

Here is the call graph for this function:

executeCommand()

McstImageGalleryGUI::executeCommand

(

)

Definition at line 63 of file class.McstImageGalleryGUI.php.

References $ctrl, and ilCtrl\getNextClass().

                                    : void
    {
        $ctrl = $this->ctrl;

        $next_class = $ctrl->getNextClass($this);
        $cmd = $ctrl->getCmd();

        switch ($next_class) {
            default:
                if (in_array($cmd, array("downloadAll"))) {
                    $this->$cmd();
                }
        }
    }

Here is the call graph for this function:

getHTML()

McstImageGalleryGUI::getHTML

(

)

Definition at line 78 of file class.McstImageGalleryGUI.php.

References Vendor\Package\$b, $ctrl, Vendor\Package\$f, $id, $lng, $rss_link, $toolbar, ilObjMediaObject\_getURL(), ILIAS\Repository\int(), ilToolbarGUI\setFormAction(), ilWACSignedPath\signFile(), and ILIAS\Repository\ui().

                             : string
    {
        $f = $this->ui->factory();
        $renderer = $this->ui->renderer();
        $ctrl = $this->ctrl;
        $lng = $this->lng;
        $toolbar = $this->toolbar;

        // toolbar
        $toolbar->setFormAction($ctrl->getFormAction($this));
        if ($this->media_cast->getDownloadable()) {
            $toolbar->addFormButton($lng->txt("mcst_download_all"), "downloadAll");
        }

        if ($this->rss_link !== "") {
            $b = $f->link()->standard(
                $lng->txt("mcst_webfeed"),
                $this->rss_link
            )->withOpenInNewViewport(true);
            $toolbar->addComponent($b);
        }

        // cards and modals
        $cards = [];
        $modals = [];

        $pages = [];

        $lp_collection_mode = $this->domain->learningProgress($this->media_cast)->isCollectionMode();

        $mob_modals = [];
        foreach ($this->media_cast->getSortedItemsArray() as $item) {
            $mob = new \ilObjMediaObject($item["mob_id"]);
            $med = $mob->getMediaItem("Standard");
            if (!in_array($med->getFormat(), iterator_to_array($this->media_types->getAllowedImageMimeTypes()), true)) {
                continue;
            }

            if (strcasecmp("Reference", $med->getLocationType()) == 0) {
                $resource = $med->getLocation();
            } else {
                $path_to_file = \ilObjMediaObject::_getURL($mob->getId()) . "/" . $med->getLocation();
                $resource = ilWACSignedPath::signFile($path_to_file);
            }

            $image = $f->image()->responsive(
                $resource,
                $mob->getTitle()
            );

            $pages[] = $f->modal()->lightboxImagePage($image, $mob->getTitle());
            if ($lp_collection_mode) {
                $mob_modals[$mob->getId()] = $f->modal()->lightbox($pages);
                $pages = [];
            }
        }
        $main_modal = null;
        if (!$lp_collection_mode) {
            $main_modal = $f->modal()->lightbox($pages);
        }

        $cnt = 0;
        foreach ($this->media_cast->getSortedItemsArray() as $item) {
            $mob = new \ilObjMediaObject($item["mob_id"]);
            $med = $mob->getMediaItem("Standard");

            if (!in_array($med->getFormat(), iterator_to_array($this->media_types->getAllowedImageMimeTypes()), true)) {
                continue;
            }

            if (strcasecmp("Reference", $med->getLocationType()) == 0) {
                $resource = $med->getLocation();
            } else {
                $path_to_file = \ilObjMediaObject::_getURL($mob->getId()) . "/" . $med->getLocation();
                $resource = ilWACSignedPath::signFile($path_to_file);
            }
            $preview_resource = $resource;
            if ($mob->getVideoPreviewPic() != "") {
                $preview_resource = ilWACSignedPath::signFile($mob->getVideoPreviewPic());
            }


            $preview_image = $f->image()->responsive(
                $preview_resource,
                $mob->getTitle()
            );

            $image = $f->image()->responsive(
                $resource,
                $mob->getTitle()
            );

            if (!$lp_collection_mode) {
                $modal = $main_modal;
            } else {
                $modal = $mob_modals[$mob->getId()];
            }

            $card_image = $preview_image->withAction($modal->getShowSignal());
            $slide_to = "";
            $completed_cb = "";
            if (!$lp_collection_mode) {
                $slide_to = "document.querySelector('.modal-body .carousel [data-slide-to=\"" . $cnt . "\"]').click();";
            } else {
                $completed_cb = $this->completed_callback . '&mob_id=' . $mob->getId();
                $completed_cb = "$.ajax({type:'GET', url: '$completed_cb'});";
            }

            $card_image = $card_image->withAdditionalOnLoadCode(function ($id) use ($slide_to, $completed_cb) {
                return "$('#$id').click(function(e) { $slide_to $completed_cb });";
            });
            if (!$lp_collection_mode) {
                $cnt++;
            }

            $sections = ($mob->getDescription())
                ? [$f->legacy($mob->getDescription())]
                : [];

            if ($this->media_cast->getDownloadable()) {
                $ctrl->setParameterByClass("ilobjmediacastgui", "item_id", $item["id"]);
                $ctrl->setParameterByClass("ilobjmediacastgui", "purpose", "Standard");
                $download = $ctrl->getLinkTargetByClass("ilobjmediacastgui", "downloadItem");
                $sections[] = $f->button()->standard($lng->txt("download"), $download);
            }

            // comments
            if ($this->mc_manager->commentsActive()) {
                $comments_gui = $this->gui->comments()->commentGUI(
                    $this->media_cast->getRefId(),
                    (int) $item["id"]
                );
                $sections[] = $f->legacy($comments_gui->getGlyph());
            }

            //$title_button = $f->button()->shy($mob->getTitle(), $modal->getShowSignal());
            $title = $mob->getTitle();

            $card = $f->card()->standard(
                $title,
                $card_image
            )->withSections(
                $sections
            )->withTitleAction($modal->getShowSignal());

            $cards[] = $card;
            $modals[] = $modal;
        }

        $deck = $f->deck($cards);

        if (count($pages) === 0 && count($mob_modals) === 0) {
            return "";
        }
        if (!$lp_collection_mode) {
            $modals = [$main_modal];
        } else {
            $modals = $mob_modals;
        }
        return "<div id='il-mcst-img-gallery'>" . $renderer->render(array_merge([$deck], $modals)) . "</div>";
    }

Here is the call graph for this function:

setCompletedCallback()

McstImageGalleryGUI::setCompletedCallback

(

string

$completed_callback

)

Definition at line 270 of file class.McstImageGalleryGUI.php.

References $completed_callback.

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

Field Documentation

$access

ilAccessHandler McstImageGalleryGUI::$access

protected

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

$completed_callback

string McstImageGalleryGUI::$completed_callback

protected

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

Referenced by setCompletedCallback().

$ctrl

ilCtrl McstImageGalleryGUI::$ctrl

protected

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

Referenced by executeCommand(), and getHTML().

$domain

ILIAS MediaCast InternalDomainService McstImageGalleryGUI::$domain

protected

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

$gui

ILIAS MediaCast InternalGUIService McstImageGalleryGUI::$gui

protected

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

$lng

ilLanguage McstImageGalleryGUI::$lng

protected

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

Referenced by getHTML().

$mc_manager

ILIAS MediaCast MediaCastManager McstImageGalleryGUI::$mc_manager

protected

Definition at line 28 of file class.McstImageGalleryGUI.php.

$media_cast

ilObjMediaCast McstImageGalleryGUI::$media_cast

protected

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

$media_types

ILIAS MediaObjects MediaType MediaTypeManager McstImageGalleryGUI::$media_types

protected

Definition at line 26 of file class.McstImageGalleryGUI.php.

$rss_link

string McstImageGalleryGUI::$rss_link

protected

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

Referenced by __construct(), and getHTML().

$toolbar

ilToolbarGUI McstImageGalleryGUI::$toolbar

protected

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

Referenced by getHTML().

$tpl

ilGlobalTemplateInterface McstImageGalleryGUI::$tpl

protected

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

Referenced by __construct().

$ui

ILIAS DI UIServices McstImageGalleryGUI::$ui

protected

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

$user

ilObjUser McstImageGalleryGUI::$user

protected

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

Referenced by downloadAll().

---

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

• Modules/MediaCast/Presentation/class.McstImageGalleryGUI.php