interface FormatInterface in Translation Management Tool 8
Interface for exporting to a given file format.
Hierarchy
- interface \Drupal\tmgmt_file\Format\FormatInterface
Expanded class hierarchy of FormatInterface
All classes that implement FormatInterface
2 files declare their use of FormatInterface
File
- translators/
tmgmt_file/ src/ Format/ FormatInterface.php, line 11
Namespace
Drupal\tmgmt_file\FormatView source
interface FormatInterface {
/**
* Return the file content for the job data.
*
* @param $job
* The translation job object to be exported.
* @param array $conditions
* (optional) An array containing list of conditions.
*
* @return
* String with the file content.
*/
function export(JobInterface $job, $conditions = array());
/**
* Validates that the given file is valid and can be imported.
*
* @param $imported_file
* File path to the file to be imported.
* @param bool $is_file
* (optional) Whether $imported_file is the path to a file or not.
*
* @return Job
* Returns the corresponding translation job entity if the import file is
* valid, FALSE otherwise.
*/
function validateImport($imported_file, $is_file = TRUE);
/**
* Converts an exported file content back to the translated data.
*
* @param string $imported_file
* Path to a file or an XML string to import.
* @param bool $is_file
* (optional) Whether $imported_file is the path to a file or not.
*
* @return
* Translated data array.
*/
function import($imported_file, $is_file = TRUE);
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FormatInterface:: |
function | Return the file content for the job data. | 2 | |
FormatInterface:: |
function | Converts an exported file content back to the translated data. | 2 | |
FormatInterface:: |
function | Validates that the given file is valid and can be imported. | 2 |