ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilObjPrivacySecurityGUI Class Reference
+ Inheritance diagram for ilObjPrivacySecurityGUI:
+ Collaboration diagram for ilObjPrivacySecurityGUI:

Public Member Functions

 __construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
 Contructor.
 executeCommand ()
 Execute command.
 getAdminTabs ()
 Get tabs.
 showPrivacy ()
 Show Privacy settings.
 showSecurity ()
 Show Privacy settings.
 save_privacy ()
 Save privacy settings.
 save_security ()
 Save security settings.
 addToExternalSettingsForm ($a_form_id)
- Public Member Functions inherited from ilObjectGUI
 ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
 Constructor public.
 withReferences ()
 determines wether objects are referenced or not (got ref ids or not)
 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
 getCreationMode ()
 get creation mode
 getAdminTabs (&$tabs_gui)
 administration tabs show only permissions and trash folder
 getHTML ()
 confirmedDeleteObject ()
 confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
 cancelDeleteObject ()
 cancel deletion of object
 cancelObject ($in_rep=false)
 cancel action and go back to previous page public
 createObject ()
 create new object form
 cancelCreation ()
 cancel create action and go back to repository parent
 saveObject ()
 save object
 editObject ()
 edit object
 updateObject ()
 updates object entry in object_data
 getFormAction ($a_cmd, $a_formaction="")
 get form action for command (command is method name without "Object", e.g.
 isVisible ($a_ref_id, $a_type)
 viewObject ()
 list childs of current object
 deleteObject ($a_error=false)
 Display deletion confirmation screen.
 cloneAllObject ()
 Clone single (not container object) Method is overwritten in ilContainerGUI.

Static Public Member Functions

static initErrorMessages ()
static getErrorMessage ($code)
 return error message for error code
- Static Public Member Functions inherited from ilObjectGUI
static _gotoRepositoryRoot ($a_raise_error=false)
 Goto repository root.
static _gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
 Goto repository root.

Static Private Attributes

static $ERROR_MESSAGE

Additional Inherited Members

- 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 ()
 prepareOutput ()
 prepare output
 setTitleAndDescription ()
 called by prepare output
 initHeaderAction ($a_sub_type=null, $a_sub_id=null)
 Add header action menu.
 insertHeaderAction ($a_list_gui)
 Insert header action into main template.
 addHeaderAction ()
 Add header action menu.
 redrawHeaderActionObject ()
 Ajax call: redraw action header only.
 showMountWebfolderIcon ()
 setTabs ()
 set admin tabs public
 setAdminTabs ()
 set admin tabs public
 setLocator ()
 set Locator
 addLocatorItems ()
 should be overwritten to add object specific items (repository items are preloaded)
 omitLocator ($a_omit=true)
 addAdminLocatorItems ($a_do_not_add_object=false)
 should be overwritten to add object specific items (repository items are preloaded)
 initCreationForms ($a_new_type)
 Init creation froms.
 getCreationFormsHTML (array $a_forms)
 Get HTML for creation forms (accordion)
 initCreateForm ($a_new_type)
 Init object creation form.
 initDidacticTemplate (ilPropertyFormGUI $form)
 Show didactic template types.
 addDidacticTemplateOptions (array &$a_options)
 Add custom templates.
 getDidacticTemplateVar ($a_type)
 Get didactic template setting from creation screen.
 putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
 Add object to tree at given position.
 afterSave (ilObject $a_new_object)
 Post (successful) object creation hook.
 initEditForm ()
 Init object edit form.
 initEditCustomForm (ilPropertyFormGUI $a_form)
 Add custom fields to update form.
 getEditFormValues ()
 Get values for edit form.
 getEditFormCustomValues (array &$a_values)
 Add values to custom edit fields.
 validateCustom (ilPropertyFormGUI $a_form)
 Validate custom values (if not possible with checkInput())
 updateCustom (ilPropertyFormGUI $a_form)
 Insert custom update form values into object.
 afterUpdate ()
 Post (successful) object update hook.
 initImportForm ($a_new_type)
 Init object import form.
 importFileObject ($parent_id=null)
 Import.
 afterImport (ilObject $a_new_object)
 Post (successful) object import hook.
 setFormAction ($a_cmd, $a_formaction)
 set specific form action for command
 getReturnLocation ($a_cmd, $a_location="")
 get return location for command (command is method name without "Object", e.g.
 setReturnLocation ($a_cmd, $a_location)
 set specific return location for command
 getTargetFrame ($a_cmd, $a_target_frame="")
 get target frame for command (command is method name without "Object", e.g.
 setTargetFrame ($a_cmd, $a_target_frame)
 set specific target frame for command
 showPossibleSubObjects ()
 show possible subobjects (pulldown menu)
 getTemplateFile ($a_cmd, $a_type="")
 get a template blockfile format: tpl.
 getTitlesByRefId ($a_ref_ids)
 get Titles of objects this method is used for error messages in methods cut/copy/paste
 getTabs (&$tabs_gui)
 get tabs abstract method.
 __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
 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
 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.
 getCenterColumnHTML ()
 Get center column.
 getRightColumnHTML ()
 Display right column.
 setColumnSettings ($column_gui)
 May be overwritten in subclasses.
 checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission and redirect on error.
 checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
 Check permission.
 enableDragDropFileUpload ()
 Enables the file upload into this object by dropping files.
 handleAutoRating (ilObject $a_new_obj)
 Activate rating automatically if parent container setting.

Detailed Description

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

Constructor & Destructor Documentation

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

Contructor.

public

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

References ilObjectGUI\ilObjectGUI(), and initErrorMessages().

{
$this->type = 'ps';
parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
}

+ Here is the call graph for this function:

Member Function Documentation

ilObjPrivacySecurityGUI::addToExternalSettingsForm (   $a_form_id)

Definition at line 390 of file class.ilObjPrivacySecurityGUI.php.

References ilPrivacySettings\_getInstance(), ilAdministrationSettingsFormHandler\FORM_COURSE, ilAdministrationSettingsFormHandler\FORM_GROUP, and ilAdministrationSettingsFormHandler\VALUE_BOOL.

{
switch($a_form_id)
{
$subitems = array(
'ps_export_course' => array($privacy->enabledCourseExport(), ilAdministrationSettingsFormHandler::VALUE_BOOL),
'ps_export_confirm' => array($privacy->courseConfirmationRequired(), ilAdministrationSettingsFormHandler::VALUE_BOOL),
'ps_show_crs_access' => array($privacy->enabledCourseAccessTimes(), ilAdministrationSettingsFormHandler::VALUE_BOOL)
);
$fields = array(
'ps_profile_export' => array(null, null, $subitems)
);
return array(array("showPrivacy", $fields));
$subitems = array(
'ps_export_groups' => array($privacy->enabledGroupExport(), ilAdministrationSettingsFormHandler::VALUE_BOOL),
'ps_export_confirm_group' => array($privacy->groupConfirmationRequired(), ilAdministrationSettingsFormHandler::VALUE_BOOL),
'ps_show_grp_access' => array($privacy->enabledGroupAccessTimes(), ilAdministrationSettingsFormHandler::VALUE_BOOL)
);
$fields = array(
'ps_profile_export' => array(null, null, $subitems)
);
return array(array("showPrivacy", $fields));
}
}

+ Here is the call graph for this function:

ilObjPrivacySecurityGUI::executeCommand ( )

Execute command.

public

Reimplemented from ilObjectGUI.

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

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

{
global $rbacsystem,$ilErr,$ilAccess;
$next_class = $this->ctrl->getNextClass($this);
$cmd = $this->ctrl->getCmd();
$this->prepareOutput();
if(!$ilAccess->checkAccess('read','',$this->object->getRefId()))
{
$ilErr->raiseError($this->lng->txt('no_permission'),$ilErr->WARNING);
}
switch($next_class)
{
case 'ilpermissiongui':
$this->tabs_gui->setTabActive('perm_settings');
include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
$perm_gui =& new ilPermissionGUI($this);
$ret =& $this->ctrl->forwardCommand($perm_gui);
break;
default:
if(!$cmd || $cmd == 'view')
{
$cmd = "showPrivacy";
}
$this->$cmd();
break;
}
return true;
}

+ Here is the call graph for this function:

ilObjPrivacySecurityGUI::getAdminTabs ( )

Get tabs.

public

Definition at line 107 of file class.ilObjPrivacySecurityGUI.php.

{
global $rbacsystem;
if ($rbacsystem->checkAccess("visible,read",$this->object->getRefId()))
{
$this->tabs_gui->addTarget("show_privacy",
$this->ctrl->getLinkTarget($this, "showPrivacy"),
'showPrivacy');
$this->tabs_gui->addTarget("show_security",
$this->ctrl->getLinkTarget($this, "showSecurity"),
'showSecurity');
}
if ($rbacsystem->checkAccess('edit_permission',$this->object->getRefId()))
{
$this->tabs_gui->addTarget("perm_settings",
$this->ctrl->getLinkTargetByClass('ilpermissiongui',"perm"),
array(),'ilpermissiongui');
}
}
static ilObjPrivacySecurityGUI::getErrorMessage (   $code)
static

return error message for error code

Parameters
int$code
Returns
string

Definition at line 384 of file class.ilObjPrivacySecurityGUI.php.

References $ERROR_MESSAGE, and initErrorMessages().

Referenced by save_privacy(), and ilSecuritySettings\validate().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilObjPrivacySecurityGUI::initErrorMessages ( )
static

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

References $ERROR_MESSAGE, ilObjectGUI\$lng, ilSecuritySettings\$SECURITY_SETTINGS_ERR_CODE_AUTO_HTTPS, ilSecuritySettings\$SECURITY_SETTINGS_ERR_CODE_HTTP_NOT_AVAILABLE, ilSecuritySettings\$SECURITY_SETTINGS_ERR_CODE_HTTPS_NOT_AVAILABLE, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1, ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2, and ilSecuritySettings\SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3.

Referenced by __construct(), and getErrorMessage().

{
global $lng;
if(is_array(self::$ERROR_MESSAGE))
{
return;
}
$lng->loadLanguageModule('ps');
ilSecuritySettings::$SECURITY_SETTINGS_ERR_CODE_AUTO_HTTPS => $lng->txt("ps_error_message_https_header_missing"),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MIN_LENGTH => $lng->txt('ps_error_message_invalid_password_min_length'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_LENGTH => $lng->txt('ps_error_message_invalid_password_max_length'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_PASSWORD_MAX_AGE => $lng->txt('ps_error_message_invalid_password_max_age'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_INVALID_LOGIN_MAX_ATTEMPTS => $lng->txt('ps_error_message_invalid_login_max_attempts'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN1 => $lng->txt('ps_error_message_password_min1_because_chars'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN2 => $lng->txt('ps_error_message_password_min2_because_chars_numbers'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MIN_LENGTH_MIN3 => $lng->txt('ps_error_message_password_min3_because_chars_numbers_sc'),
ilSecuritySettings::SECURITY_SETTINGS_ERR_CODE_PASSWORD_MAX_LENGTH_LESS_MIN_LENGTH => $lng->txt('ps_error_message_password_max_less_min')
);
}

+ Here is the caller graph for this function:

ilObjPrivacySecurityGUI::save_privacy ( )

Save privacy settings.

public

Definition at line 252 of file class.ilObjPrivacySecurityGUI.php.

References $_POST, $ilErr, $ilSetting, ilPrivacySettings\_getInstance(), ilMemberAgreement\_reset(), getErrorMessage(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and showPrivacy().

{
global $ilErr,$ilAccess, $ilSetting;
if(!$ilAccess->checkAccess('write','',$this->object->getRefId()))
{
$ilErr->raiseError($this->lng->txt('no_permission'),$ilErr->WARNING);
}
if((int) $_POST['rbac_log_age'] > 24)
{
$_POST['rbac_log_age'] = 24;
}
else if((int) $_POST['rbac_log_age'] < 1)
{
$_POST['rbac_log_age'] = 1;
}
$_POST['profile_protection'] = isset($_POST['profile_protection']) ? $_POST['profile_protection'] : array();
// to determine if agreements need to be reset - see below
$old_settings = array(
'export_course' => $privacy->enabledCourseExport(),
'export_group' => $privacy->enabledGroupExport(),
'export_confirm_course' => $privacy->courseConfirmationRequired(),
'export_confirm_group' => $privacy->groupConfirmationRequired(),
'crs_access_times' => $privacy->enabledCourseAccessTimes(),
'grp_access_times' => $privacy->enabledGroupAccessTimes()
);
$privacy->enableCourseExport((int) in_array('export_course', $_POST['profile_protection']));
$privacy->enableGroupExport((int) in_array('export_group', $_POST['profile_protection']));
$privacy->setCourseConfirmationRequired((int) in_array('export_confirm_course', $_POST['profile_protection']));
$privacy->setGroupConfirmationRequired((int) in_array('export_confirm_group', $_POST['profile_protection']));
$privacy->showGroupAccessTimes((int) in_array('grp_access_times', $_POST['profile_protection']));
$privacy->showCourseAccessTimes((int) in_array('crs_access_times', $_POST['profile_protection']));
// validate settings
$code = $privacy->validate();
// if error code != 0, display error and do not save
if ($code != 0)
{
$msg = $this->getErrorMessage ($code);
}
else
{
$privacy->save();
// reset agreements?
$do_reset = false;
if(!$old_settings['export_course'] && $privacy->enabledCourseExport())
{
$do_reset = true;
}
if(!$do_reset && !$old_settings['export_group'] && $privacy->enabledGroupExport())
{
$do_reset = true;
}
if(!$do_reset && !$old_settings['export_confirm_course'] && $privacy->courseConfirmationRequired())
{
$do_reset = true;
}
if(!$do_reset && !$old_settings['export_confirm_group'] && $privacy->groupConfirmationRequired())
{
$do_reset = true;
}
if(!$do_reset && !$old_settings['crs_access_times'] && $privacy->enabledCourseAccessTimes())
{
$do_reset = true;
}
if(!$do_reset && !$old_settings['grp_access_times'] && $privacy->enabledGroupAccessTimes())
{
$do_reset = true;
}
if($do_reset)
{
include_once('Services/Membership/classes/class.ilMemberAgreement.php');
}
ilUtil::sendSuccess($this->lng->txt('settings_saved'));
}
$this->showPrivacy();
}

+ Here is the call graph for this function:

ilObjPrivacySecurityGUI::save_security ( )

Save security settings.

public

Definition at line 347 of file class.ilObjPrivacySecurityGUI.php.

References $ilErr, $ilSetting, $ilUser, and showSecurity().

{
global $ilErr,$ilAccess, $ilSetting, $rbacreview, $ilUser;
if(!$ilAccess->checkAccess('write','',$this->object->getRefId()))
{
$ilErr->raiseError($this->lng->txt('no_permission'),$ilErr->WARNING);
}
/*
$security = ilSecuritySettings::_getInstance();
$code = $security->validate();
// if error code != 0, display error and do not save
if ($code != 0)
{
$msg = $this->getErrorMessage ($code);
ilUtil::sendFailure($msg);
} else
{
$security->save();
ilUtil::sendSuccess($this->lng->txt('settings_saved'));
}
*/
$this->showSecurity();
}

+ Here is the call graph for this function:

ilObjPrivacySecurityGUI::showPrivacy ( )

Show Privacy settings.

public

Definition at line 135 of file class.ilObjPrivacySecurityGUI.php.

References ilPrivacySettings\_getInstance(), ilMemberAgreement\_hasAgreements(), ilAdministrationSettingsFormHandler\addFieldsToForm(), ilAdministrationSettingsFormHandler\FORM_PRIVACY, ilUtil\sendInfo(), and ilCheckboxGroupInputGUI\setValue().

Referenced by save_privacy().

{
$this->tabs_gui->setTabActive('show_privacy');
include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
$form = new ilPropertyFormGUI();
$form->setFormAction($this->ctrl->getFormAction($this));
$form->setTitle($this->lng->txt('ps_privacy_protection'));
include_once('Services/Membership/classes/class.ilMemberAgreement.php');
{
ilUtil::sendInfo($this->lng->txt('ps_warning_modify'));
}
$value = array();
if($privacy->enabledCourseExport())
{
$value[] = "export_course";
}
if($privacy->enabledGroupExport())
{
$value[] = "export_group";
}
if($privacy->courseConfirmationRequired())
{
$value[] = "export_confirm_course";
}
if($privacy->groupConfirmationRequired())
{
$value[] = "export_confirm_group";
}
if($privacy->enabledGroupAccessTimes())
{
$value[] = "grp_access_times";
}
if($privacy->enabledCourseAccessTimes())
{
$value[] = "crs_access_times";
}
$group = new ilCheckboxGroupInputGUI($this->lng->txt('ps_profile_export'),'profile_protection');
$group->setValue($value);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_export_course'));
$check->setValue('export_course');
$group->addOption($check);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_export_groups'));
$check->setValue('export_group');
$group->addOption($check);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_export_confirm'));
$check->setValue('export_confirm_course');
$group->addOption($check);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_export_confirm_group'));
$check->setValue('export_confirm_group');
$group->addOption($check);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_show_grp_access'));
$check->setValue('grp_access_times');
$group->addOption($check);
$check = new ilCheckboxOption();
$check->setTitle($this->lng->txt('ps_show_crs_access'));
$check->setValue('crs_access_times');
$group->addOption($check);
$form->addItem($group);
include_once "Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php";
$form,
$this
);
$form->addCommandButton('save_privacy',$this->lng->txt('save'));
$this->tpl->setContent($form->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilObjPrivacySecurityGUI::showSecurity ( )

Show Privacy settings.

public

Definition at line 221 of file class.ilObjPrivacySecurityGUI.php.

References $ilSetting, $ilUser, ilSecuritySettings\_getInstance(), ilAdministrationSettingsFormHandler\addFieldsToForm(), and ilAdministrationSettingsFormHandler\FORM_SECURITY.

Referenced by save_security().

{
global $ilSetting, $ilUser, $rbacreview;
include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
$this->tabs_gui->setTabActive('show_security');
$form = new ilPropertyFormGUI();
$form->setFormAction($this->ctrl->getFormAction($this));
$form->setTitle($this->lng->txt('ps_security_protection'));
include_once "Services/Administration/classes/class.ilAdministrationSettingsFormHandler.php";
$form,
$this
);
// $form->addCommandButton('save_security',$this->lng->txt('save'));
$this->tpl->setContent($form->getHTML());
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilObjPrivacySecurityGUI::$ERROR_MESSAGE
staticprivate

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

Referenced by getErrorMessage(), and initErrorMessages().


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