ilPrivacySettings Class Reference

Singleton class that stores all privacy settings. More...

Collaboration diagram for ilPrivacySettings:

Public Member Functions
	getPrivacySettingsRefId ()
	enabledCourseExport ()
	enabledGroupExport ()
	checkExportAccess ($a_ref_id, $a_user_id=0)
	Check if a user has the permission to access approved user profile fields, course related user data and custom user data. More...
	enableCourseExport ($a_status)
	enableGroupExport ($a_status)
	enableForaStatistics ($a_status)
	write access to property fora statitics More...
	enabledForaStatistics ()
	read access to property enable fora statistics More...
	enableAnonymousFora ($a_status)
	write access to property anonymous fora More...
	enabledAnonymousFora ()
	read access to property enable anonymous fora More...
	enableRbacLog ($a_status)
	write access to property rbac_log More...
	enabledRbacLog ()
	read access to property enable rbac log More...
	setRbacLogAge ($a_age)
	write access to property rbac log age More...
	getRbacLogAge ()
	read access to property rbac log age More...
	confirmationRequired ($a_type)
	courseConfirmationRequired ()
	groupConfirmationRequired ()
	setCourseConfirmationRequired ($a_status)
	setGroupConfirmationRequired ($a_status)
	showGroupAccessTimes ($a_status)
	Show group last access times. More...
	enabledGroupAccessTimes ()
	check if group access time are visible More...
	showCourseAccessTimes ($a_status)
	show course access times More...
	enabledCourseAccessTimes ()
	check if access time are enabled in courses More...
	enabledAccessTimesByType ($a_obj_type)
	Check if access time are enabled for a specific type. More...
	save ()
	Save settings. More...
	validate ()
	validate settings More...
	enabledSahsProtocolData ()
	enableSahsProtocolData ($status)
	enabledExportSCORM ()
	enableExportSCORM ($a_status)

Static Public Member Functions
static	_getInstance ()
	Get instance of ilPrivacySettings. More...

Private Member Functions
	__construct ()
	Private constructor: use _getInstance() More...
	read ()
	read settings More...

Private Attributes
	$db
	$settings
	$export_course
	$export_group
	$export_confirm_course
	$export_confirm_group
	$fora_statistics
	$anonymous_fora
	$rbac_log
	$rbac_log_age
	$show_grp_access_times
	$show_crs_access_times
	$ref_id
	$sahs_protocol_data
	$export_scorm

Static Private Attributes
static	$instance = null

Detailed Description

Singleton class that stores all privacy settings.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

/

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

Constructor & Destructor Documentation

__construct()

ilPrivacySettings::__construct ( )

private

Private constructor: use _getInstance()

private

Parameters

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

References $ilDB, $ilSetting, read(), and settings().

        {
                global $ilSetting,$ilDB;

                $this->db = $ilDB;
                $this->settings = $ilSetting;

                $this->read();
        }

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilPrivacySettings::_getInstance ( )

static

Get instance of ilPrivacySettings.

public

Returns

Definition at line 77 of file class.ilPrivacySettings.php.

Referenced by ilSCORM2004TrackingItemsTableGUI\__construct(), ilSCORMTrackingItemsTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilMemberAgreementGUI\__construct(), ilGroupEditParticipantsTableGUI\__construct(), ilMemberAgreement\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilRegistrationGUI\__construct(), ilMemberExport\__construct(), ilObjLearningResourcesSettingsGUI\addToExternalSettingsForm(), ilObjPrivacySecurityGUI\addToExternalSettingsForm(), ilObjRoleFolderGUI\addToExternalSettingsForm(), ilObjGroupGUI\checkAgreement(), ilObjCourseGUI\checkAgreement(), ilObjLearningResourcesSettingsGUI\editSettings(), ilMemberExportGUI\executeCommand(), ilObjSCORMLearningModule\exportSelected(), ilRbacLog\garbageCollection(), ilTrObjectUsersPropsTableGUI\getItems(), ilTrMatrixTableGUI\getItems(), ilMemberExport\getOrderedExportableFields(), ilCourseMembershipGUI\getPrintMemberData(), ilLPTableBaseGUI\getSelectableUserColumns(), ilObjSAHSLearningModuleGUI\getTabs(), ilSoapUserAdministration\getUserForRole(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilMemberExportSettingsGUI\initForm(), ilParticipantTableGUI\initSettings(), ilObjRoleFolderGUI\initSettingsForm(), ilRbacLog\isActive(), ilObjSCORMLearningModuleGUI\modifyTrackingItems(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), ilSCORMTrackingItemsPerUserFilterGUI\parse(), ilSCORMTrackingUsersTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilMembershipGUI\printMembersOutput(), ilObjGroupGUI\readMemberData(), ilObjCourseGUI\readMemberData(), ilSubscriberTableGUI\readSubscriberData(), ilWaitingListTableGUI\readUserData(), ilObjPrivacySecurityGUI\save_privacy(), ilObjUserFolderGUI\saveGlobalUserSettingsObject(), ilObjLearningResourcesSettingsGUI\saveSettings(), ilObjRoleFolderGUI\saveSettingsObject(), ilSAHSPresentationGUI\setInfoTabs(), ilMembershipGUI\setSubTabs(), ilObjCourseGUI\setSubTabs(), ilObjGroupGUI\setSubTabs(), ilObjPrivacySecurityGUI\showPrivacy(), ilObjAICCLearningModuleGUI\showTrackingItems(), and ilSCORMTrackingItems\userDataHeaderForExport().

        {
                if(is_object(self::$instance))
                {
                        return self::$instance;
                }
                return self::$instance = new ilPrivacySettings();
        }

Here is the caller graph for this function:

checkExportAccess()

ilPrivacySettings::checkExportAccess	(		$a_ref_id,
			$a_user_id = 0
	)

Check if a user has the permission to access approved user profile fields, course related user data and custom user data.

Todo:

rename

Parameters

object

$a_ref_id

Returns

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

References $ilUser, ilObject\_lookupType(), enabledCourseExport(), enabledGroupExport(), and getPrivacySettingsRefId().

        {
                global $ilUser,$ilAccess,$rbacsystem;
                
                $user_id = $a_user_id ? $a_user_id : $ilUser->getId();
                
                if(ilObject::_lookupType($a_ref_id, true) == 'crs')
                {
                        return $this->enabledCourseExport() and $ilAccess->checkAccessOfUser($user_id,'manage_members','',$a_ref_id) and $rbacsystem->checkAccessOfUser($user_id,'export_member_data',$this->getPrivacySettingsRefId());
                }
                else
                {
                        return $this->enabledGroupExport() and $ilAccess->checkAccessOfUser($user_id,'manage_members','',$a_ref_id) and $rbacsystem->checkAccessOfUser($user_id,'export_member_data',$this->getPrivacySettingsRefId());
                }               
        }

Here is the call graph for this function:

confirmationRequired()

ilPrivacySettings::confirmationRequired

(

$a_type

)

Definition at line 205 of file class.ilPrivacySettings.php.

References $a_type, courseConfirmationRequired(), and groupConfirmationRequired().

        {
                switch($a_type)
                {
                        case 'crs':
                                return $this->courseConfirmationRequired();
                                
                        case 'grp':
                                return $this->groupConfirmationRequired();
                }
                return false;
        }

Here is the call graph for this function:

courseConfirmationRequired()

ilPrivacySettings::courseConfirmationRequired

(

)

Definition at line 218 of file class.ilPrivacySettings.php.

References $export_confirm_course.

Referenced by confirmationRequired(), and save().

        {
                return $this->export_confirm_course;
        }

Here is the caller graph for this function:

enableAnonymousFora()

ilPrivacySettings::enableAnonymousFora

(

$a_status

)

write access to property anonymous fora

Parameters

bool

$a_status

value to set property

Definition at line 155 of file class.ilPrivacySettings.php.

        {
                $this->anonymous_fora = (bool) $a_status;
        }

enableCourseExport()

ilPrivacySettings::enableCourseExport

(

$a_status

)

Definition at line 123 of file class.ilPrivacySettings.php.

        {
                $this->export_course = (bool) $a_status;
        }

enabledAccessTimesByType()

ilPrivacySettings::enabledAccessTimesByType

(

$a_obj_type

)

Check if access time are enabled for a specific type.

Parameters

type

$a_obj_type

Returns

type

Definition at line 289 of file class.ilPrivacySettings.php.

References enabledCourseAccessTimes(), and enabledGroupAccessTimes().

        {
                switch($a_obj_type)
                {
                        case 'crs':
                                return $this->enabledCourseAccessTimes();
                                
                        case 'grp':
                                return $this->enabledGroupAccessTimes();
                }
                
        }

Here is the call graph for this function:

enabledAnonymousFora()

ilPrivacySettings::enabledAnonymousFora

(

)

read access to property enable anonymous fora

Returns

bool true if enabled, false otherwise

Definition at line 164 of file class.ilPrivacySettings.php.

References $anonymous_fora.

Referenced by save().

        {
                return $this->anonymous_fora;
        }

Here is the caller graph for this function:

enabledCourseAccessTimes()

ilPrivacySettings::enabledCourseAccessTimes

(

)

check if access time are enabled in courses

public

Returns

Definition at line 279 of file class.ilPrivacySettings.php.

References $show_crs_access_times.

Referenced by enabledAccessTimesByType(), and save().

        {
                return (bool) $this->show_crs_access_times;
        }

Here is the caller graph for this function:

enabledCourseExport()

ilPrivacySettings::enabledCourseExport

(

)

Definition at line 91 of file class.ilPrivacySettings.php.

References $export_course.

Referenced by checkExportAccess(), and save().

        {
                return $this->export_course;
        }

Here is the caller graph for this function:

enabledExportSCORM()

ilPrivacySettings::enabledExportSCORM

(

)

Definition at line 376 of file class.ilPrivacySettings.php.

References $export_scorm.

Referenced by save().

        {
                return $this->export_scorm;
        }

Here is the caller graph for this function:

enabledForaStatistics()

ilPrivacySettings::enabledForaStatistics

(

)

read access to property enable fora statistics

Returns

bool true if enabled, false otherwise

Definition at line 146 of file class.ilPrivacySettings.php.

References $fora_statistics.

Referenced by save().

        {
                        return $this->fora_statistics;
        }

Here is the caller graph for this function:

enabledGroupAccessTimes()

ilPrivacySettings::enabledGroupAccessTimes

(

)

check if group access time are visible

public

Definition at line 256 of file class.ilPrivacySettings.php.

References $show_grp_access_times.

Referenced by enabledAccessTimesByType(), and save().

        {
                return (bool) $this->show_grp_access_times;
        }

Here is the caller graph for this function:

enabledGroupExport()

ilPrivacySettings::enabledGroupExport

(

)

Definition at line 96 of file class.ilPrivacySettings.php.

References $export_group.

Referenced by checkExportAccess(), and save().

        {
                return $this->export_group;
        }

Here is the caller graph for this function:

enabledRbacLog()

ilPrivacySettings::enabledRbacLog

(

)

read access to property enable rbac log

Returns

bool true if enabled, false otherwise

Definition at line 182 of file class.ilPrivacySettings.php.

References $rbac_log.

Referenced by save().

        {
                return $this->rbac_log;
        }

Here is the caller graph for this function:

enabledSahsProtocolData()

ilPrivacySettings::enabledSahsProtocolData

(

)

Definition at line 366 of file class.ilPrivacySettings.php.

References $sahs_protocol_data.

Referenced by save().

        {
                return (int) $this->sahs_protocol_data;
        }

Here is the caller graph for this function:

enableExportSCORM()

ilPrivacySettings::enableExportSCORM

(

$a_status

)

Definition at line 380 of file class.ilPrivacySettings.php.

        {
                $this->export_scorm = (bool) $a_status;
        }

enableForaStatistics()

ilPrivacySettings::enableForaStatistics

(

$a_status

)

write access to property fora statitics

Parameters

bool

$a_status

value to set property

Definition at line 137 of file class.ilPrivacySettings.php.

        {
                $this->fora_statistics = (bool) $a_status;
        }

enableGroupExport()

ilPrivacySettings::enableGroupExport

(

$a_status

)

Definition at line 128 of file class.ilPrivacySettings.php.

        {
                $this->export_group = (bool) $a_status;
        }

enableRbacLog()

ilPrivacySettings::enableRbacLog

(

$a_status

)

write access to property rbac_log

Parameters

bool

$a_status

value to set property

Definition at line 173 of file class.ilPrivacySettings.php.

        {
                $this->rbac_log = (bool) $a_status;
        }

enableSahsProtocolData()

ilPrivacySettings::enableSahsProtocolData

(

$status

)

Definition at line 370 of file class.ilPrivacySettings.php.

        {
                $this->sahs_protocol_data = (int) $status;
        }

getPrivacySettingsRefId()

ilPrivacySettings::getPrivacySettingsRefId

(

)

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

References $ref_id.

Referenced by checkExportAccess().

        {
                return $this->ref_id;
        }

Here is the caller graph for this function:

getRbacLogAge()

ilPrivacySettings::getRbacLogAge

(

)

read access to property rbac log age

Returns

int

Definition at line 200 of file class.ilPrivacySettings.php.

References $rbac_log_age.

Referenced by save().

        {
                return $this->rbac_log_age;
        }

Here is the caller graph for this function:

groupConfirmationRequired()

ilPrivacySettings::groupConfirmationRequired

(

)

Definition at line 223 of file class.ilPrivacySettings.php.

References $export_confirm_group.

Referenced by confirmationRequired(), and save().

        {
                return $this->export_confirm_group;
        }

Here is the caller graph for this function:

read()

ilPrivacySettings::read ( )

private

read settings

private

Parameters

Definition at line 329 of file class.ilPrivacySettings.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_ASSOC, and settings().

Referenced by __construct().

        {
                global $ilDB;
                
            $query = "SELECT object_reference.ref_id FROM object_reference,tree,object_data ".
                                "WHERE tree.parent = ".$ilDB->quote(SYSTEM_FOLDER_ID,'integer')." ".
                                "AND object_data.type = 'ps' ".
                                "AND object_reference.ref_id = tree.child ".
                                "AND object_reference.obj_id = object_data.obj_id";
                $res = $this->db->query($query);
                $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
                $this->ref_id = $row["ref_id"];

                $this->export_course = (bool) $this->settings->get('ps_export_course',false);
                $this->export_group = (bool) $this->settings->get('ps_export_group',false);
                $this->export_confirm_course = (bool) $this->settings->get('ps_export_confirm',false);
                $this->export_confirm_group = (bool) $this->settings->get('ps_export_confirm_group',false);
                $this->fora_statistics = (bool) $this->settings->get('enable_fora_statistics',false);
                $this->anonymous_fora = (bool) $this->settings->get('enable_anonymous_fora',false);
                $this->show_grp_access_times = (bool) $this->settings->get('ps_access_times',false);
                $this->show_crs_access_times = (bool) $this->settings->get('ps_crs_access_times',false);
                $this->rbac_log = (bool) $this->settings->get('rbac_log',false);
                $this->rbac_log_age = (int) $this->settings->get('rbac_log_age',6);
                $this->sahs_protocol_data = (int) $this->settings->get('enable_sahs_pd', 0);
                $this->export_scorm = (bool) $this->settings->get('ps_export_scorm',false);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilPrivacySettings::save

(

)

Save settings.

Definition at line 307 of file class.ilPrivacySettings.php.

References courseConfirmationRequired(), enabledAnonymousFora(), enabledCourseAccessTimes(), enabledCourseExport(), enabledExportSCORM(), enabledForaStatistics(), enabledGroupAccessTimes(), enabledGroupExport(), enabledRbacLog(), enabledSahsProtocolData(), getRbacLogAge(), groupConfirmationRequired(), and settings().

        {
                $this->settings->set('ps_export_confirm',(bool) $this->courseConfirmationRequired());
                $this->settings->set('ps_export_confirm_group',(bool) $this->groupConfirmationRequired());
                $this->settings->set('ps_export_course',(bool) $this->enabledCourseExport());
                $this->settings->set('ps_export_group',(bool) $this->enabledGroupExport());
                $this->settings->set('enable_fora_statistics',(bool) $this->enabledForaStatistics());
                $this->settings->set('enable_anonymous_fora',(bool) $this->enabledAnonymousFora());
                $this->settings->set('ps_access_times',(bool) $this->enabledGroupAccessTimes());
                $this->settings->set('ps_crs_access_times',(bool) $this->enabledCourseAccessTimes());
                $this->settings->set('rbac_log',(bool) $this->enabledRbacLog());
                $this->settings->set('rbac_log_age',(int) $this->getRbacLogAge());
                $this->settings->set('enable_sahs_pd',(int) $this->enabledSahsProtocolData());
                $this->settings->set('ps_export_scorm',(bool) $this->enabledExportSCORM());
        }

Here is the call graph for this function:

setCourseConfirmationRequired()

ilPrivacySettings::setCourseConfirmationRequired

(

$a_status

)

Definition at line 228 of file class.ilPrivacySettings.php.

        {
                $this->export_confirm_course = (bool) $a_status;
        }

setGroupConfirmationRequired()

ilPrivacySettings::setGroupConfirmationRequired

(

$a_status

)

Definition at line 233 of file class.ilPrivacySettings.php.

        {
                $this->export_confirm_group = (bool) $a_status;
        }

setRbacLogAge()

ilPrivacySettings::setRbacLogAge

(

$a_age

)

write access to property rbac log age

Parameters

int

$a_age

value to set property

Definition at line 191 of file class.ilPrivacySettings.php.

        {
                $this->rbac_log_age = (int) $a_age;
        }

showCourseAccessTimes()

ilPrivacySettings::showCourseAccessTimes

(

$a_status

)

show course access times

public

Parameters

bool

status

Returns

Definition at line 268 of file class.ilPrivacySettings.php.

        {
                $this->show_crs_access_times = $a_status;
        }

showGroupAccessTimes()

ilPrivacySettings::showGroupAccessTimes

(

$a_status

)

Show group last access times.

public

Parameters

Definition at line 245 of file class.ilPrivacySettings.php.

        {
                $this->show_grp_access_times = $a_status;
        }

validate()

ilPrivacySettings::validate

(

)

validate settings

Returns

0, if everything is ok, an error code otherwise

Definition at line 361 of file class.ilPrivacySettings.php.

        {
            return 0;
        }

Field Documentation

$anonymous_fora

ilPrivacySettings::$anonymous_fora

private

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

Referenced by enabledAnonymousFora().

$db

ilPrivacySettings::$db

private

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

$export_confirm_course

ilPrivacySettings::$export_confirm_course

private

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

Referenced by courseConfirmationRequired().

$export_confirm_group

ilPrivacySettings::$export_confirm_group

private

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

Referenced by groupConfirmationRequired().

$export_course

ilPrivacySettings::$export_course

private

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

Referenced by enabledCourseExport().

$export_group

ilPrivacySettings::$export_group

private

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

Referenced by enabledGroupExport().

$export_scorm

ilPrivacySettings::$export_scorm

private

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

Referenced by enabledExportSCORM().

$fora_statistics

ilPrivacySettings::$fora_statistics

private

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

Referenced by enabledForaStatistics().

$instance

ilPrivacySettings::$instance = null

staticprivate

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

$rbac_log

ilPrivacySettings::$rbac_log

private

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

Referenced by enabledRbacLog().

$rbac_log_age

ilPrivacySettings::$rbac_log_age

private

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

Referenced by getRbacLogAge().

$ref_id

ilPrivacySettings::$ref_id

private

Definition at line 50 of file class.ilPrivacySettings.php.

Referenced by getPrivacySettingsRefId().

$sahs_protocol_data

ilPrivacySettings::$sahs_protocol_data

private

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

Referenced by enabledSahsProtocolData().

$settings

ilPrivacySettings::$settings

private

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

$show_crs_access_times

ilPrivacySettings::$show_crs_access_times

private

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

Referenced by enabledCourseAccessTimes().

$show_grp_access_times

ilPrivacySettings::$show_grp_access_times

private

Definition at line 48 of file class.ilPrivacySettings.php.

Referenced by enabledGroupAccessTimes().

---

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

• Services/PrivacySecurity/classes/class.ilPrivacySettings.php