ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Static Public Member Functions | Data Fields | Static Protected Member Functions | Static Protected Attributes
ilAdministrationSettingsFormHandler Class Reference

Administration settings form handler. More...

+ Collaboration diagram for ilAdministrationSettingsFormHandler:

Static Public Member Functions

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

Data Fields

const FORM_PRIVACY = 1
const FORM_SECURITY = 2
const FORM_FILES_QUOTA = 3
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 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_PD = "pdts"
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 VALUE_BOOL = "bool"

Static Protected Member Functions

static initObjectMap ()
static getRefId ($a_obj_type)
static parseFieldValue ($a_field_type, &$a_field_value)
static parseFieldDefinition ($a_type, ilPropertyFormGUI $a_form, ilObjectGUI $a_gui, $a_data)

Static Protected Attributes

static $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
Version
Id:
class.ilAdministrationGUI.php 43022 2013-06-26 13:32:48Z tamstutz

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

Member Function Documentation

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

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

References getSettingsGUIInstance(), and parseFieldDefinition().

Referenced by ilObjFileAccessSettingsGUI\editDiskQuotaSettings(), ilObjPersonalDesktopSettingsGUI\editWsp(), ilObjAccessibilitySettingsGUI\getSettingsForm(), ilObjForumAdministrationGUI\getSettingsForm(), ilObjMailGUI\initForm(), ilLDAPSettingsGUI\initForm(), ilObjTaggingSettingsGUI\initFormSettings(), ilObjRepositorySettingsGUI\initSettingsForm(), ilObjUserTrackingGUI\initSettingsForm(), ilObjPrivacySecurityGUI\showPrivacy(), and ilObjPrivacySecurityGUI\showSecurity().

{
switch($a_form_id)
{
case self::FORM_SECURITY:
$types = array(self::SETTINGS_GENERAL, 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);
break;
case self::FORM_FILES_QUOTA:
$types = array(self::SETTINGS_PD);
break;
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);
break;
case self::FORM_COURSE:
case self::FORM_GROUP:
$types = array(self::SETTINGS_PRIVACY_SECURITY, self::SETTINGS_CALENDAR, self::SETTINGS_GENERAL);
break;
case self::FORM_WSP:
$types = array(self::SETTINGS_PORTFOLIO);
break;
case self::FORM_TAGGING:
$types = array(self::SETTINGS_REPOSITORY);
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
include_once "Modules/SystemFolder/classes/class.ilObjSystemFolderGUI.php";
$parent_gui = new ilObjSystemFolderGUI(null, SYSTEM_FOLDER_ID, true);
$parent_gui->setCreationMode(true);
include_once "Services/Cron/classes/class.ilCronManagerGUI.php";
$gui = new ilCronManagerGUI();
$data = $gui->addToExternalSettingsForm($a_form_id);
if(sizeof($data))
{
self::parseFieldDefinition("cron", $a_form, $parent_gui, $data);
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilAdministrationSettingsFormHandler::getRefId (   $a_obj_type)
staticprotected

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

References initObjectMap().

Referenced by getSettingsGUIInstance().

{
if(!is_array(self::$OBJ_MAP))
{
self::initObjectMap();
}
return self::$OBJ_MAP[$a_obj_type];
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilAdministrationSettingsFormHandler::getSettingsGUIInstance (   $a_settings_obj_type)
static

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

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

Referenced by addFieldsToForm(), and ilLDAPSettingsGUI\initForm().

{
global $objDefinition, $ilCtrl;
$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";
$class_path = $ilCtrl->lookupClassPath($class_name);
include_once($class_path);
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:

static ilAdministrationSettingsFormHandler::initObjectMap ( )
staticprotected

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

Referenced by getRefId().

{
global $tree;
$map = array("adm" => SYSTEM_FOLDER_ID);
foreach($tree->getChilds(SYSTEM_FOLDER_ID) as $obj)
{
$map[$obj["type"]] = $obj["ref_id"];
}
self::$OBJ_MAP = $map;
}

+ Here is the caller graph for this function:

static ilAdministrationSettingsFormHandler::parseFieldDefinition (   $a_type,
ilPropertyFormGUI  $a_form,
ilObjectGUI  $a_gui,
  $a_data 
)
staticprotected

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

References $cmd, $ilCtrl, $lng, ilPropertyFormGUI\addItem(), parseFieldValue(), and ilCustomInputGUI\setHtml().

Referenced by addFieldsToForm().

{
global $lng, $rbacsystem, $ilCtrl;
if(!is_array($a_data))
{
return;
}
foreach($a_data as $area_caption => $fields)
{
if(is_numeric($area_caption) || !trim($area_caption))
{
$area_caption = "obj_".$a_type;
}
if(is_array($fields) && sizeof($fields) == 2)
{
$cmd = $fields[0];
$fields = $fields[1];
if(is_array($fields))
{
$ftpl = new ilTemplate("tpl.external_settings.html", true, true, "Services/Administration");
$stack = array();
foreach($fields as $field_caption_id => $field_value)
{
$field_type = $subitems = null;
if(is_array($field_value))
{
$field_type = $field_value[1];
$subitems = $field_value[2];
$field_value = $field_value[0];
}
if(self::parseFieldValue($field_type, $field_value))
{
$ftpl->setCurrentBlock("value_bl");
$ftpl->setVariable("VALUE", $field_value);
$ftpl->parseCurrentBlock();
}
if(is_array($subitems))
{
$ftpl->setCurrentBlock("subitem_bl");
foreach($subitems as $sub_caption_id => $sub_value)
{
$sub_type = null;
if(is_array($sub_value))
{
$sub_type = $sub_value[1];
$sub_value = $sub_value[0];
}
self::parseFieldValue($sub_type, $sub_value);
$ftpl->setVariable("SUBKEY", $lng->txt($sub_caption_id));
$ftpl->setVariable("SUBVALUE", $sub_value);
$ftpl->parseCurrentBlock();
}
}
$ftpl->setCurrentBlock("row_bl");
$ftpl->setVariable("KEY", $lng->txt($field_caption_id));
$ftpl->parseCurrentBlock();
}
if ($rbacsystem->checkAccess("visible,read", $a_gui->object->getRefId()))
{
if(!$cmd)
{
$cmd = "view";
}
$ilCtrl->setParameter($a_gui, "ref_id", $a_gui->object->getRefId());
$ftpl->setCurrentBlock("edit_bl");
$ftpl->setVariable("URL_EDIT", $ilCtrl->getLinkTargetByClass(array("ilAdministrationGUI", get_class($a_gui)), $cmd));
$ftpl->setVariable("TXT_EDIT", $lng->txt("adm_external_setting_edit"));
$ftpl->parseCurrentBlock();
}
$ext = new ilCustomInputGUI($lng->txt($area_caption));
$ext->setHtml($ftpl->get());
$a_form->addItem($ext);
}
}
}
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilAdministrationSettingsFormHandler::parseFieldValue (   $a_field_type,
&  $a_field_value 
)
staticprotected

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

References $lng.

Referenced by parseFieldDefinition().

{
global $lng;
switch($a_field_type)
{
case self::VALUE_BOOL:
$a_field_value = (bool)$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 = "-";
}
if(is_numeric($a_field_value) || $a_field_value !== "")
{
return true;
}
return false;
}

+ Here is the caller graph for this function:

Field Documentation

ilAdministrationSettingsFormHandler::$OBJ_MAP
staticprotected

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

const ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY = 11

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

Referenced by ilObjWikiSettingsGUI\addToExternalSettingsForm(), ilObjAuthSettingsGUI\addToExternalSettingsForm(), and ilObjAccessibilitySettingsGUI\getSettingsForm().

const ilAdministrationSettingsFormHandler::FORM_COURSE = 6

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

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

const ilAdministrationSettingsFormHandler::FORM_FILES_QUOTA = 3

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

Referenced by ilDAVCronDiskQuota\addToExternalSettingsForm(), ilObjPersonalDesktopSettingsGUI\addToExternalSettingsForm(), and ilObjFileAccessSettingsGUI\editDiskQuotaSettings().

const ilAdministrationSettingsFormHandler::FORM_FORUM = 10

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

Referenced by ilObjForumAdministrationGUI\getSettingsForm().

const ilAdministrationSettingsFormHandler::FORM_GROUP = 7

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

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

const ilAdministrationSettingsFormHandler::FORM_LDAP = 9

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

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

const ilAdministrationSettingsFormHandler::FORM_LP = 4

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

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

const ilAdministrationSettingsFormHandler::FORM_MAIL = 5

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

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

const ilAdministrationSettingsFormHandler::FORM_PRIVACY = 1

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

Referenced by ilObjLearningResourcesSettingsGUI\addToExternalSettingsForm(), ilObjRoleFolderGUI\addToExternalSettingsForm(), and ilObjPrivacySecurityGUI\showPrivacy().

const ilAdministrationSettingsFormHandler::FORM_REPOSITORY = 8

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

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

const ilAdministrationSettingsFormHandler::FORM_SECURITY = 2

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

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

const ilAdministrationSettingsFormHandler::FORM_TAGGING = 13

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

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

const ilAdministrationSettingsFormHandler::FORM_WSP = 12

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

Referenced by ilObjPortfolioAdministrationGUI\addToExternalSettingsForm(), and ilObjPersonalDesktopSettingsGUI\editWsp().

const ilAdministrationSettingsFormHandler::SETTINGS_AUTH = "auth"

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

const ilAdministrationSettingsFormHandler::SETTINGS_CALENDAR = "cals"

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

const ilAdministrationSettingsFormHandler::SETTINGS_COURSE = "crss"

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

const ilAdministrationSettingsFormHandler::SETTINGS_FILE = "facs"

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

const ilAdministrationSettingsFormHandler::SETTINGS_FORUM = "frma"

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

const ilAdministrationSettingsFormHandler::SETTINGS_GENERAL = "adm"

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

const ilAdministrationSettingsFormHandler::SETTINGS_GROUP = "grps"

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

const ilAdministrationSettingsFormHandler::SETTINGS_LRES = "lrss"

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

const ilAdministrationSettingsFormHandler::SETTINGS_PD = "pdts"

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

const ilAdministrationSettingsFormHandler::SETTINGS_PORTFOLIO = "prfa"

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

const ilAdministrationSettingsFormHandler::SETTINGS_PRIVACY_SECURITY = "ps"

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

const ilAdministrationSettingsFormHandler::SETTINGS_REPOSITORY = "reps"

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

const ilAdministrationSettingsFormHandler::SETTINGS_ROLE = "rolf"

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

const ilAdministrationSettingsFormHandler::SETTINGS_USER = "usrf"

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

const ilAdministrationSettingsFormHandler::SETTINGS_WIKI = "wiks"

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

const ilAdministrationSettingsFormHandler::VALUE_BOOL = "bool"

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

Referenced by ilDAVCronDiskQuota\addToExternalSettingsForm(), ilMembershipAdministrationGUI\addToExternalSettingsForm(), ilObjWikiSettingsGUI\addToExternalSettingsForm(), ilObjPortfolioAdministrationGUI\addToExternalSettingsForm(), ilObjLearningResourcesSettingsGUI\addToExternalSettingsForm(), ilObjPrivacySecurityGUI\addToExternalSettingsForm(), ilObjPersonalDesktopSettingsGUI\addToExternalSettingsForm(), ilObjCalendarSettingsGUI\addToExternalSettingsForm(), ilObjRepositorySettingsGUI\addToExternalSettingsForm(), ilObjRoleFolderGUI\addToExternalSettingsForm(), ilObjAuthSettingsGUI\addToExternalSettingsForm(), ilObjSystemFolderGUI\addToExternalSettingsForm(), and ilObjUserFolderGUI\addToExternalSettingsForm().

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