Как программно создать пользовательский токен в модуле

Как бы вы могли программно создать токен? Я хочу добавить некоторые пользовательские токены для моего модуля.

23 голоса | спросил Lucy 10 J0000006Europe/Moscow 2011, 19:57:40

5 ответов


7

В Drupal 6 вы используете hook_token_values() .

Этот крючок позволит вам создавать токены. Вы можете создать их в глобальной области или вы можете использовать объект, подобный узлу, или пользователь, чтобы засеять значения.

Вы также можете использовать hook_token_list() , чтобы объяснить, что ваши токены есть.

Документация token.api довольно Чисто.

function my_user_token_values($type, $object = NULL, $options = array()) {
  if ($type == 'user') {
    $user = $object;
    $tokens['name']      = $user->name;
    $tokens['mail']      = $user->mail;
    return $tokens;
  }
}

Я не буду X публиковать все, но это должно дать вам идею высокого уровня.

ответил Jeremy French 10 J0000006Europe/Moscow 2011, 20:17:29
20

В Drupal 7 код для обработки токенов является частью основного модуля Drupal.

Крюкам, которые должны реализовывать модули токенов, являются:

  • hook_token_info () это крючок, который предоставляет информацию о токенах, реализованных модулем.
  • hook_tokens () это крючок, который необходимо реализовать, чтобы обеспечить фактические значения, которые заменяют токены.

Другие модули могут изменять реализацию маркера, предоставляемую модулем, используя hook_token_info_alter () и hook_tokens_alter () .

В отличие от модуля Token, код в ядре Drupal позволяет создавать содержимое токена только в случае крайней необходимости. В Drupal 6 модуль Token запросит модули, реализующие токены, все значения для их токена, используя hook_token_values(); это означает, что модуль может вычислить значение для токена, которое тогда не требуется для замененных токенов. В Drupal 7 реализация hook_tokens() получает $tokens, массив токенов, подлежащих замене, в качестве аргумента; модуль затем может вычислить значение токена, зная, что он будет использоваться.

Функция, которая в Drupal 7 используется для замены токенов своим значением, token_replace () , которая является единственной функцией, используемой для замены маркеров своими значениями.

Другая разница между модулем Token для Drupal 6 и кодом в Drupal 7:

  • В Drupal 7, [node: author] возвращает имя автора; [node: author: mail] возвращает адрес электронной почты, связанный с автором узла, а [node: author: url] возвращает URL-адрес профиля пользователя для автора узла. Другими словами, можно использовать [node: author: xyz], где «xyz» является одним из токенов, возвращаемых для пользовательского объекта.
  • В Drupal 7 нет сырых токенов; реализация hook_tokens() получает параметр, указывающий на крючок, когда содержимое маркера необходимо дезинфицировать; когда значение токена не нуждается в дезинфекции, содержимое не передается функциям check_plain() или filter_xss().
  • В Drupal 7 нет функции, отображающей список доступных токенов. Если модулю необходимо отобразить список доступных токенов, он должен создать список самих токенов и показать его в описании поля формы; альтернативно, он может использовать функцию темы, доступную в модуле Token.
ответил kiamlaluno 13 J000000Wednesday11 2011, 22:54:43
8

Я хотел добавить новый токен в раздел Информация о сайте токенов, называемый Название города . Так я сделал это в Drupal 7.

 /**
 * Implements hook_token_info().
 */
function my_module_token_info() {

  // Add tokens.
  $site['city_name'] = array(
    'name' => t('Token Name'),
    'description' => t('Token Description'),
  );

  return array(
    'tokens' => array(
      'site' => $site,
    ),
  );
}

/**
 * Implements hook_tokens().
 */
function my_module_tokens($type, $tokens, array $data = array(), array $options = array()) {
  $replacements = array();

 if ($type == 'site') {
    foreach ($tokens as $name => $original) {
      switch ($name) {
        case 'city_name':
          $city_name = variable_get('city_name');
          $replacements[$original] = $sanitize ? check_plain($city_name) : $city_name;
          break;
      }
    }
  }

  // Return the replacements.
  return $replacements;
}
ответил Lee Woodman 5 J000000Saturday14 2014, 16:00:34
2

Для Drupal 8

// We need to include the needed class for tokens.

use Drupal\Core\Render\BubbleableMetadata;

/**
 * Implements hook_token_info().
 */
function modulename_token_info() {
  $info = array();
  // Add any new tokens.
  $info['tokens']['customtokentype']['customtoken'] = t('Telling drupal that you define custom token');
  // Return them.
  return $info;
}

/**
 * Implements hook_tokens().
 */
function modulename_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
  $replacements = array();
  $simple = $data["customanything"];
  if ($type == 'customtokentype') {
    foreach ($tokens as $name => $original) {
      // Find the desired token by name
      switch ($name) {
        case 'customtoken':
          $new = $simple;
          $replacements[$original] = $new;
          break;
      }
    }
  }   
  // Return the replacements.
  return $replacements;
}

Получение значения токенов в вашей функции требует кода, аналогичного следующему.

$token = \Drupal::token();
$message_html = "hello my custom token is replaced see it here [customtokentype:customtoken]";

// Token data.
$data = array('customanything' => $tosendtotokens);
$message_html = $token->replace($message_html, $data);
ответил Karthikeyan Manivasagam 25 J000000Monday16 2016, 09:41:50
2

Для Drupal 8, пример использования узла:

Вы можете помещать токены в свой модуль на mymodule.tokens.inc с помощью hook_token_info (), чтобы зарегистрировать их и hook_tokens () для данных замены.

Если вы хотите создать пользовательский токен для существующего типа токена, например, для узлов, вам нужно поместить свой токен в подмассиве в hook_token_info (). Обратитесь к node.tokens.inc в модуле узла, чтобы узнать, из чего вы строите.

mymodule.tokens.inc:

<?php

use Drupal\Core\Render\BubbleableMetadata;
use Drupal\image\Entity\ImageStyle;

/**
 * Implements hook_token_info().
 */
function mymodule_token_info() {
  $info = array();

  $info['tokens']['node']['custom_title'] = [
    'name' => t("Custom Title"),
    'description' => t("a custom node title token"),
  ];
  // Return them.
  return $info;
}

/**
 * Implements hook_tokens().
 */
function mymodule_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {

  $replacements = array();
  if ($type == 'node') {
    foreach ($tokens as $name => $original) {
      // Find the desired token by name
      switch ($name) {
        case '$data['node']':
          $node = $data['node'];
          $replacements[$original] = $node->label();
          break;
      }
    }
  }
  // Return the replacements.
  return $replacements;
}
ответил oknate 2 FebruaryEurope/MoscowbFri, 02 Feb 2018 17:29:31 +0300000000pmFri, 02 Feb 2018 17:29:31 +030018 2018, 17:29:31

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132