User interface class for interactive images. More...

Inheritance diagram for ilPCInteractiveImageGUI:

Collaboration diagram for ilPCInteractiveImageGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")

	executeCommand ()

	getTabs (bool $a_create=false, bool $a_change_obj_ref=false)
	Add tabs to ilTabsGUI object. More...

	insert (string $a_post_cmd="edpost", string $a_submit_cmd="", bool $a_input_error=false)
	Insert new media object form. More...

	edit ()

	editBaseImage ()

	initForm (string $a_mode="edit")

	update ()
	Update (base image) More...

	centerAlign ()
	Align media object to center. More...

	leftAlign ()
	align media object to left More...

	rightAlign ()
	align media object to right More...

	leftFloatAlign ()
	align media object to left, floating text More...

	rightFloatAlign ()
	align media object to right, floating text More...

	getImportFormAdapter ()

	handleUploadResult (FileUpload $upload, UploadResult $result)

	editor ()

	getOverlayUploadFormAdapter (?array $path=null)

	handleOverlayUpload (FileUpload $upload, UploadResult $result)

	getPopupFormAdapter ()

	getBackgroundPropertiesFormAdapter (?array $path=null)

	handleBackgroundUpload (FileUpload $upload, UploadResult $result)

Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")

	setContentObject (ilPageContent $a_val)

	getContentObject ()

	setPage (ilPageObject $a_val)

	getPage ()

	setPageConfig (ilPageConfig $a_val)

	getPageConfig ()

	setStyleId (int $a_styleid)

	getStyleId ()

	getStyle ()

	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...

	setCharacteristics (array $a_chars)

	getCharacteristics ()

	getHierId ()

	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...

	delete ()

	displayValidationError ()

	cancelCreate ()
	cancel creating page content More...

	cancelUpdate ()
	cancel update More...

	cancel ()
	Cancel. More...

	deactivate ()
	gui function set enabled if is not enabled and vice versa More...

	cut ()
	Cut single element. More...

	copy ()
	Copy single element. More...

	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Member Functions
	forwardFormToUploadHandler ()

	initInteractiveImageEditor ()

Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")

	getParentReturn (string $hier_id="")

	updateAndReturn ()

	setCurrentTextLang (string $lang_key)

	getCurrentTextLang ()

	setEditorToolContext ()

	initEditor ()

	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Protected Attributes
ILIAS COPage PC InteractiveImage IIMManager	$iim_manager

ILIAS COPage PC InteractiveImage GUIService	$iim_gui

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui

ILIAS COPage InternalGUIService	$gui

EditSessionRepository	$edit_repo

string	$pc_id = ""

array	$chars

ilObjStyleSheet	$style = null

LOMServices	$lom_services

ilLogger	$log

int	$styleid = 0

EditGUIRequest	$request

string	$sub_command = ""

int	$requested_ref_id = 0

ILIAS GlobalScreen ScreenContext ContextServices	$tool_context

Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

ilCtrl	$ctrl

ilPageObject	$pg_obj

string	$hier_id = ""

DOMDocument	$dom

array bool null	$updated = null

string	$target_script = ""

string	$return_location = ""

ilPageConfig	$page_config = null

Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"

Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

User interface class for interactive images.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_Calls ilPCInteractiveImageGUI: ilPCIIMTriggerEditorGUI, ilRepoStandardUploadHandlerGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPCInteractiveImageGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = `""`
	)

Reimplemented from ilPageContentGUI.

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

      {
        global $DIC;
 
        $this->tpl = $DIC["tpl"];
        $this->lng = $DIC->language();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->iim_gui = $DIC->copage()->internal()->gui()->pc()->interactiveImage();
        $this->iim_manager = $DIC->copage()->internal()->domain()->pc()->interactiveImage();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

Member Function Documentation

◆ centerAlign()

ilPCInteractiveImageGUI::centerAlign ( )

Align media object to center.

Definition at line 268 of file class.ilPCInteractiveImageGUI.php.

                                 : void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Center");
        $this->updateAndReturn();
    }

◆ edit()

ilPCInteractiveImageGUI::edit ( )

Definition at line 145 of file class.ilPCInteractiveImageGUI.php.

                          : void
    {
        $ilCtrl = $this->ctrl;
        $ilCtrl->redirect($this, "editor");
    }

◆ editBaseImage()

ilPCInteractiveImageGUI::editBaseImage ( )

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

                                   : void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
        $ilTabs->activateTab("edit_base_image");
        $form = $this->initForm();
        $tpl->setContent($form->getHTML());
    }

◆ editor()

ilPCInteractiveImageGUI::editor ( )

Definition at line 372 of file class.ilPCInteractiveImageGUI.php.

                            : void
    {
        $ilTabs = $this->tabs;
        $ilTabs->activateTab("editor");
        $this->tpl->addCss(ilObjStyleSheet::getBaseContentStylePath());
        $this->tpl->setContent($this->iim_gui->editorInit()->getInitHtml());
        $this->initInteractiveImageEditor();
    }

References ilObjStyleSheet\getBaseContentStylePath().

Here is the call graph for this function:

◆ executeCommand()

ilPCInteractiveImageGUI::executeCommand ( )

Definition at line 56 of file class.ilPCInteractiveImageGUI.php.

                                    : void
    {
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;
 
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);
 
        // get current command
        $cmd = $this->ctrl->getCmd();
 
        if (is_object($this->content_obj)) {
            $tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_mob.svg"));
            $this->getTabs();
        }
 
        switch ($next_class) {
            case strtolower(ilRepoStandardUploadHandlerGUI::class):
                $this->forwardFormToUploadHandler();
                break;
 
            default:
                $this->$cmd();
                break;
        }
    }

References $tabs, ilPageContentGUI\$tpl, ILIAS\Repository\ctrl(), forwardFormToUploadHandler(), ilUtil\getImagePath(), getTabs(), and ILIAS\UICore\GlobalTemplate\setTitleIcon().

Here is the call graph for this function:

◆ forwardFormToUploadHandler()

ilPCInteractiveImageGUI::forwardFormToUploadHandler ( )

protected

Definition at line 83 of file class.ilPCInteractiveImageGUI.php.

                                                   : void
    {
        switch ($this->request->getString("mode")) {
            case "overlayUpload":
                $form = $this->getOverlayUploadFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("overlay_file");
                break;
 
            case "backgroundUpdate":
                $form = $this->getBackgroundPropertiesFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("input_file");
                break;
 
            default:
                $form = $this->getImportFormAdapter();
                $gui = $form->getRepoStandardUploadHandlerGUI("input_file");
                break;
        }
        $this->ctrl->forwardCommand($gui);
    }

References ilPageContentGUI\$gui, ILIAS\Repository\ctrl(), getBackgroundPropertiesFormAdapter(), getImportFormAdapter(), and getOverlayUploadFormAdapter().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBackgroundPropertiesFormAdapter()

ilPCInteractiveImageGUI::getBackgroundPropertiesFormAdapter ( ?array $path = null )

Definition at line 431 of file class.ilPCInteractiveImageGUI.php.

                                                                           : \ILIAS\Repository\Form\FormAdapterGUI
    {
        if (is_null($path)) {
            $path = [self::class];
        }
 
        $f = $this->gui->form($path, "#")
                       ->async()
                       ->file(
                           "input_file",
                           $this->lng->txt("file"),
                           \Closure::fromCallable([$this, 'handleBackgroundUpload']),
                           "mob_id",
                           "",
                           1,
                           ["image/png", "image/jpeg", "image/gif"],
                           $path,
                           "copg"
                       )->text(
                           "caption",
                           $this->lng->txt("cont_caption")
                       );
        return $f;
    }

References Vendor\Package\$f, $path, and ILIAS\Repository\lng().

Referenced by forwardFormToUploadHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImportFormAdapter()

ilPCInteractiveImageGUI::getImportFormAdapter ( )

Definition at line 345 of file class.ilPCInteractiveImageGUI.php.

                                          : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $this->ctrl->setParameter($this, "cname", "InteractiveImage");
        $form = $this->gui->form([self::class], "#")
                          ->async()
            ->section("f", $this->lng->txt("cont_ed_insert_iim"))
                          ->file(
                              "input_file",
                              $this->lng->txt("file"),
                              \Closure::fromCallable([$this, 'handleUploadResult']),
                              "mob_id",
                              "",
                              1,
                              [],
                              [self::class],
                              "copg"
                          )->required();
        return $form;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by forwardFormToUploadHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOverlayUploadFormAdapter()

ilPCInteractiveImageGUI::getOverlayUploadFormAdapter ( ?array $path = null )

Definition at line 387 of file class.ilPCInteractiveImageGUI.php.

                                                                    : \ILIAS\Repository\Form\FormAdapterGUI
    {
        if (is_null($path)) {
            $path = [self::class];
        }
 
        $f = $this->gui->form($path, "#")
                       ->async()
                       ->file(
                           "overlay_file",
                           $this->lng->txt("file"),
                           \Closure::fromCallable([$this, 'handleOverlayUpload']),
                           "mob_id",
                           "",
                           1,
                           ["image/png", "image/jpeg", "image/gif"],
                           $path,
                           "copg"
                       );
        return $f;
    }

References Vendor\Package\$f, $path, and ILIAS\Repository\lng().

Referenced by forwardFormToUploadHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPopupFormAdapter()

ilPCInteractiveImageGUI::getPopupFormAdapter ( )

Definition at line 421 of file class.ilPCInteractiveImageGUI.php.

                                         : \ILIAS\Repository\Form\FormAdapterGUI
    {
        $f = $this->gui->form(null, "#")
                       ->text(
                           "title",
                           $this->lng->txt("title")
                       );
        return $f;
    }

References Vendor\Package\$f, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTabs()

ilPCInteractiveImageGUI::getTabs	(	bool	$a_create = `false`,
		bool	$a_change_obj_ref = `false`
	)

Add tabs to ilTabsGUI object.

Definition at line 107 of file class.ilPCInteractiveImageGUI.php.

     : void {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;
 
        if (!$a_create) {
            $ilTabs->setBackTarget(
                $lng->txt("pg"),
                (string) $ilCtrl->getParentReturn($this)
            );
        }
    }

References ilPageContentGUI\$lng, and ilLanguage\txt().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleBackgroundUpload()

ilPCInteractiveImageGUI::handleBackgroundUpload	(	FileUpload	$upload,
		UploadResult	$result
	)

Definition at line 457 of file class.ilPCInteractiveImageGUI.php.

     : BasicHandlerResult {
        $this->log->debug(">>>");
        $this->log->debug("Start upload");
        $this->log->debug($this->content_obj->getMediaObject()->getId());
        return $this->iim_manager->handleUploadResult(
            $upload,
            $result,
            $this->content_obj->getMediaObject()
        );
    }

◆ handleOverlayUpload()

ilPCInteractiveImageGUI::handleOverlayUpload	(	FileUpload	$upload,
		UploadResult	$result
	)

Definition at line 410 of file class.ilPCInteractiveImageGUI.php.

     : BasicHandlerResult {
        return $this->iim_manager->handleOverlayUpload(
            $this->content_obj->getMediaObject(),
            $upload,
            $result
        );
    }

◆ handleUploadResult()

ilPCInteractiveImageGUI::handleUploadResult	(	FileUpload	$upload,
		UploadResult	$result
	)

Definition at line 365 of file class.ilPCInteractiveImageGUI.php.

     : BasicHandlerResult {
        return $this->iim_manager->handleUploadResult($upload, $result);
    }

◆ initForm()

ilPCInteractiveImageGUI::initForm ( string $a_mode = "edit" )

Definition at line 161 of file class.ilPCInteractiveImageGUI.php.

                                                     : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ti = null;
 
        $form = new ilPropertyFormGUI();
 
        // image file
        $fi = new ilImageFileInputGUI($lng->txt("cont_file"), "image_file");
        $fi->setAllowDeletion(false);
        if ($a_mode == "edit") {
            $fi->setImage($this->content_obj->getBaseThumbnailTarget());
        } else {
            $fi->setRequired(true);
        }
        $form->addItem($fi);
 
        if ($a_mode == "edit") {
            // caption
            $ti = new ilTextInputGUI($this->lng->txt("cont_caption"), "caption");
            $ti->setMaxLength(200);
            $ti->setSize(50);
            $form->addItem($ti);
        }
 
        // save and cancel commands
        if ($a_mode == "create") {
            $form->setTitle($lng->txt("cont_ed_insert_iim"));
            $form->addCommandButton("create_iim", $lng->txt("save"));
            $form->addCommandButton("cancelCreate", $lng->txt("cancel"));
        } else {
            // get caption
            $std_alias_item = new ilMediaAliasItem(
                $this->content_obj->getDomDoc(),
                $this->getHierId(),
                "Standard",
                $this->content_obj->getPCId(),
                "InteractiveImage"
            );
            $ti->setValue($std_alias_item->getCaption());
 
            $form->setTitle($lng->txt("cont_edit_base_image"));
            $form->addCommandButton("update", $lng->txt("save"));
        }
 
        $form->setFormAction($ilCtrl->getFormAction($this));
 
        return $form;
    }

References $lng, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ initInteractiveImageEditor()

ilPCInteractiveImageGUI::initInteractiveImageEditor ( )

protected

Definition at line 381 of file class.ilPCInteractiveImageGUI.php.

                                                   : void
    {
        $this->setEditorToolContext();
        $this->iim_gui->editorInit()->initUI($this->tpl);
    }

◆ insert()

ilPCInteractiveImageGUI::insert	(	string	$a_post_cmd = `"edpost"`,
		string	$a_submit_cmd = `""`,
		bool	$a_input_error = `false`
	)

Insert new media object form.

Definition at line 126 of file class.ilPCInteractiveImageGUI.php.

     : void {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_iim_create_info"));
 
        $form = $this->initForm("create");
        $form->setFormAction($ilCtrl->getFormAction($this));
 
        $this->displayValidationError();
 
        $tpl->setContent($form->getHTML());
    }

◆ leftAlign()

ilPCInteractiveImageGUI::leftAlign ( )

align media object to left

Definition at line 284 of file class.ilPCInteractiveImageGUI.php.

                               : void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->dom,
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Left");
        $this->updateAndReturn();
    }

◆ leftFloatAlign()

ilPCInteractiveImageGUI::leftFloatAlign ( )

align media object to left, floating text

Definition at line 316 of file class.ilPCInteractiveImageGUI.php.

                                    : void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("LeftFloat");
        $this->updateAndReturn();
    }

◆ rightAlign()

ilPCInteractiveImageGUI::rightAlign ( )

align media object to right

Definition at line 300 of file class.ilPCInteractiveImageGUI.php.

                                : void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("Right");
        $this->updateAndReturn();
    }

◆ rightFloatAlign()

ilPCInteractiveImageGUI::rightFloatAlign ( )

align media object to right, floating text

Definition at line 332 of file class.ilPCInteractiveImageGUI.php.

                                     : void
    {
        $std_alias_item = new ilMediaAliasItem(
            $this->content_obj->getDomDoc(),
            $this->getHierId(),
            "Standard",
            $this->content_obj->getPCId(),
            "InteractiveImage"
        );
        $std_alias_item->setHorizontalAlign("RightFloat");
        $this->updateAndReturn();
    }

◆ update()

ilPCInteractiveImageGUI::update ( )

Update (base image)

Definition at line 216 of file class.ilPCInteractiveImageGUI.php.

                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $form = $this->initForm("edit");
        if ($form->checkInput()) {
            $mob = $this->content_obj->getMediaObject();
            $mob_dir = ilObjMediaObject::_getDirectory($mob->getId());
            $std_item = $mob->getMediaItem("Standard");
            $location = $_FILES['image_file']['name'];
 
            if ($location != "" && is_file($_FILES['image_file']['tmp_name'])) {
                $file = $mob_dir . "/" . $_FILES['image_file']['name'];
                ilFileUtils::moveUploadedFile(
                    $_FILES['image_file']['tmp_name'],
                    $_FILES['image_file']['name'],
                    $file
                );
 
                // get mime type
                $format = ilObjMediaObject::getMimeType($file);
                $location = $_FILES['image_file']['name'];
                $std_item->setFormat($format);
                $std_item->setLocation($location);
                $std_item->setLocationType("LocalFile");
                $mob->setDescription($format);
                $mob->update();
            }
 
            // set caption
            $std_alias_item = new ilMediaAliasItem(
                $this->content_obj->getDomDoc(),
                $this->getHierId(),
                "Standard",
                $this->content_obj->getPCId(),
                "InteractiveImage"
            );
            $std_alias_item->setCaption(
                $form->getInput("caption")
            );
            $this->edit_repo->setPageError($this->pg_obj->update());
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
 
        $ilCtrl->redirectByClass("ilpcinteractiveimagegui", "editBaseImage");
    }

References $lng, $location, ilObjMediaObject\_getDirectory(), ilObjMediaObject\getMimeType(), and ilFileUtils\moveUploadedFile().

Here is the call graph for this function:

Field Documentation

◆ $iim_gui

ILIAS COPage PC InteractiveImage GUIService ilPCInteractiveImageGUI::$iim_gui

protected

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

◆ $iim_manager

ILIAS COPage PC InteractiveImage IIMManager ilPCInteractiveImageGUI::$iim_manager

protected

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

◆ $tabs

ilTabsGUI ilPCInteractiveImageGUI::$tabs

protected

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

Referenced by executeCommand().

◆ $toolbar

ilToolbarGUI ilPCInteractiveImageGUI::$toolbar

protected

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

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

components/ILIAS/COPage/PC/InteractiveImage/class.ilPCInteractiveImageGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ centerAlign()

◆ edit()

◆ editBaseImage()

◆ editor()

◆ executeCommand()

◆ forwardFormToUploadHandler()

◆ getBackgroundPropertiesFormAdapter()

◆ getImportFormAdapter()

◆ getOverlayUploadFormAdapter()

◆ getPopupFormAdapter()

◆ getTabs()

◆ handleBackgroundUpload()

◆ handleOverlayUpload()

◆ handleUploadResult()

◆ initForm()

◆ initInteractiveImageEditor()

◆ insert()

◆ leftAlign()

◆ leftFloatAlign()

◆ rightAlign()

◆ rightFloatAlign()

◆ update()

Field Documentation

◆ $iim_gui

◆ $iim_manager

◆ $tabs

◆ $toolbar