ilLTIProviderObjectSetting 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 ilLTIProviderObjectSetting:

Public Member Functions
	__construct (int $a_ref_id, int $a_ext_consumer_id)
	Constructor. More...
	setAdminRole (int $a_role)
	getAdminRole ()
	setTutorRole (int $a_role)
	getTutorRole ()
	setMemberRole (int $a_role)
	getMemberRole ()
	setConsumerId (int $a_consumer_id)
	Set consumer id. More...
	getConsumerId ()
	delete ()
	Delete obj setting. More...
	save ()

Protected Member Functions
	read ()
	Read object settings. More...

Private Attributes
ilLogger	$log = null
ilDBInterface	$db = null
int	$ref_id = 0
int	$consumer_id = 0
int	$admin = 0
int	$tutor = 0
int	$member = 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 Stores

Author

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

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

Constructor & Destructor Documentation

__construct()

ilLTIProviderObjectSetting::__construct	(	int	$a_ref_id,
		int	$a_ext_consumer_id
	)

Constructor.

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

References $DIC, ilLoggerFactory\getLogger(), and read().

    {
        global $DIC;

        $this->log = ilLoggerFactory::getLogger('ltis');
        $this->db = $DIC->database();

        $this->ref_id = $a_ref_id;
        $this->consumer_id = $a_ext_consumer_id;

        $ok = $this->read();
        if (!$ok) {
            $this->log->warning("no ref_id set");
        }
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilLTIProviderObjectSetting::delete

(

)

Delete obj setting.

Definition at line 106 of file class.ilLTIProviderObjectSetting.php.

References $query, and getConsumerId().

                            : void
    {
        $query = 'DELETE FROM lti_int_provider_obj ' .
            'WHERE ref_id = ' . $this->db->quote($this->ref_id, 'integer') . ' ' .
            'AND ext_consumer_id = ' . $this->db->quote($this->getConsumerId(), 'integer');
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

getAdminRole()

ilLTIProviderObjectSetting::getAdminRole

(

)

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

References $admin.

Referenced by save().

                                  : int
    {
        return $this->admin;
    }

Here is the caller graph for this function:

getConsumerId()

ilLTIProviderObjectSetting::getConsumerId

(

)

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

References $consumer_id.

Referenced by delete(), read(), and save().

                                   : int
    {
        return $this->consumer_id;
    }

Here is the caller graph for this function:

getMemberRole()

ilLTIProviderObjectSetting::getMemberRole

(

)

Definition at line 84 of file class.ilLTIProviderObjectSetting.php.

References $member.

Referenced by save().

                                   : int
    {
        return $this->member;
    }

Here is the caller graph for this function:

getTutorRole()

ilLTIProviderObjectSetting::getTutorRole

(

)

Definition at line 74 of file class.ilLTIProviderObjectSetting.php.

References $tutor.

Referenced by save().

                                  : int
    {
        return $this->tutor;
    }

Here is the caller graph for this function:

read()

ilLTIProviderObjectSetting::read ( )

protected

Read object settings.

Definition at line 132 of file class.ilLTIProviderObjectSetting.php.

References $query, $res, getConsumerId(), and ILIAS\Repository\int().

Referenced by __construct().

                             : bool
    {
        if (!$this->ref_id) {
            return false;
        }

        $query = 'SELECT * FROM lti_int_provider_obj ' .
            'WHERE ref_id = ' . $this->db->quote($this->ref_id, 'integer') . ' ' .
            'AND ext_consumer_id = ' . $this->db->quote($this->getConsumerId(), 'integer');

        $res = $this->db->query($query);
        while ($row = $res->fetchObject()) {
            $this->ref_id = (int) $row->ref_id;
            $this->consumer_id = (int) $row->ext_consumer_id;
            $this->admin = (int) $row->admin;
            $this->tutor = (int) $row->tutor;
            $this->member = (int) $row->member;
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilLTIProviderObjectSetting::save

(

)

Definition at line 114 of file class.ilLTIProviderObjectSetting.php.

References $query, getAdminRole(), getConsumerId(), getMemberRole(), and getTutorRole().

                          : void
    {
        $this->delete();

        $query = 'INSERT INTO lti_int_provider_obj ' .
            '(ref_id,ext_consumer_id,admin,tutor,member) VALUES( ' .
            $this->db->quote($this->ref_id, 'integer') . ', ' .
            $this->db->quote($this->getConsumerId(), 'integer') . ', ' .
            $this->db->quote($this->getAdminRole(), 'integer') . ', ' .
            $this->db->quote($this->getTutorRole(), 'integer') . ', ' .
            $this->db->quote($this->getMemberRole(), 'integer') .
            ' )';
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

setAdminRole()

ilLTIProviderObjectSetting::setAdminRole

(

int

$a_role

)

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

                                             : void
    {
        $this->admin = $a_role;
    }

setConsumerId()

ilLTIProviderObjectSetting::setConsumerId

(

int

$a_consumer_id

)

Set consumer id.

Definition at line 92 of file class.ilLTIProviderObjectSetting.php.

                                                     : void
    {
        $this->consumer_id = $a_consumer_id;
    }

setMemberRole()

ilLTIProviderObjectSetting::setMemberRole

(

int

$a_role

)

Definition at line 79 of file class.ilLTIProviderObjectSetting.php.

                                              : void
    {
        $this->member = $a_role;
    }

setTutorRole()

ilLTIProviderObjectSetting::setTutorRole

(

int

$a_role

)

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

                                             : void
    {
        $this->tutor = $a_role;
    }

Field Documentation

$admin

int ilLTIProviderObjectSetting::$admin = 0

private

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

Referenced by getAdminRole().

$consumer_id

int ilLTIProviderObjectSetting::$consumer_id = 0

private

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

Referenced by getConsumerId().

$db

ilDBInterface ilLTIProviderObjectSetting::$db = null

private

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

$log

ilLogger ilLTIProviderObjectSetting::$log = null

private

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

$member

int ilLTIProviderObjectSetting::$member = 0

private

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

Referenced by getMemberRole().

$ref_id

int ilLTIProviderObjectSetting::$ref_id = 0

private

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

$tutor

int ilLTIProviderObjectSetting::$tutor = 0

private

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

Referenced by getTutorRole().

---

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

• Services/LTI/classes/InternalProvider/class.ilLTIProviderObjectSetting.php