5 * Builds placeholder replacement tokens for media_entity-related data.
8 use Drupal\Component\Utility\Html;
9 use Drupal\Core\Datetime\Entity\DateFormat;
10 use Drupal\Core\Language\LanguageInterface;
11 use Drupal\Core\Render\BubbleableMetadata;
12 use Drupal\media_entity\Entity\MediaBundle;
15 * Implements hook_token_info().
17 function media_entity_token_info() {
20 'description' => t('Tokens related to individual media items.'),
21 'needs-data' => 'media',
24 // Core tokens for media.
26 'name' => t("Media ID"),
27 'description' => t('The unique ID of the media item.'),
30 'name' => t("Media UUID"),
31 'description' => t('The unique UUID of the media item.'),
34 'name' => t("Revision ID"),
35 'description' => t("The unique ID of the media's latest revision."),
38 'name' => t("Media bundle"),
40 $media['bundle-name'] = [
41 'name' => t("Media bundle name"),
42 'description' => t("The human-readable name of the media bundle."),
44 $media['langcode'] = [
45 'name' => t('Language code'),
46 'description' => t('The language code of the language the media is written in.'),
50 'description' => t('The name of this media.'),
54 'description' => t("The type of this media."),
57 'name' => t("Author"),
62 'description' => t("The URL of the media."),
64 $media['edit-url'] = [
65 'name' => t("Edit URL"),
66 'description' => t("The URL of the media's edit page."),
69 // Chained tokens for media.
71 'name' => t("Date created"),
75 'name' => t("Date changed"),
76 'description' => t("The date the media was most recently updated."),
81 'types' => ['media' => $type],
82 'tokens' => ['media' => $media],
87 * Implements hook_tokens().
89 function media_entity_tokens($type, $tokens, array $data, array $options, BubbleableMetadata $bubbleable_metadata) {
90 $token_service = \Drupal::token();
92 $url_options = ['absolute' => TRUE];
93 if (isset($options['langcode'])) {
94 $url_options['language'] = \Drupal::languageManager()->getLanguage($options['langcode']);
95 $langcode = $options['langcode'];
98 $langcode = LanguageInterface::LANGCODE_DEFAULT;
100 $sanitize = !empty($options['sanitize']);
104 if ($type == 'media' && !empty($data['media'])) {
105 /** @var \Drupal\media_entity\MediaInterface $media */
106 $media = \Drupal::service('entity.repository')->getTranslationFromContext($data['media'], $langcode, ['operation' => 'media_entity_tokens']);
108 foreach ($tokens as $name => $original) {
110 // Simple key values on the media_entity.
112 $replacements[$original] = $media->id();
116 $replacements[$original] = $media->uuid();
120 $replacements[$original] = $media->getRevisionId();
124 $replacements[$original] = $sanitize ? Html::escape($media->bundle()) : $media->bundle();
128 $bundle_name = MediaBundle::load($media->bundle())->label();
129 $replacements[$original] = $sanitize ? Html::escape($bundle_name) : $bundle_name;
133 $replacements[$original] = $sanitize ? Html::escape($media->language()->getId()) : $media->language()->getId();
137 $media_name = $media->get('name')->value;
138 $replacements[$original] = $sanitize ? Html::escape($media_name) : $media_name;
142 $media_type = $media->get('name')->value;
143 $replacements[$original] = $sanitize ? Html::escape($media_type) : $media_type;
147 $replacements[$original] = $media->toUrl('canonical', $url_options);
151 $replacements[$original] = $media->toUrl('edit-form', $url_options);
154 // Default values for the chained tokens handled below.
156 /** @var \Drupal\user\UserInterface $account */
157 $account = $media->get('uid')->entity;
158 $bubbleable_metadata->addCacheableDependency($account);
159 $replacements[$original] = $sanitize ? Html::escape($account->label()) : $account->label();
163 $date_format = DateFormat::load('medium');
164 $bubbleable_metadata->addCacheableDependency($date_format);
165 $replacements[$original] = \Drupal::service('date.formatter')
166 ->format($media->getCreatedTime(), 'medium', '', NULL, $langcode);
170 $date_format = DateFormat::load('medium');
171 $bubbleable_metadata->addCacheableDependency($date_format);
172 $replacements[$original] = \Drupal::service('date.formatter')
173 ->format($media->getChangedTime(), 'medium', '', NULL, $langcode);
178 if ($author_tokens = $token_service->findWithPrefix($tokens, 'author')) {
179 $account = $media->get('uid')->entity;
180 $replacements += $token_service->generate('user', $author_tokens, ['user' => $account], $options, $bubbleable_metadata);
183 if ($created_tokens = $token_service->findWithPrefix($tokens, 'created')) {
184 $replacements += $token_service->generate('date', $created_tokens, ['date' => $media->getCreatedTime()], $options, $bubbleable_metadata);
187 if ($changed_tokens = $token_service->findWithPrefix($tokens, 'changed')) {
188 $replacements += $token_service->generate('date', $changed_tokens, ['date' => $media->getChangedTime()], $options, $bubbleable_metadata);
192 return $replacements;