123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198 |
- <?php
- /**
- * @file
- * Builds placeholder replacement tokens system-wide data.
- *
- * This file handles tokens for the global 'site' and 'date' tokens.
- */
- use Drupal\Core\Url;
- use Drupal\Core\Datetime\Entity\DateFormat;
- use Drupal\Core\Render\BubbleableMetadata;
- /**
- * Implements hook_token_info().
- */
- function system_token_info() {
- $types['site'] = [
- 'name' => t("Site information"),
- 'description' => t("Tokens for site-wide settings and other global information."),
- ];
- $types['date'] = [
- 'name' => t("Dates"),
- 'description' => t("Tokens related to times and dates."),
- ];
- // Site-wide global tokens.
- $site['name'] = [
- 'name' => t("Name"),
- 'description' => t("The name of the site."),
- ];
- $site['slogan'] = [
- 'name' => t("Slogan"),
- 'description' => t("The slogan of the site."),
- ];
- $site['mail'] = [
- 'name' => t("Email"),
- 'description' => t("The administrative email address for the site."),
- ];
- $site['url'] = [
- 'name' => t("URL"),
- 'description' => t("The URL of the site's front page."),
- ];
- $site['url-brief'] = [
- 'name' => t("URL (brief)"),
- 'description' => t("The URL of the site's front page without the protocol."),
- ];
- $site['login-url'] = [
- 'name' => t("Login page"),
- 'description' => t("The URL of the site's login page."),
- ];
- /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
- $date_formatter = \Drupal::service('date.formatter');
- // Date related tokens.
- $date['short'] = [
- 'name' => t("Short format"),
- 'description' => t("A date in 'short' format. (%date)", ['%date' => $date_formatter->format(REQUEST_TIME, 'short')]),
- ];
- $date['medium'] = [
- 'name' => t("Medium format"),
- 'description' => t("A date in 'medium' format. (%date)", ['%date' => $date_formatter->format(REQUEST_TIME, 'medium')]),
- ];
- $date['long'] = [
- 'name' => t("Long format"),
- 'description' => t("A date in 'long' format. (%date)", ['%date' => $date_formatter->format(REQUEST_TIME, 'long')]),
- ];
- $date['custom'] = [
- 'name' => t("Custom format"),
- 'description' => t('A date in a custom format. See <a href="http://php.net/manual/function.date.php">the PHP documentation</a> for details.'),
- ];
- $date['since'] = [
- 'name' => t("Time-since"),
- 'description' => t("A date in 'time-since' format. (%date)", ['%date' => $date_formatter->formatTimeDiffSince(REQUEST_TIME - 360)]),
- ];
- $date['raw'] = [
- 'name' => t("Raw timestamp"),
- 'description' => t("A date in UNIX timestamp format (%date)", ['%date' => REQUEST_TIME]),
- ];
- return [
- 'types' => $types,
- 'tokens' => [
- 'site' => $site,
- 'date' => $date,
- ],
- ];
- }
- /**
- * Implements hook_tokens().
- */
- function system_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
- $token_service = \Drupal::token();
- $url_options = ['absolute' => TRUE];
- if (isset($options['langcode'])) {
- $url_options['language'] = \Drupal::languageManager()->getLanguage($options['langcode']);
- $langcode = $options['langcode'];
- }
- else {
- $langcode = NULL;
- }
- $replacements = [];
- if ($type == 'site') {
- foreach ($tokens as $name => $original) {
- switch ($name) {
- case 'name':
- $config = \Drupal::config('system.site');
- $bubbleable_metadata->addCacheableDependency($config);
- $site_name = $config->get('name');
- $replacements[$original] = $site_name;
- break;
- case 'slogan':
- $config = \Drupal::config('system.site');
- $bubbleable_metadata->addCacheableDependency($config);
- $slogan = $config->get('slogan');
- $build = [
- '#markup' => $slogan,
- ];
- // @todo Fix in https://www.drupal.org/node/2577827
- $replacements[$original] = \Drupal::service('renderer')->renderPlain($build);
- break;
- case 'mail':
- $config = \Drupal::config('system.site');
- $bubbleable_metadata->addCacheableDependency($config);
- $replacements[$original] = $config->get('mail');
- break;
- case 'url':
- /** @var \Drupal\Core\GeneratedUrl $result */
- $result = Url::fromRoute('<front>', [], $url_options)->toString(TRUE);
- $bubbleable_metadata->addCacheableDependency($result);
- $replacements[$original] = $result->getGeneratedUrl();
- break;
- case 'url-brief':
- /** @var \Drupal\Core\GeneratedUrl $result */
- $result = Url::fromRoute('<front>', [], $url_options)->toString(TRUE);
- $bubbleable_metadata->addCacheableDependency($result);
- $replacements[$original] = preg_replace(['!^https?://!', '!/$!'], '', $result->getGeneratedUrl());
- break;
- case 'login-url':
- /** @var \Drupal\Core\GeneratedUrl $result */
- $result = Url::fromRoute('user.page', [], $url_options)->toString(TRUE);
- $bubbleable_metadata->addCacheableDependency($result);
- $replacements[$original] = $result->getGeneratedUrl();
- break;
- }
- }
- }
- elseif ($type == 'date') {
- if (empty($data['date'])) {
- $date = REQUEST_TIME;
- // We depend on the current request time, so the tokens are not cacheable
- // at all.
- $bubbleable_metadata->setCacheMaxAge(0);
- }
- else {
- $date = $data['date'];
- }
- foreach ($tokens as $name => $original) {
- switch ($name) {
- case 'short':
- case 'medium':
- case 'long':
- $date_format = DateFormat::load($name);
- $bubbleable_metadata->addCacheableDependency($date_format);
- $replacements[$original] = \Drupal::service('date.formatter')->format($date, $name, '', NULL, $langcode);
- break;
- case 'since':
- $replacements[$original] = \Drupal::service('date.formatter')->formatTimeDiffSince($date, ['langcode' => $langcode]);
- $bubbleable_metadata->setCacheMaxAge(0);
- break;
- case 'raw':
- $replacements[$original] = $date;
- break;
- }
- }
- if ($created_tokens = $token_service->findWithPrefix($tokens, 'custom')) {
- foreach ($created_tokens as $name => $original) {
- $replacements[$original] = \Drupal::service('date.formatter')->format($date, 'custom', $name, NULL, $langcode);
- }
- }
- }
- return $replacements;
- }
|