Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
enrol_lti\local\ltiadvantage\repository\deployment_repository Class Reference

Public Member Functions

 count_by_registration (int $registrationid)
 Return a count of how many deployments exists for a given application_registration.
 
 delete (int $id)
 Delete a deployment from the store.
 
 delete_by_registration (int $registrationid)
 Delete all deployments for the given registration.
 
 exists (int $id)
 Determine whether a deployment exists in the repository.
 
 find (int $id)
 Find and return a deployment, by id.
 
 find_all_by_registration (int $registrationid)
 Get all deployments for a given application registration id.
 
 find_by_registration (int $registrationid, string $deploymentid)
 Get a deployment based on its deploymentid and a for a given application registration id.
 
 save (deployment $deployment)
 Save a deployment to the store.
 

Member Function Documentation

◆ count_by_registration()

enrol_lti\local\ltiadvantage\repository\deployment_repository::count_by_registration ( int $registrationid)

Return a count of how many deployments exists for a given application_registration.

Parameters
int$registrationidthe id of the application_registration instance.
Return values
intthe number of deployments found.

◆ delete()

enrol_lti\local\ltiadvantage\repository\deployment_repository::delete ( int $id)

Delete a deployment from the store.

Parameters
int$idthe id of the deployment object to remove.

◆ delete_by_registration()

enrol_lti\local\ltiadvantage\repository\deployment_repository::delete_by_registration ( int $registrationid)

Delete all deployments for the given registration.

Parameters
int$registrationidthe registration id.

◆ exists()

enrol_lti\local\ltiadvantage\repository\deployment_repository::exists ( int $id)

Determine whether a deployment exists in the repository.

Parameters
int$idthe identifier of the deployment
Return values
booltrue if the deployment exists, false otherwise.

◆ find()

enrol_lti\local\ltiadvantage\repository\deployment_repository::find ( int $id)

Find and return a deployment, by id.

Parameters
int$idthe id of the deployment to find.
Return values
deployment|null

◆ find_all_by_registration()

enrol_lti\local\ltiadvantage\repository\deployment_repository::find_all_by_registration ( int $registrationid)

Get all deployments for a given application registration id.

Parameters
int$registrationidthe id of the application_registration to which the deployment belongs.
Return values
deployment[]|nulldeployments if found, otherwise null.

◆ find_by_registration()

enrol_lti\local\ltiadvantage\repository\deployment_repository::find_by_registration ( int $registrationid,
string $deploymentid )

Get a deployment based on its deploymentid and a for a given application registration id.

Parameters
int$registrationidthe id of the application_registration to which the deployment belongs.
string$deploymentidthe deploymentid of the deployment, as set by the platform.
Return values
deployment|nulldeployment if found, otherwise null.

◆ save()

enrol_lti\local\ltiadvantage\repository\deployment_repository::save ( deployment $deployment)

Save a deployment to the store.

Parameters
deployment$deploymentthe deployment instance to save.
Return values
deploymentthe saved deployment instance.

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