Class for converting files between different formats using unoconv.
More...
Class for converting files between different formats using unoconv.
- Copyright
- 2017 Damyon Wiese
- License
- http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
◆ can_convert_format_to()
core_files\converter::can_convert_format_to |
( |
| $from, |
|
|
| $to ) |
Check whether document conversion is supported for this file and target format.
- Parameters
-
string | $from | The source target file (file extension) |
string | $to | The desired target file format (file extension) |
- Return values
-
bool | Whether the target type can be converted |
◆ can_convert_storedfile_to()
core_files\converter::can_convert_storedfile_to |
( |
stored_file | $file, |
|
|
| $to ) |
Check whether document conversion is supported for this file and target format.
- Parameters
-
stored_file | $file | The file to convert |
string | $to | The desired target file format (file extension) |
- Return values
-
bool | Whether the target type can be converted |
◆ get_document_converter_classes()
core_files\converter::get_document_converter_classes |
( |
| $from, |
|
|
| $to ) |
|
protected |
Fetch the class for the preferred document converter.
- Parameters
-
string | $from | The source target file (file extension) |
string | $to | The desired target file format (file extension) |
- Return values
-
string | The class for document conversion |
◆ get_enabled_plugins()
core_files\converter::get_enabled_plugins |
( |
| ) |
|
|
protected |
Get a list of enabled plugins and classes.
- Return values
-
array | List of enabled plugins |
◆ get_file_storage()
core_files\converter::get_file_storage |
( |
| ) |
|
|
protected |
◆ get_next_converter()
core_files\converter::get_next_converter |
( |
| $converters, |
|
|
| $currentconverter = null ) |
|
protected |
Fetch the next converter to try.
- Parameters
-
array | $converters | The list of converters to try |
string | null | $currentconverter | The converter currently in use |
- Return values
-
string|false | Name of next converter if present |
◆ poll_conversion()
core_files\converter::poll_conversion |
( |
conversion | $conversion | ) |
|
Poll for updates to the supplied conversion.
- Parameters
-
conversion | $conversion | The conversion in progress |
- Return values
-
◆ start_conversion()
core_files\converter::start_conversion |
( |
stored_file | $file, |
|
|
| $format, |
|
|
| $forcerefresh = false ) |
Start the conversion for a stored_file into a new format.
- Parameters
-
stored_file | $file | The file to convert |
string | $format | The desired target file format (file extension) |
boolean | $forcerefresh | If true, the file will be converted every time (not cached). |
- Return values
-
conversion | conversion object |
The documentation for this class was generated from the following file:
- files/classes/converter.php