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.
/mod/bigbluebuttonbn/classes/local/proxy/ -> proxy_base.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

(no description)

File Size: 182 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

proxy_base:: (7 methods):
  action_url()
  sanitized_url()
  sanitized_secret()
  assert_returned_xml()
  get_errorcode_from_xml_messagekey()
  is_known_server_unavailable_errorcode()
  fetch_endpoint_xml()


Class: proxy_base  - X-Ref

The abstract proxy base class.

This class provides common and shared functions used when interacting with
the BigBlueButton API server.

action_url(string $action = '', array $data = [], array $metadata = [])   X-Ref
Returns the right URL for the action specified.

param: string $action
param: array $data
param: array $metadata
return: string

sanitized_url()   X-Ref
Makes sure the url used doesn't is in the format required.

return: string

sanitized_secret()   X-Ref
Makes sure the shared_secret used doesn't have trailing white characters.

return: string

assert_returned_xml($xml, ?array $additionaldetails = null)   X-Ref
Throw an exception if there is a problem in the returned XML value

param: SimpleXMLElement|bool $xml
param: array|null $additionaldetails

get_errorcode_from_xml_messagekey(string $messagekey)   X-Ref
Get Moodle error code from returned Message Key

param: string $messagekey
return: string

is_known_server_unavailable_errorcode(string $messagekey)   X-Ref
Get Moodle error code from returned Message Key

param: string $messagekey
return: string

fetch_endpoint_xml(string $action,array $data = [],array $metadata = [])   X-Ref
Fetch the XML from an endpoint and test for success.

If the result could not be loaded, or the returncode was not 'SUCCESS', a null value is returned.

param: string $action
param: array $data
param: array $metadata
return: null|bool|SimpleXMLElement