ilPCInteractiveImageGUI Class Reference

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="create_mob", bool $a_input_error=false)
	Insert new media object form. More...
	edit ()
	editBaseImage ()
	initForm (string $a_mode="edit")
	create ()
	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...
	listOverlayImages ()
	addOverlayImages (ilPropertyFormGUI $a_form=null)
	initAddOverlaysForm ()
	uploadOverlayImages ()
	confirmDeleteOverlays ()
	deleteOverlays ()
	addPopup ()
	savePopups ()
	confirmPopupDeletion ()
	deletePopups ()
	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
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
	$updated
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 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 = ""
	)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

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

Here is the call graph for this function:

Member Function Documentation

addOverlayImages()

ilPCInteractiveImageGUI::addOverlayImages

(

ilPropertyFormGUI

$a_form = null

)

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

References ilPageContentGUI\$tpl, initAddOverlaysForm(), and ilGlobalTemplateInterface\setContent().

Referenced by uploadOverlayImages().

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

        if ($a_form) {
            $form = $a_form;
        } else {
            $form = $this->initAddOverlaysForm();
        }

        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addPopup()

ilPCInteractiveImageGUI::addPopup

(

)

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

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

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

        $this->content_obj->addContentPopup();
        $this->pg_obj->update();
        $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "listContentPopups");
    }

Here is the call graph for this function:

centerAlign()

ilPCInteractiveImageGUI::centerAlign

(

)

Align media object to center.

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

References ilPageContentGUI\getHierId(), ilMediaAliasItem\setHorizontalAlign(), and ilPageContentGUI\updateAndReturn().

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

Here is the call graph for this function:

confirmDeleteOverlays()

ilPCInteractiveImageGUI::confirmDeleteOverlays

(

)

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

References ilPageContentGUI\$ctrl, Vendor\Package\$d, ilPageContentGUI\$lng, $tabs, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), ilTabsGUI\setTabActive(), and ilLanguage\txt().

                                           : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilTabs = $this->tabs;

        $ilTabs->setTabActive("list_overlays");

        $files = $this->request->getStringArray("file");
        if (count($files) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listOverlayImages");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_really_delete_overlays"));
            $cgui->setCancel($lng->txt("cancel"), "listOverlayImages");
            $cgui->setConfirm($lng->txt("delete"), "deleteOverlays");

            foreach ($files as $i => $d) {
                $cgui->addItem("file[]", $i, $i);
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

confirmPopupDeletion()

ilPCInteractiveImageGUI::confirmPopupDeletion

(

)

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

References ilPageContentGUI\$ctrl, Vendor\Package\$d, ilPageContentGUI\$lng, $tabs, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), ilTabsGUI\setTabActive(), and ilLanguage\txt().

                                          : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilTabs = $this->tabs;

        $ilTabs->setTabActive("content_popups");

        $tids = $this->request->getStringArray("tid");
        $titles = $this->request->getStringArray("title");

        if (count($tids) == 0) {
            $this->tpl->setOnScreenMessage('failure', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listContentPopups");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("cont_really_delete_popups"));
            $cgui->setCancel($lng->txt("cancel"), "listContentPopups");
            $cgui->setConfirm($lng->txt("delete"), "deletePopups");

            foreach ($tids as $i => $d) {
                $cgui->addItem("tid[]", $i, $titles[$i]);
            }

            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

create()

ilPCInteractiveImageGUI::create

(

)

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

References ilPageContentGUI\$ctrl, Vendor\Package\$e, ilPageContentGUI\$lng, $location, ilPageContentGUI\$tpl, ilObjMediaObject\_getDirectory(), ILIAS\Repository\ctrl(), ilPageContentGUI\displayValidationError(), ilObjMediaObject\getMimeType(), ilPageContentGUI\getPage(), initForm(), insert(), ILIAS\Repository\lng(), ilFileUtils\moveUploadedFile(), ilFileUtils\renameExecutables(), ilGlobalTemplateInterface\setContent(), ilPageContentGUI\setHierId(), and ilLanguage\txt().

                            : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $form = $this->initForm("create");
        if (!$form->checkInput()) {
            $this->displayValidationError();
            $form->setValuesByPost();
            $tpl->setContent($form->getHTML());
            return;
        }

        $this->content_obj = new ilPCInteractiveImage($this->getPage());
        $this->content_obj->createMediaObject();
        $media_obj = $this->content_obj->getMediaObject();
        $media_obj->setTitle($_FILES['image_file']['name']);
        $media_obj->create();
        $mob_dir = ilObjMediaObject::_getDirectory($media_obj->getId());
        //              $media_obj->setStandardType("File");
        $media_obj->createDirectory();
        $media_item = new ilMediaItem();
        $media_obj->addMediaItem($media_item);
        $media_item->setPurpose("Standard");

        $file = $mob_dir . "/" . $_FILES['image_file']['name'];
        try {
            ilFileUtils::moveUploadedFile(
                $_FILES['image_file']['tmp_name'],
                $_FILES['image_file']['name'],
                $file
            );
        } catch (ilException $e) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_is_infected"), true);
            return;
        }
        // get mime type
        $format = ilObjMediaObject::getMimeType($file);
        $location = $_FILES['image_file']['name'];

        // set real meta and object data
        $media_item->setFormat($format);
        $media_item->setLocation($location);
        $media_item->setLocationType("LocalFile");

        ilFileUtils::renameExecutables($mob_dir);
        $media_obj->update();

        $this->content_obj->createAlias($this->pg_obj, $this->hier_id, $this->pc_id);
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            $this->pg_obj->stripHierIDs();
            $this->pg_obj->addHierIDs();
            $ilCtrl->setParameter($this, "hier_id", $this->content_obj->readHierId());
            $ilCtrl->setParameter($this, "pc_id", $this->content_obj->readPCId());
            $this->content_obj->setHierId($this->content_obj->readHierId());
            $this->setHierId($this->content_obj->readHierId());
            $this->content_obj->setPcId($this->content_obj->readPCId());
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_saved_interactive_image"), true);
            $this->ctrl->redirectByClass("ilpcinteractiveimagegui", "edit");

            //$this->ctrl->returnToParent($this, "jump".$this->hier_id);
        } else {
            $this->insert();
        }
    }

Here is the call graph for this function:

deleteOverlays()

ilPCInteractiveImageGUI::deleteOverlays

(

)

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

References ilPageContentGUI\$content_obj, ilPageContentGUI\$ctrl, Vendor\Package\$f, ilPageContentGUI\$lng, $tabs, $toolbar, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), ilUtil\stripSlashes(), and ilLanguage\txt().

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

        $files = $this->request->getStringArray("file");
        if (count($files) > 0) {
            foreach ($files as $f) {
                $f = str_replace("..", "", ilUtil::stripSlashes($f));
                $this->content_obj->getMediaObject()
                    ->removeAdditionalFile("overlays/" . $f);
            }

            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_overlays_have_been_deleted"), true);
        }
        $ilCtrl->redirect($this, "listOverlayImages");
    }

Here is the call graph for this function:

deletePopups()

ilPCInteractiveImageGUI::deletePopups

(

)

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

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

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

        $tids = $this->request->getStringArray("tid");

        if (count($tids) > 0) {
            foreach ($tids as $id) {
                $id = explode(":", $id);
                $this->content_obj->deletePopup($id[0], $id[1]);
            }
            $this->pg_obj->update();
            $this->tpl->setOnScreenMessage('success', $lng->txt("cont_popups_have_been_deleted"), true);
        }
        $ilCtrl->redirect($this, "listContentPopups");
    }

Here is the call graph for this function:

edit()

ilPCInteractiveImageGUI::edit

(

)

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

References ilPageContentGUI\$ctrl, and ilCtrl\redirect().

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

Here is the call graph for this function:

editBaseImage()

ilPCInteractiveImageGUI::editBaseImage

(

)

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

References $tabs, ilPageContentGUI\$tpl, ilTabsGUI\activateTab(), initForm(), and ilGlobalTemplateInterface\setContent().

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

Here is the call graph for this function:

editor()

ilPCInteractiveImageGUI::editor

(

)

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

References $tabs, ilTabsGUI\activateTab(), ilObjStyleSheet\getBaseContentStylePath(), and initInteractiveImageEditor().

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

Here is the call graph for this function:

executeCommand()

ilPCInteractiveImageGUI::executeCommand

(

)

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

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

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

Here is the call graph for this function:

forwardFormToUploadHandler()

ilPCInteractiveImageGUI::forwardFormToUploadHandler ( )

protected

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

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

Referenced by executeCommand().

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

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 748 of file class.ilPCInteractiveImageGUI.php.

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

Referenced by forwardFormToUploadHandler().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getImportFormAdapter()

ilPCInteractiveImageGUI::getImportFormAdapter

(

)

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

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

Referenced by forwardFormToUploadHandler(), and ilPCInteractiveImageEditorGUI\getRenderedCreationForm().

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

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 704 of file class.ilPCInteractiveImageGUI.php.

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

Referenced by forwardFormToUploadHandler().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPopupFormAdapter()

ilPCInteractiveImageGUI::getPopupFormAdapter

(

)

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

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

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

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.

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

Referenced by executeCommand().

     : void {
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;

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

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 774 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 727 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 682 of file class.ilPCInteractiveImageGUI.php.

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

initAddOverlaysForm()

ilPCInteractiveImageGUI::initAddOverlaysForm

(

)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, $tabs, ilFileInputGUI\setSuffixes(), ilTabsGUI\setTabActive(), and ilLanguage\txt().

Referenced by addOverlayImages(), and uploadOverlayImages().

                                         : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;

        $ilTabs->setTabActive("list_overlays");

        $form = new ilPropertyFormGUI();
        $form->setTitle($lng->txt("cont_add_images"));
        $form->setFormAction($ilCtrl->getFormAction($this));

        // file input
        $fi = new ilFileWizardInputGUI($lng->txt("file"), "ovfile");
        $fi->setSuffixes(array("gif", "jpeg", "jpg", "png"));
        $fi->setFilenames(array(0 => ''));
        $fi->setRequired(true);
        $form->addItem($fi);

        $form->addCommandButton("uploadOverlayImages", $lng->txt("upload"));
        $form->addCommandButton("listOverlayImages", $lng->txt("cancel"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilPCInteractiveImageGUI::initForm

(

string

$a_mode = "edit"

)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilPageContentGUI\getHierId(), ILIAS\Repository\lng(), ilImageFileInputGUI\setAllowDeletion(), and ilLanguage\txt().

Referenced by create(), editBaseImage(), insert(), and update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initInteractiveImageEditor()

ilPCInteractiveImageGUI::initInteractiveImageEditor ( )

protected

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

References ilPageContentGUI\setEditorToolContext().

Referenced by editor().

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

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

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

Insert new media object form.

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), initForm(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Referenced by create().

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

Here is the call graph for this function:

Here is the caller graph for this function:

leftAlign()

ilPCInteractiveImageGUI::leftAlign

(

)

align media object to left

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

References ilPageContentGUI\getHierId(), ilMediaAliasItem\setHorizontalAlign(), and ilPageContentGUI\updateAndReturn().

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

Here is the call graph for this function:

leftFloatAlign()

ilPCInteractiveImageGUI::leftFloatAlign

(

)

align media object to left, floating text

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

References ilPageContentGUI\getHierId(), ilMediaAliasItem\setHorizontalAlign(), and ilPageContentGUI\updateAndReturn().

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

Here is the call graph for this function:

listOverlayImages()

ilPCInteractiveImageGUI::listOverlayImages

(

)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, $tabs, $toolbar, ilPageContentGUI\$tpl, ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                       : void
    {
        $tpl = $this->tpl;
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $ilTabs = $this->tabs;
        $lng = $this->lng;

        $this->tpl->setOnScreenMessage('info', $lng->txt("cont_iim_overlay_info"));

        $ilTabs->setTabActive("list_overlays");

        $ilToolbar->addButton(
            $lng->txt("cont_add_images"),
            $ilCtrl->getLinkTarget($this, "addOverlayImages")
        );

        $tab = new ilPCIIMOverlaysTableGUI(
            $this,
            "listOverlayImages",
            $this->content_obj->getMediaObject()
        );
        $tpl->setContent($tab->getHTML());
    }

Here is the call graph for this function:

rightAlign()

ilPCInteractiveImageGUI::rightAlign

(

)

align media object to right

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

References ilPageContentGUI\getHierId(), ilMediaAliasItem\setHorizontalAlign(), and ilPageContentGUI\updateAndReturn().

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

Here is the call graph for this function:

rightFloatAlign()

ilPCInteractiveImageGUI::rightFloatAlign

(

)

align media object to right, floating text

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

References ilPageContentGUI\getHierId(), ilMediaAliasItem\setHorizontalAlign(), and ilPageContentGUI\updateAndReturn().

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

Here is the call graph for this function:

savePopups()

ilPCInteractiveImageGUI::savePopups

(

)

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

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

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

        $titles = $this->request->getStringArray("title");
        if (count($titles) > 0) {
            $this->content_obj->savePopups($titles);
            $this->pg_obj->update();
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "listContentPopups");
    }

Here is the call graph for this function:

update()

ilPCInteractiveImageGUI::update

(

)

Update (base image)

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

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, $location, ilObjMediaObject\_getDirectory(), ilPageContentGUI\getHierId(), ilObjMediaObject\getMimeType(), initForm(), ilFileUtils\moveUploadedFile(), ilMediaAliasItem\setCaption(), and ilLanguage\txt().

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

Here is the call graph for this function:

uploadOverlayImages()

ilPCInteractiveImageGUI::uploadOverlayImages

(

)

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

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

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

        $form = $this->initAddOverlaysForm();
        if ($form->checkInput()) {
            if (is_array($_FILES["ovfile"]["name"])) {
                foreach ($_FILES["ovfile"]["name"] as $k => $v) {
                    $name = $_FILES["ovfile"]["name"][$k];
                    $tmp_name = $_FILES["ovfile"]["tmp_name"][$k];

                    $this->content_obj->getMediaObject()->uploadAdditionalFile(
                        $name,
                        $tmp_name,
                        "overlays"
                    );
                    $piname = pathinfo($name);
                    $this->content_obj->getMediaObject()->makeThumbnail(
                        "overlays/" . $name,
                        basename($name, "." . $piname['extension']) . ".png"
                    );
                }
            }
            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"));
            $ilCtrl->redirect($this, "listOverlayImages");
        } else {
            $form->setValuesByPost();
            $this->addOverlayImages($form);
        }
    }

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 confirmDeleteOverlays(), confirmPopupDeletion(), deleteOverlays(), editBaseImage(), editor(), executeCommand(), getTabs(), initAddOverlaysForm(), and listOverlayImages().

$toolbar

ilToolbarGUI ilPCInteractiveImageGUI::$toolbar

protected

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

Referenced by deleteOverlays(), and listOverlayImages().

---

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

• Services/COPage/PC/InteractiveImage/class.ilPCInteractiveImageGUI.php