Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
enrol_lti\local\ltiadvantage\repository\application_registration_repository Class Reference

Public Member Functions

 delete (int $id)
 Delete the application_registration identified by id.
 
 exists (int $appregid)
 Report whether an application_registration with id $id exists or not.
 
 find (int $id)
 Find a registration by id.
 
 find_all ()
 Get all app registrations in the repository.
 
 find_by_deployment (int $deploymentid)
 Find an application_registration corresponding to the local id of a given tool deployment.
 
 find_by_platform (string $platformid, string $clientid)
 Find a registration by its unique {platformid, clientid} tuple.
 
 find_by_platform_uniqueid (string $platformid, string $uniqueid)
 Find a registration by its unique {platformid, uniqueid} tuple.
 
 find_by_uniqueid (string $uniqueid)
 Find a registration by its uniqueid.
 
 save (application_registration $appregistration)
 Save an application_registration instance to the store.
 

Member Function Documentation

◆ delete()

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

Delete the application_registration identified by id.

Parameters
int$idthe id of the object to delete.

◆ exists()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::exists ( int $appregid)

Report whether an application_registration with id $id exists or not.

Parameters
int$appregidthe id of the application_registration
Return values
booltrue if the object exists, false otherwise.

◆ find()

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

Find a registration by id.

Parameters
int$idthe id of the application registration.
Return values
null|application_registrationthe registration object if found, otherwise null.

◆ find_all()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::find_all ( )

Get all app registrations in the repository.

Return values
application_registration[]the array of application registration instances.

◆ find_by_deployment()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::find_by_deployment ( int $deploymentid)

Find an application_registration corresponding to the local id of a given tool deployment.

Parameters
int$deploymentidthe local id of the tool deployment object.
Return values
application_registration|nullthe application_registration instance or null if not found.

◆ find_by_platform()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::find_by_platform ( string $platformid,
string $clientid )

Find a registration by its unique {platformid, clientid} tuple.

Parameters
string$platformidthe url of the platform (the issuer).
string$clientidthe client_id of the tool registration on the platform.
Return values
application_registration|nullapplication registration instance if found, else null.

◆ find_by_platform_uniqueid()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::find_by_platform_uniqueid ( string $platformid,
string $uniqueid )

Find a registration by its unique {platformid, uniqueid} tuple.

Parameters
string$platformidthe url of the platform (the issuer).
string$uniqueidthe locally uniqueid of the tool registration.
Return values
application_registration|nullapplication registration instance if found, else null.

◆ find_by_uniqueid()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::find_by_uniqueid ( string $uniqueid)

Find a registration by its uniqueid.

Parameters
string$uniqueidthe uniqueid identifying the registration.
Return values
application_registration|nullapplication_registration instance if found, else null.

◆ save()

enrol_lti\local\ltiadvantage\repository\application_registration_repository::save ( application_registration $appregistration)

Save an application_registration instance to the store.

Parameters
application_registration$appregistrationthe application registration instance.
Return values
application_registrationthe saved application registration instance.

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