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_TOS = 16

const	FORM_CALENDAR = 17

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 117 of file class.ilAdministrationSettingsFormHandler.php.

References $data, $type, and SYSTEM_FOLDER_ID.

Referenced by ilObjTermsOfServiceGUI\getAdminTabs(), ilObjMailGUI\getGeneralSettingsForm(), ilObjAccessibilitySettingsGUI\getSettingsForm(), ilObjForumAdministrationGUI\getSettingsForm(), ilLDAPSettingsGUI\initForm(), ilMembershipAdministrationGUI\initFormSettings(), ilObjCalendarSettingsGUI\initFormSettings(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjPrivacySecurityGUI\initPrivacyForm(), ilObjRepositorySettingsGUI\initSettingsForm(), ilObjUserTrackingGUI\initSettingsForm(), ilObjMDSettingsGUI\initSettingsForm(), ilObjCertificateSettingsGUI\settings(), and ilObjPrivacySecurityGUI\showSecurity().

      : void {
         switch ($a_form_id) {
             case self::FORM_SECURITY:
                 $types = array(self::SETTINGS_USER, self::SETTINGS_FILE, self::SETTINGS_ROLE);
                 break;
 
             case self::FORM_PRIVACY:
                 $types = array(self::SETTINGS_ROLE, self::SETTINGS_FORUM, self::SETTINGS_LRES, self::SETTINGS_COMMENTS);
                 break;
 
             case self::FORM_TAGGING:
             case self::FORM_LP:
                 $types = array(self::SETTINGS_REPOSITORY);
                 break;
 
             case self::FORM_ACCESSIBILITY:
                 $types = array(self::SETTINGS_FORUM, self::SETTINGS_AUTH, self::SETTINGS_WIKI);
                 break;
 
             case self::FORM_MAIL:
                 $types = array(self::SETTINGS_COURSE, self::SETTINGS_GROUP, self::SETTINGS_LEARNINGSEQUENCE);
                 break;
 
             case self::FORM_COURSE:
                 $types = array(self::SETTINGS_PRIVACY_SECURITY, self::SETTINGS_CALENDAR, self::SETTINGS_GENERAL);
                 break;
 
             case self::FORM_GROUP:
                 $types = array(self::SETTINGS_PRIVACY_SECURITY, self::SETTINGS_CALENDAR, self::SETTINGS_GENERAL, self::SETTINGS_COURSE);
                 break;
 
             case self::FORM_WSP:
                 $types = array(self::SETTINGS_PORTFOLIO);
                 break;
 
             case self::FORM_CERTIFICATE:
                 $types = array(self::SETTINGS_LP_COMPLETION_STATUS);
                 break;
 
             case self::FORM_TOS:
                 $types = [self::SETTINGS_USER];
                 break;
 
             default:
                 $types = null;
                 break;
         }
 
         if (is_array($types)) {
             foreach ($types as $type) {
                 $gui = self::getSettingsGUIInstance($type);
                 if ($gui && method_exists($gui, "addToExternalSettingsForm")) {
                     $data = $gui->addToExternalSettingsForm($a_form_id);
                     if (is_array($data)) {
                         self::parseFieldDefinition($type, $a_form, $gui, $data);
                     }
                 }
             }
         }
 
         // cron jobs - special handling
 
         $parent_gui = new ilObjSystemFolderGUI(null, SYSTEM_FOLDER_ID, true);
         $parent_gui->setCreationMode(true);
 
         $gui = new ilCronManagerGUI();
         $data = $gui->addToExternalSettingsForm($a_form_id);
         if (is_array($data) && count($data)) {
             self::parseFieldDefinition("cron", $a_form, $parent_gui, $data);
         }
     }

Here is the caller graph for this function:

◆ getRefId()

static ilAdministrationSettingsFormHandler::getRefId ( string $a_obj_type )

staticprotected

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

                                                           : int
     {
         if (!isset(self::$OBJ_MAP)) {
             self::initObjectMap();
         }
         return self::$OBJ_MAP[$a_obj_type] ?? 0;
     }

◆ getSettingsGUIInstance()

static ilAdministrationSettingsFormHandler::getSettingsGUIInstance ( string $a_settings_obj_type )

static

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

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

Referenced by ilLDAPSettingsGUI\initForm().

                                                                               : ilObjectGUI
     {
         global $DIC;
 
         $objDefinition = $DIC["objDefinition"];
 
         $ref_id = self::getRefId($a_settings_obj_type);
         $obj_type = ilObject::_lookupType($ref_id, true);
 
         $class_name = $objDefinition->getClassName($obj_type);
         $class_name = "ilObj" . $class_name . "GUI";
         if (is_subclass_of($class_name, "ilObject2GUI")) {
             $gui_obj = new $class_name($ref_id, ilObject2GUI::REPOSITORY_NODE_ID);
         } else {
             $gui_obj = new $class_name([], $ref_id, true, false);
         }
 
         $gui_obj->setCreationMode(true);
 
         return $gui_obj;
     }

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 197 of file class.ilAdministrationSettingsFormHandler.php.

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

       {
         global $DIC;
 
         $lng = $DIC->language();
 
         switch ($a_field_type) {
             case self::VALUE_BOOL:
                 $a_field_value = $a_field_value ?
                     $lng->txt("enabled") :
                     $lng->txt("disabled");
                 return $a_field_value;
         }
 
         if (!is_numeric($a_field_value) &&
             $a_field_value !== null && !trim($a_field_value)) {
             $a_field_value = "-";
         }
 
         return is_numeric($a_field_value) || $a_field_value !== "";
     }

Here is the call graph for this function:

Field Documentation

◆ $OBJ_MAP

array ilAdministrationSettingsFormHandler::$OBJ_MAP

staticprotected

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

◆ FORM_ACCESSIBILITY

const ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY = 11

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

Referenced by ilObjAccessibilitySettingsGUI\getSettingsForm().

◆ FORM_CALENDAR

const ilAdministrationSettingsFormHandler::FORM_CALENDAR = 17

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

Referenced by ilCalendarCronRemoteReader\addToExternalSettingsForm(), and ilObjCalendarSettingsGUI\initFormSettings().

◆ FORM_CERTIFICATE

const ilAdministrationSettingsFormHandler::FORM_CERTIFICATE = 14

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

Referenced by ilObjUserTrackingGUI\addToExternalSettingsForm(), and ilObjCertificateSettingsGUI\settings().

◆ FORM_COURSE

const ilAdministrationSettingsFormHandler::FORM_COURSE = 6

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

Referenced by ilObjPrivacySecurityGUI\addToExternalSettingsForm(), ilObjCalendarSettingsGUI\addToExternalSettingsForm(), ilMembershipCronNotifications\addToExternalSettingsForm(), and ilObjCourseAdministrationGUI\getAdministrationFormId().

◆ FORM_FORUM

const ilAdministrationSettingsFormHandler::FORM_FORUM = 10

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

Referenced by ilForumCronNotification\addToExternalSettingsForm(), and ilObjForumAdministrationGUI\getSettingsForm().

◆ FORM_GROUP

const ilAdministrationSettingsFormHandler::FORM_GROUP = 7

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

Referenced by ilObjPrivacySecurityGUI\addToExternalSettingsForm(), ilObjCalendarSettingsGUI\addToExternalSettingsForm(), ilMembershipCronNotifications\addToExternalSettingsForm(), ilObjGroupAdministrationGUI\getAdministrationFormId(), and ilObjCourseAdministrationGUI\getChildSettingsInfo().

◆ FORM_LDAP

const ilAdministrationSettingsFormHandler::FORM_LDAP = 9

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

Referenced by ilLDAPCronSynchronization\addToExternalSettingsForm(), and ilLDAPSettingsGUI\initForm().

◆ FORM_LP

const ilAdministrationSettingsFormHandler::FORM_LP = 4

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

Referenced by ilObjRepositorySettingsGUI\addToExternalSettingsForm(), and ilObjUserTrackingGUI\initSettingsForm().

◆ FORM_MAIL

const ilAdministrationSettingsFormHandler::FORM_MAIL = 5

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

Referenced by ilMembershipAdministrationGUI\addToExternalSettingsForm(), and ilObjMailGUI\getGeneralSettingsForm().

◆ FORM_META_COPYRIGHT

const ilAdministrationSettingsFormHandler::FORM_META_COPYRIGHT = 15

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

Referenced by ilCronOerHarvester\addToExternalSettingsForm(), and ilObjMDSettingsGUI\getAdministrationFormId().

◆ FORM_PRIVACY

const ilAdministrationSettingsFormHandler::FORM_PRIVACY = 1

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

Referenced by ilObjCommentsSettingsGUI\addToExternalSettingsForm(), ilObjForumAdministrationGUI\addToExternalSettingsForm(), ilObjLearningResourcesSettingsGUI\addToExternalSettingsForm(), ilObjRoleFolderGUI\addToExternalSettingsForm(), and ilObjPrivacySecurityGUI\initPrivacyForm().

◆ FORM_REPOSITORY

const ilAdministrationSettingsFormHandler::FORM_REPOSITORY = 8

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

Referenced by ilObjRepositorySettingsGUI\initSettingsForm().

◆ FORM_SECURITY

const ilAdministrationSettingsFormHandler::FORM_SECURITY = 2

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

Referenced by ilObjRoleFolderGUI\addToExternalSettingsForm(), ilObjUserFolderGUI\addToExternalSettingsForm(), and ilObjPrivacySecurityGUI\showSecurity().

◆ FORM_TAGGING

const ilAdministrationSettingsFormHandler::FORM_TAGGING = 13

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

Referenced by ilObjRepositorySettingsGUI\addToExternalSettingsForm(), and ilObjTaggingSettingsGUI\initFormSettings().

◆ FORM_TOS

const ilAdministrationSettingsFormHandler::FORM_TOS = 16

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

Referenced by ilObjUserFolderGUI\addToExternalSettingsForm(), and ilObjTermsOfServiceGUI\getAdminTabs().

◆ FORM_WSP

const ilAdministrationSettingsFormHandler::FORM_WSP = 12

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

Referenced by ilObjPortfolioAdministrationGUI\addToExternalSettingsForm().

◆ SETTINGS_AUTH

const ilAdministrationSettingsFormHandler::SETTINGS_AUTH = "auth"

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

◆ SETTINGS_CALENDAR

const ilAdministrationSettingsFormHandler::SETTINGS_CALENDAR = "cals"

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

◆ SETTINGS_COMMENTS

const ilAdministrationSettingsFormHandler::SETTINGS_COMMENTS = "coms"

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

◆ SETTINGS_COURSE

const ilAdministrationSettingsFormHandler::SETTINGS_COURSE = "crss"

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

◆ SETTINGS_FILE

const ilAdministrationSettingsFormHandler::SETTINGS_FILE = "facs"

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

◆ SETTINGS_FORUM

const ilAdministrationSettingsFormHandler::SETTINGS_FORUM = "frma"

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

◆ SETTINGS_GENERAL

const ilAdministrationSettingsFormHandler::SETTINGS_GENERAL = "adm"

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

◆ SETTINGS_GROUP

const ilAdministrationSettingsFormHandler::SETTINGS_GROUP = "grps"

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

◆ SETTINGS_LEARNINGSEQUENCE

const ilAdministrationSettingsFormHandler::SETTINGS_LEARNINGSEQUENCE = "lsos"

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

◆ SETTINGS_LP_COMPLETION_STATUS

const ilAdministrationSettingsFormHandler::SETTINGS_LP_COMPLETION_STATUS = "trac"

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

◆ SETTINGS_LRES

const ilAdministrationSettingsFormHandler::SETTINGS_LRES = "lrss"

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

◆ SETTINGS_PORTFOLIO

const ilAdministrationSettingsFormHandler::SETTINGS_PORTFOLIO = "prfa"

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

◆ SETTINGS_PR

const ilAdministrationSettingsFormHandler::SETTINGS_PR = "prss"

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

◆ SETTINGS_PRIVACY_SECURITY

const ilAdministrationSettingsFormHandler::SETTINGS_PRIVACY_SECURITY = "ps"

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

◆ SETTINGS_REPOSITORY

const ilAdministrationSettingsFormHandler::SETTINGS_REPOSITORY = "reps"

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

◆ SETTINGS_ROLE

const ilAdministrationSettingsFormHandler::SETTINGS_ROLE = "rolf"

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

◆ SETTINGS_USER

const ilAdministrationSettingsFormHandler::SETTINGS_USER = "usrf"

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

◆ SETTINGS_WIKI

const ilAdministrationSettingsFormHandler::SETTINGS_WIKI = "wiks"

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

◆ VALUE_BOOL

const ilAdministrationSettingsFormHandler::VALUE_BOOL = "bool"

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

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

Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ addFieldsToForm()

◆ getRefId()

◆ getSettingsGUIInstance()

◆ parseFieldValue()

Field Documentation

◆ $OBJ_MAP

◆ FORM_ACCESSIBILITY

◆ FORM_CALENDAR

◆ FORM_CERTIFICATE

◆ FORM_COURSE

◆ FORM_FORUM

◆ FORM_GROUP

◆ FORM_LDAP

◆ FORM_LP

◆ FORM_MAIL

◆ FORM_META_COPYRIGHT

◆ FORM_PRIVACY

◆ FORM_REPOSITORY

◆ FORM_SECURITY

◆ FORM_TAGGING

◆ FORM_TOS

◆ FORM_WSP

◆ SETTINGS_AUTH

◆ SETTINGS_CALENDAR

◆ SETTINGS_COMMENTS

◆ SETTINGS_COURSE

◆ SETTINGS_FILE

◆ SETTINGS_FORUM

◆ SETTINGS_GENERAL

◆ SETTINGS_GROUP

◆ SETTINGS_LEARNINGSEQUENCE

◆ SETTINGS_LP_COMPLETION_STATUS

◆ SETTINGS_LRES

◆ SETTINGS_PORTFOLIO

◆ SETTINGS_PR

◆ SETTINGS_PRIVACY_SECURITY

◆ SETTINGS_REPOSITORY

◆ SETTINGS_ROLE

◆ SETTINGS_USER

◆ SETTINGS_WIKI

◆ VALUE_BOOL