ilMemberAgreement Class Reference

Collaboration diagram for ilMemberAgreement:

Public Member Functions
	__construct ($a_usr_id, $a_obj_id)
	Constructor. More...
	setAccepted ($a_status)
	set accepted More...
	setAcceptanceTime ($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 ()
	Is accepted. More...
	getAcceptanceTime ()
	get Acceptance time More...
	save ()
	save Acceptance settings More...
	delete ()
	Delete entry. More...
	read ()
	Read user entries. More...

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

Private Attributes
	$db
	$user_id
	$obj_id
	$type
	$privacy
	$accepted = false
	$acceptance_time = 0

Detailed Description

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilMemberAgreement::__construct	(		$a_usr_id,
			$a_obj_id
	)

Constructor.

public

Parameters

int	usr_id
int	obj_id

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

References $DIC, $ilDB, ilPrivacySettings\_getInstance(), ilCourseDefinedFieldDefinition\_hasFields(), ilObject\_lookupType(), 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 (   $a_obj_id )

static

Delete all entries by obj_id.

public static

Parameters

int

obj_id

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

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

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

    {
        global $DIC;

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

Here is the caller graph for this function:

_deleteByUser()

static ilMemberAgreement::_deleteByUser (   $a_usr_id )

static

Delete all entries by user.

public static

Parameters

int

user id

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

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

Referenced by ilCourseTest\testMemberAgreement().

    {
        global $DIC;

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

Here is the caller graph for this function:

_hasAccepted()

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

static

Check if user has accepted agreement.

public

Parameters

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

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        
        return $row->accepted == 1 ? true : false;
    }

Here is the caller graph for this function:

_hasAgreements()

static ilMemberAgreement::_hasAgreements ( )

static

Check if there is any user agreement.

public

Parameters

int

obj_id

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

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

Referenced by ilCustomUserFieldsGUI\initFieldDefinition(), ilCustomUserFieldsGUI\initForm(), ilObjPrivacySecurityGUI\showPrivacy(), and ilCourseTest\testMemberAgreement().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM member_agreement " .
            "WHERE accepted = 1";
        
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }

Here is the caller graph for this function:

_hasAgreementsByObjId()

static ilMemberAgreement::_hasAgreementsByObjId (   $a_obj_id )

static

Check if there is any user agreement.

public

Parameters

int

obj_id

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

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

Referenced by ilObjectCustomUserFieldsGUI\show(), and ilCourseTest\testMemberAgreement().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM member_agreement " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " " .
            "AND accepted = 1";
        
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }

Here is the caller graph for this function:

_readByObjId()

static ilMemberAgreement::_readByObjId (   $a_obj_id )

static

Read user data by object id.

public

Parameters

int

obj_id

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

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

Referenced by ilMemberExport\__construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM member_agreement " .
            "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer');
            
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $user_data[$row->usr_id]['accepted'] = $row->accepted;
            $user_data[$row->usr_id]['acceptance_time'] = $row->acceptance_time;
        }
        return $user_data ? $user_data : array();
    }

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.

public

Parameters

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

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "UPDATE member_agreement SET accepted = 0 ";
        $res = $ilDB->manipulate($query);
        
        return true;
    }

Here is the caller graph for this function:

_resetContainer()

static ilMemberAgreement::_resetContainer (   $a_container_id )

static

Reset all agreements for a specific container.

public static

Parameters

int	obj_id of container

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

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

    {
        global $DIC;

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

agreementRequired()

ilMemberAgreement::agreementRequired

(

)

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

public

Returns

bool

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

References ilCourseDefinedFieldDefinition\_hasFields().

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

Here is the call graph for this function:

delete()

ilMemberAgreement::delete

(

)

Delete entry.

public

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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 = $ilDB->manipulate($query);
        return true;
    }

getAcceptanceTime()

ilMemberAgreement::getAcceptanceTime

(

)

get Acceptance time

public

Parameters

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

References $acceptance_time.

Referenced by save().

    {
        return $this->acceptance_time;
    }

Here is the caller graph for this function:

isAccepted()

ilMemberAgreement::isAccepted

(

)

Is accepted.

public

Parameters

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

References $accepted.

Referenced by save().

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

Here is the caller graph for this function:

lookupAcceptedAgreements()

static ilMemberAgreement::lookupAcceptedAgreements (   $a_obj_id )

static

Lookup users who have accepted the agreement.

Parameters

int

$a_obj_id

Returns

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

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_ASSOC.

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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 = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $user_ids[] = $row['usr_id'];
        }
        return $user_ids;
    }

Here is the caller graph for this function:

read()

ilMemberAgreement::read

(

)

Read user entries.

private

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

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

Referenced by __construct().

    {
        $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 = $row->accepted;
            $this->acceptance_time = $row->acceptance_time;
        }
    }

Here is the caller graph for this function:

save()

ilMemberAgreement::save

(

)

save Acceptance settings

public

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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') . " " .
            ")";
        $ilDB->manipulate($query);
        return true;
    }

Here is the call graph for this function:

setAcceptanceTime()

ilMemberAgreement::setAcceptanceTime

(

$a_timest

)

set acceptance time

public

Parameters

int	unix time of acceptance

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

    {
        $this->acceptance_time = $a_timest;
    }

setAccepted()

ilMemberAgreement::setAccepted

(

$a_status

)

set accepted

public

Parameters

bool

status

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

Referenced by ilRegistrationGUI\setAccepted().

    {
        $this->accepted = $a_status;
    }

Here is the caller graph for this function:

Field Documentation

$acceptance_time

ilMemberAgreement::$acceptance_time = 0

private

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

Referenced by getAcceptanceTime().

$accepted

ilMemberAgreement::$accepted = false

private

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

Referenced by isAccepted().

$db

ilMemberAgreement::$db

private

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

$obj_id

ilMemberAgreement::$obj_id

private

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

$privacy

ilMemberAgreement::$privacy

private

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

$type

ilMemberAgreement::$type

private

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

$user_id

ilMemberAgreement::$user_id

private

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

---

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

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