Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
fileconverter_googledrive\converter Class Reference

Class for converting files between different formats using unoconv. More...

Inheritance diagram for fileconverter_googledrive\converter:
core_files\converter_interface

Public Member Functions

 get_supported_conversions ()
 A list of the supported conversions.
 
 poll_conversion_status (conversion $conversion)
 Poll an existing conversion for status update.
 
 serve_test_document ()
 Generate and serve the test document.
 
 start_document_conversion (conversion $conversion)
 Convert a document to a new format and return a conversion object relating to the conversion in progress.
 
 start_document_conversion (\core_files\conversion $conversion)
 Convert a document to a new format and return a conversion object relating to the conversion in progress.
 

Static Public Member Functions

static are_requirements_met ()
 Whether the plugin is configured and requirements are met.
 
static supports ($from, $to)
 Whether a file conversion can be completed using this converter.
 

Detailed Description

Class for converting files between different formats using unoconv.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ are_requirements_met()

static fileconverter_googledrive\converter::are_requirements_met ( )
static

Whether the plugin is configured and requirements are met.

Return values
bool

Implements core_files\converter_interface.

◆ get_supported_conversions()

fileconverter_googledrive\converter::get_supported_conversions ( )

A list of the supported conversions.

Return values
string

Implements core_files\converter_interface.

◆ poll_conversion_status()

fileconverter_googledrive\converter::poll_conversion_status ( conversion $conversion)

Poll an existing conversion for status update.

Parameters
conversion$conversionThe file to be converted
Return values
$this;

Implements core_files\converter_interface.

◆ serve_test_document()

fileconverter_googledrive\converter::serve_test_document ( )

Generate and serve the test document.

Return values
stored_file

◆ start_document_conversion() [1/2]

core_files\converter_interface::start_document_conversion ( conversion $conversion)
inherited

Convert a document to a new format and return a conversion object relating to the conversion in progress.

Parameters
conversion$conversionThe file to be converted
Return values
$this

◆ start_document_conversion() [2/2]

fileconverter_googledrive\converter::start_document_conversion ( \core_files\conversion $conversion)

Convert a document to a new format and return a conversion object relating to the conversion in progress.

Parameters
core_files\conversion$conversionThe file to be converted
Return values
this

◆ supports()

static fileconverter_googledrive\converter::supports ( $from,
$to )
static

Whether a file conversion can be completed using this converter.

Parameters
string$fromThe source type
string$toThe destination type
Return values
bool

Implements core_files\converter_interface.


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