Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
(no description)
| File Size: | 178 lines (7 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Defines 1 class
deployment:: (10 methods):
__construct()
create()
get_id()
get_deploymentname()
get_deploymentid()
get_registrationid()
get_legacy_consumer_key()
add_context()
add_resource_link()
set_legacy_consumer_key()
Class: deployment - X-Ref
Class deployment.This class represents an LTI Advantage Tool Deployment (http://www.imsglobal.org/spec/lti/v1p3/#tool-deployment).
| __construct(string $deploymentname, string $deploymentid, int $registrationid, ?int $id = null,?string $legacyconsumerkey = null) X-Ref |
| The private deployment constructor. param: string $deploymentname the name of this deployment. param: string $deploymentid the platform-issued deployment id. param: int $registrationid the local ID of the application registration. param: int|null $id the id of this object instance, or null if it is a new instance which has not yet been saved. param: string|null $legacyconsumerkey the 1.1 consumer key associated with this deployment, used for upgrades. |
| create(int $registrationid, string $deploymentid, string $deploymentname,?int $id = null, ?string $legacyconsumerkey = null) X-Ref |
| Factory method to create a new instance of a deployment. return: deployment the deployment instance. param: int $registrationid the local ID of the application registration. param: string $deploymentid the platform-issued deployment id. param: string $deploymentname the name of this deployment. param: int|null $id optional local id of this object instance, omitted for new deployment objects. param: string|null $legacyconsumerkey the 1.1 consumer key associated with this deployment, used for upgrades. |
| get_id() X-Ref |
| Return the object id. return: int|null the id. |
| get_deploymentname() X-Ref |
| Return the short name of this tool deployment. return: string the short name. |
| get_deploymentid() X-Ref |
| Get the deployment id string. return: string deploymentid |
| get_registrationid() X-Ref |
| Get the id of the application_registration. return: int the id of the application_registration instance to which this deployment belongs. |
| get_legacy_consumer_key() X-Ref |
| Get the legacy consumer key to which this deployment instance is mapped. return: string|null the legacy consumer key, if set, else null. |
| add_context(string $contextid, array $types) X-Ref |
| Factory method to add a platform-specific context to the deployment. return: context the context instance. param: string $contextid the contextid, as supplied by the platform during launch. param: array $types the context types the context represents, as supplied by the platform during launch. |
| add_resource_link(string $resourcelinkid, int $resourceid,int $contextid = null) X-Ref |
| Factory method to create a resource link from this deployment instance. return: resource_link the resource_link instance. param: string $resourcelinkid the platform-issued string id of the resource link. param: int $resourceid the local published resource to which this link points. param: int|null $contextid the platform context instance in which the resource link resides, if available. |
| set_legacy_consumer_key(string $key) X-Ref |
| Set the legacy consumer key for this instance, indicating that the deployment has been migrated from a consumer. param: string $key the legacy consumer key. |
