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.
/h5p/classes/ -> external.php (source)

[Source view]

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

This is the external API for this component.

Copyright: 2019 Carlos Escobedo <carlos@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 164 lines (6 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

external:: (3 methods):
  get_trusted_h5p_file_parameters()
  get_trusted_h5p_file()
  get_trusted_h5p_file_returns()


Class: external  - X-Ref

This is the external API for this component.

get_trusted_h5p_file_parameters()   X-Ref
get_trusted_h5p_file parameters.

return: external_function_parameters

get_trusted_h5p_file(string $url, int $frame, int $export, int $embed, int $copyright)   X-Ref
Return the H5P file trusted.

The Mobile App needs to work with an H5P package which can trust.
And this H5P package is only trusted by the Mobile App once it's been processed
by the core checking the right caps, validating the H5P package
and doing any clean-up process involved.

param: string $url H5P file url
param: int $frame The frame allow to show the bar options below the content
param: int $export The export allow to download the package
param: int $embed The embed allow to copy the code to your site
param: int $copyright The copyright option
return: array

get_trusted_h5p_file_returns()   X-Ref
get_trusted_h5p_file return

return: external_description