fileconverter_googledrive\converter Class Reference

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

Inheritance diagram for fileconverter_googledrive\converter:

Public Member Functions
	get_supported_conversions ()
	A list of the supported conversions. More...
	poll_conversion_status (conversion $conversion)
	Poll an existing conversion for status update. More...
	serve_test_document ()
	Generate and serve the test document. More...
	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. More...
	start_document_conversion (conversion $conversion)
	Convert a document to a new format and return a conversion object relating to the conversion in progress. More...

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

Detailed Description

Class for converting files between different formats using unoconv.

Copyright

2017 Andrew Nicols andre.nosp@m.w@ni.nosp@m.cols..nosp@m.co.u.nosp@m.k

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

$conversion

The 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]

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

$conversion

The file to be converted

Return values

this

start_document_conversion() [2/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

$conversion

The 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	$from	The source type
string	$to	The destination type

Return values

bool

Implements core_files\converter_interface.

---

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

• files/converter/googledrive/classes/converter.php