ilCmiXapiLrsType Class Reference

Collaboration diagram for ilCmiXapiLrsType:

Public Member Functions
	__construct ($a_type_id=0)
	Constructor. More...
	setTypeId ($a_type_id)
	getTypeId ()
	setTitle ($a_title)
	getTitle ()
	setDescription ($a_description)
	getDescription ()
	setAvailability ($a_availability)
	getAvailability ()
	isAvailable ()
	setTimeToDelete ($a_time_to_delete)
	getTimeToDelete ()
	setLrsEndpoint ($a_endpoint)
	getLrsEndpoint ()
	setLrsKey ($a_lrs_key)
	getLrsKey ()
	setLrsSecret ($a_lrs_secret)
	getLrsSecret ()
	setPrivacyIdent ($a_option)
	getPrivacyIdent ()
	setPrivacyName ($a_option)
	getPrivacyName ()
	getOnlyMoveon ()
	setOnlyMoveon (bool $only_moveon)
	getAchieved ()
	setAchieved (bool $achieved)
	getAnswered ()
	setAnswered (bool $answered)
	getCompleted ()
	setCompleted (bool $completed)
	getFailed ()
	setFailed (bool $failed)
	getInitialized ()
	setInitialized (bool $initialized)
	getPassed ()
	setPassed (bool $passed)
	getProgressed ()
	setProgressed (bool $progressed)
	getSatisfied ()
	setSatisfied (bool $satisfied)
	getTerminated ()
	setTerminated (bool $terminated)
	getHideData ()
	setHideData (bool $hide_data)
	getTimestamp ()
	setTimestamp (bool $timestamp)
	getDuration ()
	setDuration (bool $duration)
	getNoSubstatements ()
	setNoSubstatements (bool $no_substatements)
	getForcePrivacySettings ()
	setForcePrivacySettings ($force_privacy_settings)
	setPrivacyCommentDefault ($a_option)
	getPrivacyCommentDefault ()
	setExternalLrs ($a_option)
	getExternalLrs ()
	getLaunchType ()
	setRemarks ($a_remarks)
	getRemarks ()
	isBypassProxyEnabled ()
	setBypassProxyEnabled (bool $bypassProxyEnabled)
	read ()
	public More...
	save ()
	create ()
	public More...
	update ()
	public More...
	delete ()
	public More...
	getLrsEndpointStatementsLink ()
	getLrsEndpointStatementsAggregationLink ()
	getBasicAuth ()
	getBasicAuthWithoutBasic ()

Static Public Member Functions
static	getDbTableName ()
static	buildBasicAuth ($lrsKey, $lrsSecret)
static	buildBasicAuthWithoutBasic ($lrsKey, $lrsSecret)

Data Fields
const	DB_TABLE_NAME = 'cmix_lrs_types'
const	AVAILABILITY_NONE = 0
const	AVAILABILITY_EXISTING = 1
const	AVAILABILITY_CREATE = 2
const	LAUNCH_TYPE_PAGE = "page"
const	LAUNCH_TYPE_LINK = "link"
const	LAUNCH_TYPE_EMBED = "embed"
const	PRIVACY_IDENT_IL_UUID_USER_ID = 0
const	PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT = 1
const	PRIVACY_IDENT_IL_UUID_LOGIN = 2
const	PRIVACY_IDENT_REAL_EMAIL = 3
const	PRIVACY_IDENT_IL_UUID_RANDOM = 4
const	PRIVACY_IDENT_IL_UUID_SHA256 = 5
const	PRIVACY_NAME_NONE = 0
const	PRIVACY_NAME_FIRSTNAME = 1
const	PRIVACY_NAME_LASTNAME = 2
const	PRIVACY_NAME_FULLNAME = 3
const	ENDPOINT_STATEMENTS_SUFFIX = 'statements'
const	ENDPOINT_AGGREGATE_SUFFIX = 'statements/aggregate'

Protected Attributes
	$type_id
	$title
	$description
	$availability = self::AVAILABILITY_CREATE
	$lrs_endpoint
	$lrs_key
	$lrs_secret
	$privacy_ident
	$privacy_name
	$force_privacy_settings
	$privacy_comment_default
	$external_lrs
	$time_to_delete
	$launch_type = self::LAUNCH_TYPE_LINK
	$remarks
	$bypassProxyEnabled = false
	$only_moveon = false
	$achieved = true
	$answered = true
	$completed = true
	$failed = true
	$initialized = true
	$passed = true
	$progressed = true
	$satisfied = true
	$terminated = true
	$hide_data = false
	$timestamp = false
	$duration = true
	$no_substatements = false

Detailed Description

Definition at line 15 of file class.ilCmiXapiLrsType.php.

Constructor & Destructor Documentation

__construct()

ilCmiXapiLrsType::__construct

(

$a_type_id = 0

)

Constructor.

Definition at line 115 of file class.ilCmiXapiLrsType.php.

References read().

    {

        if ($a_type_id) {
            $this->type_id = $a_type_id;
            $this->read();
        }
    }

Here is the call graph for this function:

Member Function Documentation

buildBasicAuth()

static ilCmiXapiLrsType::buildBasicAuth (   $lrsKey,   $lrsSecret  )

static

Definition at line 713 of file class.ilCmiXapiLrsType.php.

Referenced by ilObjLTIConsumerGUI\debug(), ilLTIConsumerScoringGUI\initTableData(), and ilLTIConsumerXapiStatementsGUI\initTableData().

    {
        return 'Basic ' . base64_encode("{$lrsKey}:{$lrsSecret}");
    }

Here is the caller graph for this function:

buildBasicAuthWithoutBasic()

static ilCmiXapiLrsType::buildBasicAuthWithoutBasic (   $lrsKey,   $lrsSecret  )

static

Definition at line 723 of file class.ilCmiXapiLrsType.php.

    {
        return base64_encode("{$lrsKey}:{$lrsSecret}");
    }

create()

ilCmiXapiLrsType::create

(

)

public

Definition at line 631 of file class.ilCmiXapiLrsType.php.

References $DIC, setTypeId(), and update().

Referenced by save().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */      
        $this->setTypeId($DIC->database()->nextId(self::DB_TABLE_NAME) );
        $this->update();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilCmiXapiLrsType::delete

(

)

public

Definition at line 688 of file class.ilCmiXapiLrsType.php.

References $DIC, $query, and getTypeId().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $query = "DELETE FROM " . self::DB_TABLE_NAME . " WHERE type_id = %s";
        $DIC->database()->manipulateF($query, ['integer'], [$this->getTypeId()]);
        
        return true;
    }

Here is the call graph for this function:

getAchieved()

ilCmiXapiLrsType::getAchieved

(

)

Returns

bool

Definition at line 289 of file class.ilCmiXapiLrsType.php.

References $achieved.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                 : bool
    {
        return $this->achieved;
    }

Here is the caller graph for this function:

getAnswered()

ilCmiXapiLrsType::getAnswered

(

)

Returns

bool

Definition at line 305 of file class.ilCmiXapiLrsType.php.

References $answered.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                 : bool
    {
        return $this->answered;
    }

Here is the caller graph for this function:

getAvailability()

ilCmiXapiLrsType::getAvailability

(

)

Returns

integer availability

Definition at line 183 of file class.ilCmiXapiLrsType.php.

References $availability.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), isAvailable(), and update().

    {
        return $this->availability;
    }

Here is the caller graph for this function:

getBasicAuth()

ilCmiXapiLrsType::getBasicAuth

(

)

Definition at line 708 of file class.ilCmiXapiLrsType.php.

References getLrsKey(), and getLrsSecret().

    {
        return self::buildBasicAuth($this->getLrsKey(), $this->getLrsSecret());
    }

Here is the call graph for this function:

getBasicAuthWithoutBasic()

ilCmiXapiLrsType::getBasicAuthWithoutBasic

(

)

Definition at line 718 of file class.ilCmiXapiLrsType.php.

References getLrsKey(), and getLrsSecret().

    {
        return self::buildBasicAuthWithoutBasic($this->getLrsKey(), $this->getLrsSecret());
    }

Here is the call graph for this function:

getCompleted()

ilCmiXapiLrsType::getCompleted

(

)

Returns

bool

Definition at line 321 of file class.ilCmiXapiLrsType.php.

References $completed.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                  : bool
    {
        return $this->completed;
    }

Here is the caller graph for this function:

getDbTableName()

static ilCmiXapiLrsType::getDbTableName ( )

static

Definition at line 18 of file class.ilCmiXapiLrsType.php.

Referenced by ilCmiXapiLrsTypeList\getCountTypesForCreate(), ilCmiXapiLrsTypeList\getTypeOptions(), and ilCmiXapiLrsTypeList\getTypesData().

    {
        return self::DB_TABLE_NAME;
    }

Here is the caller graph for this function:

getDescription()

ilCmiXapiLrsType::getDescription

(

)

Returns

string description

Definition at line 167 of file class.ilCmiXapiLrsType.php.

References $description.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getDuration()

ilCmiXapiLrsType::getDuration

(

)

Returns

bool

Definition at line 465 of file class.ilCmiXapiLrsType.php.

References $duration.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                 : bool
    {
        return $this->duration;
    }

Here is the caller graph for this function:

getExternalLrs()

ilCmiXapiLrsType::getExternalLrs

(

)

Definition at line 525 of file class.ilCmiXapiLrsType.php.

References $external_lrs.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->external_lrs;
    }

Here is the caller graph for this function:

getFailed()

ilCmiXapiLrsType::getFailed

(

)

Returns

bool

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

References $failed.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                               : bool
    {
        return $this->failed;
    }

Here is the caller graph for this function:

getForcePrivacySettings()

ilCmiXapiLrsType::getForcePrivacySettings

(

)

Returns

bool

Definition at line 497 of file class.ilCmiXapiLrsType.php.

References $force_privacy_settings.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->force_privacy_settings;
    }

Here is the caller graph for this function:

getHideData()

ilCmiXapiLrsType::getHideData

(

)

Returns

bool

Definition at line 433 of file class.ilCmiXapiLrsType.php.

References $hide_data.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                 : bool
    {
        return $this->hide_data;
    }

Here is the caller graph for this function:

getInitialized()

ilCmiXapiLrsType::getInitialized

(

)

Returns

bool

Definition at line 353 of file class.ilCmiXapiLrsType.php.

References $initialized.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                    : bool
    {
        return $this->initialized;
    }

Here is the caller graph for this function:

getLaunchType()

ilCmiXapiLrsType::getLaunchType

(

)

Returns

string launch_type

Definition at line 533 of file class.ilCmiXapiLrsType.php.

References $launch_type.

    {
        return $this->launch_type;
    }

getLrsEndpoint()

ilCmiXapiLrsType::getLrsEndpoint

(

)

Definition at line 225 of file class.ilCmiXapiLrsType.php.

References $lrs_endpoint.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), getLrsEndpointStatementsAggregationLink(), getLrsEndpointStatementsLink(), and update().

    {
        return $this->lrs_endpoint;
    }

Here is the caller graph for this function:

getLrsEndpointStatementsAggregationLink()

ilCmiXapiLrsType::getLrsEndpointStatementsAggregationLink

(

)

Definition at line 703 of file class.ilCmiXapiLrsType.php.

References getLrsEndpoint().

    {
        return dirname(dirname($this->getLrsEndpoint())) . '/api/' . self::ENDPOINT_AGGREGATE_SUFFIX;
    }

Here is the call graph for this function:

getLrsEndpointStatementsLink()

ilCmiXapiLrsType::getLrsEndpointStatementsLink

(

)

Definition at line 698 of file class.ilCmiXapiLrsType.php.

References getLrsEndpoint().

    {
        return $this->getLrsEndpoint() . '/' . self::ENDPOINT_STATEMENTS_SUFFIX;
    }

Here is the call graph for this function:

getLrsKey()

ilCmiXapiLrsType::getLrsKey

(

)

Definition at line 235 of file class.ilCmiXapiLrsType.php.

References $lrs_key.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), getBasicAuth(), getBasicAuthWithoutBasic(), and update().

    {
        return $this->lrs_key;
    }

Here is the caller graph for this function:

getLrsSecret()

ilCmiXapiLrsType::getLrsSecret

(

)

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

References $lrs_secret.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), getBasicAuth(), getBasicAuthWithoutBasic(), and update().

    {
        return $this->lrs_secret;
    }

Here is the caller graph for this function:

getNoSubstatements()

ilCmiXapiLrsType::getNoSubstatements

(

)

Returns

bool

Definition at line 481 of file class.ilCmiXapiLrsType.php.

References $no_substatements.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                        : bool
    {
        return $this->no_substatements;
    }

Here is the caller graph for this function:

getOnlyMoveon()

ilCmiXapiLrsType::getOnlyMoveon

(

)

Returns

bool

Definition at line 273 of file class.ilCmiXapiLrsType.php.

References $only_moveon.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                   : bool
    {
        return $this->only_moveon;
    }

Here is the caller graph for this function:

getPassed()

ilCmiXapiLrsType::getPassed

(

)

Returns

bool

Definition at line 369 of file class.ilCmiXapiLrsType.php.

References $passed.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                               : bool
    {
        return $this->passed;
    }

Here is the caller graph for this function:

getPrivacyCommentDefault()

ilCmiXapiLrsType::getPrivacyCommentDefault

(

)

Definition at line 515 of file class.ilCmiXapiLrsType.php.

References $privacy_comment_default.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->privacy_comment_default;
    }

Here is the caller graph for this function:

getPrivacyIdent()

ilCmiXapiLrsType::getPrivacyIdent

(

)

Definition at line 255 of file class.ilCmiXapiLrsType.php.

References $privacy_ident.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

    {
        return $this->privacy_ident;
    }

Here is the caller graph for this function:

getPrivacyName()

ilCmiXapiLrsType::getPrivacyName

(

)

Definition at line 265 of file class.ilCmiXapiLrsType.php.

References $privacy_name.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

    {
        return $this->privacy_name;
    }

Here is the caller graph for this function:

getProgressed()

ilCmiXapiLrsType::getProgressed

(

)

Returns

bool

Definition at line 385 of file class.ilCmiXapiLrsType.php.

References $progressed.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                   : bool
    {
        return $this->progressed;
    }

Here is the caller graph for this function:

getRemarks()

ilCmiXapiLrsType::getRemarks

(

)

Returns

string remarks

Definition at line 549 of file class.ilCmiXapiLrsType.php.

References $remarks.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->remarks;
    }

Here is the caller graph for this function:

getSatisfied()

ilCmiXapiLrsType::getSatisfied

(

)

Returns

bool

Definition at line 401 of file class.ilCmiXapiLrsType.php.

References $satisfied.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                  : bool
    {
        return $this->satisfied;
    }

Here is the caller graph for this function:

getTerminated()

ilCmiXapiLrsType::getTerminated

(

)

Returns

bool

Definition at line 417 of file class.ilCmiXapiLrsType.php.

References $terminated.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                   : bool
    {
        return $this->terminated;
    }

Here is the caller graph for this function:

getTimestamp()

ilCmiXapiLrsType::getTimestamp

(

)

Returns

bool

Definition at line 449 of file class.ilCmiXapiLrsType.php.

References $timestamp.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

                                  : bool
    {
        return $this->timestamp;
    }

Here is the caller graph for this function:

getTimeToDelete()

ilCmiXapiLrsType::getTimeToDelete

(

)

Returns

string time_to_delete

Definition at line 215 of file class.ilCmiXapiLrsType.php.

References $time_to_delete.

Referenced by update().

    {
        return $this->time_to_delete;
    }

Here is the caller graph for this function:

getTitle()

ilCmiXapiLrsType::getTitle

(

)

Returns

string title

Definition at line 151 of file class.ilCmiXapiLrsType.php.

References $title.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and update().

    {
        return $this->title;
    }

Here is the caller graph for this function:

getTypeId()

ilCmiXapiLrsType::getTypeId

(

)

Returns

int id

Definition at line 135 of file class.ilCmiXapiLrsType.php.

References $type_id.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), delete(), read(), save(), update(), ilObjCmiXapi\updateByPassProxyFromLrsType(), and ilObjCmiXapi\updatePrivacySettingsFromLrsType().

    {
        return $this->type_id;
    }

Here is the caller graph for this function:

isAvailable()

ilCmiXapiLrsType::isAvailable

(

)

Returns

bool

Definition at line 191 of file class.ilCmiXapiLrsType.php.

References getAvailability().

    {
        if ($this->getAvailability() == self::AVAILABILITY_CREATE) {
            return true;
        }
        
        if ($this->getAvailability() == self::AVAILABILITY_EXISTING) {
            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

isBypassProxyEnabled()

ilCmiXapiLrsType::isBypassProxyEnabled

(

)

Returns

bool

Definition at line 557 of file class.ilCmiXapiLrsType.php.

References $bypassProxyEnabled.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), update(), and ilObjCmiXapi\updateByPassProxyFromLrsType().

                                           : bool
    {
        return $this->bypassProxyEnabled;
    }

Here is the caller graph for this function:

read()

ilCmiXapiLrsType::read

(

)

public

Definition at line 573 of file class.ilCmiXapiLrsType.php.

References $ilDB, $ilErr, $query, $res, getTypeId(), setAchieved(), setAnswered(), setAvailability(), setBypassProxyEnabled(), setCompleted(), setDescription(), setDuration(), setExternalLrs(), setFailed(), setForcePrivacySettings(), setHideData(), setInitialized(), setLrsEndpoint(), setLrsKey(), setLrsSecret(), setNoSubstatements(), setOnlyMoveon(), setPassed(), setPrivacyCommentDefault(), setPrivacyIdent(), setPrivacyName(), setProgressed(), setRemarks(), setSatisfied(), setTerminated(), setTimestamp(), setTimeToDelete(), setTitle(), and setTypeId().

Referenced by __construct().

    {
        global $ilDB, $ilErr;
        
        $query = "SELECT * FROM " . self::DB_TABLE_NAME . " WHERE type_id = %s";
        
        $res = $ilDB->queryF($query, ['integer'], [$this->getTypeId()]);
        $row = $ilDB->fetchObject($res);
        if ($row)
        {
            $this->setTypeId($row->type_id);
            $this->setTitle($row->title);
            $this->setDescription($row->description);
            $this->setAvailability($row->availability);
            $this->setLrsEndpoint($row->lrs_endpoint);
            $this->setLrsKey($row->lrs_key);
            $this->setLrsSecret($row->lrs_secret);
            $this->setPrivacyIdent($row->privacy_ident);
            $this->setPrivacyName($row->privacy_name);
            $this->setForcePrivacySettings((bool) $row->force_privacy_settings);
            $this->setPrivacyCommentDefault($row->privacy_comment_default);
            $this->setExternalLrs($row->external_lrs);
            $this->setTimeToDelete($row->time_to_delete);
            $this->setRemarks($row->remarks);
            $this->setBypassProxyEnabled((bool) $row->bypass_proxy);
            $this->setOnlyMoveon((bool)$row->only_moveon);
            $this->setAchieved((bool)$row->achieved);
            $this->setAnswered((bool)$row->answered);
            $this->setCompleted((bool)$row->completed);
            $this->setFailed((bool)$row->failed);
            $this->setInitialized((bool)$row->initialized);
            $this->setPassed((bool)$row->passed);
            $this->setProgressed((bool)$row->progressed);
            $this->setSatisfied((bool)$row->satisfied);
            $this->setTerminated((bool)$row->c_terminated);
            $this->setHideData((bool)$row->hide_data);
            $this->setTimestamp((bool)$row->c_timestamp);
            $this->setDuration((bool)$row->duration);
            $this->setNoSubstatements((bool)$row->no_substatements);

            return true;
        }
        
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilCmiXapiLrsType::save

(

)

Definition at line 619 of file class.ilCmiXapiLrsType.php.

References create(), getTypeId(), and update().

    {
        if ($this->getTypeId()) {
            $this->update();
        } else {
            $this->create();
        }
    }

Here is the call graph for this function:

setAchieved()

ilCmiXapiLrsType::setAchieved

(

bool

$achieved

)

Parameters

bool

$achieved

Definition at line 297 of file class.ilCmiXapiLrsType.php.

References $achieved.

Referenced by read().

    {
        $this->achieved = $achieved;
    }

Here is the caller graph for this function:

setAnswered()

ilCmiXapiLrsType::setAnswered

(

bool

$answered

)

Parameters

bool

$answered

Definition at line 313 of file class.ilCmiXapiLrsType.php.

References $answered.

Referenced by read().

    {
        $this->answered = $answered;
    }

Here is the caller graph for this function:

setAvailability()

ilCmiXapiLrsType::setAvailability

(

$a_availability

)

Parameters

integer

availability

Definition at line 175 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->availability = $a_availability;
    }

Here is the caller graph for this function:

setBypassProxyEnabled()

ilCmiXapiLrsType::setBypassProxyEnabled

(

bool

$bypassProxyEnabled

)

Parameters

bool

$bypassProxyEnabled

Definition at line 565 of file class.ilCmiXapiLrsType.php.

References $bypassProxyEnabled.

Referenced by read().

    {
        $this->bypassProxyEnabled = $bypassProxyEnabled;
    }

Here is the caller graph for this function:

setCompleted()

ilCmiXapiLrsType::setCompleted

(

bool

$completed

)

Parameters

bool

$completed

Definition at line 329 of file class.ilCmiXapiLrsType.php.

References $completed.

Referenced by read().

    {
        $this->completed = $completed;
    }

Here is the caller graph for this function:

setDescription()

ilCmiXapiLrsType::setDescription

(

$a_description

)

Parameters

string

description

Definition at line 159 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->description = $a_description;
    }

Here is the caller graph for this function:

setDuration()

ilCmiXapiLrsType::setDuration

(

bool

$duration

)

Parameters

bool

$duration

Definition at line 473 of file class.ilCmiXapiLrsType.php.

References $duration.

Referenced by read().

    {
        $this->duration = $duration;
    }

Here is the caller graph for this function:

setExternalLrs()

ilCmiXapiLrsType::setExternalLrs

(

$a_option

)

Definition at line 520 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->external_lrs = $a_option;
    }

Here is the caller graph for this function:

setFailed()

ilCmiXapiLrsType::setFailed

(

bool

$failed

)

Parameters

bool

$failed

Definition at line 345 of file class.ilCmiXapiLrsType.php.

References $failed.

Referenced by read().

    {
        $this->failed = $failed;
    }

Here is the caller graph for this function:

setForcePrivacySettings()

ilCmiXapiLrsType::setForcePrivacySettings

(

$force_privacy_settings

)

Parameters

bool

$force_privacy_settings

Definition at line 505 of file class.ilCmiXapiLrsType.php.

References $force_privacy_settings.

Referenced by read().

    {
        $this->force_privacy_settings = $force_privacy_settings;
    }

Here is the caller graph for this function:

setHideData()

ilCmiXapiLrsType::setHideData

(

bool

$hide_data

)

Parameters

bool

$hide_data

Definition at line 441 of file class.ilCmiXapiLrsType.php.

References $hide_data.

Referenced by read().

    {
        $this->hide_data = $hide_data;
    }

Here is the caller graph for this function:

setInitialized()

ilCmiXapiLrsType::setInitialized

(

bool

$initialized

)

Parameters

bool

$initialized

Definition at line 361 of file class.ilCmiXapiLrsType.php.

References $initialized.

Referenced by read().

    {
        $this->initialized = $initialized;
    }

Here is the caller graph for this function:

setLrsEndpoint()

ilCmiXapiLrsType::setLrsEndpoint

(

$a_endpoint

)

Definition at line 220 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->lrs_endpoint = $a_endpoint;
    }

Here is the caller graph for this function:

setLrsKey()

ilCmiXapiLrsType::setLrsKey

(

$a_lrs_key

)

Definition at line 230 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->lrs_key = $a_lrs_key;
    }

Here is the caller graph for this function:

setLrsSecret()

ilCmiXapiLrsType::setLrsSecret

(

$a_lrs_secret

)

Definition at line 240 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->lrs_secret = $a_lrs_secret;
    }

Here is the caller graph for this function:

setNoSubstatements()

ilCmiXapiLrsType::setNoSubstatements

(

bool

$no_substatements

)

Parameters

bool

$no_substatements

Definition at line 489 of file class.ilCmiXapiLrsType.php.

References $no_substatements.

Referenced by read().

    {
        $this->no_substatements = $no_substatements;
    }

Here is the caller graph for this function:

setOnlyMoveon()

ilCmiXapiLrsType::setOnlyMoveon

(

bool

$only_moveon

)

Parameters

bool

$only_moveon

Definition at line 281 of file class.ilCmiXapiLrsType.php.

References $only_moveon.

Referenced by read().

    {
        $this->only_moveon = $only_moveon;
    }

Here is the caller graph for this function:

setPassed()

ilCmiXapiLrsType::setPassed

(

bool

$passed

)

Parameters

bool

$passed

Definition at line 377 of file class.ilCmiXapiLrsType.php.

References $passed.

Referenced by read().

    {
        $this->passed = $passed;
    }

Here is the caller graph for this function:

setPrivacyCommentDefault()

ilCmiXapiLrsType::setPrivacyCommentDefault

(

$a_option

)

Definition at line 510 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->privacy_comment_default = $a_option;
    }

Here is the caller graph for this function:

setPrivacyIdent()

ilCmiXapiLrsType::setPrivacyIdent

(

$a_option

)

Definition at line 250 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->privacy_ident = $a_option;
    }

Here is the caller graph for this function:

setPrivacyName()

ilCmiXapiLrsType::setPrivacyName

(

$a_option

)

Definition at line 260 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->privacy_name = $a_option;
    }

Here is the caller graph for this function:

setProgressed()

ilCmiXapiLrsType::setProgressed

(

bool

$progressed

)

Parameters

bool

$progressed

Definition at line 393 of file class.ilCmiXapiLrsType.php.

References $progressed.

Referenced by read().

    {
        $this->progressed = $progressed;
    }

Here is the caller graph for this function:

setRemarks()

ilCmiXapiLrsType::setRemarks

(

$a_remarks

)

Parameters

string

remarks

Definition at line 541 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->remarks = $a_remarks;
    }

Here is the caller graph for this function:

setSatisfied()

ilCmiXapiLrsType::setSatisfied

(

bool

$satisfied

)

Parameters

bool

$satisfied

Definition at line 409 of file class.ilCmiXapiLrsType.php.

References $satisfied.

Referenced by read().

    {
        $this->satisfied = $satisfied;
    }

Here is the caller graph for this function:

setTerminated()

ilCmiXapiLrsType::setTerminated

(

bool

$terminated

)

Parameters

bool

$terminated

Definition at line 425 of file class.ilCmiXapiLrsType.php.

References $terminated.

Referenced by read().

    {
        $this->terminated = $terminated;
    }

Here is the caller graph for this function:

setTimestamp()

ilCmiXapiLrsType::setTimestamp

(

bool

$timestamp

)

Parameters

bool

$timestamp

Definition at line 457 of file class.ilCmiXapiLrsType.php.

References $timestamp.

Referenced by read().

    {
        $this->timestamp = $timestamp;
    }

Here is the caller graph for this function:

setTimeToDelete()

ilCmiXapiLrsType::setTimeToDelete

(

$a_time_to_delete

)

Parameters

string

time_to_delete

Definition at line 207 of file class.ilCmiXapiLrsType.php.

Referenced by read().

    {
        $this->time_to_delete = $a_time_to_delete;
    }

Here is the caller graph for this function:

setTitle()

ilCmiXapiLrsType::setTitle

(

$a_title

)

Parameters

string

title

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

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setTypeId()

ilCmiXapiLrsType::setTypeId

(

$a_type_id

)

Parameters

int

id

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

Referenced by create(), and read().

    {
        $this->type_id = $a_type_id;
    }

Here is the caller graph for this function:

update()

ilCmiXapiLrsType::update

(

)

public

Definition at line 641 of file class.ilCmiXapiLrsType.php.

References $DIC, getAchieved(), getAnswered(), getAvailability(), getCompleted(), getDescription(), getDuration(), getExternalLrs(), getFailed(), getForcePrivacySettings(), getHideData(), getInitialized(), getLrsEndpoint(), getLrsKey(), getLrsSecret(), getNoSubstatements(), getOnlyMoveon(), getPassed(), getPrivacyCommentDefault(), getPrivacyIdent(), getPrivacyName(), getProgressed(), getRemarks(), getSatisfied(), getTerminated(), getTimestamp(), getTimeToDelete(), getTitle(), getTypeId(), and isBypassProxyEnabled().

Referenced by create(), and save().

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $DIC->database()->replace(
            self::DB_TABLE_NAME,
            array(
                'type_id' => array('integer', $this->getTypeId())
            ),
            array(
                'title' => array('text', $this->getTitle()),
                'description' => array('clob', $this->getDescription()),
                'availability' => array('integer', $this->getAvailability()),
                'remarks' => array('clob', $this->getRemarks()),
                'time_to_delete' => array('integer', $this->getTimeToDelete()),
                'lrs_endpoint' => array('text', $this->getLrsEndpoint()),
                'lrs_key' => array('text', $this->getLrsKey()),
                'lrs_secret' => array('text', $this->getLrsSecret()),
                'privacy_ident' => array('integer', $this->getPrivacyIdent()),
                'privacy_name' => array('integer', $this->getPrivacyName()),
                'force_privacy_settings' => array('integer', (int) $this->getForcePrivacySettings()),
                'privacy_comment_default' => array('text', $this->getPrivacyCommentDefault()),
                'external_lrs' => array('integer', $this->getExternalLrs()),
                'bypass_proxy' => array('integer', (int) $this->isBypassProxyEnabled()),
                'only_moveon' => array('integer', (int)$this->getOnlyMoveon()),
                'achieved' => array('integer', (int)$this->getAchieved()),
                'answered' => array('integer', (int)$this->getAnswered()),
                'completed' => array('integer', (int)$this->getCompleted()),
                'failed' => array('integer', (int)$this->getFailed()),
                'initialized' => array('integer', (int)$this->getInitialized()),
                'passed' => array('integer', (int)$this->getPassed()),
                'progressed' => array('integer', (int)$this->getProgressed()),
                'satisfied' => array('integer', (int)$this->getSatisfied()),
                'c_terminated' => array('integer', (int)$this->getTerminated()),
                'hide_data' => array('integer', (int)$this->getHideData()),
                'c_timestamp' => array('integer', (int)$this->getTimestamp()),
                'duration' => array('integer', (int)$this->getDuration()),
                'no_substatements' => array('integer', (int)$this->getNoSubstatements())
            )
        );
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$achieved

ilCmiXapiLrsType::$achieved = true

protected

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

Referenced by getAchieved(), and setAchieved().

$answered

ilCmiXapiLrsType::$answered = true

protected

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

Referenced by getAnswered(), and setAnswered().

$availability

ilCmiXapiLrsType::$availability = self::AVAILABILITY_CREATE

protected

Definition at line 50 of file class.ilCmiXapiLrsType.php.

Referenced by getAvailability().

$bypassProxyEnabled

ilCmiXapiLrsType::$bypassProxyEnabled = false

protected

Definition at line 68 of file class.ilCmiXapiLrsType.php.

Referenced by isBypassProxyEnabled(), and setBypassProxyEnabled().

$completed

ilCmiXapiLrsType::$completed = true

protected

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

Referenced by getCompleted(), and setCompleted().

$description

ilCmiXapiLrsType::$description

protected

Definition at line 49 of file class.ilCmiXapiLrsType.php.

Referenced by getDescription().

$duration

ilCmiXapiLrsType::$duration = true

protected

Definition at line 107 of file class.ilCmiXapiLrsType.php.

Referenced by getDuration(), and setDuration().

$external_lrs

ilCmiXapiLrsType::$external_lrs

protected

Definition at line 58 of file class.ilCmiXapiLrsType.php.

Referenced by getExternalLrs().

$failed

ilCmiXapiLrsType::$failed = true

protected

Definition at line 83 of file class.ilCmiXapiLrsType.php.

Referenced by getFailed(), and setFailed().

$force_privacy_settings

ilCmiXapiLrsType::$force_privacy_settings

protected

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

Referenced by getForcePrivacySettings(), and setForcePrivacySettings().

$hide_data

ilCmiXapiLrsType::$hide_data = false

protected

Definition at line 101 of file class.ilCmiXapiLrsType.php.

Referenced by getHideData(), and setHideData().

$initialized

ilCmiXapiLrsType::$initialized = true

protected

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

Referenced by getInitialized(), and setInitialized().

$launch_type

ilCmiXapiLrsType::$launch_type = self::LAUNCH_TYPE_LINK

protected

Definition at line 61 of file class.ilCmiXapiLrsType.php.

Referenced by getLaunchType().

$lrs_endpoint

ilCmiXapiLrsType::$lrs_endpoint

protected

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

Referenced by getLrsEndpoint().

$lrs_key

ilCmiXapiLrsType::$lrs_key

protected

Definition at line 52 of file class.ilCmiXapiLrsType.php.

Referenced by getLrsKey().

$lrs_secret

ilCmiXapiLrsType::$lrs_secret

protected

Definition at line 53 of file class.ilCmiXapiLrsType.php.

Referenced by getLrsSecret().

$no_substatements

ilCmiXapiLrsType::$no_substatements = false

protected

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

Referenced by getNoSubstatements(), and setNoSubstatements().

$only_moveon

ilCmiXapiLrsType::$only_moveon = false

protected

Definition at line 71 of file class.ilCmiXapiLrsType.php.

Referenced by getOnlyMoveon(), and setOnlyMoveon().

$passed

ilCmiXapiLrsType::$passed = true

protected

Definition at line 89 of file class.ilCmiXapiLrsType.php.

Referenced by getPassed(), and setPassed().

$privacy_comment_default

ilCmiXapiLrsType::$privacy_comment_default

protected

Definition at line 57 of file class.ilCmiXapiLrsType.php.

Referenced by getPrivacyCommentDefault().

$privacy_ident

ilCmiXapiLrsType::$privacy_ident

protected

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

Referenced by getPrivacyIdent().

$privacy_name

ilCmiXapiLrsType::$privacy_name

protected

Definition at line 55 of file class.ilCmiXapiLrsType.php.

Referenced by getPrivacyName().

$progressed

ilCmiXapiLrsType::$progressed = true

protected

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

Referenced by getProgressed(), and setProgressed().

$remarks

ilCmiXapiLrsType::$remarks

protected

Definition at line 63 of file class.ilCmiXapiLrsType.php.

Referenced by getRemarks().

$satisfied

ilCmiXapiLrsType::$satisfied = true

protected

Definition at line 95 of file class.ilCmiXapiLrsType.php.

Referenced by getSatisfied(), and setSatisfied().

$terminated

ilCmiXapiLrsType::$terminated = true

protected

Definition at line 98 of file class.ilCmiXapiLrsType.php.

Referenced by getTerminated(), and setTerminated().

$time_to_delete

ilCmiXapiLrsType::$time_to_delete

protected

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

Referenced by getTimeToDelete().

$timestamp

ilCmiXapiLrsType::$timestamp = false

protected

Definition at line 104 of file class.ilCmiXapiLrsType.php.

Referenced by getTimestamp(), and setTimestamp().

$title

ilCmiXapiLrsType::$title

protected

Definition at line 48 of file class.ilCmiXapiLrsType.php.

Referenced by getTitle().

$type_id

ilCmiXapiLrsType::$type_id

protected

Definition at line 46 of file class.ilCmiXapiLrsType.php.

Referenced by getTypeId().

AVAILABILITY_CREATE

const ilCmiXapiLrsType::AVAILABILITY_CREATE = 2

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

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), ilCmiXapiLrsTypeList\getCountTypesForCreate(), and ilObjCmiXapiGUI\initCreateForm().

AVAILABILITY_EXISTING

const ilCmiXapiLrsType::AVAILABILITY_EXISTING = 1

Definition at line 24 of file class.ilCmiXapiLrsType.php.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

AVAILABILITY_NONE

const ilCmiXapiLrsType::AVAILABILITY_NONE = 0

Definition at line 23 of file class.ilCmiXapiLrsType.php.

Referenced by ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and ilObjCmiXapiGUI\handleAvailablityMessage().

DB_TABLE_NAME

const ilCmiXapiLrsType::DB_TABLE_NAME = 'cmix_lrs_types'

Definition at line 17 of file class.ilCmiXapiLrsType.php.

ENDPOINT_AGGREGATE_SUFFIX

const ilCmiXapiLrsType::ENDPOINT_AGGREGATE_SUFFIX = 'statements/aggregate'

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

ENDPOINT_STATEMENTS_SUFFIX

const ilCmiXapiLrsType::ENDPOINT_STATEMENTS_SUFFIX = 'statements'

Definition at line 43 of file class.ilCmiXapiLrsType.php.

LAUNCH_TYPE_EMBED

const ilCmiXapiLrsType::LAUNCH_TYPE_EMBED = "embed"

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

LAUNCH_TYPE_LINK

const ilCmiXapiLrsType::LAUNCH_TYPE_LINK = "link"

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

LAUNCH_TYPE_PAGE

const ilCmiXapiLrsType::LAUNCH_TYPE_PAGE = "page"

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

PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT

const ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_EXT_ACCOUNT = 1

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_IDENT_IL_UUID_LOGIN

const ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_LOGIN = 2

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_IDENT_IL_UUID_RANDOM

const ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_RANDOM = 4

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_IDENT_IL_UUID_SHA256

const ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_SHA256 = 5

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), ilObjCmiXapiAdministrationGUI\buildLrsTypeForm(), and ilLTIConsumeProviderFormGUI\initForm().

PRIVACY_IDENT_IL_UUID_USER_ID

const ilCmiXapiLrsType::PRIVACY_IDENT_IL_UUID_USER_ID = 0

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_IDENT_REAL_EMAIL

const ilCmiXapiLrsType::PRIVACY_IDENT_REAL_EMAIL = 3

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_NAME_FIRSTNAME

const ilCmiXapiLrsType::PRIVACY_NAME_FIRSTNAME = 1

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_NAME_FULLNAME

const ilCmiXapiLrsType::PRIVACY_NAME_FULLNAME = 3

Definition at line 41 of file class.ilCmiXapiLrsType.php.

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_NAME_LASTNAME

const ilCmiXapiLrsType::PRIVACY_NAME_LASTNAME = 2

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

PRIVACY_NAME_NONE

const ilCmiXapiLrsType::PRIVACY_NAME_NONE = 0

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

Referenced by ilCmiXapiSettingsGUI\buildForm(), and ilObjCmiXapiAdministrationGUI\buildLrsTypeForm().

---

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

• Modules/CmiXapi/classes/class.ilCmiXapiLrsType.php