class TMGMTFileFormatHTML in Translation Management Tool 7

Export into HTML.

Hierarchy

• class \TMGMTFileFormatHTML implements TMGMTFileFormatInterface

2 string references to 'TMGMTFileFormatHTML'

hook_tmgmt_file_format_plugin_info in translators/file/tmgmt_file.api.php

Provide information about available file format to export to and import from.

tmgmt_file_tmgmt_file_format_plugin_info in translators/file/tmgmt_file.module

Implements hook_tmgmt_file_format_info().

File

translators/file/tmgmt_file.format.html.inc, line 6

class TMGMTFileFormatHTML implements TMGMTFileFormatInterface {

  /**
   * Returns base64 encoded data that is safe for use in xml ids.
   */
  protected function encodeIdSafeBase64($data) {

    // Prefix with a b to enforce that the first character is a letter.
    return 'b' . rtrim(strtr(base64_encode($data), '+/', '-_'), '=');
  }

  /**
   * Returns decoded id safe base64 data.
   */
  protected function decodeIdSafeBase64($data) {

    // Remove prefixed b.
    $data = substr($data, 1);
    return base64_decode(str_pad(strtr($data, '-_', '+/'), strlen($data) % 4, '=', STR_PAD_RIGHT));
  }

  /**
   * {@inheritdoc}
   */
  public function export(TMGMTJob $job, $conditions = array()) {
    $items = array();
    foreach ($job
      ->getItems($conditions) as $item) {
      $data = array_filter(tmgmt_flatten_data($item
        ->getData()), '_tmgmt_filter_data');
      foreach ($data as $key => $value) {
        $items[$item->tjiid][$this
          ->encodeIdSafeBase64($item->tjiid . '][' . $key)] = $value;
      }
    }
    return theme('tmgmt_file_html_template', array(
      'tjid' => $job->tjid,
      'source_language' => $job
        ->getTranslator()
        ->mapToRemoteLanguage($job->source_language),
      'target_language' => $job
        ->getTranslator()
        ->mapToRemoteLanguage($job->target_language),
      'items' => $items,
    ));
  }

  /**
   * {@inheritdoc}
   */
  public function import($imported_file, $is_file = TRUE) {
    $dom = new DOMDocument();
    $dom
      ->loadHTMLFile($imported_file);
    $xml = simplexml_import_dom($dom);
    $data = array();
    foreach ($xml
      ->xpath("//div[@class='atom']") as $atom) {

      // Assets are our strings (eq fields in nodes).
      $key = $this
        ->decodeIdSafeBase64((string) $atom['id']);
      $data[$key]['#text'] = (string) $atom;
    }
    return tmgmt_unflatten_data($data);
  }

  /**
   * {@inheritdoc}
   */
  public function validateImport($imported_file, $is_file = TRUE) {
    $dom = new DOMDocument();
    if (!$dom
      ->loadHTMLFile($imported_file)) {
      return FALSE;
    }
    $xml = simplexml_import_dom($dom);

    // Collect meta information.
    $meta_tags = $xml
      ->xpath('//meta');
    $meta = array();
    foreach ($meta_tags as $meta_tag) {
      $meta[(string) $meta_tag['name']] = (string) $meta_tag['content'];
    }

    // Check required meta tags.
    foreach (array(
      'JobID',
      'languageSource',
      'languageTarget',
    ) as $name) {
      if (!isset($meta[$name])) {
        return FALSE;
      }
    }

    // Attempt to load the job.
    if (!($job = tmgmt_job_load($meta['JobID']))) {
      drupal_set_message(t('The imported file job id @file_tjid is not available.', array(
        '@file_tjid' => $job->tjid,
      )), 'error');
      return FALSE;
    }

    // Check language.
    if ($meta['languageSource'] != $job
      ->getTranslator()
      ->mapToRemoteLanguage($job->source_language) || $meta['languageTarget'] != $job
      ->getTranslator()
      ->mapToRemoteLanguage($job->target_language)) {
      return FALSE;
    }

    // Validation successful.
    return $job;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
TMGMTFileFormatHTML::decodeIdSafeBase64	protected	function	Returns decoded id safe base64 data.
TMGMTFileFormatHTML::encodeIdSafeBase64	protected	function	Returns base64 encoded data that is safe for use in xml ids.
TMGMTFileFormatHTML::export	public	function	Return the file content for the job data. Overrides TMGMTFileFormatInterface::export
TMGMTFileFormatHTML::import	public	function	Converts an exported file content back to the translated data. Overrides TMGMTFileFormatInterface::import
TMGMTFileFormatHTML::validateImport	public	function	Validates that the given file is valid and can be imported. Overrides TMGMTFileFormatInterface::validateImport