enrol_lti\local\ltiadvantage\entity\deployment Class Reference

Public Member Functions
	add_context (string $contextid, array $types)
	Factory method to add a platform-specific context to the deployment.
	add_resource_link (string $resourcelinkid, int $resourceid, int $contextid=null)
	Factory method to create a resource link from this deployment instance.
	get_deploymentid ()
	Get the deployment id string.
	get_deploymentname ()
	Return the short name of this tool deployment.
	get_id ()
	Return the object id.
	get_legacy_consumer_key ()
	Get the legacy consumer key to which this deployment instance is mapped.
	get_registrationid ()
	Get the id of the application_registration.
	set_legacy_consumer_key (string $key)
	Set the legacy consumer key for this instance, indicating that the deployment has been migrated from a consumer.

Static Public Member Functions
static	create (int $registrationid, string $deploymentid, string $deploymentname, ?int $id=null, ?string $legacyconsumerkey=null)
	Factory method to create a new instance of a deployment.

Member Function Documentation

add_context()

enrol_lti\local\ltiadvantage\entity\deployment::add_context	(	string	$contextid,
		array	$types )

Factory method to add a platform-specific context to the deployment.

Parameters

string	$contextid	the contextid, as supplied by the platform during launch.
array	$types	the context types the context represents, as supplied by the platform during launch.

Return values

context

the context instance.

Exceptions

coding_exception

if the context could not be created.

add_resource_link()

enrol_lti\local\ltiadvantage\entity\deployment::add_resource_link	(	string	$resourcelinkid,
		int	$resourceid,
		int	$contextid = null )

Factory method to create a resource link from this deployment instance.

Parameters

string	$resourcelinkid	the platform-issued string id of the resource link.
int	$resourceid	the local published resource to which this link points.
int | null	$contextid	the platform context instance in which the resource link resides, if available.

Return values

resource_link

the resource_link instance.

Exceptions

coding_exception

if the resource_link can't be created.

create()

static enrol_lti\local\ltiadvantage\entity\deployment::create ( int $registrationid, string $deploymentid, string $deploymentname, ?int $id = null, ?string $legacyconsumerkey = null )

static

Factory method to create a new instance of a deployment.

Parameters

int	$registrationid	the local ID of the application registration.
string	$deploymentid	the platform-issued deployment id.
string	$deploymentname	the name of this deployment.
int | null	$id	optional local id of this object instance, omitted for new deployment objects.
string | null	$legacyconsumerkey	the 1.1 consumer key associated with this deployment, used for upgrades.

Return values

deployment

the deployment instance.

get_deploymentid()

enrol_lti\local\ltiadvantage\entity\deployment::get_deploymentid

(

)

Get the deployment id string.

Return values

string

deploymentid

get_deploymentname()

enrol_lti\local\ltiadvantage\entity\deployment::get_deploymentname

(

)

Return the short name of this tool deployment.

Return values

string

the short name.

get_id()

enrol_lti\local\ltiadvantage\entity\deployment::get_id

(

)

Return the object id.

Return values

int|null

the id.

get_legacy_consumer_key()

enrol_lti\local\ltiadvantage\entity\deployment::get_legacy_consumer_key

(

)

Get the legacy consumer key to which this deployment instance is mapped.

Return values

string|null

the legacy consumer key, if set, else null.

get_registrationid()

enrol_lti\local\ltiadvantage\entity\deployment::get_registrationid

(

)

Get the id of the application_registration.

Return values

int	the id of the application_registration instance to which this deployment belongs.

set_legacy_consumer_key()

enrol_lti\local\ltiadvantage\entity\deployment::set_legacy_consumer_key

(

string

$key

)

Set the legacy consumer key for this instance, indicating that the deployment has been migrated from a consumer.

Parameters

string

$key

the legacy consumer key.

Exceptions

coding_exception

if the key is invalid.

---

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

• enrol/lti/classes/local/ltiadvantage/entity/deployment.php