globallink.api.php in GlobalLink Connect for Drupal 7.5

This file provides an example for the implementation of hooks that other modules can implement. Please read documentation for more details.

File

globallink.api.php

<?php

/**
 * @file
 * This file provides an example for the
 * implementation of hooks that other modules can implement.
 * Please read documentation for more details.
 */

/**
 * By implementing this hook, you can programmatically filter out if a particular
 * node is translatable or not by displaying/hiding it on the Send For Translation dashboard.
 * If the node is not translatable, this method should not return anything (not even false)
 * and the node will not show up on the dashboard.
 *
 * @param object $node
 *   The node object on which this check is being performed.
 * @param string $target_drupal_locale
 *   The target language code is only passed if the target language filter is selected on the dashboard.  Defaults to NULL.
 *
 * @return bool
 *   TRUE if the node is translatable.
 */
function module_globallink_is_node_translatable($node, $drupal_target_locale = NULL) {
  if ($node->type == 'article') {
    return TRUE;
  }
  elseif ($drupal_target_locale != NULL && $drupal_target_locale == 'fr') {
    return TRUE;
  }
}

/**
 * By implementing this hook, you can programmatically filter out if a particular
 * field is translatable or not.
 * If the field is not translatable, this method should not return anything (not even false).
 * This hook overrides the field configuration settings on the Field Configuration tab.
 *
 * @param object $node
 *   The node object on which this check is being performed.
 * @param string $field
 *   The field name on which this check is being performed.
 * @param array $target_arr
 *   The target language array as selected while creating the submission.  Defaults to NULL.
 *
 * @return bool
 *   TRUE if the field is translatable.
 */
function module_globallink_is_field_translatable($node, $field, $target_arr = NULL) {
  if ($node->type == 'article') {
    if ($field == 'title' || $field == 'body') {
      return TRUE;
    }
  }
  else {
    if ($target_arr != NULL) {
      foreach ($target_arr as $language) {
        if ($language == 'fr') {
          if ($field == 'title') {
            return TRUE;
          }
        }
      }
    }
  }
}

/**
 * By implementing this hook, you can modify translated node before it's imported in Drupal.
 * This hook is called just before the translated node is saved in the database.
 *
 * @param $source_nid
 *   The node id of the source node object.
 * @param $target_node
 *   The translated node object about to be saved in database.
 */
function module_globallink_import_translation($source_nid, &$target_node) {
  $source_node = node_load($source_nid);
  $target_node->title = 'TEST ' . $source_node->title;
}

/**
 * By implementing this hook, you can programmatically filter out if a particular
 * node is translatable or not for a particular language.
 * If the node is not translatable, this method should not return anything (not even false).
 * This hook is called just before the content is being send for translation.
 *
 * @param object $source_node
 *   The source node object.
 * @param string $drupal_target_locale
 *   Drupal target language selected by user for which this node is being translated.
 *
 * @return bool
 *   TRUE if the translation was successful.
 */
function module_globallink_translate_node_for_language($source_node, $drupal_target_locale) {
  if ($source_node->type == 'article' && $drupal_target_locale == 'fr') {
    return TRUE;
  }
}

/**
 * Allows other modules to alter node submissions.
 *
 * @param array $globalLink_arr
 *  The submission array.
 * @param array $data
 *  An array of data about the node translation.
 */
function hook_transperfect_node_send_alter($globalLink_arr, $data) {
}

/**
 * Allows other modules to hook into the updating of a node ticket ID post
 * submission.
 *
 * @param array $submissions
 *  The submissions that were sent.
 * @param string $project_code
 *  The project code.
 */
function hook_transperfect_update_node_ticket_id_alter($submissions, $project_code) {
}

Functions

Name	Description
hook_transperfect_node_send_alter	Allows other modules to alter node submissions.
hook_transperfect_update_node_ticket_id_alter	Allows other modules to hook into the updating of a node ticket ID post submission.
module_globallink_import_translation	By implementing this hook, you can modify translated node before it's imported in Drupal. This hook is called just before the translated node is saved in the database.
module_globallink_is_field_translatable	By implementing this hook, you can programmatically filter out if a particular field is translatable or not. If the field is not translatable, this method should not return anything (not even false). This hook overrides the field configuration…
module_globallink_is_node_translatable	By implementing this hook, you can programmatically filter out if a particular node is translatable or not by displaying/hiding it on the Send For Translation dashboard. If the node is not translatable, this method should not return anything (not even…
module_globallink_translate_node_for_language	By implementing this hook, you can programmatically filter out if a particular node is translatable or not for a particular language. If the node is not translatable, this method should not return anything (not even false). This hook is called just…