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... | |
| 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 () | |
| list childs of current object More... | |
| deleteObject ($a_error=false) | |
| Display deletion confirmation screen. More... | |
| cloneAllObject () | |
| Clone single (not container object) Method is overwritten in ilContainerGUI. More... | |
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 |
| $ilias | |
| $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 | |
| 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... | |
| showMountWebfolderIcon () | |
| 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... | |
| 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... | |
| 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... | |
| Protected Attributes inherited from ilObjectGUI | |
| $tmp_import_dir | |
| $tabs_gui = null | |
| $ctrl | |
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 24 of file class.ilObjExternalToolsSettingsGUI.php.
25 {
26 global $lng;
27
28 $this->type = "extt";
29 parent::__construct($a_data,$a_id,$a_call_by_reference,false);
30
34 }
References ilObjectGUI\$lng.
Member Function Documentation
◆ __initSubTabs()
| ilObjExternalToolsSettingsGUI::__initSubTabs | ( | $a_cmd | ) |
Definition at line 328 of file class.ilObjExternalToolsSettingsGUI.php.
329 {
330 $maps = ($a_cmd == 'editMaps') ? true : false;
331 $mathjax = ($a_cmd == 'editMathJax') ? true : false;
332
333 $this->tabs_gui->addSubTabTarget("maps_extt_maps", $this->ctrl->getLinkTarget($this, "editMaps"),
334 "", "", "", $maps);
335 $this->tabs_gui->addSubTabTarget("mathjax_mathjax", $this->ctrl->getLinkTarget($this, "editMathJax"),
336 "", "", "", $mathjax);
337 }
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 220 of file class.ilObjExternalToolsSettingsGUI.php.
221 {
222 global $lng;
223
224 include_once './Services/MathJax/classes/class.ilMathJax.php';
225 ilMathJax::getInstance()->clearCache();
226
228 $this->ctrl->redirect($this, 'editMathJax');
229 }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
Definition: class.ilUtil.php:4801
References ilObjectGUI\$lng, ilMathJax\getInstance(), and ilUtil\sendSuccess().
Here is the call graph for this function:
◆ editMapsObject()
| ilObjExternalToolsSettingsGUI::editMapsObject | ( | ) |
Configure maps settings.
@access public
Definition at line 236 of file class.ilObjExternalToolsSettingsGUI.php.
237 {
238 require_once("Services/Maps/classes/class.ilMapUtil.php");
239
241
243 $std_latitude = ilMapUtil::getStdLatitude();
244 $std_longitude = ilMapUtil::getStdLongitude();
245 $std_zoom = ilMapUtil::getStdZoom();
246 $type = ilMapUtil::getType();
247
248 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
249 include_once("./Services/Form/classes/class.ilCheckboxOption.php");
251 $form->setFormAction($ilCtrl->getFormAction($this));
253
254 // Enable Maps
256 $enable->setChecked(ilMapUtil::isActivated());
258 $form->addItem($enable);
259
260 // Select type
262 $types->setOptions(ilMapUtil::getAvailableMapTypes());
263 $types->setValue($type);
264 $form->addItem($types);
265
266 // map data server property
267 if($type == "openlayers") {
269 $tile->setValue(ilMapUtil::getStdTileServers());
272 $geolocation->setValue(ilMapUtil::getStdGeolocationServer());
274
275 $form->addItem($tile);
276 $form->addItem($geolocation);
277 } else {
278 // api key for google
280 $key->setMaxLength(200);
281 $key->setValue(ilMapUtil::getApiKey());
282 $form->addItem($key);
283 }
284
285 // location property
287 "std_location");
288
289 $loc_prop->setLatitude($std_latitude);
290 $loc_prop->setLongitude($std_longitude);
291 $loc_prop->setZoom($std_zoom);
292 $form->addItem($loc_prop);
293
294 if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
295 {
298 }
299
301 }
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:145
static getStdTileServers()
Returns the tile server to be used in the installation.
Definition: class.ilMapUtil.php:128
static getAvailableMapTypes()
Get a dict { $id => $name } for available maps services.
Definition: class.ilMapUtil.php:191
__initSubTabs($a_cmd)
Definition: class.ilObjExternalToolsSettingsGUI.php:328
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 $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, __initSubTabs(), ilMapUtil\DEFAULT_TILE, ilMapUtil\getApiKey(), ilMapUtil\getAvailableMapTypes(), ilMapUtil\getStdGeolocationServer(), ilMapUtil\getStdLatitude(), ilMapUtil\getStdLongitude(), ilMapUtil\getStdTileServers(), ilMapUtil\getStdZoom(), ilMapUtil\getType(), ilMapUtil\isActivated(), and sprintf.
Here is the call graph for this function:
◆ editMathJaxObject()
| ilObjExternalToolsSettingsGUI::editMathJaxObject | ( | ) |
Configure MathJax settings.
Definition at line 70 of file class.ilObjExternalToolsSettingsGUI.php.
71 {
73
76
78
79 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
81 $form->setFormAction($ilCtrl->getFormAction($this));
83
84 // Enable MathJax
87 $enable->setInfo($lng->txt("mathjax_enable_mathjax_info")." <a target='blank' href='http://www.mathjax.org/'>"
88 .$lng->txt("mathjax_home_link")."</a>");
89 $form->addItem($enable);
90
91 // Path to mathjax
94 $text_prop->setValue($path_to_mathjax);
95 $text_prop->setRequired(true);
96 $text_prop->setMaxLength(400);
97 $text_prop->setSize(100);
98 $enable->addSubItem($text_prop);
99
100 // mathjax limiter
101 $options = array(
102 0 => '\​(...\​)',
103 1 => '[tex]...[/tex]',
104 2 => '<span class="math">...</span>'
105 );
110 $enable->addSubItem($si);
111
112 include_once './Services/MathJax/classes/class.ilMathJax.php';
113 $install_link = ' <a target="_blank" href="Services/MathJax/docs/Install-MathJax-Server.txt">'
114 .$lng->txt("mathjax_server_installation").'</a>';
115 $clear_cache_link = ' <a href="'.$this->ctrl->getLinkTarget($this,'clearMathJaxCache').'"">'
116 .$lng->txt("mathjax_server_clear_cache").'</a>';
117
118 // Enable Server MathJax
122
123 $form->addItem($server);
124
125 // Path to Server MathJax
129 $text_prop->setRequired(true);
130 $text_prop->setMaxLength(400);
131 $text_prop->setSize(100);
132 $server->addSubItem($text_prop);
133
134 // Server Timeout
137 $number_prop->setValue($mathJaxSetting->get("server_timeout") ? (int) $mathJaxSetting->get("server_timeout") : 5);
138 $number_prop->setRequired(true);
139 $number_prop->setSize(3);
140 $server->addSubItem($number_prop);
141
142 // Server for Browser
143 $checkbox = new ilCheckboxInputGUI($lng->txt("mathjax_server_for_browser"),"server_for_browser");
146 $server->addSubItem($checkbox);
147
148 // Server for HTML Export
152 $server->addSubItem($checkbox);
153
154 // Server for PDF
158 $server->addSubItem($checkbox);
159
160 // Cache Size / Clear Cache
165
166 // Test expression
168 include_once './Services/MathJax/classes/class.ilMathJax.php';
169 $html = ilMathJax::getInstance()->insertLatexImages('[tex]f(x)=\int_{-\infty}^x e^{-t^2}dt[/tex]');
172 $form->addItem($test);
173
174 if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
175 {
177 }
178
180 }
if(strpos( $jquery_path, './')===0) else if(strpos($jquery_path, '.')===0) $mathJaxSetting
Definition: latex.php:36
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
References $html, $ilCtrl, ilObjectGUI\$lng, $mathJaxSetting, $options, $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 339 of file class.ilObjExternalToolsSettingsGUI.php.
340 {
341 global $ilAccess;
342
343 $next_class = $this->ctrl->getNextClass($this);
344 $cmd = $this->ctrl->getCmd();
345 $this->prepareOutput();
346
347 if (!$ilAccess->checkAccess("read", "", $this->object->getRefId()))
348 {
349 $this->ilias->raiseError($this->lng->txt("permission_denied"),$this->ilias->error_obj->MESSAGE);
350 }
351
352 switch($next_class)
353 {
354 case 'ilecssettingsgui':
355 $this->tabs_gui->setTabActive('ecs_server_settings');
356 include_once('./Services/WebServices/ECS/classes/class.ilECSSettingsGUI.php');
358 break;
359
360 case 'ilpermissiongui':
361 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
363 $ret =& $this->ctrl->forwardCommand($perm_gui);
364 $this->tabs_gui->setTabActive('perm_settings');
365 break;
366
367 default:
368 $this->tabs_gui->setTabActive('settings');
370 {
372 }
374 $this->$cmd();
375
376 break;
377 }
378 return true;
379 }
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 $cmd, $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 36 of file class.ilObjExternalToolsSettingsGUI.php.
37 {
38 $this->getTabs();
39 }
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 46 of file class.ilObjExternalToolsSettingsGUI.php.
47 {
48 global $rbacsystem;
49
50 $this->ctrl->setParameter($this,"ref_id",$this->object->getRefId());
51
52 if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
53 {
54 $this->tabs_gui->addTarget("settings",
55 $this->ctrl->getLinkTarget($this, "view"),
56 array("editMaps", "editMathJax", ""), "", "");
57 $this->lng->loadLanguageModule('ecs');
58 }
59
60 if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
61 {
62 $this->tabs_gui->addTarget("perm_settings",
63 $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm"), array("perm","info","owner"), 'ilpermissiongui');
64 }
65 }
Referenced by getAdminTabs().
Here is the caller graph for this function:
◆ saveMapsObject()
| ilObjExternalToolsSettingsGUI::saveMapsObject | ( | ) |
Save Maps Setttings.
Definition at line 307 of file class.ilObjExternalToolsSettingsGUI.php.
308 {
309 require_once("Services/Maps/classes/class.ilMapUtil.php");
310
311 global $ilCtrl;
312 if(ilUtil::stripSlashes($_POST["type"]) == 'openlayers' && 'openlayers' == ilMapUtil::getType()) {
315 } else {
317 }
318
325 }
static setStdGeolocationServer($a_geolocation)
Definition: class.ilMapUtil.php:135
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2639
References $_POST, $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 185 of file class.ilObjExternalToolsSettingsGUI.php.
186 {
188
189 if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
190 {
192 // Client settings
195 {
198 }
200
201 // Server settings
203 {
206 $mathJaxSetting->set("server_for_browser", (bool) ilUtil::stripSlashes($_POST["server_for_browser"]));
207 $mathJaxSetting->set("server_for_export", (bool) ilUtil::stripSlashes($_POST["server_for_export"]));
209 }
211
213 }
215 }
static sendInfo($a_info="", $a_keep=false)
Send Info Message to Screen.
Definition: class.ilUtil.php:4757
References $_POST, $ilCtrl, ilObjectGUI\$lng, $mathJaxSetting, ilUtil\sendInfo(), and ilUtil\stripSlashes().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Services/Administration/classes/class.ilObjExternalToolsSettingsGUI.php
