
| Current Path : /var/www/html/c12park/web/modules/contrib/webform/src/Element/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : /var/www/html/c12park/web/modules/contrib/webform/src/Element/WebformMessage.php |
<?php
namespace Drupal\webform\Element;
use Drupal\Core\Render\Element;
use Drupal\Core\Render\Element\RenderElement;
use Drupal\Core\Url;
/**
* Provides a render element for message.
*
* @FormElement("webform_message")
*/
class WebformMessage extends RenderElement {
/**
* Storage none.
*/
const STORAGE_NONE = '';
/**
* Storage local.
*/
const STORAGE_LOCAL = 'local';
/**
* Storage session.
*/
const STORAGE_SESSION = 'session';
/**
* Storage user (data).
*/
const STORAGE_USER = 'user';
/**
* Storage state (API).
*/
const STORAGE_STATE = 'state';
/**
* Storage custom.
*
* @see hook_webform_message_custom()
*/
const STORAGE_CUSTOM = 'custom';
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#message_type' => 'status',
'#message_message' => '',
'#message_close' => FALSE,
'#message_close_effect' => 'slide',
'#message_id' => '',
'#message_storage' => '',
'#status_headings' => [],
'#pre_render' => [
[$class, 'preRenderWebformMessage'],
],
'#theme_wrappers' => ['webform_message'],
];
}
/**
* Create status message for rendering.
*
* @param array $element
* An associative array containing the properties and children of the
* element.
*
* @return array
* The modified element with status message.
*/
public static function preRenderWebformMessage(array $element) {
$message_type = $element['#message_type'];
$message_close = $element['#message_close'];
$message_close_effect = $element['#message_close_effect'];
$message_id = $element['#message_id'];
$message_storage = $element['#message_storage'];
$message_message = $element['#message_message'];
$element['#attributes']['class'][] = 'webform-message';
$element['#attributes']['class'][] = 'js-webform-message';
// Ignore 'user' and 'state' storage is current user is anonymous.
if (\Drupal::currentUser()->isAnonymous() && in_array($message_storage, [static::STORAGE_USER, static::STORAGE_STATE, static::STORAGE_CUSTOM])) {
$message_storage = '';
}
// Build the messages render array.
$messages = [];
// Add close button as the first message.
if ($message_close) {
$element['#attributes']['data-message-close-effect'] = $message_close_effect;
$element['#attributes']['class'][] = 'webform-message--close';
$element['#attributes']['class'][] = 'js-webform-message--close';
$close_attributes = [
'aria-label' => t('close'),
'class' => ['js-webform-message__link', 'webform-message__link'],
];
if (in_array($message_storage, [static::STORAGE_USER, static::STORAGE_STATE, static::STORAGE_CUSTOM])) {
$close_url = Url::fromRoute('webform.element.message.close', [
'storage' => $message_storage,
'id' => $message_id,
]);
}
else {
$close_url = Url::fromRoute('<none>', [], ['fragment' => 'close']);
}
$messages[] = [
'#type' => 'link',
'#title' => '×',
'#url' => $close_url,
'#attributes' => $close_attributes,
];
// Add close attributes and check is message is closed.
if ($message_storage && $message_id) {
$element['#attributes']['data-message-id'] = $message_id;
$element['#attributes']['data-message-storage'] = $message_storage;
$element['#attributes']['class'][] = 'js-webform-message--close-storage';
if (static::isClosed($message_storage, $message_id)) {
$element['#closed'] = TRUE;
}
}
}
// Add messages to container children.
$messages[] = (!is_array($message_message)) ? ['#markup' => $message_message] : $message_message;
foreach (Element::children($element) as $key) {
$messages[] = $element[$key];
unset($element[$key]);
}
// Add status messages as the message.
$element['#message'] = [
'#theme' => 'status_messages',
'#message_list' => [$message_type => [$messages]],
'#status_headings' => $element['#status_headings'] + [
'status' => t('Status message'),
'error' => t('Error message'),
'warning' => t('Warning message'),
],
];
// Attach message styles and JavaScript.
$element['#attached']['library'][] = 'webform/webform.element.message';
// Attach info message styles.
// Gin theme declares the message info style, which is not included in core.
/** @var \Drupal\webform\WebformThemeManagerInterface $theme_manager */
$theme_manager = \Drupal::service('webform.theme_manager');
$is_gin_theme = $theme_manager->isActiveTheme('gin');
$is_olivero_theme = $theme_manager->isActiveTheme('olivero');
if ($message_type === 'info' && !$is_gin_theme && !$is_olivero_theme) {
$element['#attached']['library'][] = 'webform/webform.element.message.info';
}
return $element;
}
/* ************************************************************************ */
// Manage closed functions.
/* ************************************************************************ */
/**
* Is message closed via User Data, State API, or Custom.
*
* @param string $storage
* The storage mechanism to check if a message is closed.
* @param string $id
* The ID of the message.
*
* @return bool
* TRUE if the message is closed.
*/
public static function isClosed($storage, $id) {
$account = \Drupal::currentUser();
$namespace = 'webform.element.message';
switch ($storage) {
case static::STORAGE_STATE:
/** @var \Drupal\Core\State\StateInterface $state */
$state = \Drupal::service('state');
$values = $state->get($namespace, []);
return (isset($values[$id])) ? TRUE : FALSE;
case static::STORAGE_USER:
/** @var \Drupal\user\UserDataInterface $user_data */
$user_data = \Drupal::service('user.data');
$values = $user_data->get('webform', $account->id(), $namespace) ?: [];
return (isset($values[$id])) ? TRUE : FALSE;
case static::STORAGE_CUSTOM:
$result = \Drupal::moduleHandler()->invokeAll('webform_message_custom', ['closed', $id]);
return array_filter($result) ? TRUE : FALSE;
}
return FALSE;
}
/**
* Set message closed via User Data, State API, or Custom.
*
* @param string $storage
* The storage mechanism save message closed.
* @param string $id
* The ID of the message.
*
* @see \Drupal\webform\Controller\WebformElementController::close
*/
public static function setClosed($storage, $id) {
$account = \Drupal::currentUser();
$namespace = 'webform.element.message';
switch ($storage) {
case static::STORAGE_STATE:
/** @var \Drupal\Core\State\StateInterface $state */
$state = \Drupal::service('state');
$values = $state->get($namespace, []);
$values[$id] = TRUE;
$state->set($namespace, $values);
break;
case static::STORAGE_USER:
/** @var \Drupal\user\UserDataInterface $user_data */
$user_data = \Drupal::service('user.data');
$values = $user_data->get('webform', $account->id(), $namespace) ?: [];
$values[$id] = TRUE;
$user_data->set('webform', $account->id(), $namespace, $values);
break;
case static::STORAGE_CUSTOM:
\Drupal::moduleHandler()->invokeAll('webform_message_custom', ['close', $id]);
break;
}
}
/**
* Reset message closed via User Data, State API, or Custom.
*
* @param string $storage
* The storage mechanism save message closed.
* @param string $id
* The ID of the message.
*
* @see \Drupal\webform\Controller\WebformElementController::close
*/
public static function resetClosed($storage, $id) {
$account = \Drupal::currentUser();
$namespace = 'webform.element.message';
switch ($storage) {
case static::STORAGE_STATE:
/** @var \Drupal\Core\State\StateInterface $state */
$state = \Drupal::service('state');
$values = $state->get($namespace, []);
unset($values[$id]);
$state->set($namespace, $values);
break;
case static::STORAGE_USER:
/** @var \Drupal\user\UserDataInterface $user_data */
$user_data = \Drupal::service('user.data');
$values = $user_data->get('webform', $account->id(), $namespace) ?: [];
unset($values[$id]);
$user_data->set('webform', $account->id(), $namespace, $values);
break;
case static::STORAGE_CUSTOM:
\Drupal::moduleHandler()->invokeAll('webform_message_custom', ['reset', $id]);
break;
}
}
}