Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/classes/oauth2/ -> issuer.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 39 and 401]

Class for loading/storing issuers from the DB.

Copyright: 2017 Damyon Wiese
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 271 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

issuer:: (10 methods):
  define_properties()
  before_validate()
  get_endpoint_url()
  is_valid_login_domain()
  is_authentication_supported()
  is_available_for_login()
  is_configured()
  is_system_account_connected()
  validate_baseurl()
  get_display_name()


Class: issuer  - X-Ref

Class for loading/storing issuer from the DB

define_properties()   X-Ref
Return the definition of the properties of this model.

return: array

before_validate()   X-Ref
Hook to execute before validate.

return: void

get_endpoint_url($type)   X-Ref
Helper the get a named service endpoint.

param: string $type
return: string|false

is_valid_login_domain($email)   X-Ref
Perform matching against the list of allowed login domains for this issuer.

param: string $email The email to check.
return: boolean

is_authentication_supported()   X-Ref
Does this OAuth service support user authentication?

return: boolean

is_available_for_login()   X-Ref
Is this issue fully configured and enabled and can be used for login/signup

return: bool

is_configured()   X-Ref
Return true if this issuer looks like it has been configured.

return: boolean

is_system_account_connected()   X-Ref
Do we have a refresh token for a system account?

return: boolean

validate_baseurl($value)   X-Ref
Custom validator for end point URLs.
Because we send Bearer tokens we must ensure SSL.

param: string $value The value to check.
return: lang_string|boolean

get_display_name()   X-Ref
Display name for the issuers used on the login page

return: string