ILIAS  trunk Revision v5.2.0beta1-34115-g3a2438be29
ilAdministrationSettingsFormHandler Class Reference

Administration settings form handler. More...

+ Collaboration diagram for ilAdministrationSettingsFormHandler:

Static Public Member Functions

static getSettingsGUIInstance (string $a_settings_obj_type)
 
static addFieldsToForm (int $a_form_id, ilPropertyFormGUI $a_form, ilObjectGUI $a_parent_gui)
 

Data Fields

const FORM_PRIVACY = 1
 
const FORM_SECURITY = 2
 
const FORM_LP = 4
 
const FORM_MAIL = 5
 
const FORM_COURSE = 6
 
const FORM_GROUP = 7
 
const FORM_REPOSITORY = 8
 
const FORM_LDAP = 9
 
const FORM_FORUM = 10
 
const FORM_ACCESSIBILITY = 11
 
const FORM_WSP = 12
 
const FORM_TAGGING = 13
 
const FORM_CERTIFICATE = 14
 
const FORM_META_COPYRIGHT = 15
 
const FORM_CALENDAR = 17
 
const FORM_PRG = 18
 
const SETTINGS_USER = "usrf"
 
const SETTINGS_GENERAL = "adm"
 
const SETTINGS_FILE = "facs"
 
const SETTINGS_ROLE = "rolf"
 
const SETTINGS_FORUM = "frma"
 
const SETTINGS_LRES = "lrss"
 
const SETTINGS_REPOSITORY = "reps"
 
const SETTINGS_PR = "prss"
 
const SETTINGS_COURSE = "crss"
 
const SETTINGS_GROUP = "grps"
 
const SETTINGS_PRIVACY_SECURITY = "ps"
 
const SETTINGS_CALENDAR = "cals"
 
const SETTINGS_AUTH = "auth"
 
const SETTINGS_WIKI = "wiks"
 
const SETTINGS_PORTFOLIO = "prfa"
 
const SETTINGS_LP_COMPLETION_STATUS = "trac"
 
const SETTINGS_LEARNINGSEQUENCE = "lsos"
 
const SETTINGS_COMMENTS = "coms"
 
const VALUE_BOOL = "bool"
 

Static Protected Member Functions

static getRefId (string $a_obj_type)
 
static parseFieldValue (?string $a_field_type, &$a_field_value)
 

Static Protected Attributes

static array $OBJ_MAP
 

Detailed Description

Administration settings form handler.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilAdministrationSettingsFormHandler.php.

Member Function Documentation

◆ addFieldsToForm()

static ilAdministrationSettingsFormHandler::addFieldsToForm ( int  $a_form_id,
ilPropertyFormGUI  $a_form,
ilObjectGUI  $a_parent_gui 
)
static

Definition at line 116 of file class.ilAdministrationSettingsFormHandler.php.

References $data, and SYSTEM_FOLDER_ID.

Referenced by ilObjMailGUI\getGeneralSettingsForm(), ilObjAccessibilitySettingsGUI\getSettingsForm(), ilLDAPSettingsGUI\initForm(), ilObjStudyProgrammeAdminGUI\initFormSettings(), ilMembershipAdministrationGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjPrivacySecurityGUI\initPrivacyForm(), ilObjUserTrackingGUI\initSettingsForm(), ilMDCopyrightSelectionGUI\initSettingsForm(), ilObjCertificateSettingsGUI\settings(), and ilObjPrivacySecurityGUI\showSecurity().

120  : void {
121  switch ($a_form_id) {
122  case self::FORM_SECURITY:
123  $types = array(self::SETTINGS_USER, self::SETTINGS_FILE, self::SETTINGS_ROLE);
124  break;
125 
126  case self::FORM_PRIVACY:
127  $types = array(self::SETTINGS_ROLE, self::SETTINGS_FORUM, self::SETTINGS_LRES, self::SETTINGS_COMMENTS);
128  break;
129 
130  case self::FORM_TAGGING:
131  case self::FORM_LP:
132  $types = array(self::SETTINGS_REPOSITORY);
133  break;
134 
135  case self::FORM_ACCESSIBILITY:
136  $types = array(self::SETTINGS_FORUM, self::SETTINGS_AUTH, self::SETTINGS_WIKI);
137  break;
138 
139  case self::FORM_MAIL:
140  $types = array(self::SETTINGS_COURSE, self::SETTINGS_GROUP, self::SETTINGS_LEARNINGSEQUENCE);
141  break;
142 
143  case self::FORM_COURSE:
144  $types = array(self::SETTINGS_PRIVACY_SECURITY, self::SETTINGS_CALENDAR, self::SETTINGS_GENERAL);
145  break;
146 
147  case self::FORM_GROUP:
148  $types = array(self::SETTINGS_PRIVACY_SECURITY, self::SETTINGS_CALENDAR, self::SETTINGS_GENERAL, self::SETTINGS_COURSE);
149  break;
150 
151  case self::FORM_WSP:
152  $types = array(self::SETTINGS_PORTFOLIO);
153  break;
154 
155  case self::FORM_CERTIFICATE:
156  $types = array(self::SETTINGS_LP_COMPLETION_STATUS);
157  break;
158 
159  case self::FORM_PRG:
160  $types = array(self::SETTINGS_PRIVACY_SECURITY);
161  break;
162 
163  default:
164  $types = null;
165  break;
166  }
167 
168  if (is_array($types)) {
169  foreach ($types as $type) {
170  $gui = self::getSettingsGUIInstance($type);
171  if ($gui && method_exists($gui, "addToExternalSettingsForm")) {
172  $data = $gui->addToExternalSettingsForm($a_form_id);
173  if (is_array($data)) {
174  self::parseFieldDefinition($type, $a_form, $gui, $data);
175  }
176  }
177  }
178  }
179 
180  // cron jobs - special handling
181 
182  $parent_gui = new ilObjSystemFolderGUI(null, SYSTEM_FOLDER_ID, true);
183  $parent_gui->setCreationMode(true);
184 
185  $gui = new ilCronManagerGUI();
186  $data = $gui->addToExternalSettingsForm($a_form_id);
187  if (is_array($data) && count($data)) {
188  self::parseFieldDefinition("cron", $a_form, $parent_gui, $data);
189  }
190  }
const SYSTEM_FOLDER_ID
Definition: constants.php:35
Class ilObjSystemFolderGUI.
Class ilCronManagerGUI.
+ Here is the caller graph for this function:

◆ getRefId()

static ilAdministrationSettingsFormHandler::getRefId ( string  $a_obj_type)
staticprotected

Definition at line 86 of file class.ilAdministrationSettingsFormHandler.php.

86  : int
87  {
88  if (!isset(self::$OBJ_MAP)) {
89  self::initObjectMap();
90  }
91  return self::$OBJ_MAP[$a_obj_type] ?? 0;
92  }

◆ getSettingsGUIInstance()

static ilAdministrationSettingsFormHandler::getSettingsGUIInstance ( string  $a_settings_obj_type)
static

Definition at line 94 of file class.ilAdministrationSettingsFormHandler.php.

References $DIC, $ref_id, ilObject\_lookupType(), and ilObject2GUI\REPOSITORY_NODE_ID.

Referenced by ilLDAPSettingsGUI\initForm(), and ilObjBlogAdministrationGUI\initFormSettings().

94  : ilObjectGUI
95  {
96  global $DIC;
97 
98  $objDefinition = $DIC["objDefinition"];
99 
100  $ref_id = self::getRefId($a_settings_obj_type);
101  $obj_type = ilObject::_lookupType($ref_id, true);
102 
103  $class_name = $objDefinition->getClassName($obj_type);
104  $class_name = "ilObj" . $class_name . "GUI";
105  if (is_subclass_of($class_name, "ilObject2GUI")) {
106  $gui_obj = new $class_name($ref_id, ilObject2GUI::REPOSITORY_NODE_ID);
107  } else {
108  $gui_obj = new $class_name([], $ref_id, true, false);
109  }
110 
111  $gui_obj->setCreationMode(true);
112 
113  return $gui_obj;
114  }
$ref_id
Definition: ltiauth.php:65
Class ilObjectGUI Basic methods of all Output classes.
$DIC
Definition: xapitoken.php:62
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseFieldValue()

static ilAdministrationSettingsFormHandler::parseFieldValue ( ?string  $a_field_type,
$a_field_value 
)
staticprotected
Parameters
mixed$a_field_value
Returns
mixed

Definition at line 196 of file class.ilAdministrationSettingsFormHandler.php.

References $DIC, $lng, ilPropertyFormGUI\addItem(), ilLogLevel\ERROR, ilLoggerFactory\getLogger(), and ilObjectGUI\getObject().

199  {
200  global $DIC;
201 
202  $lng = $DIC->language();
203 
204  switch ($a_field_type) {
205  case self::VALUE_BOOL:
206  $a_field_value = $a_field_value ?
207  $lng->txt("enabled") :
208  $lng->txt("disabled");
209  return $a_field_value;
210  }
211 
212  if (!is_numeric($a_field_value) &&
213  $a_field_value !== null && !trim($a_field_value)) {
214  $a_field_value = "-";
215  }
216 
217  return is_numeric($a_field_value) || $a_field_value !== "";
218  }
$lng
$DIC
Definition: xapitoken.php:62
+ Here is the call graph for this function:

Field Documentation

◆ $OBJ_MAP

array ilAdministrationSettingsFormHandler::$OBJ_MAP
staticprotected

◆ FORM_ACCESSIBILITY

const ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY = 11

◆ FORM_CALENDAR

const ilAdministrationSettingsFormHandler::FORM_CALENDAR = 17

◆ FORM_CERTIFICATE

const ilAdministrationSettingsFormHandler::FORM_CERTIFICATE = 14

◆ FORM_COURSE

◆ FORM_FORUM

const ilAdministrationSettingsFormHandler::FORM_FORUM = 10

◆ FORM_GROUP

◆ FORM_LDAP

const ilAdministrationSettingsFormHandler::FORM_LDAP = 9

◆ FORM_LP

const ilAdministrationSettingsFormHandler::FORM_LP = 4

◆ FORM_MAIL

const ilAdministrationSettingsFormHandler::FORM_MAIL = 5

◆ FORM_META_COPYRIGHT

const ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT = 15

◆ FORM_PRG

const ilAdministrationSettingsFormHandler::FORM_PRG = 18

◆ FORM_PRIVACY

◆ FORM_REPOSITORY

const ilAdministrationSettingsFormHandler::FORM_REPOSITORY = 8

◆ FORM_SECURITY

◆ FORM_TAGGING

const ilAdministrationSettingsFormHandler::FORM_TAGGING = 13

◆ FORM_WSP

const ilAdministrationSettingsFormHandler::FORM_WSP = 12

◆ SETTINGS_AUTH

const ilAdministrationSettingsFormHandler::SETTINGS_AUTH = "auth"

◆ SETTINGS_CALENDAR

const ilAdministrationSettingsFormHandler::SETTINGS_CALENDAR = "cals"

◆ SETTINGS_COMMENTS

const ilAdministrationSettingsFormHandler::SETTINGS_COMMENTS = "coms"

◆ SETTINGS_COURSE

const ilAdministrationSettingsFormHandler::SETTINGS_COURSE = "crss"

◆ SETTINGS_FILE

const ilAdministrationSettingsFormHandler::SETTINGS_FILE = "facs"

◆ SETTINGS_FORUM

const ilAdministrationSettingsFormHandler::SETTINGS_FORUM = "frma"

◆ SETTINGS_GENERAL

const ilAdministrationSettingsFormHandler::SETTINGS_GENERAL = "adm"

◆ SETTINGS_GROUP

const ilAdministrationSettingsFormHandler::SETTINGS_GROUP = "grps"

◆ SETTINGS_LEARNINGSEQUENCE

const ilAdministrationSettingsFormHandler::SETTINGS_LEARNINGSEQUENCE = "lsos"

◆ SETTINGS_LP_COMPLETION_STATUS

const ilAdministrationSettingsFormHandler::SETTINGS_LP_COMPLETION_STATUS = "trac"

◆ SETTINGS_LRES

const ilAdministrationSettingsFormHandler::SETTINGS_LRES = "lrss"

◆ SETTINGS_PORTFOLIO

const ilAdministrationSettingsFormHandler::SETTINGS_PORTFOLIO = "prfa"

◆ SETTINGS_PR

const ilAdministrationSettingsFormHandler::SETTINGS_PR = "prss"

◆ SETTINGS_PRIVACY_SECURITY

const ilAdministrationSettingsFormHandler::SETTINGS_PRIVACY_SECURITY = "ps"

◆ SETTINGS_REPOSITORY

const ilAdministrationSettingsFormHandler::SETTINGS_REPOSITORY = "reps"

◆ SETTINGS_ROLE

const ilAdministrationSettingsFormHandler::SETTINGS_ROLE = "rolf"

◆ SETTINGS_USER

const ilAdministrationSettingsFormHandler::SETTINGS_USER = "usrf"

◆ SETTINGS_WIKI

const ilAdministrationSettingsFormHandler::SETTINGS_WIKI = "wiks"

◆ VALUE_BOOL


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