tmgmt_smartling.api.php in TMGMT Translator Smartling 8.4

Hooks provided by the TMGMT Smartling module.

File

tmgmt_smartling.api.php

<?php

/**
 * @file
 * Hooks provided by the TMGMT Smartling module.
 */
use Drupal\tmgmt\JobInterface;
use Drupal\tmgmt\JobItemInterface;

/**
 * Alter entity context url.
 *
 * @param string $url
 * @param \Drupal\tmgmt\JobItemInterface $job_item
 */
function hook_tmgmt_smartling_context_url_alter(&$url, JobItemInterface $job_item) {

  // Set NULL to avoid creating context for a content from $job_item.
  $url = NULL;
}

/**
 * Alter translation file name.
 *
 * @param string $name
 * @param JobInterface $job
 */
function hook_tmgmt_smartling_filename_alter(&$name, JobInterface $job) {

  // Example: filename = job's label. If you have only one job item in a job
  // then file name will look like "[node_title]_job_id_[id]". If there are more
  // than 1 job item inside a job then filename will look like
  // "[node_title]_and_[n]_more_job_id_[id]". If you enter your own job label
  // then filename will look like "[your_own_label]_job_id_[id]"
  $name = preg_replace('/[^a-zA-Z0-9_\\-\\:]/i', '_', $job
    ->label()) . '_job_id_' . $job
    ->id();
}

/**
 * Alter daily bucket job name.
 *
 * @param string $name
 */
function hook_tmgmt_smartling_bucket_job_name_alter(&$name) {
  $name = 'My daily bucket job';
}

/**
 * Alter directives for the file being uploaded.
 *
 * @param array $directives
 */
function hook_tmgmt_smartling_directives_alter(array &$directives) {
  $directives['smartling.force_inline_for_tags'] = 'icon';
}

/**
 * Alter list of base form ids of entities which are enabled for lock fields
 * mechanism.
 *
 * @param array $forms_to_enable_locked_fields
 */
function hook_tmgmt_smartling_locked_fields_base_form_id_list_alter(array &$forms_to_enable_locked_fields) {
  $forms_to_enable_locked_fields[] = 'my_custom_entity_base_form';
}

/**
 * Alter data to be exported into an XML file.
 *
 * @param array $data
 */
function hook_tmgmt_smartling_xml_file_export_data_alter(array &$data) {
}

/**
 * Alter data to be imported from an XML file.
 *
 * @param array $data
 */
function hook_tmgmt_smartling_xml_file_import_data_alter(array &$data) {
}

Functions

Name	Description
hook_tmgmt_smartling_bucket_job_name_alter	Alter daily bucket job name.
hook_tmgmt_smartling_context_url_alter	Alter entity context url.
hook_tmgmt_smartling_directives_alter	Alter directives for the file being uploaded.
hook_tmgmt_smartling_filename_alter	Alter translation file name.
hook_tmgmt_smartling_locked_fields_base_form_id_list_alter	Alter list of base form ids of entities which are enabled for lock fields mechanism.
hook_tmgmt_smartling_xml_file_export_data_alter	Alter data to be exported into an XML file.
hook_tmgmt_smartling_xml_file_import_data_alter	Alter data to be imported from an XML file.