ilPCMediaObjectEditorGUI Class Reference

Inheritance diagram for ilPCMediaObjectEditorGUI:

Collaboration diagram for ilPCMediaObjectEditorGUI:

Public Member Functions
	getEditorElements (UIWrapper $ui_wrapper, string $page_type, ilPageObjectGUI $page_gui, int $style_id)
	getRenderedUploadForm (UIWrapper $ui_wrapper, ilLanguage $lng, ilPropertyFormGUI $form=null)
	getUploadForm ( $lng)
	getRenderedUrlForm (UIWrapper $ui_wrapper, ilLanguage $lng, ilPropertyFormGUI $form=null)
	getUrlForm (ilLanguage $lng)
Public Member Functions inherited from ILIAS\COPage\Editor\Components\PageComponentEditor
	getEditorElements (UIWrapper $ui_wrapper, string $page_type, \ilPageObjectGUI $page_gui, int $style_id)
	Get rendered editor elements. More...
	getEditComponentForm (UIWrapper $ui_wrapper, string $page_type, \ilPageObjectGUI $page_gui, int $style_id, string $pcid)
	Get rendered editor elements. More...

Protected Member Functions
	getRenderedPoolBar (UIWrapper $ui_wrapper, ilLanguage $lng)
	getRenderedClipboardBar (UIWrapper $ui_wrapper, ilLanguage $lng, ilPageObjectGUI $page_gui)

Detailed Description

Author

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

Definition at line 25 of file class.ilPCMediaObjectEditorGUI.php.

Member Function Documentation

getEditorElements()

ilPCMediaObjectEditorGUI::getEditorElements	(	UIWrapper	$ui_wrapper,
		string	$page_type,
		ilPageObjectGUI	$page_gui,
		int	$style_id
	)

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

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

getRenderedClipboardBar()

ilPCMediaObjectEditorGUI::getRenderedClipboardBar ( UIWrapper  $ui_wrapper, ilLanguage  $lng, ilPageObjectGUI  $page_gui  )

protected

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

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

getRenderedPoolBar()

ilPCMediaObjectEditorGUI::getRenderedPoolBar ( UIWrapper  $ui_wrapper, ilLanguage  $lng  )

protected

Definition at line 248 of file class.ilPCMediaObjectEditorGUI.php.

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

getRenderedUploadForm()

ilPCMediaObjectEditorGUI::getRenderedUploadForm	(	UIWrapper	$ui_wrapper,
		ilLanguage	$lng,
		ilPropertyFormGUI	$form = null
	)

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

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

References $lng.

getRenderedUrlForm()

ilPCMediaObjectEditorGUI::getRenderedUrlForm	(	UIWrapper	$ui_wrapper,
		ilLanguage	$lng,
		ilPropertyFormGUI	$form = null
	)

Definition at line 200 of file class.ilPCMediaObjectEditorGUI.php.

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

References $lng.

getUploadForm()

ilPCMediaObjectEditorGUI::getUploadForm

(

$lng

)

Definition at line 169 of file class.ilPCMediaObjectEditorGUI.php.

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

getUrlForm()

ilPCMediaObjectEditorGUI::getUrlForm

(

ilLanguage

$lng

)

Definition at line 218 of file class.ilPCMediaObjectEditorGUI.php.

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

---

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

• Services/COPage/Editor/Components/MediaObject/class.ilPCMediaObjectEditorGUI.php