ILIAS  release_4-4 Revision
ilObjAccessibilitySettingsGUI Class Reference

Accessibility Settings. More...

+ Inheritance diagram for ilObjAccessibilitySettingsGUI:
+ Collaboration diagram for ilObjAccessibilitySettingsGUI:

Public Member Functions

 __construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Contructor. More...
 
 executeCommand ()
 Execute command. More...
 
 getAdminTabs ()
 Get tabs. More...
 
 editAccessKeys ()
 Edit access keys. More...
 
 saveAccessKeys ()
 Save access keys. More...
 
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public. More...
 
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...
 
 getAdminTabs (&$tabs_gui)
 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 ($in_rep=false)
 cancel action and go back to previous page 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...
 
 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...
 

Protected Member Functions

 getSettingsForm ()
 
 editAccessibilitySettings (ilPropertyFormGUI $form=null)
 
- Protected Member Functions inherited from ilObjectGUI
 assignObject ()
 
 prepareOutput ()
 prepare output More...
 
 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 public More...
 
 setAdminTabs ()
 set admin tabs 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...
 
 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)
 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...
 
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste More...
 
 getTabs (&$tabs_gui)
 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 ($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...
 

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
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

ilObjAccessibilitySettingsGUI::__construct (   $a_data,
  $a_id,
  $a_call_by_reference = true,
  $a_prepare_output = true 
)

Contructor.

public

Definition at line 24 of file class.ilObjAccessibilitySettingsGUI.php.

25  {
26  $this->type = 'accs';
27  parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
28 
29  $this->lng->loadLanguageModule('acc');
30  }

Member Function Documentation

◆ editAccessibilitySettings()

ilObjAccessibilitySettingsGUI::editAccessibilitySettings ( ilPropertyFormGUI  $form = null)
protected
Parameters
ilPropertyFormGUI$form

Definition at line 95 of file class.ilObjAccessibilitySettingsGUI.php.

References getSettingsForm().

96  {
97  $this->tabs_gui->setTabActive('acc_settings');
98  if(!$form)
99  {
100  $form = $this->getSettingsForm();
101  }
102 
103  $this->tpl->setContent($form->getHTML());
104  }
+ Here is the call graph for this function:

◆ editAccessKeys()

ilObjAccessibilitySettingsGUI::editAccessKeys ( )

Edit access keys.

Definition at line 139 of file class.ilObjAccessibilitySettingsGUI.php.

References ilObjectGUI\$tpl.

140  {
141  global $tpl;
142 
143  $this->tabs_gui->setTabActive('acc_access_keys');
144 
145  include_once("./Services/Accessibility/classes/class.ilAccessKeyTableGUI.php");
146  $table = new ilAccessKeyTableGUI($this, "editAccessKeys");
147 
148  $tpl->setContent($table->getHTML());
149  }
TableGUI class for access keys.

◆ executeCommand()

ilObjAccessibilitySettingsGUI::executeCommand ( )

Execute command.

public

Definition at line 38 of file class.ilObjAccessibilitySettingsGUI.php.

References $cmd, $ilErr, $ret, and ilObjectGUI\prepareOutput().

39  {
40  global $rbacsystem,$ilErr,$ilAccess;
41 
42  $next_class = $this->ctrl->getNextClass($this);
43  $cmd = $this->ctrl->getCmd();
44 
45  $this->prepareOutput();
46 
47  if(!$ilAccess->checkAccess('read','',$this->object->getRefId()))
48  {
49  $ilErr->raiseError($this->lng->txt('no_permission'),$ilErr->WARNING);
50  }
51 
52  switch($next_class)
53  {
54  case 'ilpermissiongui':
55  $this->tabs_gui->setTabActive('perm_settings');
56  include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
57  $perm_gui =& new ilPermissionGUI($this);
58  $ret =& $this->ctrl->forwardCommand($perm_gui);
59  break;
60 
61  default:
62  if(!$cmd || $cmd == 'view')
63  {
64  $cmd = "editAccessibilitySettings";
65  }
66 
67  $this->$cmd();
68  break;
69  }
70  return true;
71  }
$cmd
Definition: sahs_server.php:35
prepareOutput()
prepare output
New PermissionGUI (extends from old ilPermission2GUI) RBAC related output.
+ Here is the call graph for this function:

◆ getAdminTabs()

ilObjAccessibilitySettingsGUI::getAdminTabs ( )

Get tabs.

public

Definition at line 112 of file class.ilObjAccessibilitySettingsGUI.php.

113  {
114  global $rbacsystem, $ilAccess, $ilTabs;
115 
116  if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
117  {
118  $ilTabs->addTab('acc_settings', $this->lng->txt('settings'), $this->ctrl->getLinkTarget($this, 'editAccessibilitySettings'));
119  }
120 
121  if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
122  {
123  $ilTabs->addTarget("acc_access_keys",
124  $this->ctrl->getLinkTarget($this, "editAccessKeys"),
125  array("editAccessKeys", "view"));
126  }
127 
128  if ($ilAccess->checkAccess('edit_permission', "", $this->object->getRefId()))
129  {
130  $ilTabs->addTarget("perm_settings",
131  $this->ctrl->getLinkTargetByClass('ilpermissiongui',"perm"),
132  array(),'ilpermissiongui');
133  }
134  }

◆ getSettingsForm()

ilObjAccessibilitySettingsGUI::getSettingsForm ( )
protected
Returns
ilPropertyFormGUI

Definition at line 76 of file class.ilObjAccessibilitySettingsGUI.php.

References ilAdministrationSettingsFormHandler\addFieldsToForm(), and ilAdministrationSettingsFormHandler\FORM_ACCESSIBILITY.

Referenced by editAccessibilitySettings().

77  {
78  require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
79  $form = new ilPropertyFormGUI();
80  $form->setTitle($this->lng->txt('settings'));
81 
82  require_once 'Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php';
85  $form,
86  $this
87  );
88 
89  return $form;
90  }
This class represents a property form user interface.
static addFieldsToForm($a_form_id, ilPropertyFormGUI $a_form, ilObjectGUI $a_parent_gui)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ saveAccessKeys()

ilObjAccessibilitySettingsGUI::saveAccessKeys ( )

Save access keys.

Definition at line 154 of file class.ilObjAccessibilitySettingsGUI.php.

References $_GET, $_POST, $ilCtrl, ilObjectGUI\$lng, ilUtil\sendSuccess(), ilUtil\stripSlashesArray(), and ilAccessKey\writeKeys().

155  {
156  global $ilCtrl, $lng, $ilAccess;
157 
158  if ($ilAccess->checkAccess("write", "", $_GET["ref_id"]))
159  {
160  include_once("./Services/Accessibility/classes/class.ilAccessKey.php");
162  ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
163  }
164  $ilCtrl->redirect($this, "editAccessKeys");
165  }
static sendSuccess($a_info="", $a_keep=false)
Send Success Message to Screen.
$_POST['username']
Definition: cron.php:12
$_GET["client_id"]
static writeKeys($a_keys, $a_lang_key="0")
Write keys.
global $ilCtrl
Definition: ilias.php:18
static stripSlashesArray($a_arr, $a_strip_html=true, $a_allow="")
Strip slashes from array.
+ Here is the call graph for this function:

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