ilPrivacySettings Class Reference

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

Collaboration diagram for ilPrivacySettings:

Public Member Functions
	_getInstance ()
	Get instance of ilPrivacySettings.
	getPrivacySettingsRefId ()
	enabledExport ()
	enableExport ($a_status)
	enableForaStatistics ($a_status)
	write access to property fora statitics
	enabledForaStatistics ()
	read access to property enable fora statistics
	confirmationRequired ()
	setConfirmationRequired ($a_status)
	showAccessTimes ($a_status)
	Show group last access times.
	enabledAccessTimes ()
	check if group access time are visible
	save ()
	Save settings.
	validate ()
	validate settings
Private Member Functions
	__construct ()
	Private constructor: use _getInstance().
	read ()
	read settings
Private Attributes
	$db
	$settings
	$export_course
	$export_confirm
	$fora_statistics
	$access_times
	$ref_id
Static Private Attributes
static	$instance = null

---

Detailed Description

Singleton class that stores all privacy settings.

Author:

Stefan Meyer <smeyer@databay.de>

Version:

$Id$

/

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

---

Constructor & Destructor Documentation

ilPrivacySettings::__construct

(

)

[private]

Private constructor: use _getInstance().

private

Parameters:

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

References $ilSetting, and read().

        {
                global $ilSetting,$ilDB;

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

                $this->read();
        }

Here is the call graph for this function:

---

Member Function Documentation

ilPrivacySettings::_getInstance

(

)

Get instance of ilPrivacySettings.

public

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

Referenced by ilMemberExport::__construct(), ilCourseRegisterGUI::__construct(), ilCourseAgreementGUI::__construct(), ilCourseAgreement::__construct(), ilObjGroupGUI::__showMembersTable(), ilObjCourseGUI::checkAgreement(), ilMemberExportGUI::executeCommand(), ilExportUserSettings::getOrderedExportableFields(), ilSoapUserAdministration::getUserForRole(), ilObjCourseGUI::infoScreen(), ilObjGroupGUI::membersObject(), ilObjPrivacySecurityGUI::save_privacy(), ilObjUserFolderGUI::saveGlobalUserSettingsObject(), ilObjCourseGUI::setSubTabs(), ilObjPrivacySecurityGUI::showPrivacy(), and ilObjUserFolderGUI::updateFieldsObject().

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

Here is the caller graph for this function:

ilPrivacySettings::confirmationRequired

(

)

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

Referenced by save().

        {
                return $this->export_confirm;
        }

Here is the caller graph for this function:

ilPrivacySettings::enabledAccessTimes

(

)

check if group access time are visible

public

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

Referenced by save().

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

Here is the caller graph for this function:

ilPrivacySettings::enabledExport

(

)

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

Referenced by save().

        {
                return $this->export_course;
        }

Here is the caller graph for this function:

ilPrivacySettings::enabledForaStatistics

(

)

read access to property enable fora statistics

Returns:

bool true if enabled, false otherwise

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

Referenced by save().

                                                  {
                        return $this->fora_statistics;
                }

Here is the caller graph for this function:

ilPrivacySettings::enableExport

(

$

a_status

)

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

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

ilPrivacySettings::enableForaStatistics

(

$

a_status

)

write access to property fora statitics

Parameters:

bool

$a_status value to set property

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

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

ilPrivacySettings::getPrivacySettingsRefId

(

)

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

        {
                return $this->ref_id;
        }

ilPrivacySettings::read

(

)

[private]

read settings

private

Parameters:

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

References $res.

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)." ".
                                "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(DB_FETCHMODE_ASSOC);
                $this->ref_id = $row["ref_id"];

                $this->export_course = (bool) $this->settings->get('ps_export_course',false);
                $this->export_confirm = (bool) $this->settings->get('ps_export_confirm',false);
                $this->fora_statistics = (bool) $this->settings->get('enable_fora_statistics',false);
                $this->show_access_times = (bool) $this->settings->get('ps_access_times',false);

        }

Here is the caller graph for this function:

ilPrivacySettings::save

(

)

Save settings.

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

References confirmationRequired(), enabledAccessTimes(), enabledExport(), and enabledForaStatistics().

        {
                $this->settings->set('ps_export_confirm',(bool) $this->confirmationRequired());
                $this->settings->set('ps_export_course',(bool) $this->enabledExport());
                $this->settings->set('enable_fora_statistics',(bool) $this->enabledForaStatistics());
                $this->settings->set('ps_access_times',(bool) $this->enabledAccessTimes());
        }

Here is the call graph for this function:

ilPrivacySettings::setConfirmationRequired

(

$

a_status

)

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

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

ilPrivacySettings::showAccessTimes

(

$

a_status

)

Show group last access times.

public

Parameters:

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

        {
                $this->show_access_times = $a_status;
        }

ilPrivacySettings::validate

(

)

validate settings

Returns:

0, if everything is ok, an error code otherwise

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

                                   {
            return 0;
        }

---

Field Documentation

ilPrivacySettings::$access_times [private]

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

ilPrivacySettings::$db [private]

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

ilPrivacySettings::$export_confirm [private]

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

ilPrivacySettings::$export_course [private]

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

ilPrivacySettings::$fora_statistics [private]

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

ilPrivacySettings::$instance = null [static, private]

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

ilPrivacySettings::$ref_id [private]

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

ilPrivacySettings::$settings [private]

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

---

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

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