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.

Class for converting files between different file formats using unoconv.

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

Defines 1 class


Class: converter  - X-Ref

Class for converting files between different formats using unoconv.

start_document_conversion(\core_files\conversion $conversion)   X-Ref
Convert a document to a new format and return a conversion object relating to the conversion in progress.

param: conversion $conversion The file to be converted
return: $this

poll_conversion_status(conversion $conversion)   X-Ref
Poll an existing conversion for status update.

param: conversion $conversion The file to be converted
return: $this

serve_test_document()   X-Ref
Generate and serve the test document.

return: void

are_requirements_met()   X-Ref
Whether the plugin is configured and requirements are met.

return: bool

is_minimum_version_met()   X-Ref
Whether the minimum version of unoconv has been met.

return: bool

test_unoconv_path()   X-Ref
Whether the plugin is fully configured.

return: \stdClass

supports($from, $to)   X-Ref
Whether a file conversion can be completed using this converter.

param: string $from The source type
param: string $to The destination type
return: bool

is_format_supported($format)   X-Ref
Whether the specified file format is supported.

param: string $format Whether conversions between this format and another are supported
return: bool

fetch_supported_formats()   X-Ref
Fetch the list of supported file formats.

return: array

get_supported_conversions()   X-Ref
A list of the supported conversions.

return: string