class.ilPCMediaObjectEditorGUI.php

Go to the documentation of this file.

<?php

use ILIAS\COPage\Editor\Components\PageComponentEditor;
use ILIAS\COPage\Editor\Server\UIWrapper;

class ilPCMediaObjectEditorGUI implements PageComponentEditor
{
    public function getEditorElements(
        UIWrapper $ui_wrapper,
        string $page_type,
        ilPageObjectGUI $page_gui,
        int $style_id
    ): array {
        global $DIC;
        $lng = $DIC->language();
        $lng->loadLanguageModule("content");

        $acc = new ilAccordionGUI();
        $acc->addItem($lng->txt("cont_upload_file"), $this->getRenderedUploadForm($ui_wrapper, $lng));
        $acc->addItem($lng->txt("cont_add_url"), $this->getRenderedUrlForm($ui_wrapper, $lng));
        $acc->addItem($lng->txt("cont_choose_from_pool"), $this->getRenderedPoolBar($ui_wrapper, $lng));
        $acc->addItem($lng->txt("cont_choose_from_clipboard"), $this->getRenderedClipboardBar($ui_wrapper, $lng, $page_gui));
        $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);

        return [
            "creation_form" => $acc->getHTML(true),
            "icon" => $ui_wrapper->getRenderedIcon("pemed")
        ];
    }

    public function getEditComponentForm(
        UIWrapper $ui_wrapper,
        string $page_type,
        \ilPageObjectGUI $page_gui,
        int $style_id,
        string $pcid
    ): string {
        global $DIC;
        $lng = $DIC->language();
        $lng->loadLanguageModule("content");

        $media_type = $DIC->mediaObjects()
            ->internal()
            ->domain()
            ->mediaType();

        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);
        $form->setTitle($lng->txt("cont_edit_mob"));

        $pc_media = $page_gui->getPageObject()->getContentObjectForPcId($pcid);

        $quick_edit = new ilPCMediaObjectQuickEdit($pc_media);

        $pc_media_gui = new ilPCMediaObjectGUI(
            $page_gui->getPageObject(),
            $pc_media,
            $page_gui->getPageObject()->getHierIdForPcId($pcid),
            $pcid
        );
        $pc_media_gui->setStyleId($style_id);
        $pc_media_gui->getCharacteristicsOfCurrentStyle(["media_cont"]);

        if (is_null($pc_media->getMediaObject())) {
            return "<div id='copg-top-actions'>" . $ui_wrapper->getRenderedInfoBox($lng->txt("copg_pc_mob_does_not_exist")) .
                $ui_wrapper->getRenderedButton($lng->txt("cancel"), "form-button", "component.cancel", null, "Page") . "</div>";
        }
        $media = $pc_media->getMediaObject()->getMediaItem("Standard");

        // title
        $title = new ilTextInputGUI($lng->txt("title"), "standard_title");
        $title->setSize(40);
        $title->setMaxLength(120);
        $title->setValue($quick_edit->getTitle());
        $form->addItem($title);

        // style
        if ($pc_media_gui->checkStyleSelection()) {
            $style_input = $pc_media_gui->getStyleInput();
            $form->addItem($style_input);
        }

        // horizonal align
        $align_prop = new ilSelectInputGUI(
            $lng->txt("cont_align"),
            "horizontal_align"
        );
        $options = array(
            "Left" => $lng->txt("cont_left"),
            "Center" => $lng->txt("cont_center"),
            "Right" => $lng->txt("cont_right"),
            "LeftFloat" => $lng->txt("cont_left_float"),
            "RightFloat" => $lng->txt("cont_right_float"));
        $align_prop->setOptions($options);
        $align_prop->setValue($quick_edit->getHorizontalAlign());
        $form->addItem($align_prop);

        // fullscreen
        if ($media_type->isImage($media->getFormat())) {
            $cb = new ilCheckboxInputGUI($lng->txt("cont_show_fullscreen"), "fullscreen");
            $cb->setChecked($quick_edit->getUseFullscreen());
            $form->addItem($cb);
        }

        // standard caption
        $caption = new ilTextAreaInputGUI($lng->txt("cont_caption"), "standard_caption");
        $caption->setRows(2);
        $caption->setValue($quick_edit->getCaption());
        $form->addItem($caption);

        // text representation
        if ($media_type->usesAltTextProperty($media->getFormat())) {
            $ta = new ilTextAreaInputGUI($lng->txt("text_repr"), "text_representation");
            $ta->setRows(2);
            $ta->setInfo($lng->txt("text_repr_info"));
            $ta->setValue($quick_edit->getTextRepresentation());
            $form->addItem($ta);
        }

        $html = $ui_wrapper->getRenderedForm(
            $form,
            [["Page", "component.update", $lng->txt("save")],
             ["Page", "component.cancel", $lng->txt("cancel")]]
        );

        $link = $ui_wrapper->getRenderedLink($lng->txt("cont_advanced_settings"), "Page", "link", "component.settings");

        return $html . $link;
    }

    public function getRenderedUploadForm(
        UIWrapper $ui_wrapper,
        ilLanguage $lng,
        ilPropertyFormGUI $form = null
    ): string {
        if (!$form) {
            $form = $this->getUploadForm($lng);
        }

        $html = $ui_wrapper->getRenderedForm(
            $form,
            [["Page", "component.save", $lng->txt("insert")],
             ["Page", "component.cancel", $lng->txt("cancel")]]
        );

        return $html;
    }

    public function getUploadForm(
        $lng
    ): ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);

        // standard type
        $hi = new ilHiddenInputGUI("standard_type");
        $hi->setValue("File");
        $form->addItem($hi);

        // standard size
        $hi2 = new ilHiddenInputGUI("standard_size");
        $hi2->setValue("original");
        $form->addItem($hi2);

        // standard size
        $hi3 = new ilHiddenInputGUI("full_type");
        $hi3->setValue("None");
        $form->addItem($hi3);

        // standard file
        $up = new ilFileInputGUI($lng->txt("cont_file"), "standard_file");
        $up->setSuffixes(ilObjMediaObject::getRestrictedFileTypes());
        $up->setForbiddenSuffixes(ilObjMediaObject::getForbiddenFileTypes());
        $up->setRequired(true);
        $form->addItem($up);

        return $form;
    }

    public function getRenderedUrlForm(
        UIWrapper $ui_wrapper,
        ilLanguage $lng,
        ilPropertyFormGUI $form = null
    ): string {
        if (!$form) {
            $form = $this->getUrlForm($lng);
        }

        $html = $ui_wrapper->getRenderedForm(
            $form,
            [["Page", "component.save", $lng->txt("insert")],
             ["Page", "component.cancel", $lng->txt("cancel")]]
        );

        return $html;
    }

    public function getUrlForm(
        ilLanguage $lng
    ): ilPropertyFormGUI {
        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);

        // standard type
        $hi = new ilHiddenInputGUI("standard_type");
        $hi->setValue("Reference");
        $form->addItem($hi);

        // standard size
        $hi2 = new ilHiddenInputGUI("standard_size");
        $hi2->setValue("original");
        $form->addItem($hi2);

        // standard size
        $hi3 = new ilHiddenInputGUI("full_type");
        $hi3->setValue("None");
        $form->addItem($hi3);

        // standard reference
        $ti = new ilTextInputGUI($lng->txt("url"), "standard_reference");
        $ti->setInfo($lng->txt("cont_url_info"));
        $ti->setRequired(true);
        $form->addItem($ti);

        return $form;
    }

    protected function getRenderedPoolBar(
        UIWrapper $ui_wrapper,
        ilLanguage $lng
    ): string {
        global $DIC;

        $ui = $DIC->ui();
        $ctrl = $DIC->ctrl();
        $lng = $DIC->language();

        $buttons = [];

        $ctrl->setParameterByClass("ilpcmediaobjectgui", "subCmd", "poolSelection");
        $buttons[] = $ui_wrapper->getButton(
            $lng->txt("cont_choose_media_pool"),
            "media-action",
            "select.pool",
            [
                "url" => $ctrl->getLinkTargetByClass("ilpcmediaobjectgui", "insert")
            ],
            "MediaObject"
        );
        $buttons[] = $ui_wrapper->getButton(
            $lng->txt("cancel"),
            "form-button",
            "component.cancel",
            [
            ],
            "Page"
        );
        $ctrl->setParameterByClass("ilpcmediaobjectgui", "subCmd", "poolSelection");

        return $ui_wrapper->getRenderedFormFooter($buttons);
    }

    protected function getRenderedClipboardBar(
        UIWrapper $ui_wrapper,
        ilLanguage $lng,
        ilPageObjectGUI $page_gui
    ): string {
        global $DIC;

        $ctrl = $DIC->ctrl();

        $return_cmd = $ctrl->getLinkTargetByClass("ilpageeditorgui", "insertFromClipboard");

        $ctrl->setParameterByClass("ileditclipboardgui", "returnCommand", rawurlencode($return_cmd));

        $buttons = [];

        $buttons[] = $ui_wrapper->getButton(
            $lng->txt("cont_open_clipboard"),
            "media-action",
            "open.clipboard",
            ["url" => $ctrl->getLinkTargetByClass([get_class($page_gui), "ileditclipboardgui"], "getObject")],
            "MediaObject"
        );

        $buttons[] = $ui_wrapper->getButton(
            $lng->txt("cancel"),
            "form-button",
            "component.cancel",
            [
            ],
            "Page"
        );

        return $ui_wrapper->getRenderedFormFooter($buttons);
    }
}