class WebformTokenManager in Webform 8.5
Same name and namespace in other branches
- 6.x src/WebformTokenManager.php \Drupal\webform\WebformTokenManager
Defines a class to manage token replacement.
Hierarchy
- class \Drupal\webform\WebformTokenManager implements WebformTokenManagerInterface uses StringTranslationTrait
Expanded class hierarchy of WebformTokenManager
1 string reference to 'WebformTokenManager'
1 service uses WebformTokenManager
File
- src/
WebformTokenManager.php, line 21
Namespace
Drupal\webformView source
class WebformTokenManager implements WebformTokenManagerInterface {
use StringTranslationTrait;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* The configuration object factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* The module handler.
*
* @var \Drupal\Core\Extension\ModuleHandlerInterface
*/
protected $moduleHandler;
/**
* The token service.
*
* @var \Drupal\Core\Utility\Token
*/
protected $token;
/**
* An array of support token suffixes.
*
* @var array
*
* @see webform_token_info_alter()
*/
protected static $suffixes = [
// Removes the token when not replaced.
'clear',
// Decodes HTML entities.
'htmldecode',
// Removes all HTML tags from the token's value.
'striptags',
// URL encodes the token's value.
// @see https://www.php.net/manual/en/function.urlencode.php
'urlencode',
// Raw URL encodes the token's value.
// @see https://www.php.net/manual/en/function.rawurlencode.php
'rawurlencode',
// XML encodes the token's value.
'xmlencode',
];
/**
* Constructs a WebformTokenManager object.
*
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The configuration object factory.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Utility\Token $token
* The token service.
*/
public function __construct(AccountInterface $current_user, LanguageManagerInterface $language_manager, ConfigFactoryInterface $config_factory, ModuleHandlerInterface $module_handler, Token $token) {
$this->currentUser = $current_user;
$this->languageManager = $language_manager;
$this->configFactory = $config_factory;
$this->moduleHandler = $module_handler;
$this->token = $token;
$this->config = $this->configFactory
->get('webform.settings');
}
/**
* {@inheritdoc}
*/
public function replace($text, EntityInterface $entity = NULL, array $data = [], array $options = [], BubbleableMetadata $bubbleable_metadata = NULL) {
// Replace tokens within an array.
if (is_array($text)) {
foreach ($text as $key => $token_value) {
$text[$key] = $this
->replace($token_value, $entity, $data, $options, $bubbleable_metadata);
}
return $text;
}
// Most strings won't contain tokens so let's check and return ASAP.
if (!is_string($text) || strpos($text, '[') === FALSE) {
return $text;
}
if ($entity) {
// Replace @deprecated [webform-submission] with [webform_submission].
$text = str_replace('[webform-submission:', '[webform_submission:', $text);
// Set token data based on entity type.
$this
->setTokenData($data, $entity);
// Set token options based on entity.
$this
->setTokenOptions($options, $entity);
}
// For anonymous users remove all [current-user] tokens to prevent
// anonymous user properties from being displayed.
// For example, the [current-user:display-name] token will return
// 'Anonymous', which is not an expected behavior.
if ($this->currentUser
->isAnonymous() && strpos($text, '[current-user:') !== FALSE) {
$text = preg_replace('/\\[current-user:[^]]+\\]/', '', $text);
}
// Get supported suffixes.
$suffixes = $this
->getSuffixes($options);
// Prepare suffixes.
$text = $this
->prepareSuffixes($text, $suffixes);
// Replace the webform related tokens.
$text = $this->token
->replace($text, $data, $options, $bubbleable_metadata);
// Process token suffixes.
$text = $this
->processSuffixes($text);
// Clear current user tokens for undefined values.
if (strpos($text, '[current-user:') !== FALSE) {
$text = preg_replace('/\\[current-user:[^\\]]+\\]/', '', $text);
}
return $text;
}
/**
* {@inheritdoc}
*/
public function replaceNoRenderContext($text, EntityInterface $entity = NULL, array $data = [], array $options = []) {
// Create BubbleableMetadata object which will be ignored.
$bubbleable_metadata = new BubbleableMetadata();
return $this
->replace($text, $entity, $data, $options, $bubbleable_metadata);
}
/**
* Get token data based on an entity's type.
*
* @param array $data
* An array of token data.
* @param \Drupal\Core\Entity\EntityInterface $entity
* A Webform, Webform submission entity, or other entity.
*/
protected function setTokenData(array &$data, EntityInterface $entity) {
if ($entity instanceof WebformSubmissionInterface) {
$data['webform_submission'] = $entity;
$data['webform'] = $entity
->getWebform();
}
elseif ($entity instanceof WebformInterface) {
$data['webform'] = $entity;
}
else {
$data[$entity
->getEntityTypeId()] = $entity;
}
}
/**
* Set token option based on the entity.
*
* @param array $options
* An array of token data.
* @param \Drupal\Core\Entity\EntityInterface $entity
* A Webform or Webform submission entity.
*/
protected function setTokenOptions(array &$options, EntityInterface $entity) {
$token_options = [];
if ($entity instanceof WebformSubmissionInterface) {
$token_options['langcode'] = $entity
->language()
->getId();
}
elseif ($entity instanceof WebformInterface) {
$token_options['langcode'] = $this->languageManager
->getCurrentLanguage()
->getId();
}
$options += $token_options;
}
/****************************************************************************/
// Token elements.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function buildTreeLink(array $token_types = [
'webform',
'webform_submission',
'webform_handler',
]) {
if (!$this->moduleHandler
->moduleExists('token')) {
return [
'#type' => 'link',
'#title' => $this
->t('You may use tokens.'),
'#url' => Url::fromUri('https://www.drupal.org/project/token'),
];
}
else {
return [
'#theme' => 'token_tree_link',
'#text' => $this
->t('You may use tokens.'),
'#token_types' => $token_types,
'#click_insert' => TRUE,
'#dialog' => TRUE,
'#attached' => [
'library' => [
'webform/webform.token',
],
],
];
}
}
/**
* {@inheritdoc}
*/
public function buildTreeElement(array $token_types = [
'webform',
'webform_submission',
'webform_handler',
], $description = NULL) {
if (!$this->moduleHandler
->moduleExists('token')) {
return [];
}
$build = [
'#theme' => 'token_tree_link',
'#token_types' => $token_types,
'#click_insert' => TRUE,
'#dialog' => TRUE,
'#attached' => [
'library' => [
'webform/webform.token',
],
],
];
if ($description) {
if ($this->config
->get('ui.description_help')) {
return [
'#type' => 'container',
'token_tree_link' => $build,
'help' => [
'#type' => 'webform_help',
'#help' => $description,
],
];
}
else {
return [
'#type' => 'container',
'token_tree_link' => $build,
'description' => [
'#prefix' => ' ',
'#markup' => $description,
],
];
}
}
else {
return [
'#type' => 'container',
'token_tree_link' => $build,
];
}
}
/****************************************************************************/
// Token validation.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function elementValidate(array &$form, array $token_types = [
'webform',
'webform_submission',
'webform_handler',
]) {
if (!function_exists('token_element_validate')) {
return;
}
// Always add system tokens.
// @see system_token_info()
$token_types = array_merge($token_types, [
'site',
'date',
]);
$text_element_types = [
'email' => 'email',
'textfield' => 'textfield',
'textarea' => 'textarea',
'url' => 'url',
'webform_codemirror' => 'webform_codemirror',
'webform_email_multiple' => 'webform_email_multiple',
'webform_html_editor' => 'webform_html_editor',
'webform_checkboxes_other' => 'webform_checkboxes_other',
'webform_select_other' => 'webform_select_other',
'webform_radios_other' => 'webform_radios_other',
];
// If $form render array is an element then see if we should add
// validation callback.
if (isset($form['#type']) && isset($text_element_types[$form['#type']])) {
$form['#element_validate'][] = [
get_called_class(),
'validateElement',
];
$form['#token_types'] = $token_types;
}
$elements =& WebformFormHelper::flattenElements($form);
foreach ($elements as &$element) {
if (!isset($element['#type']) || !isset($text_element_types[$element['#type']])) {
continue;
}
$element['#element_validate'][] = [
get_called_class(),
'validateElement',
];
$element['#token_types'] = $token_types;
}
}
/**
* Validates an element's tokens.
*
* Note:
* Element is not being based by reference since the #value is being altered.
*/
public static function validateElement($element, FormStateInterface $form_state, &$complete_form) {
$value = isset($element['#value']) ? $element['#value'] : $element['#default_value'];
if (!mb_strlen($value)) {
return $element;
}
// Remove all suffixes which are not valid.
$pattern = '/\\[((?:webform|current-user)[^]]+)((?::' . implode('|:', static::$suffixes) . ')+)\\]/';
while (preg_match($pattern, $value)) {
$value = preg_replace($pattern, '[\\1]', $value);
}
// Convert all token field deltas to 0 to prevent unexpected
// token validation errors.
$value = preg_replace('/:\\d+:/', ':0:', $value);
$element['#value'] = $value;
token_element_validate($element, $form_state);
}
/****************************************************************************/
// Suffix handling.
/****************************************************************************/
/**
* Get an array of supported token suffixes.
*
* @param array $options
* A keyed array of settings and flags to control the token
* replacement process.
*
* @return array
* An array of supported token suffixes,
*/
protected function getSuffixes(array $options) {
$suffixes = static::$suffixes;
// Unset any $option['suffixes'] set to FALSE.
if (isset($options['suffixes'])) {
foreach ($suffixes as $index => $suffix) {
if (isset($options['suffixes'][$suffix]) && $options['suffixes'][$suffix] === FALSE) {
unset($suffixes[$index]);
}
}
}
return $suffixes;
}
/**
* Prepare token suffixes to be replaced and processed.
*
* Prepare token suffixes by wrapping them in temp
* {webform-token-suffixes} tags.
*
* [webform:token:clear:urlencode] becomes
* {webform-token-suffixes:clear:urlencode}[webform:token]{/webform-token-suffixes}.
*
* @param string|array $text
* A string of text that may contain tokens.
* @param array $suffixes
* An array of supported suffixes.
*
* @return string
* A string of text with token suffixes wrapped in
* {webform-token-suffixes} tags.
*/
protected function prepareSuffixes($text, array $suffixes) {
if (preg_match_all('/\\[([^\\]]+?)((?::' . implode('|:', $suffixes) . ')+)\\]/', $text, $matches)) {
foreach ($matches[0] as $index => $match) {
$value = $matches[1][$index];
$suffixes = $matches[2][$index];
$wrapper = '{webform-token-suffixes' . $suffixes . '}[' . $value . ']{/webform-token-suffixes}';
$text = str_replace($match, $wrapper, $text);
}
}
return $text;
}
/**
* Process token suffixes after all tokens are replaced.
*
* @param string|array $text
* A string of text that may contain {webform-token-suffixes} tags.
*
* @return string
* String to text with all tokens suffixes processed.
*/
protected function processSuffixes($text) {
if (preg_match_all('/{webform-token-suffixes:([^}]+)}(.*?){\\/webform-token-suffixes}/ms', $text, $matches)) {
foreach ($matches[0] as $index => $match) {
$search = $matches[0][$index];
$replace = $matches[2][$index];
$value = $matches[2][$index];
$suffixes = explode(':', $matches[1][$index]);
$suffixes = array_combine($suffixes, $suffixes);
// If token is not replaced then only the :clear suffix is applicable.
if (preg_match('/^\\[[^}]+\\]$/', $value)) {
// Clear token text or restore the original token.
$original = str_replace(']', ':' . $matches[1][$index] . ']', $value);
$replace = isset($suffixes['clear']) ? '' : $original;
}
else {
// Decode and XSS filter value first.
if (isset($suffixes['htmldecode'])) {
$replace = html_entity_decode($replace, ENT_QUOTES);
$replace = isset($suffixes['striptags']) ? strip_tags($replace) : html_entity_decode(Xss::filterAdmin($replace));
}
// Encode URL.
if (isset($suffixes['urlencode'])) {
$replace = urlencode($replace);
}
if (isset($suffixes['rawurlencode'])) {
$replace = rawurlencode($replace);
}
// Encode xml.
if (isset($suffixes['xmlencode'])) {
$replace = htmlspecialchars($replace, ENT_XML1);
}
}
$text = str_replace($search, $replace, $text);
}
}
return $text;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
|
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
|
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
|
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
|
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
|
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
|
WebformTokenManager:: |
protected | property | The configuration object factory. | |
|
WebformTokenManager:: |
protected | property | The current user. | |
|
WebformTokenManager:: |
protected | property | The language manager. | |
|
WebformTokenManager:: |
protected | property | The module handler. | |
|
WebformTokenManager:: |
protected static | property | An array of support token suffixes. | |
|
WebformTokenManager:: |
protected | property | The token service. | |
|
WebformTokenManager:: |
public | function |
Build token tree element if token.module is installed. Overrides WebformTokenManagerInterface:: |
|
|
WebformTokenManager:: |
public | function |
Build token tree link if token.module is installed. Overrides WebformTokenManagerInterface:: |
|
|
WebformTokenManager:: |
public | function |
Validate form that should have tokens in it. Overrides WebformTokenManagerInterface:: |
|
|
WebformTokenManager:: |
protected | function | Get an array of supported token suffixes. | |
|
WebformTokenManager:: |
protected | function | Prepare token suffixes to be replaced and processed. | |
|
WebformTokenManager:: |
protected | function | Process token suffixes after all tokens are replaced. | |
|
WebformTokenManager:: |
public | function |
Replace tokens in text. Overrides WebformTokenManagerInterface:: |
|
|
WebformTokenManager:: |
public | function |
Replace tokens in text with no render context. Overrides WebformTokenManagerInterface:: |
|
|
WebformTokenManager:: |
protected | function | Get token data based on an entity's type. | |
|
WebformTokenManager:: |
protected | function | Set token option based on the entity. | |
|
WebformTokenManager:: |
public static | function | Validates an element's tokens. | |
|
WebformTokenManager:: |
public | function | Constructs a WebformTokenManager object. |