ilMemberAgreement Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilMemberAgreement:

Public Member Functions
	__construct (int $a_usr_id, int $a_obj_id)
	setAccepted (bool $a_status)
	set accepted More...
	setAcceptanceTime (int $a_timest)
	set acceptance time More...
	agreementRequired ()
	Checks whether the agreement is accepted This function return always true if no acceptance is required by global setting. More...
	isAccepted ()
	getAcceptanceTime ()
	save ()
	save acceptance settings More...
	delete ()
	Delete entry. More...
	read ()
	Read user entries. More...

Static Public Member Functions
static	_readByObjId (int $a_obj_id)
	Read user data by object id. More...
static	_hasAgreementsByObjId (int $a_obj_id)
	Check if there is any user agreement. More...
static	_hasAgreements ()
	Check if there is any user agreement. More...
static	_hasAccepted (int $a_usr_id, int $a_obj_id)
	Check if user has accepted agreement. More...
static	lookupAcceptedAgreements (int $a_obj_id)
	Lookup users who have accepted the agreement. More...
static	_deleteByUser (int $a_usr_id)
	Delete all entries by user. More...
static	_deleteByObjId (int $a_obj_id)
	Delete all entries by obj_id. More...
static	_reset ()
	Reset all. More...
static	_resetContainer (int $a_container_id)
	Reset all agreements for a specific container. More...

Private Attributes
ilDBInterface	$db
int	$user_id
int	$obj_id
string	$type
ilPrivacySettings	$privacy
bool	$accepted = false
int	$acceptance_time = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

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

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

Constructor & Destructor Documentation

__construct()

ilMemberAgreement::__construct	(	int	$a_usr_id,
		int	$a_obj_id
	)

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

References $DIC, $ilDB, ilCourseDefinedFieldDefinition\_hasFields(), ilObject\_lookupType(), ilPrivacySettings\getInstance(), and read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $this->db = $ilDB;
        $this->user_id = $a_usr_id;
        $this->obj_id = $a_obj_id;
        $this->type = ilObject::_lookupType($this->obj_id);

        $this->privacy = ilPrivacySettings::getInstance();

        if ($this->privacy->confirmationRequired($this->type) or ilCourseDefinedFieldDefinition::_hasFields($this->obj_id)) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

_deleteByObjId()

static ilMemberAgreement::_deleteByObjId ( int  $a_obj_id )

static

Delete all entries by obj_id.

Definition at line 162 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilObjectCustomUserFieldsGUI\deleteFields(), ilObjectCustomUserFieldsGUI\saveField(), ilObjectCustomUserFieldsGUI\saveFields(), and ilObjectCustomUserFieldsGUI\updateField().

                                                        : void
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "DELETE FROM member_agreement " .
            "WHERE obj_id =" . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

Here is the caller graph for this function:

_deleteByUser()

static ilMemberAgreement::_deleteByUser ( int  $a_usr_id )

static

Delete all entries by user.

Definition at line 148 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, and $res.

                                                       : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "DELETE FROM member_agreement " .
            "WHERE usr_id =" . $ilDB->quote($a_usr_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

_hasAccepted()

static ilMemberAgreement::_hasAccepted ( int  $a_usr_id, int  $a_obj_id  )

static

Check if user has accepted agreement.

Definition at line 108 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjGroupGUI\checkAgreement(), and ilObjCourseGUI\checkAgreement().

                                                                     : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT accepted FROM member_agreement " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_obj_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->accepted === 1;
        }
        return false;
    }

Here is the caller graph for this function:

_hasAgreements()

static ilMemberAgreement::_hasAgreements ( )

static

Check if there is any user agreement.

Definition at line 93 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilCustomUserFieldsGUI\initFieldDefinition(), ilCustomUserFieldsGUI\initForm(), and ilObjPrivacySecurityGUI\initPrivacyForm().

                                           : bool
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT * FROM member_agreement " .
            "WHERE accepted = 1";

        $res = $ilDB->query($query);
        return (bool) $res->numRows();
    }

Here is the caller graph for this function:

_hasAgreementsByObjId()

static ilMemberAgreement::_hasAgreementsByObjId ( int  $a_obj_id )

static

Check if there is any user agreement.

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

References $DIC, $ilDB, $query, and $res.

Referenced by ilObjectCustomUserFieldsGUI\show().

                                                               : bool
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT * FROM member_agreement " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND accepted = 1";

        $res = $ilDB->query($query);
        return (bool) $res->numRows();
    }

Here is the caller graph for this function:

_readByObjId()

static ilMemberAgreement::_readByObjId ( int  $a_obj_id )

static

Read user data by object id.

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilMemberExport\__construct().

                                                      : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT * FROM member_agreement " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');

        $res = $ilDB->query($query);
        $user_data = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $user_data[(int) $row->usr_id]['accepted'] = $row->accepted;
            $user_data[(int) $row->usr_id]['acceptance_time'] = $row->acceptance_time;
        }
        return $user_data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_reset()

static ilMemberAgreement::_reset ( )

static

Reset all.

Set all aggrement to 0. This is called after global settings have been modified.

Definition at line 176 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, and $res.

Referenced by ilCustomUserFieldsGUI\create(), ilObjPrivacySecurityGUI\save_privacy(), ilObjUserFolderGUI\saveGlobalUserSettingsObject(), and ilCustomUserFieldsGUI\update().

                                   : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "UPDATE member_agreement SET accepted = 0 ";
        $res = $ilDB->manipulate($query);
    }

Here is the caller graph for this function:

_resetContainer()

static ilMemberAgreement::_resetContainer ( int  $a_container_id )

static

Reset all agreements for a specific container.

Definition at line 189 of file class.ilMemberAgreement.php.

References $DIC, $ilDB, $query, and $res.

                                                               : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "UPDATE member_agreement " .
            "SET accepted = 0 " .
            "WHERE obj_id = " . $ilDB->quote($a_container_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

agreementRequired()

ilMemberAgreement::agreementRequired

(

)

Checks whether the agreement is accepted This function return always true if no acceptance is required by global setting.

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

References $accepted, and ilCourseDefinedFieldDefinition\_hasFields().

                                       : bool
    {
        if (
            !$this->privacy->confirmationRequired($this->type) &&
            !ilCourseDefinedFieldDefinition::_hasFields($this->obj_id)
        ) {
            return false;
        }
        return !$this->accepted;
    }

Here is the call graph for this function:

delete()

ilMemberAgreement::delete

(

)

Delete entry.

Definition at line 261 of file class.ilMemberAgreement.php.

References $query, and $res.

                            : void
    {
        $query = "DELETE FROM member_agreement " .
            "WHERE usr_id = " . $this->db->quote($this->user_id, 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->obj_id, 'integer');
        $res = $this->db->manipulate($query);
    }

getAcceptanceTime()

ilMemberAgreement::getAcceptanceTime

(

)

Definition at line 237 of file class.ilMemberAgreement.php.

References $acceptance_time.

Referenced by save().

                                       : int
    {
        return $this->acceptance_time;
    }

Here is the caller graph for this function:

isAccepted()

ilMemberAgreement::isAccepted

(

)

Definition at line 232 of file class.ilMemberAgreement.php.

References $accepted.

Referenced by save().

                                : bool
    {
        return $this->accepted;
    }

Here is the caller graph for this function:

lookupAcceptedAgreements()

static ilMemberAgreement::lookupAcceptedAgreements ( int  $a_obj_id )

static

Lookup users who have accepted the agreement.

Returns

int[]

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_ASSOC, and ILIAS\Repository\int().

Referenced by ilBookingReservationsTableGUI\getItems(), ilTrQuery\getUDFAndHandlePrivacy(), and ilParticipantTableGUI\initSettings().

                                                                  : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = "SELECT usr_id FROM member_agreement " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . ' ' .
            "AND accepted = 1 ";

        $res = $ilDB->query($query);
        $user_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $user_ids[] = (int) $row['usr_id'];
        }
        return $user_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilMemberAgreement::read

(

)

Read user entries.

Definition at line 272 of file class.ilMemberAgreement.php.

References $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by __construct().

                          : void
    {
        $query = "SELECT * FROM member_agreement " .
            "WHERE usr_id = " . $this->db->quote($this->user_id, 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->obj_id, 'integer') . " ";

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->accepted = (bool) $row->accepted;
            $this->acceptance_time = (int) $row->acceptance_time;
        }
    }

Here is the caller graph for this function:

save()

ilMemberAgreement::save

(

)

save acceptance settings

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

References $query, getAcceptanceTime(), and isAccepted().

                          : void
    {
        $this->delete();
        $query = "INSERT INTO member_agreement (usr_id,obj_id,accepted,acceptance_time) " .
            "VALUES( " .
            $this->db->quote($this->user_id, 'integer') . ", " .
            $this->db->quote($this->obj_id, 'integer') . ", " .
            $this->db->quote((int) $this->isAccepted(), 'integer') . ", " .
            $this->db->quote($this->getAcceptanceTime(), 'integer') . " " .
            ")";
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

setAcceptanceTime()

ilMemberAgreement::setAcceptanceTime

(

int

$a_timest

)

set acceptance time

Definition at line 212 of file class.ilMemberAgreement.php.

                                                    : void
    {
        $this->acceptance_time = $a_timest;
    }

setAccepted()

ilMemberAgreement::setAccepted

(

bool

$a_status

)

set accepted

Definition at line 204 of file class.ilMemberAgreement.php.

Referenced by ilRegistrationGUI\setAccepted().

                                               : void
    {
        $this->accepted = $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$acceptance_time

int ilMemberAgreement::$acceptance_time = 0

private

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

Referenced by getAcceptanceTime().

$accepted

bool ilMemberAgreement::$accepted = false

private

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

Referenced by agreementRequired(), and isAccepted().

$db

ilDBInterface ilMemberAgreement::$db

private

Definition at line 27 of file class.ilMemberAgreement.php.

$obj_id

int ilMemberAgreement::$obj_id

private

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

$privacy

ilPrivacySettings ilMemberAgreement::$privacy

private

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

$type

string ilMemberAgreement::$type

private

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

$user_id

int ilMemberAgreement::$user_id

private

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

---

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

• Services/Membership/classes/class.ilMemberAgreement.php