ilLTIPlatform Class Reference

The platforms of the administration that launch ILIAS: what lti_ext_consumer keeps of them, and their LTI Advantage registration in lti2_consumer, the table of celtic/lti, which ilLTIDataConnector reads at a launch. More...

Collaboration diagram for ilLTIPlatform:

Static Public Member Functions
static	lookupVersion (int $platform_id)
	The LTI version of a platform of the administration: LTI Advantage when it has an LTI Advantage registration, for the whole platform or, in older installations, for one of its objects. More...
static	saveRegistration (int $platform_id, string $name, bool $enabled, array $registration, array $settings=[])
	Stores the LTI Advantage registration of a platform of the administration, once for the whole platform (ref_id 0). More...
static	lookupIdByRegistration (string $issuer, string $client_id, string $deployment_id)
	The platform of the administration an LTI Advantage registration belongs to, 0 when none has it. More...
static	lookupAdministrationRow (int $platform_id)
	The platform of the administration as stored in lti_ext_consumer, empty when it does not exist. More...
static	lookupNamesRoles (int $platform_id)
	Whether ILIAS reads the members of the contexts of the platform when an instructor launches (LTI Advantage NRPS). More...
static	lookupObjectTypes (int $platform_id)
	The types of the objects that can be released to a platform of the administration. More...
static	lookupRegistrationSettings (int $platform_id)
	The settings of celtic/lti the LTI Advantage registration of a platform of the administration has. More...

Detailed Description

The platforms of the administration that launch ILIAS: what lti_ext_consumer keeps of them, and their LTI Advantage registration in lti2_consumer, the table of celtic/lti, which ilLTIDataConnector reads at a launch.

Author

Saúl Díaz sdiaz.nosp@m.@sur.nosp@m.labs..nosp@m.com

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

Member Function Documentation

lookupAdministrationRow()

static ilLTIPlatform::lookupAdministrationRow ( int  $platform_id )

static

The platform of the administration as stored in lti_ext_consumer, empty when it does not exist.

Definition at line 129 of file class.ilLTIPlatform.php.

                                                                    : array
    {
        global $DIC;
 
        $db = $DIC->database();
 
        return $db->fetchAssoc($db->query(
            'SELECT * FROM lti_ext_consumer WHERE id = ' . $db->quote($platform_id, 'integer')
        )) ?? [];
    }

References $DIC.

Referenced by ilLTIAdvantageToolRegistration\acceptToken(), ilLTIAdvantageToolRegistration\getPlatformToRegister(), ilAuthProviderLTI\lookupConsumer(), and ilLTIAdministrationPlatformForm\read().

Here is the caller graph for this function:

lookupIdByRegistration()

static ilLTIPlatform::lookupIdByRegistration ( string  $issuer, string  $client_id, string  $deployment_id  )

static

The platform of the administration an LTI Advantage registration belongs to, 0 when none has it.

A launch names the platform by these three ids, so no two platforms may share them.

Definition at line 110 of file class.ilLTIPlatform.php.

                                                                                                           : int
    {
        global $DIC;
 
        $db = $DIC->database();
        $db->setLimit(1);
        $row = $db->fetchAssoc($db->queryF(
            'SELECT ext_consumer_id FROM lti2_consumer WHERE platform_id = %s AND client_id = %s AND deployment_id = %s'
            . ' AND lti_version = %s ORDER BY ref_id, consumer_pk',
            ['text', 'text', 'text', 'text'],
            [$issuer, $client_id, $deployment_id, LtiVersion::V1P3->value]
        ));
 
        return (int) ($row['ext_consumer_id'] ?? 0);
    }

References $client_id, and $DIC.

Referenced by ilLTIAdministrationPlatformForm\getForm(), and ilLTIAdvantageToolRegistration\getPlatformToRegister().

Here is the caller graph for this function:

lookupNamesRoles()

static ilLTIPlatform::lookupNamesRoles ( int  $platform_id )

static

Whether ILIAS reads the members of the contexts of the platform when an instructor launches (LTI Advantage NRPS).

Definition at line 143 of file class.ilLTIPlatform.php.

                                                             : bool
    {
        return (bool) (self::lookupAdministrationRow($platform_id)['names_roles'] ?? false);
    }

Referenced by ilAuthProviderLTI\syncMembers().

Here is the caller graph for this function:

lookupObjectTypes()

static ilLTIPlatform::lookupObjectTypes ( int  $platform_id )

static

The types of the objects that can be released to a platform of the administration.

Returns

string[]

Definition at line 153 of file class.ilLTIPlatform.php.

                                                              : array
    {
        global $DIC;
 
        $db = $DIC->database();
        $result = $db->queryF(
            'SELECT object_type FROM lti_ext_consumer_otype WHERE consumer_id = %s',
            ['integer'],
            [$platform_id]
        );
        $types = [];
        while ($row = $db->fetchAssoc($result)) {
            $types[] = (string) $row['object_type'];
        }
 
        return $types;
    }

References $DIC.

Referenced by ilLTIAdministrationPlatformTable\getObjectTypes(), and ilLTIAdministrationPlatformForm\read().

Here is the caller graph for this function:

lookupRegistrationSettings()

static ilLTIPlatform::lookupRegistrationSettings ( int  $platform_id )

static

The settings of celtic/lti the LTI Advantage registration of a platform of the administration has.

Definition at line 174 of file class.ilLTIPlatform.php.

                                                                       : array
    {
        global $DIC;
 
        $db = $DIC->database();
        $row = $db->fetchAssoc($db->query(
            'SELECT settings FROM lti2_consumer WHERE ref_id = 0 AND ext_consumer_id = ' . $db->quote($platform_id, 'integer')
        ));
        $settings = json_decode((string) ($row['settings'] ?? ''), true);
 
        return is_array($settings) ? $settings : [];
    }

References $DIC, and $settings.

Referenced by ilLTIAdvantageToolRegistration\acceptToken(), and ilLTIAdministrationPlatformForm\save().

Here is the caller graph for this function:

lookupVersion()

static ilLTIPlatform::lookupVersion ( int  $platform_id )

static

The LTI version of a platform of the administration: LTI Advantage when it has an LTI Advantage registration, for the whole platform or, in older installations, for one of its objects.

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

                                                          : string
    {
        global $DIC;
 
        $db = $DIC->database();
        $db->setLimit(1);
        $row = $db->fetchAssoc($db->queryF(
            'SELECT consumer_pk FROM lti2_consumer WHERE lti_version = %s AND ext_consumer_id = %s',
            ['text', 'integer'],
            [ilLTITool::VERSION_ADVANTAGE, $platform_id]
        ));
 
        return $row !== null ? ilLTITool::VERSION_ADVANTAGE : ilLTITool::VERSION_1P1;
    }

References $DIC, ilLTITool\VERSION_1P1, and ilLTITool\VERSION_ADVANTAGE.

Referenced by ilLTIAdvantageToolRegistration\acceptToken(), ilObjLTIAdministrationGUI\getPlatformForm(), and ilLTIProviderObjectSettingGUI\isAdvantage().

Here is the caller graph for this function:

saveRegistration()

static ilLTIPlatform::saveRegistration ( int  $platform_id, string  $name, bool  $enabled, array  $registration, array  $settings = []  )

static

Stores the LTI Advantage registration of a platform of the administration, once for the whole platform (ref_id 0).

The URLs go to the settings of celtic/lti. An empty registration still marks the platform as an LTI Advantage one, until it registers through Dynamic Registration.

Parameters

int	$platform_id	the platform in lti_ext_consumer
array	$registration	platform_id, client_id, deployment_id, keyset_url, token_url and authentication_url
array	$settings	further settings of celtic/lti to store

Definition at line 60 of file class.ilLTIPlatform.php.

     : void {
        global $DIC;
 
        $db = $DIC->database();
        $now = date('Y-m-d H:i:s');
        $fields = [
            'name' => ['text', ilStr::subStr($name, 0, 50)],
            'lti_version' => ['text', LtiVersion::V1P3->value],
            'signature_method' => ['text', 'RS256'],
            'enabled' => ['integer', (int) $enabled],
            'platform_id' => ['text', $registration['platform_id']],
            'client_id' => ['text', $registration['client_id']],
            'deployment_id' => ['text', $registration['deployment_id']],
            'settings' => ['text', json_encode([
                '_jku' => $registration['keyset_url'],
                '_oauth2_access_token_url' => $registration['token_url'],
                '_authentication_request_url' => $registration['authentication_url'],
            ] + $settings, JSON_UNESCAPED_SLASHES)],
            // the key celtic/lti fetched from the key set is a cache: it is fetched again from the saved URL
            'public_key' => ['clob', null],
            'updated' => ['timestamp', $now],
        ];
 
        $row = $db->fetchAssoc($db->query(
            'SELECT consumer_pk FROM lti2_consumer WHERE ref_id = 0 AND ext_consumer_id = ' . $db->quote($platform_id, 'integer')
        ));
        if ($row !== null) {
            $db->update('lti2_consumer', $fields, ['consumer_pk' => ['integer', (int) $row['consumer_pk']]]);
            return;
        }
        $db->insert('lti2_consumer', $fields + [
            'consumer_pk' => ['integer', $db->nextId('lti2_consumer')],
            'secret' => ['text', ''],
            'protected' => ['integer', 0],
            'created' => ['timestamp', $now],
            'ext_consumer_id' => ['integer', $platform_id],
            'ref_id' => ['integer', 0],
        ]);
    }

Referenced by ilLTIAdvantageToolRegistration\getPlatformToRegister(), and ilLTIAdministrationPlatformForm\save().

Here is the caller graph for this function:

---

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

• components/ILIAS/LTI/classes/Object/class.ilLTIPlatform.php