lionbridge_content_api_test-8.x-4.0/tmgmt_contentapi/src/Format/FormatInterface.php

<?php

namespace Drupal\tmgmt_contentapi\Format;

use Drupal\tmgmt\Entity\Job;
use Drupal\tmgmt\JobInterface;

/**
 * Interface for exporting to a given file format.
 */
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);
}