tmgmt_entity_ui.pages.inc in Translation Management Tool 7

Provides page and form callbacks for the Translation Management Tool Entity Source User Interface module.

File

sources/entity/ui/tmgmt_entity_ui.pages.inc

<?php

/**
 * @file
 * Provides page and form callbacks for the Translation Management Tool Entity
 * Source User Interface module.
 */

/**
 * Entity translation overview form.
 */
function tmgmt_entity_ui_translate_form($form, &$form_state, $build) {

  // Store the entity in the form state so we can easily create the job in the
  // submit handler.
  $form_state['entity_type'] = $build['#entity_type'];
  $form_state['entity'] = $build['#entity'];
  $overview = $build['entity_translation_overview'];
  list($id, $vid, $bundle) = entity_extract_ids($form_state['entity_type'], $form_state['entity']);
  $form['top_actions']['#type'] = 'actions';
  $form['top_actions']['#weight'] = -10;
  tmgmt_ui_add_cart_form($form['top_actions'], $form_state, 'entity', $build['#entity_type'], $id);

  // Inject our additional column into the header.
  array_splice($overview['#header'], -1, 0, array(
    t('Pending Translations'),
  ));

  // Make this a tableselect form.
  $form['languages'] = array(
    '#type' => 'tableselect',
    '#header' => $overview['#header'],
    '#options' => array(),
  );
  $languages = language_list();

  // Check if there is a job / job item that references this translation.
  $entity_language = entity_language($form_state['entity_type'], $form_state['entity']);
  $items = tmgmt_job_item_load_latest('entity', $form_state['entity_type'], $id, $entity_language);
  foreach ($languages as $langcode => $language) {
    if ($langcode == LANGUAGE_NONE) {

      // Never show language neutral on the overview.
      continue;
    }

    // Since the keys are numeric and in the same order we can shift one element
    // after the other from the original non-form rows.
    $option = array_shift($overview['#rows']);
    if ($langcode == $entity_language) {
      $additional = '<strong>' . t('Source') . '</strong>';

      // This is the source object so we disable the checkbox for this row.
      $form['languages'][$langcode] = array(
        '#type' => 'checkbox',
        '#disabled' => TRUE,
      );
    }
    elseif (isset($items[$langcode])) {
      $item = $items[$langcode];
      $uri = $item
        ->uri();
      $wrapper = entity_metadata_wrapper('tmgmt_job_item', $item);
      $additional = l($wrapper->state
        ->label(), $uri['path'], array(
        'query' => array(
          'destination' => current_path(),
        ),
      ));

      // Disable the checkbox for this row since there is already a translation
      // in progress that has not yet been finished. This way we make sure that
      // we don't stack multiple active translations for the same item on top
      // of each other.
      $form['languages'][$langcode] = array(
        '#type' => 'checkbox',
        '#disabled' => TRUE,
      );
    }
    else {

      // There is no translation job / job item for this target language.
      $additional = t('None');
    }

    // Inject the additional column into the array.
    // The generated form structure has changed, support both an additional
    // 'data' key (that is not supported by tableselect) and the old version
    // without.
    if (isset($option['data'])) {
      array_splice($option['data'], -1, 0, array(
        $additional,
      ));

      // Append the current option array to the form.
      $form['languages']['#options'][$langcode] = $option['data'];
    }
    else {
      array_splice($option, -1, 0, array(
        $additional,
      ));

      // Append the current option array to the form.
      $form['languages']['#options'][$langcode] = $option;
    }
  }
  $form['actions']['#type'] = 'actions';
  $form['actions']['request'] = array(
    '#type' => 'submit',
    '#value' => t('Request translation'),
    '#submit' => array(
      'tmgmt_entity_ui_translate_form_submit',
    ),
    '#validate' => array(
      'tmgmt_entity_ui_translate_form_validate',
    ),
  );
  return $form;
}

/**
 * Validation callback for the entity translation overview form.
 */
function tmgmt_entity_ui_translate_form_validate($form, &$form_state) {
  $selected = array_filter($form_state['values']['languages']);
  if (empty($selected)) {
    form_set_error('languages', t('You have to select at least one language for requesting a translation.'));
  }
}

/**
 * Submit callback for the entity translation overview form.
 */
function tmgmt_entity_ui_translate_form_submit($form, &$form_state) {
  $entity = $form_state['entity'];
  $entity_type = $form_state['entity_type'];
  list($id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
  $values = $form_state['values'];
  $jobs = array();
  foreach (array_keys(array_filter($values['languages'])) as $langcode) {

    // Create the job object.
    $job = tmgmt_job_create(entity_language($entity_type, $entity), $langcode, $GLOBALS['user']->uid);
    try {

      // Add the job item.
      $job
        ->addItem('entity', $entity_type, $id);

      // Append this job to the array of created jobs so we can redirect the user
      // to a multistep checkout form if necessary.
      $jobs[$job->tjid] = $job;
    } catch (TMGMTException $e) {
      watchdog_exception('tmgmt', $e);
      $languages = language_list();
      $target_lang_name = $languages[$langcode]->language;
      drupal_set_message(t('Unable to add job item for target language %name. Make sure the source content is not empty.', array(
        '%name' => $target_lang_name,
      )), 'error');
    }
  }
  tmgmt_ui_job_checkout_and_redirect($form_state, $jobs);
}

Functions

Name	Description
tmgmt_entity_ui_translate_form	Entity translation overview form.
tmgmt_entity_ui_translate_form_submit	Submit callback for the entity translation overview form.
tmgmt_entity_ui_translate_form_validate	Validation callback for the entity translation overview form.