ilECSUserConsents Class Reference

Class ilECSUserConsents. More...

Collaboration diagram for ilECSUserConsents:

Public Member Functions
	getUserId ()
	hasConsented (int $server_id, int $a_mid)
	delete ()
	add (int $server_id, int $a_mid)

Static Public Member Functions
static	getInstanceByUserId (int $a_usr_id)

Protected Member Functions
	__construct (int $a_usr_id)
	read ()

Protected Attributes
ilDBInterface	$db

Private Attributes
int	$usr_id
array	$consents = []

Static Private Attributes
static array	$instances = []

Detailed Description

Class ilECSUserConsents.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilECSUserConsents::__construct ( int  $a_usr_id )

protected

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

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->usr_id = $a_usr_id;
        if ($a_usr_id > 0) {
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilECSUserConsents::add	(	int	$server_id,
		int	$a_mid
	)

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

References getUserId(), and hasConsented().

                                                   : void
    {
        if (!$this->hasConsented($server_id, $a_mid)) {
            $consent = new ilECSUserConsent($this->getUserId(), $server_id, $a_mid);
            $consent->save();
            $this->consents["{$server_id}:{$a_mid}"] = $consent;
        }
    }

Here is the call graph for this function:

delete()

ilECSUserConsents::delete

(

)

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

                            : void
    {
        foreach ($this->consents as $mid => $consent) {
            $consent->delete();
        }
        $this->consents = [];
    }

getInstanceByUserId()

static ilECSUserConsents::getInstanceByUserId ( int  $a_usr_id )

static

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

Referenced by ilECSUserConsentModalGUI\__construct().

                                                             : self
    {
        if (!isset(self::$instances[$a_usr_id])) {
            self::$instances[$a_usr_id] = new self($a_usr_id);
        }
        return self::$instances[$a_usr_id];
    }

Here is the caller graph for this function:

getUserId()

ilECSUserConsents::getUserId

(

)

Definition at line 59 of file class.ilECSUserConsents.php.

References $usr_id.

Referenced by add(), and read().

                               : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

hasConsented()

ilECSUserConsents::hasConsented	(	int	$server_id,
		int	$a_mid
	)

Definition at line 64 of file class.ilECSUserConsents.php.

Referenced by add().

                                                            : bool
    {
        return array_key_exists("{$server_id}:{$a_mid}", $this->consents);
    }

Here is the caller graph for this function:

read()

ilECSUserConsents::read ( )

protected

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

References $res, ilDBConstants\FETCHMODE_OBJECT, getUserId(), and ilDBConstants\T_INTEGER.

Referenced by __construct().

                             : void
    {
        $query = 'SELECT * FROM ecs_user_consent ' .
            'WHERE usr_id = ' . $this->db->quote(
                $this->getUserId(),
                ilDBConstants::T_INTEGER
            );
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->consents["{$row->server_id}:{$row->mid}"] = new ilECSUserConsent(
                (int) $row->usr_id,
                (int) $row->server_id,
                (int) $row->mid
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$consents

array ilECSUserConsents::$consents = []

private

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

$db

ilDBInterface ilECSUserConsents::$db

protected

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

$instances

array ilECSUserConsents::$instances = []

staticprivate

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

$usr_id

int ilECSUserConsents::$usr_id

private

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

Referenced by getUserId().

---

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

• components/ILIAS/WebServices/ECS/classes/Consent/class.ilECSUserConsents.php