ILIAS  release_8 Revision v8.19-1-g4e8f2f9140c
All Data Structures Namespaces Files Functions Variables Modules Pages
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.

References $DIC, $lng, ilAccordionGUI\FIRST_OPEN, ILIAS\COPage\Editor\Components\PageComponentEditor\getEditComponentForm(), ilPageObjectGUI\getPageObject(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedButton(), getRenderedClipboardBar(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedForm(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedIcon(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedInfoBox(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedLink(), getRenderedPoolBar(), getRenderedUploadForm(), getRenderedUrlForm(), ilCheckboxInputGUI\setChecked(), ilTextAreaInputGUI\setRows(), and ilPageContentGUI\setStyleId().

32  : array {
33  global $DIC;
34  $lng = $DIC->language();
35  $lng->loadLanguageModule("content");
36 
37  $acc = new ilAccordionGUI();
38  $acc->addItem($lng->txt("cont_upload_file"), $this->getRenderedUploadForm($ui_wrapper, $lng));
39  $acc->addItem($lng->txt("cont_add_url"), $this->getRenderedUrlForm($ui_wrapper, $lng));
40  $acc->addItem($lng->txt("cont_choose_from_pool"), $this->getRenderedPoolBar($ui_wrapper, $lng));
41  $acc->addItem($lng->txt("cont_choose_from_clipboard"), $this->getRenderedClipboardBar($ui_wrapper, $lng, $page_gui));
42  $acc->setBehaviour(ilAccordionGUI::FIRST_OPEN);
43 
44  return [
45  "creation_form" => $acc->getHTML(true),
46  "icon" => $ui_wrapper->getRenderedIcon("pemed")
47  ];
48  }
$lng
getRenderedUrlForm(UIWrapper $ui_wrapper, ilLanguage $lng, ilPropertyFormGUI $form=null)
getRenderedPoolBar(UIWrapper $ui_wrapper, ilLanguage $lng)
global $DIC
Definition: feed.php:28
getRenderedClipboardBar(UIWrapper $ui_wrapper, ilLanguage $lng, ilPageObjectGUI $page_gui)
getRenderedUploadForm(UIWrapper $ui_wrapper, ilLanguage $lng, ilPropertyFormGUI $form=null)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:

◆ getRenderedClipboardBar()

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

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

References $DIC, ILIAS\COPage\Editor\Server\UIWrapper\getButton(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedFormFooter(), and ilLanguage\txt().

Referenced by getEditorElements().

287  : string {
288  global $DIC;
289 
290  $ctrl = $DIC->ctrl();
291 
292  $return_cmd = $ctrl->getLinkTargetByClass("ilpageeditorgui", "insertFromClipboard");
293 
294  $ctrl->setParameterByClass("ileditclipboardgui", "returnCommand", rawurlencode($return_cmd));
295 
296  $buttons = [];
297 
298  $buttons[] = $ui_wrapper->getButton(
299  $lng->txt("cont_open_clipboard"),
300  "media-action",
301  "open.clipboard",
302  ["url" => $ctrl->getLinkTargetByClass([get_class($page_gui), "ileditclipboardgui"], "getObject")],
303  "MediaObject"
304  );
305 
306  $buttons[] = $ui_wrapper->getButton(
307  $lng->txt("cancel"),
308  "form-button",
309  "component.cancel",
310  [
311  ],
312  "Page"
313  );
314 
315  return $ui_wrapper->getRenderedFormFooter($buttons);
316  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
global $DIC
Definition: feed.php:28
getButton(string $content, string $type, string $action, array $data=null, string $component="", string $aria_label="")
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getRenderedPoolBar()

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

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

References $DIC, ILIAS\COPage\Editor\Server\UIWrapper\getButton(), ILIAS\COPage\Editor\Server\UIWrapper\getRenderedFormFooter(), and ilLanguage\txt().

Referenced by getEditorElements().

251  : string {
252  global $DIC;
253 
254  $ui = $DIC->ui();
255  $ctrl = $DIC->ctrl();
256  $lng = $DIC->language();
257 
258  $buttons = [];
259 
260  $ctrl->setParameterByClass("ilpcmediaobjectgui", "subCmd", "poolSelection");
261  $buttons[] = $ui_wrapper->getButton(
262  $lng->txt("cont_choose_media_pool"),
263  "media-action",
264  "select.pool",
265  [
266  "url" => $ctrl->getLinkTargetByClass("ilpcmediaobjectgui", "insert")
267  ],
268  "MediaObject"
269  );
270  $buttons[] = $ui_wrapper->getButton(
271  $lng->txt("cancel"),
272  "form-button",
273  "component.cancel",
274  [
275  ],
276  "Page"
277  );
278  $ctrl->setParameterByClass("ilpcmediaobjectgui", "subCmd", "poolSelection");
279 
280  return $ui_wrapper->getRenderedFormFooter($buttons);
281  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
global $DIC
Definition: feed.php:28
getButton(string $content, string $type, string $action, array $data=null, string $component="", string $aria_label="")
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getRenderedUploadForm()

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

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

References ILIAS\COPage\Editor\Server\UIWrapper\getRenderedForm(), getUploadForm(), and ilLanguage\txt().

Referenced by getEditorElements().

155  : string {
156  if (!$form) {
157  $form = $this->getUploadForm($lng);
158  }
159 
160  $html = $ui_wrapper->getRenderedForm(
161  $form,
162  [["Page", "component.save", $lng->txt("insert")],
163  ["Page", "component.cancel", $lng->txt("cancel")]]
164  );
165 
166  return $html;
167  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
getRenderedForm(\ilPropertyFormGUI $form, array $buttons)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getRenderedUrlForm()

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

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

References ILIAS\COPage\Editor\Server\UIWrapper\getRenderedForm(), getUrlForm(), and ilLanguage\txt().

Referenced by getEditorElements().

204  : string {
205  if (!$form) {
206  $form = $this->getUrlForm($lng);
207  }
208 
209  $html = $ui_wrapper->getRenderedForm(
210  $form,
211  [["Page", "component.save", $lng->txt("insert")],
212  ["Page", "component.cancel", $lng->txt("cancel")]]
213  );
214 
215  return $html;
216  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
getRenderedForm(\ilPropertyFormGUI $form, array $buttons)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getUploadForm()

ilPCMediaObjectEditorGUI::getUploadForm (   $lng)

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

References $lng, ilObjMediaObject\getForbiddenFileTypes(), ilObjMediaObject\getRestrictedFileTypes(), and ilFileInputGUI\setSuffixes().

Referenced by getRenderedUploadForm().

172  $form = new ilPropertyFormGUI();
173  $form->setShowTopButtons(false);
174 
175  // standard type
176  $hi = new ilHiddenInputGUI("standard_type");
177  $hi->setValue("File");
178  $form->addItem($hi);
179 
180  // standard size
181  $hi2 = new ilHiddenInputGUI("standard_size");
182  $hi2->setValue("original");
183  $form->addItem($hi2);
184 
185  // standard size
186  $hi3 = new ilHiddenInputGUI("full_type");
187  $hi3->setValue("None");
188  $form->addItem($hi3);
189 
190  // standard file
191  $up = new ilFileInputGUI($lng->txt("cont_file"), "standard_file");
193  $up->setForbiddenSuffixes(ilObjMediaObject::getForbiddenFileTypes());
194  $up->setRequired(true);
195  $form->addItem($up);
196 
197  return $form;
198  }
$lng
This class represents a file property in a property form.
setSuffixes(array $a_suffixes)
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static getForbiddenFileTypes()
Get forbidden file types.
static getRestrictedFileTypes()
Get restricted file types (this is for the input form, this list will be empty, if "allowed list" is ...
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getUrlForm()

ilPCMediaObjectEditorGUI::getUrlForm ( ilLanguage  $lng)

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

References ilLanguage\txt().

Referenced by getRenderedUrlForm().

221  $form = new ilPropertyFormGUI();
222  $form->setShowTopButtons(false);
223 
224  // standard type
225  $hi = new ilHiddenInputGUI("standard_type");
226  $hi->setValue("Reference");
227  $form->addItem($hi);
228 
229  // standard size
230  $hi2 = new ilHiddenInputGUI("standard_size");
231  $hi2->setValue("original");
232  $form->addItem($hi2);
233 
234  // standard size
235  $hi3 = new ilHiddenInputGUI("full_type");
236  $hi3->setValue("None");
237  $form->addItem($hi3);
238 
239  // standard reference
240  $ti = new ilTextInputGUI($lng->txt("url"), "standard_reference");
241  $ti->setInfo($lng->txt("cont_url_info"));
242  $ti->setRequired(true);
243  $form->addItem($ti);
244 
245  return $form;
246  }
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

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