ilObjExternalToolsSettingsGUI Class Reference
Class ilObjExternalToolsSettingsGUI. More...
Inheritance diagram for ilObjExternalToolsSettingsGUI:
Collaboration diagram for ilObjExternalToolsSettingsGUI:
Public Member Functions | |
| __construct ($a_data, $a_id, $a_call_by_reference, $a_prepare_output=true) | |
| Constructor @access public. More... | |
| getAdminTabs () | |
| administration tabs show only permissions and trash folder More... | |
| getTabs () | |
| get tabs @access public More... | |
| editMathJaxObject () | |
| Configure MathJax settings. More... | |
| saveMathJaxObject () | |
| Save MathJax Setttings. More... | |
| clearMathJaxCacheObject () | |
| Clear the directory with cached LaTeX graphics. More... | |
| editMapsObject () | |
| Configure maps settings. More... | |
| saveMapsObject () | |
| Save Maps Setttings. More... | |
| __initSubTabs ($a_cmd) | |
| executeCommand () | |
| execute command More... | |
| Public Member Functions inherited from ilObjectGUI | |
| executeCommand () | |
| execute command More... | |
| withReferences () | |
| determines wether objects are referenced or not (got ref ids or not) More... | |
| setCreationMode ($a_mode=true) | |
| if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More... | |
| getCreationMode () | |
| get creation mode More... | |
| prepareOutput ($a_show_subobjects=true) | |
| prepare output More... | |
| getAdminTabs () | |
| administration tabs show only permissions and trash folder More... | |
| getHTML () | |
| confirmedDeleteObject () | |
| confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More... | |
| cancelDeleteObject () | |
| cancel deletion of object More... | |
| cancelObject () | |
| cancel action and go back to previous page @access public More... | |
| createObject () | |
| create new object form More... | |
| cancelCreation () | |
| cancel create action and go back to repository parent More... | |
| saveObject () | |
| save object More... | |
| getDidacticTemplateVar ($a_type) | |
| Get didactic template setting from creation screen. More... | |
| putObjectInTree (ilObject $a_obj, $a_parent_node_id=null) | |
| Add object to tree at given position. More... | |
| editObject () | |
| edit object More... | |
| addExternalEditFormCustom (ilPropertyFormGUI $a_form) | |
| updateObject () | |
| updates object entry in object_data More... | |
| getFormAction ($a_cmd, $a_formaction="") | |
| get form action for command (command is method name without "Object", e.g. More... | |
| isVisible ($a_ref_id, $a_type) | |
| viewObject () | |
| viewObject container presentation for "administration -> repository, trash, permissions" More... | |
| deleteObject ($a_error=false) | |
| Display deletion confirmation screen. More... | |
| cloneAllObject () | |
| Clone single (not container object) Method is overwritten in ilContainerGUI. More... | |
| redirectAfterCreation () | |
| Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More... | |
| addToDeskObject () | |
| @inheritDoc More... | |
| removeFromDeskObject () | |
| @inheritDoc More... | |
Protected Attributes | |
| $rbacsystem | |
| $access | |
| $rbacreview | |
| Protected Attributes inherited from ilObjectGUI | |
| $ilErr | |
| $locator | |
| $user | |
| $access | |
| $rbacsystem | |
| $settings | |
| $rbacreview | |
| $toolbar | |
| $tmp_import_dir | |
| $tabs_gui = null | |
| $ctrl | |
| $object_service | |
| $favourites | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObjectGUI | |
| static | _gotoRepositoryRoot ($a_raise_error=false) |
| Goto repository root. More... | |
| static | _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset") |
| Goto repository root. More... | |
| Data Fields inherited from ilObjectGUI | |
| const | COPY_WIZARD_NEEDS_PAGE = 1 |
| $objDefinition | |
| $tpl | |
| $tree | |
| $lng | |
| $data | |
| $object | |
| $ref_id | |
| $obj_id | |
| $maxcount | |
| $formaction | |
| $return_location | |
| $target_frame | |
| $tab_target_script | |
| $actions | |
| $sub_objects | |
| $omit_locator = false | |
| const | CFORM_NEW = 1 |
| const | CFORM_IMPORT = 2 |
| const | CFORM_CLONE = 3 |
| Protected Member Functions inherited from ilObjectGUI | |
| getObjectService () | |
| Get object service. More... | |
| assignObject () | |
| setTitleAndDescription () | |
| called by prepare output More... | |
| initHeaderAction ($a_sub_type=null, $a_sub_id=null) | |
| Add header action menu. More... | |
| insertHeaderAction ($a_list_gui) | |
| Insert header action into main template. More... | |
| addHeaderAction () | |
| Add header action menu. More... | |
| redrawHeaderActionObject () | |
| Ajax call: redraw action header only. More... | |
| setTabs () | |
| set admin tabs @access public More... | |
| setAdminTabs () | |
| set admin tabs @access public More... | |
| setLocator () | |
| set Locator More... | |
| addLocatorItems () | |
| should be overwritten to add object specific items (repository items are preloaded) More... | |
| omitLocator ($a_omit=true) | |
| addAdminLocatorItems ($a_do_not_add_object=false) | |
| should be overwritten to add object specific items (repository items are preloaded) More... | |
| initCreationForms ($a_new_type) | |
| Init creation froms. More... | |
| getCreationFormsHTML (array $a_forms) | |
| Get HTML for creation forms (accordion) More... | |
| initCreateForm ($a_new_type) | |
| Init object creation form. More... | |
| initDidacticTemplate (ilPropertyFormGUI $form) | |
| Show didactic template types. More... | |
| addDidacticTemplateOptions (array &$a_options) | |
| Add custom templates. More... | |
| afterSave (ilObject $a_new_object) | |
| Post (successful) object creation hook. More... | |
| initEditForm () | |
| Init object edit form. More... | |
| initEditCustomForm (ilPropertyFormGUI $a_form) | |
| Add custom fields to update form. More... | |
| getEditFormValues () | |
| Get values for edit form. More... | |
| getEditFormCustomValues (array &$a_values) | |
| Add values to custom edit fields. More... | |
| validateCustom (ilPropertyFormGUI $a_form) | |
| Validate custom values (if not possible with checkInput()) More... | |
| updateCustom (ilPropertyFormGUI $a_form) | |
| Insert custom update form values into object. More... | |
| afterUpdate () | |
| Post (successful) object update hook. More... | |
| initImportForm ($a_new_type) | |
| Init object import form. More... | |
| importFileObject ($parent_id=null, $a_catch_errors=true) | |
| Import. More... | |
| afterImport (ilObject $a_new_object) | |
| Post (successful) object import hook. More... | |
| setFormAction ($a_cmd, $a_formaction) | |
| set specific form action for command More... | |
| getReturnLocation ($a_cmd, $a_location="") | |
| get return location for command (command is method name without "Object", e.g. More... | |
| setReturnLocation ($a_cmd, $a_location) | |
| set specific return location for command More... | |
| getTargetFrame ($a_cmd, $a_target_frame="") | |
| get target frame for command (command is method name without "Object", e.g. More... | |
| setTargetFrame ($a_cmd, $a_target_frame) | |
| set specific target frame for command More... | |
| showPossibleSubObjects () | |
| show possible subobjects (pulldown menu) More... | |
| getTemplateFile ($a_cmd, $a_type="") | |
| get a template blockfile format: tpl. More... | |
| getTabs () | |
| get tabs abstract method. More... | |
| __showButton ($a_cmd, $a_text, $a_target='') | |
| hitsperpageObject () | |
| & | __initTableGUI () |
| __setTableGUIBasicData (&$tbl, &$result_set, $a_from="") | |
| standard implementation for tables use 'from' variable use different initial setting of table More... | |
| redirectToRefId ($a_ref_id, $a_cmd="") | |
| redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current $_GET["ref_id"] value More... | |
| fillCloneTemplate ($a_tpl_varname, $a_type) | |
| Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More... | |
| getCenterColumnHTML () | |
| Get center column. More... | |
| getRightColumnHTML () | |
| Display right column. More... | |
| setColumnSettings (ilColumnGUI $column_gui) | |
| May be overwritten in subclasses. More... | |
| checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null) | |
| Check permission and redirect on error. More... | |
| checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null) | |
| Check permission. More... | |
| enableDragDropFileUpload () | |
| Enables the file upload into this object by dropping files. More... | |
| handleAutoRating (ilObject $a_new_obj) | |
| Activate rating automatically if parent container setting. More... | |
Detailed Description
Class ilObjExternalToolsSettingsGUI.
- Version
- $Id$
@ilCtrl_Calls ilObjExternalToolsSettingsGUI: ilPermissionGUI
Definition at line 18 of file class.ilObjExternalToolsSettingsGUI.php.
Constructor & Destructor Documentation
◆ __construct()
| ilObjExternalToolsSettingsGUI::__construct | ( | $a_data, | |
| $a_id, | |||
| $a_call_by_reference, | |||
$a_prepare_output = true |
|||
| ) |
Constructor @access public.
Definition at line 39 of file class.ilObjExternalToolsSettingsGUI.php.
40 {
41 global $DIC;
42
43 $this->lng = $DIC->language();
44 $this->rbacsystem = $DIC->rbac()->system();
45 $this->access = $DIC->access();
46 $this->rbacreview = $DIC->rbac()->review();
47 $this->ctrl = $DIC->ctrl();
50
51 $this->type = "extt";
53
57 }
References $DIC, ilObjectGUI\$lng, and ILIAS\GlobalScreen\Provider\__construct().
Here is the call graph for this function:
Member Function Documentation
◆ __initSubTabs()
| ilObjExternalToolsSettingsGUI::__initSubTabs | ( | $a_cmd | ) |
Definition at line 363 of file class.ilObjExternalToolsSettingsGUI.php.
364 {
365 $maps = ($a_cmd == 'editMaps') ? true : false;
366 $mathjax = ($a_cmd == 'editMathJax') ? true : false;
367
368 $this->tabs_gui->addSubTabTarget(
369 "maps_extt_maps",
370 $this->ctrl->getLinkTarget($this, "editMaps"),
371 "",
372 "",
373 "",
374 $maps
375 );
376 $this->tabs_gui->addSubTabTarget(
377 "mathjax_mathjax",
378 $this->ctrl->getLinkTarget($this, "editMathJax"),
379 "",
380 "",
381 "",
382 $mathjax
383 );
384 }
Referenced by editMapsObject(), and editMathJaxObject().
Here is the caller graph for this function:
◆ clearMathJaxCacheObject()
| ilObjExternalToolsSettingsGUI::clearMathJaxCacheObject | ( | ) |
Clear the directory with cached LaTeX graphics.
Definition at line 251 of file class.ilObjExternalToolsSettingsGUI.php.
252 {
254
255 include_once './Services/MathJax/classes/class.ilMathJax.php';
256 ilMathJax::getInstance()->clearCache();
257
259 $this->ctrl->redirect($this, 'editMathJax');
260 }
References ilObjectGUI\$lng, and ilMathJax\getInstance().
Here is the call graph for this function:
◆ editMapsObject()
| ilObjExternalToolsSettingsGUI::editMapsObject | ( | ) |
Configure maps settings.
@access public
Definition at line 267 of file class.ilObjExternalToolsSettingsGUI.php.
268 {
269 require_once("Services/Maps/classes/class.ilMapUtil.php");
270
271 $ilAccess = $this->access;
275
277 $std_latitude = ilMapUtil::getStdLatitude();
278 $std_longitude = ilMapUtil::getStdLongitude();
279 $std_zoom = ilMapUtil::getStdZoom();
281
282 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
283 include_once("./Services/Form/classes/class.ilCheckboxOption.php");
285 $form->setFormAction($ilCtrl->getFormAction($this));
287
288 // Enable Maps
290 $enable->setChecked(ilMapUtil::isActivated());
292 $form->addItem($enable);
293
294 // Select type
296 $types->setOptions(ilMapUtil::getAvailableMapTypes());
297 $types->setValue($type);
298 $form->addItem($types);
299
300 // map data server property
303 $tile->setValue(ilMapUtil::getStdTileServers());
306 $geolocation->setValue(ilMapUtil::getStdGeolocationServer());
308
309 $form->addItem($tile);
310 $form->addItem($geolocation);
311 } else {
312 // api key for google
314 $key->setMaxLength(200);
315 $key->setValue(ilMapUtil::getApiKey());
316 $form->addItem($key);
317 }
318
319 // location property
322 "std_location"
323 );
324
325 $loc_prop->setLatitude($std_latitude);
326 $loc_prop->setLongitude($std_longitude);
327 $loc_prop->setZoom($std_zoom);
328 $form->addItem($loc_prop);
329
330 if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
333 }
334
336 }
This class represents a checkbox property in a property form.
Definition: class.ilCheckboxInputGUI.php:34
This class represents a location property in a property form.
Definition: class.ilLocationInputGUI.php:32
static getStdGeolocationServer()
Returns the reverse geolocation server to be used in the installation.
Definition: class.ilMapUtil.php:146
static getStdTileServers()
Returns the tile server to be used in the installation.
Definition: class.ilMapUtil.php:129
static getAvailableMapTypes()
Get a dict { $id => $name } for available maps services.
Definition: class.ilMapUtil.php:192
__initSubTabs($a_cmd)
Definition: class.ilObjExternalToolsSettingsGUI.php:363
This class represents a property form user interface.
Definition: class.ilPropertyFormGUI.php:48
This class represents a selection list property in a property form.
Definition: class.ilSelectInputGUI.php:18
This class represents a text property in a property form.
Definition: class.ilTextInputGUI.php:17
References $access, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, $type, __initSubTabs(), ilMapUtil\DEFAULT_TILE, ilMapUtil\getApiKey(), ilMapUtil\getAvailableMapTypes(), ilMapUtil\getStdGeolocationServer(), ilMapUtil\getStdLatitude(), ilMapUtil\getStdLongitude(), ilMapUtil\getStdTileServers(), ilMapUtil\getStdZoom(), ilMapUtil\getType(), and ilMapUtil\isActivated().
Here is the call graph for this function:
◆ editMathJaxObject()
| ilObjExternalToolsSettingsGUI::editMathJaxObject | ( | ) |
Configure MathJax settings.
Definition at line 99 of file class.ilObjExternalToolsSettingsGUI.php.
100 {
101 $ilAccess = $this->access;
106
109
111
112 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
114 $form->setFormAction($ilCtrl->getFormAction($this));
116
117 // Enable MathJax
120 $enable->setInfo($lng->txt("mathjax_enable_mathjax_info") . " <a target='blank' href='http://www.mathjax.org/'>"
122 $form->addItem($enable);
123
124 // Path to mathjax
127 $text_prop->setValue($path_to_mathjax);
128 $text_prop->setRequired(true);
129 $text_prop->setMaxLength(400);
130 $text_prop->setSize(100);
131 $enable->addSubItem($text_prop);
132
133 // mathjax limiter
134 $options = array(
135 0 => '\​(...\​)',
136 1 => '[tex]...[/tex]',
137 2 => '<span class="math">...</span>'
138 );
140 $si->setOptions($options);
143 $enable->addSubItem($si);
144
145 include_once './Services/MathJax/classes/class.ilMathJax.php';
146 $install_link = ' <a target="_blank" href="Services/MathJax/docs/Install-MathJax-Server.txt">'
148 $clear_cache_link = ' <a href="' . $this->ctrl->getLinkTarget($this, 'clearMathJaxCache') . '"">'
150
151 // Enable Server MathJax
155
156 $form->addItem($server);
157
158 // Path to Server MathJax
162 $text_prop->setRequired(true);
163 $text_prop->setMaxLength(400);
164 $text_prop->setSize(100);
165 $server->addSubItem($text_prop);
166
167 // Server Timeout
170 $number_prop->setValue($mathJaxSetting->get("server_timeout") ? (int) $mathJaxSetting->get("server_timeout") : 5);
171 $number_prop->setRequired(true);
172 $number_prop->setSize(3);
173 $server->addSubItem($number_prop);
174
175 // Server for Browser
176 $checkbox = new ilCheckboxInputGUI($lng->txt("mathjax_server_for_browser"), "server_for_browser");
179 $server->addSubItem($checkbox);
180
181 // Server for HTML Export
182 $checkbox = new ilCheckboxInputGUI($lng->txt("mathjax_server_for_export"), "server_for_export");
185 $server->addSubItem($checkbox);
186
187 // Server for PDF
191 $server->addSubItem($checkbox);
192
193 // Cache Size / Clear Cache
198
199 // Test expression
201 include_once './Services/MathJax/classes/class.ilMathJax.php';
202 $html = ilMathJax::getInstance()->insertLatexImages('[tex]f(x)=\int_{-\infty}^x e^{-t^2}dt[/tex]');
203 $test->setHtml($html);
205 $form->addItem($test);
206
207 if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
209 }
210
212 }
This class represents a custom property in a property form.
Definition: class.ilCustomInputGUI.php:35
This class represents a non editable value in a property form.
Definition: class.ilNonEditableValueGUI.php:14
This class represents a number property in a property form.
Definition: class.ilNumberInputGUI.php:15
$rbacreview
Definition: class.ilObjExternalToolsSettingsGUI.php:33
if(strpos( $jquery_path, './')===0) elseif(strpos($jquery_path, '.')===0) $mathJaxSetting
Definition: latex.php:32
References $access, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $mathJaxSetting, $rbacreview, $server, $si, $size, $test, ilObjectGUI\$tpl, __initSubTabs(), and ilMathJax\getInstance().
Here is the call graph for this function:
◆ executeCommand()
| ilObjExternalToolsSettingsGUI::executeCommand | ( | ) |
execute command
Reimplemented from ilObjectGUI.
Definition at line 386 of file class.ilObjExternalToolsSettingsGUI.php.
387 {
388 $ilAccess = $this->access;
389
390 $next_class = $this->ctrl->getNextClass($this);
391 $cmd = $this->ctrl->getCmd();
392 $this->prepareOutput();
393
394 if (!$this->rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
395 $this->ilias->raiseError($this->lng->txt("permission_denied"), $this->ilias->error_obj->MESSAGE);
396 }
397
398 switch ($next_class) {
399 case 'ilecssettingsgui':
400 $this->tabs_gui->setTabActive('ecs_server_settings');
401 include_once('./Services/WebServices/ECS/classes/class.ilECSSettingsGUI.php');
403 break;
404
405 case 'ilpermissiongui':
406 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
408 $ret = &$this->ctrl->forwardCommand($perm_gui);
409 $this->tabs_gui->setTabActive('perm_settings');
410 break;
411
412 default:
413 $this->tabs_gui->setTabActive('settings');
414 if (!$cmd || $cmd == 'view') {
415 $cmd = "editMaps";
416 }
417 $cmd .= "Object";
418 $this->$cmd();
419
420 break;
421 }
422 return true;
423 }
Definition: class.ilECSSettingsGUI.php:36
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
Definition: class.ilPermissionGUI.php:20
redirection script todo: (a better solution should control the processing via a xml file)
References $access, $ret, and ilObjectGUI\prepareOutput().
Here is the call graph for this function:
◆ getAdminTabs()
| ilObjExternalToolsSettingsGUI::getAdminTabs | ( | ) |
administration tabs show only permissions and trash folder
Reimplemented from ilObjectGUI.
Definition at line 59 of file class.ilObjExternalToolsSettingsGUI.php.
60 {
61 $this->getTabs();
62 }
References getTabs().
Here is the call graph for this function:
◆ getTabs()
| ilObjExternalToolsSettingsGUI::getTabs | ( | ) |
get tabs @access public
- Parameters
-
object tabs gui object
Reimplemented from ilObjectGUI.
Definition at line 69 of file class.ilObjExternalToolsSettingsGUI.php.
70 {
72
73 $this->ctrl->setParameter($this, "ref_id", $this->object->getRefId());
74
76 $this->tabs_gui->addTarget(
77 "settings",
78 $this->ctrl->getLinkTarget($this, "view"),
79 array("editMaps", "editMathJax", ""),
80 "",
81 ""
82 );
83 $this->lng->loadLanguageModule('ecs');
84 }
85
87 $this->tabs_gui->addTarget(
88 "perm_settings",
89 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"),
90 array("perm","info","owner"),
91 'ilpermissiongui'
92 );
93 }
94 }
$rbacsystem
Definition: class.ilObjExternalToolsSettingsGUI.php:23
References $rbacsystem.
Referenced by getAdminTabs().
Here is the caller graph for this function:
◆ saveMapsObject()
| ilObjExternalToolsSettingsGUI::saveMapsObject | ( | ) |
Save Maps Setttings.
Definition at line 342 of file class.ilObjExternalToolsSettingsGUI.php.
343 {
344 require_once("Services/Maps/classes/class.ilMapUtil.php");
345
347 if (ilUtil::stripSlashes($_POST["type"]) == 'openlayers' && 'openlayers' == ilMapUtil::getType()) {
350 } else {
352 }
353
360 }
static setStdGeolocationServer($a_geolocation)
Definition: class.ilMapUtil.php:136
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2408
References $_POST, ilObjectGUI\$ctrl, $ilCtrl, ilMapUtil\getType(), ilMapUtil\setActivated(), ilMapUtil\setApiKey(), ilMapUtil\setStdGeolocationServer(), ilMapUtil\setStdLatitude(), ilMapUtil\setStdLongitude(), ilMapUtil\setStdTileServers(), ilMapUtil\setStdZoom(), ilMapUtil\setType(), and ilUtil\stripSlashes().
Here is the call graph for this function:
◆ saveMathJaxObject()
| ilObjExternalToolsSettingsGUI::saveMathJaxObject | ( | ) |
Save MathJax Setttings.
Definition at line 217 of file class.ilObjExternalToolsSettingsGUI.php.
218 {
221 $ilAccess = $this->access;
222
223 if ($ilAccess->checkAccess("write", "", $this->object->getRefId())) {
225 // Client settings
230 }
232
233 // Server settings
237 $mathJaxSetting->set("server_for_browser", (bool) ilUtil::stripSlashes($_POST["server_for_browser"]));
238 $mathJaxSetting->set("server_for_export", (bool) ilUtil::stripSlashes($_POST["server_for_export"]));
240 }
242
244 }
246 }
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4503
References $_POST, $access, ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, $mathJaxSetting, ilUtil\sendInfo(), and ilUtil\stripSlashes().
Here is the call graph for this function:
Field Documentation
◆ $access
|
protected |
Definition at line 28 of file class.ilObjExternalToolsSettingsGUI.php.
Referenced by editMapsObject(), editMathJaxObject(), executeCommand(), and saveMathJaxObject().
◆ $rbacreview
|
protected |
Definition at line 33 of file class.ilObjExternalToolsSettingsGUI.php.
Referenced by editMathJaxObject().
◆ $rbacsystem
|
protected |
Definition at line 23 of file class.ilObjExternalToolsSettingsGUI.php.
Referenced by getTabs().
The documentation for this class was generated from the following file:
- Services/Administration/classes/class.ilObjExternalToolsSettingsGUI.php
