abstract class WebformCompositeBase in Webform 8.5
Same name in this branch
- 8.5 src/Element/WebformCompositeBase.php \Drupal\webform\Element\WebformCompositeBase
- 8.5 src/Plugin/WebformElement/WebformCompositeBase.php \Drupal\webform\Plugin\WebformElement\WebformCompositeBase
Same name and namespace in other branches
- 6.x src/Plugin/WebformElement/WebformCompositeBase.php \Drupal\webform\Plugin\WebformElement\WebformCompositeBase
Provides a base for composite elements.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
- class \Drupal\webform\Plugin\WebformElement\WebformCompositeBase implements WebformElementAttachmentInterface, WebformElementCompositeInterface
- class \Drupal\webform\Plugin\WebformElementBase implements TrustedCallbackInterface, WebformElementInterface uses MessengerTrait, StringTranslationTrait, WebformCompositeFormElementTrait, WebformEntityInjectionTrait
Expanded class hierarchy of WebformCompositeBase
15 files declare their use of WebformCompositeBase
- EmailWebformHandler.php in src/
Plugin/ WebformHandler/ EmailWebformHandler.php - RemotePostWebformHandler.php in src/
Plugin/ WebformHandler/ RemotePostWebformHandler.php - WebformDevelSchema.php in modules/
webform_devel/ src/ WebformDevelSchema.php - WebformElementBase.php in src/
Plugin/ WebformElementBase.php - WebformElementComposite.php in src/
Element/ WebformElementComposite.php
File
- src/
Plugin/ WebformElement/ WebformCompositeBase.php, line 26
Namespace
Drupal\webform\Plugin\WebformElementView source
abstract class WebformCompositeBase extends WebformElementBase implements WebformElementCompositeInterface, WebformElementAttachmentInterface {
/**
* Track managed file elements.
*
* @var array
*/
protected $elementsManagedFiles = [];
/****************************************************************************/
// Property definitions.
/****************************************************************************/
/**
* {@inheritdoc}
*/
protected function defineDefaultProperties() {
$properties = [
'default_value' => [],
'title_display' => 'invisible',
'disabled' => FALSE,
'flexbox' => '',
// Enhancements.
'select2' => FALSE,
'choices' => FALSE,
'chosen' => FALSE,
// Wrapper.
'wrapper_type' => 'fieldset',
] + parent::defineDefaultProperties() + $this
->defineDefaultMultipleProperties();
unset($properties['required_error']);
$composite_elements = $this
->getCompositeElements();
foreach ($composite_elements as $composite_key => $composite_element) {
// Get #type, #title, and #option from composite elements.
foreach ($composite_element as $composite_property_key => $composite_property_value) {
if (in_array($composite_property_key, [
'#type',
'#title',
'#options',
])) {
$property_key = str_replace('#', $composite_key . '__', $composite_property_key);
if ($composite_property_value instanceof TranslatableMarkup) {
$properties[$property_key] = (string) $composite_property_value;
}
else {
$properties[$property_key] = $composite_property_value;
}
}
}
if (isset($properties[$composite_key . '__type'])) {
$properties[$composite_key . '__title_display'] = '';
$properties[$composite_key . '__description'] = '';
$properties[$composite_key . '__help'] = '';
$properties[$composite_key . '__required'] = FALSE;
$properties[$composite_key . '__placeholder'] = '';
}
$properties[$composite_key . '__access'] = TRUE;
}
return $properties;
}
/**
* {@inheritdoc}
*/
protected function defineDefaultMultipleProperties() {
return [
'multiple__header' => FALSE,
'multiple__header_label' => '',
] + parent::defineDefaultMultipleProperties();
}
/****************************************************************************/
// Property methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function hasManagedFiles(array $element) {
return $this
->getManagedFiles($element) ? TRUE : FALSE;
}
/****************************************************************************/
// Element relationship methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getRelatedTypes(array $element) {
return [];
}
/****************************************************************************/
// Element rendering methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function initialize(array &$element) {
parent::initialize($element);
$this
->initializeCompositeElements($element);
}
/**
* {@inheritdoc}
*/
public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
parent::prepare($element, $webform_submission);
// If #flexbox is not set or an empty string, determine if the
// webform is using a flexbox layout.
if ((!isset($element['#flexbox']) || $element['#flexbox'] === '') && $webform_submission) {
$webform = $webform_submission
->getWebform();
$element['#flexbox'] = $webform
->hasFlexboxLayout();
}
}
/**
* Set multiple element wrapper.
*
* @param array $element
* An element.
*/
protected function prepareMultipleWrapper(array &$element) {
if (empty($element['#multiple']) || !$this
->supportsMultipleValues()) {
return;
}
parent::prepareMultipleWrapper($element);
// Set #header.
if (!empty($element['#multiple__header'])) {
$element['#header'] = TRUE;
// Set #element.
// We don't need to get the initialized composite elements because
// they will be initialized, prepared, and finalize by the
// WebformMultiple (wrapper) element.
// @see \Drupal\webform\Element\WebformMultiple::processWebformMultiple
$element['#element'] = [];
$composite_elements = $this
->getCompositeElements();
foreach (Element::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
// Transfer '#{composite_key}_{property}' from main element to composite
// element.
foreach ($element as $property_key => $property_value) {
if (strpos($property_key, '#' . $composite_key . '__') === 0) {
$composite_property_key = str_replace('#' . $composite_key . '__', '#', $property_key);
$composite_element[$composite_property_key] = $property_value;
}
}
$element['#element'][$composite_key] = $composite_element;
}
}
}
/****************************************************************************/
// Table methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getTableColumn(array $element) {
$key = $element['#webform_key'];
$title = $element['#title'] ?: $key;
$is_title_displayed = WebformElementHelper::isTitleDisplayed($element);
// Get the main composite element, which can't be sorted.
$columns = parent::getTableColumn($element);
$columns['element__' . $key]['sort'] = FALSE;
// Get individual composite elements.
if (!$this
->hasMultipleValues($element)) {
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach (RenderElement::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
// Make sure the composite element is visible.
$access_key = '#' . $composite_key . '__access';
if (isset($element[$access_key]) && $element[$access_key] === FALSE) {
continue;
}
// Add reference to initialized composite element so that it can be
// used by ::formatTableColumn().
$columns['element__' . $key . '__' . $composite_key] = [
'title' => ($is_title_displayed ? $title . ': ' : '') . (!empty($composite_element['#title']) ? $composite_element['#title'] : $composite_key),
'sort' => TRUE,
'default' => FALSE,
'key' => $key,
'element' => $element,
'property_name' => $composite_key,
'composite_key' => $composite_key,
'composite_element' => $composite_element,
'plugin' => $this,
];
}
}
return $columns;
}
/**
* {@inheritdoc}
*/
public function formatTableColumn(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
if (isset($options['composite_key']) && isset($options['composite_element'])) {
$composite_element = $options['composite_element'];
$composite_element['#webform_key'] = $element['#webform_key'];
return $this->elementManager
->invokeMethod('formatHtml', $composite_element, $webform_submission, $options);
}
else {
return $this
->formatHtml($element, $webform_submission);
}
}
/****************************************************************************/
// #states API methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getElementSelectorOptions(array $element) {
if ($this
->hasMultipleValues($element)) {
return [];
}
$title = $this
->getAdminLabel($element) . ' [' . $this
->getPluginLabel() . ']';
$name = $element['#webform_key'];
$selectors = [];
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach ($composite_elements as $composite_key => $composite_element) {
if (Element::isVisibleElement($composite_elements) && isset($composite_element['#type'])) {
$element_plugin = $this->elementManager
->getElementInstance($composite_element);
$composite_element['#webform_key'] = "{$name}[{$composite_key}]";
$selectors += OptGroup::flattenOptions($element_plugin
->getElementSelectorOptions($composite_element));
}
}
return [
$title => $selectors,
];
}
/**
* {@inheritdoc}
*/
public function getElementSelectorSourceValues(array $element) {
if ($this
->hasMultipleValues($element)) {
return [];
}
$name = $element['#webform_key'];
$source_values = [];
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach ($composite_elements as $composite_key => $composite_element) {
if (Element::isVisibleElement($composite_elements) && isset($composite_element['#type'])) {
$element_plugin = $this->elementManager
->getElementInstance($composite_element);
$composite_element['#webform_key'] = "{$name}[{$composite_key}]";
$source_values += $element_plugin
->getElementSelectorSourceValues($composite_element);
}
}
return $source_values;
}
/****************************************************************************/
// Display submission value methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function formatHtml(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
if (isset($options['composite_key'])) {
return $this
->formatCompositeHtml($element, $webform_submission, $options);
}
else {
return parent::formatHtml($element, $webform_submission, $options);
}
}
/**
* {@inheritdoc}
*/
public function formatText(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
if (isset($options['composite_key'])) {
return $this
->formatCompositeText($element, $webform_submission, $options);
}
else {
return parent::formatText($element, $webform_submission, $options);
}
}
/**
* {@inheritdoc}
*/
protected function formatCustomItem($type, array &$element, WebformSubmissionInterface $webform_submission, array $options = [], array $context = []) {
$name = strtolower($type);
// Parse element.composite_key from template and add composite element
// to context.
$template = trim($element['#format_' . $name]);
if (preg_match_all("/element(?:\\[['\"]|\\.)([a-zA-Z0-9-_:]+)/", $template, $matches)) {
$composite_elements = $this
->getInitializedCompositeElement($element);
$composite_keys = array_unique($matches[1]);
$item_function = 'format' . $type;
$context['element'] = [];
foreach ($composite_keys as $composite_key) {
if (isset($composite_elements[$composite_key])) {
$context['element'][$composite_key] = $this
->{$item_function}([
'#format' => NULL,
] + $element, $webform_submission, [
'composite_key' => $composite_key,
] + $options);
}
}
}
return parent::formatCustomItem($type, $element, $webform_submission, $options, $context);
}
/**
* {@inheritdoc}
*/
protected function formatHtmlItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
if (!$this
->hasValue($element, $webform_submission, $options)) {
return '';
}
$format = $this
->getItemFormat($element);
// Handle custom composite html items.
if ($format === 'custom' && !empty($element['#format_html'])) {
return $this
->formatCustomItem('html', $element, $webform_submission, $options);
}
switch ($format) {
case 'list':
case 'raw':
$items = $this
->formatCompositeHtmlItems($element, $webform_submission, $options);
return [
'#theme' => 'item_list',
'#items' => $items,
];
default:
$lines = $this
->formatHtmlItemValue($element, $webform_submission, $options);
if (empty($lines)) {
return '';
}
foreach ($lines as $key => $line) {
if (is_string($line)) {
$lines[$key] = [
'#markup' => $line,
];
}
$lines[$key]['#suffix'] = '<br />';
}
// Remove the <br/> suffix from the last line.
unset($lines[$key]['#suffix']);
return $lines;
}
}
/**
* {@inheritdoc}
*/
protected function formatHtmlItems(array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemsFormat($element);
if ($format !== 'table') {
return parent::formatHtmlItems($element, $webform_submission, $options);
}
$composite_elements = $this
->getInitializedCompositeElement($element);
// Get header.
$header = [];
foreach (RenderElement::children($composite_elements) as $composite_key) {
if (!Element::isVisibleElement($composite_elements[$composite_key])) {
unset($composite_elements[$composite_key]);
continue;
}
$composite_element = $composite_elements[$composite_key];
$header[$composite_key] = [
'data' => isset($composite_element['#title']) ? $composite_element['#title'] : $composite_key,
'bgcolor' => '#eee',
];
}
// Get rows.
$rows = [];
$values = $this
->getValue($element, $webform_submission, $options);
foreach ($values as $delta => $value) {
foreach ($header as $composite_key => $composite_title) {
$composite_value = $this
->formatCompositeHtml($element, $webform_submission, [
'delta' => $delta,
'composite_key' => $composite_key,
] + $options);
if (is_array($composite_value)) {
$rows[$delta][$composite_key] = [
'data' => $composite_value,
];
}
else {
$rows[$delta][$composite_key] = [
'data' => [
'#markup' => $composite_value,
],
];
}
}
}
return [
'#type' => 'table',
'#header' => $header,
'#rows' => $rows,
'#attributes' => [
'width' => '100%',
'cellspacing' => 0,
'cellpadding' => 5,
'border' => 1,
],
];
}
/**
* {@inheritdoc}
*/
protected function formatTextItems(array &$element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemsFormat($element);
if ($format === 'table') {
$element['#format_items'] = 'hr';
}
return parent::formatTextItems($element, $webform_submission, $options);
}
/**
* {@inheritdoc}
*/
protected function formatTextItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
if (!$this
->hasValue($element, $webform_submission, $options)) {
return '';
}
$format = $this
->getItemFormat($element);
// Handle custom composite text items.
if ($format === 'custom' && !empty($element['#format_text'])) {
return $this
->formatCustomItem('text', $element, $webform_submission, $options);
}
switch ($format) {
case 'list':
case 'raw':
$lines = $this
->formatCompositeTextItems($element, $webform_submission, $options);
return implode(PHP_EOL, $lines);
default:
$lines = $this
->formatTextItemValue($element, $webform_submission, $options);
return implode(PHP_EOL, $lines);
}
}
/**
* Format a composite as a list of HTML items.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array|string
* A composite as a list of HTML items.
*/
protected function formatCompositeHtmlItems(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemFormat($element);
$items = [];
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach (RenderElement::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
$composite_title = isset($composite_element['#title']) && $format !== 'raw' ? $composite_element['#title'] : $composite_key;
$composite_value = $this
->formatCompositeHtml($element, $webform_submission, [
'composite_key' => $composite_key,
] + $options);
if ($composite_value !== '') {
$items[$composite_key] = [
'#type' => 'inline_template',
'#template' => '<b>{{ title }}:</b> {{ value }}',
'#context' => [
'title' => $composite_title,
'value' => $composite_value,
],
];
}
}
return $items;
}
/**
* Format a composite as a list of plain text items.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array|string
* A composite as a list of plain text items.
*/
protected function formatCompositeTextItems(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemFormat($element);
$items = [];
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach (RenderElement::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
$composite_title = isset($composite_element['#title']) && $format !== 'raw' ? $composite_element['#title'] : $composite_key;
$composite_value = $this
->formatCompositeText($element, $webform_submission, [
'composite_key' => $composite_key,
] + $options);
if (is_array($composite_value)) {
$composite_value = \Drupal::service('renderer')
->renderPlain($composite_value);
}
if ($composite_value !== '') {
$items[$composite_key] = "{$composite_title}: {$composite_value}";
}
}
return $items;
}
/**
* Format a composite's sub element's value as HTML.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array|string
* A composite's sub element's value formatted as an HTML string or a render array.
*/
protected function formatCompositeHtml(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
return $this
->formatComposite('Html', $element, $webform_submission, $options);
}
/**
* Format a composite's sub element's value as plain text.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array|string
* A composite's sub element's value formatted as plain text or a render array.
*/
protected function formatCompositeText(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
return $this
->formatComposite('Text', $element, $webform_submission, $options);
}
/**
* Format a composite's sub element's value as HTML or plain text.
*
* @param string $type
* The format type, HTML or Text.
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array|string
* The element's value formatted as plain text or a render array.
*/
protected function formatComposite($type, array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$options['webform_key'] = $element['#webform_key'];
$composite_element = $this
->getInitializedCompositeElement($element, $options['composite_key']);
$composite_plugin = $this->elementManager
->getElementInstance($composite_element);
// Exclude attachments for composite element.
// @see \Drupal\webform\WebformSubmissionViewBuilder::isElementVisible
if (!empty($options['exclude_attachments']) && $composite_plugin instanceof WebformElementAttachmentInterface) {
return '';
}
$format_function = 'format' . $type;
return $composite_plugin
->{$format_function}($composite_element, $webform_submission, $options);
}
/**
* Format composite element value into lines of text.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array
* Composite element values converted into lines of html.
*/
protected function formatHtmlItemValue(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
return $this
->formatCompositeHtmlItems($element, $webform_submission, $options);
}
/**
* Format composite element value into lines of text.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array
* Composite element values converted into lines of text.
*/
protected function formatTextItemValue(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
return $this
->formatCompositeTextItems($element, $webform_submission, $options);
}
/**
* {@inheritdoc}
*/
public function getItemFormats() {
return parent::getItemFormats() + [
'list' => $this
->t('List'),
];
}
/**
* {@inheritdoc}
*/
public function getItemsDefaultFormat() {
return 'ul';
}
/**
* {@inheritdoc}
*/
public function getItemsFormats() {
return [
'ol' => $this
->t('Ordered list'),
'ul' => $this
->t('Unordered list'),
'hr' => $this
->t('Horizontal rule'),
'table' => $this
->t('Table'),
];
}
/****************************************************************************/
// Export methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getExportDefaultOptions() {
return [
'composite_element_item_format' => 'label',
];
}
/**
* {@inheritdoc}
*/
public function buildExportOptionsForm(array &$form, FormStateInterface $form_state, array $export_options) {
parent::buildExportOptionsForm($form, $form_state, $export_options);
if (isset($form['composite'])) {
return;
}
$form['composite'] = [
'#type' => 'details',
'#title' => $this
->t('Composite element options'),
'#open' => TRUE,
'#weight' => -10,
];
$form['composite']['composite_element_item_format'] = [
'#type' => 'radios',
'#title' => $this
->t('Composite element item format'),
'#options' => [
'label' => $this
->t('Option labels, the human-readable value (label)'),
'key' => $this
->t('Option values, the raw value stored in the database (key)'),
],
'#default_value' => $export_options['composite_element_item_format'],
];
}
/**
* {@inheritdoc}
*/
public function buildExportHeader(array $element, array $options) {
if ($this
->hasMultipleValues($element)) {
return parent::buildExportHeader($element, $options);
}
$composite_elements = $this
->getInitializedCompositeElement($element);
$header = [];
foreach (RenderElement::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
if (!Element::isVisibleElement($composite_element)) {
continue;
}
if ($options['header_format'] === 'label' && !empty($composite_element['#title'])) {
$header[] = $composite_element['#title'];
}
else {
$header[] = $composite_key;
}
}
return $this
->prefixExportHeader($header, $element, $options);
}
/**
* {@inheritdoc}
*/
public function buildExportRecord(array $element, WebformSubmissionInterface $webform_submission, array $export_options) {
$value = $this
->getValue($element, $webform_submission);
if ($this
->hasMultipleValues($element)) {
$element['#format'] = $export_options['header_format'] === 'label' ? 'list' : 'raw';
$export_options['multiple_delimiter'] = PHP_EOL . '---' . PHP_EOL;
return parent::buildExportRecord($element, $webform_submission, $export_options);
}
$record = [];
$composite_elements = $this
->getInitializedCompositeElement($element);
foreach (RenderElement::children($composite_elements) as $composite_key) {
$composite_element = $composite_elements[$composite_key];
if (!Element::isVisibleElement($composite_element)) {
continue;
}
if ($export_options['composite_element_item_format'] === 'label' && $composite_element['#type'] !== 'textfield' && !empty($composite_element['#options'])) {
$record[] = WebformOptionsHelper::getOptionText($value[$composite_key], $composite_element['#options']);
}
else {
$record[] = isset($value[$composite_key]) ? $value[$composite_key] : NULL;
}
}
return $record;
}
/****************************************************************************/
// Test methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
if (empty($element['#webform_composite_elements'])) {
$this
->initialize($element);
}
/** @var \Drupal\webform\WebformSubmissionGenerateInterface $generate */
$generate = \Drupal::service('webform_submission.generate');
$composite_elements = $this
->getInitializedCompositeElement($element);
$composite_elements = WebformElementHelper::getFlattened($composite_elements);
$values = [];
for ($i = 1; $i <= 3; $i++) {
// Add delta to $options to allow multiple unique managed test files
// to be created.
// @see \Drupal\webform\Plugin\WebformElement\WebformManagedFileBase::getTestValues
$options['delta'] = $i;
$value = [];
foreach (RenderElement::children($composite_elements) as $composite_key) {
$value[$composite_key] = $generate
->getTestValue($webform, $composite_key, $composite_elements[$composite_key], $options);
}
$values[] = $value;
}
return $values;
}
/****************************************************************************/
// Element configuration methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$form = parent::buildConfigurationForm($form, $form_state);
$form['custom']['properties']['#description'] .= '<br /><br />' . $this
->t("You can set sub-element properties using a double underscore between the sub-element's key and sub-element's property (subelement__property). For example, you can add custom attributes or states (conditional logic) to the title sub-element using 'title__attributes' and 'title__states'.");
return $form;
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
// Update #default_value description.
$form['default']['default_value']['#description'] = $this
->t("The default value of the composite webform element as YAML.");
// Update #required label.
$form['validation']['required_container']['required']['#title'] .= ' <em>' . $this
->t('(Display purposes only)') . '</em>';
$form['validation']['required_container']['required']['#description'] = $this
->t('If checked, adds required indicator to the title, if visible. To required individual elements, also tick "Required" under the @name settings above.', [
'@name' => $this
->getPluginLabel(),
]);
// Update '#multiple__header_label'.
$form['element']['multiple__header_container']['multiple__header_label']['#states']['visible'][':input[name="properties[multiple__header]"]'] = [
'checked' => FALSE,
];
$form['composite'] = [
'#type' => 'fieldset',
'#title' => $this
->t('@title settings', [
'@title' => $this
->getPluginLabel(),
]),
'#attributes' => [
'class' => [
'webform-admin-composite-elements',
],
],
];
$form['composite']['element'] = $this
->buildCompositeElementsTable($form, $form_state);
$form['composite']['flexbox'] = [
'#type' => 'select',
'#title' => $this
->t('Use Flexbox'),
'#description' => $this
->t("If 'Automatic' is selected Flexbox layout will only be used if a 'Flexbox layout' element is included in the webform."),
'#options' => [
'' => $this
->t('Automatic'),
0 => $this
->t('No'),
1 => $this
->t('Yes'),
],
];
// Hide single item display when multiple item display is set to 'table'.
$form['display']['item']['#states']['invisible'] = [
':input[name="properties[format_items]"]' => [
'value' => 'table',
],
];
$form['#attached']['library'][] = 'webform/webform.admin.composite';
// Select2, Chosen, and/or Choices enhancements.
// @see \Drupal\webform\Plugin\WebformElement\Select::form
$select2_exists = $this->librariesManager
->isIncluded('jquery.select2');
$choices_exists = $this->librariesManager
->isIncluded('choices');
$chosen_exists = $this->librariesManager
->isIncluded('jquery.chosen');
$form['composite']['select2'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Select2'),
'#description' => $this
->t('Replace select element with jQuery <a href=":href">Select2</a> select box.', [
':href' => 'https://select2.github.io/',
]),
'#return_value' => TRUE,
'#states' => [
'disabled' => [
':input[name="properties[chosen]"]' => [
'checked' => TRUE,
],
],
],
];
if (!$select2_exists) {
$form['composite']['select2']['#access'] = FALSE;
}
$form['composite']['choices'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Choices'),
'#description' => $this
->t('Replace select element with <a href=":href">Choice.js</a> select box.', [
':href' => 'https://joshuajohnson.co.uk/Choices/',
]),
'#return_value' => TRUE,
'#states' => [
'disabled' => [
':input[name="properties[select2]"]' => [
'checked' => TRUE,
],
],
],
];
if (!$choices_exists) {
$form['composite']['choices']['#access'] = FALSE;
}
$form['composite']['chosen'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Chosen'),
'#description' => $this
->t('Replace select element with jQuery <a href=":href">Chosen</a> select box.', [
':href' => 'https://harvesthq.github.io/chosen/',
]),
'#return_value' => TRUE,
'#states' => [
'disabled' => [
':input[name="properties[select2]"]' => [
'checked' => TRUE,
],
],
],
];
if (!$chosen_exists) {
$form['composite']['chosen']['#access'] = FALSE;
}
if ($select2_exists + $chosen_exists + $choices_exists > 1) {
$select_libraries = [];
if ($select2_exists) {
$select_libraries[] = $this
->t('Select2');
}
if ($choices_exists) {
$select_libraries[] = $this
->t('Choices');
}
if ($chosen_exists) {
$select_libraries[] = $this
->t('Chosen');
}
$t_args = [
'@libraries' => WebformArrayHelper::toString($select_libraries),
];
$form['composite']['select_message'] = [
'#type' => 'webform_message',
'#message_type' => 'warning',
'#message_message' => $this
->t('@libraries provide very similar functionality, only one should be enabled.', $t_args),
'#access' => TRUE,
];
}
return $form;
}
/**
* Build the composite elements settings table.
*
* @param array $form
* An associative array containing the structure of the form.
* @param \Drupal\Core\Form\FormStateInterface $form_state
* The current state of the form.
*
* @return array
* A renderable array container the composite elements settings table.
*/
protected function buildCompositeElementsTable(array $form, FormStateInterface $form_state) {
$labels_help = [
'help' => [
'#type' => 'webform_help',
'#help' => '<b>' . $this
->t('Key') . ':</b> ' . $this
->t('The machine-readable name.') . '<hr/><b>' . $this
->t('Title') . ':</b> ' . $this
->t('This is used as a descriptive label when displaying this webform element.') . '<hr/><b>' . $this
->t('Placeholder') . ':</b> ' . $this
->t('The placeholder will be shown in the element until the user starts entering a value.') . '<hr/><b>' . $this
->t('Description') . ':</b> ' . $this
->t('A short description of the element used as help for the user when they use the webform.') . '<hr/><b>' . $this
->t('Help text') . ':</b> ' . $this
->t('A tooltip displayed after the title.') . '<hr/><b>' . $this
->t('Title display') . ':</b> ' . $this
->t('A tooltip displayed after the title.'),
'#help_title' => $this
->t('Labels'),
],
];
$settings_help = [
'help' => [
'#type' => 'webform_help',
'#help' => '<b>' . $this
->t('Required') . ':</b> ' . $this
->t('Check this option if the user must enter a value.') . '<hr/><b>' . $this
->t('Type') . ':</b> ' . $this
->t('The type of element to be displayed.') . '<hr/><b>' . $this
->t('Options') . ':</b> ' . $this
->t('Please select predefined options.'),
'#help_title' => $this
->t('Settings'),
],
];
$header = [
'visible' => $this
->t('Visible'),
'labels' => [
'data' => [
[
'title' => [
'#markup' => $this
->t('Labels'),
],
],
$labels_help,
],
],
'settings' => [
'data' => [
[
'title' => [
'#markup' => $this
->t('Settings'),
],
],
$settings_help,
],
],
];
$rows = [];
$composite_elements = $this
->getCompositeElements();
foreach ($composite_elements as $composite_key => $composite_element) {
$title = isset($composite_element['#title']) ? $composite_element['#title'] : $composite_key;
$type = isset($composite_element['#type']) ? $composite_element['#type'] : NULL;
$t_args = [
'@title' => $title,
];
$state_disabled = [
'disabled' => [
':input[name="properties[' . $composite_key . '__access]"]' => [
'checked' => FALSE,
],
],
];
$row = [];
// Access.
$row[$composite_key . '__access'] = [
'#title' => $this
->t('@title visible', $t_args),
'#title_display' => 'invisible',
'#type' => 'checkbox',
'#return_value' => TRUE,
];
// Key, title, placeholder, help, description, and title display.
if ($type) {
$row['labels'] = [
'data' => [
$composite_key . '__key' => [
'#markup' => $composite_key,
'#suffix' => '<hr/>',
'#access' => TRUE,
],
$composite_key . '__title' => [
'#type' => 'textfield',
'#title' => $this
->t('@title title', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('This is used as a descriptive label when displaying this webform element.'),
'#description_display' => 'invisible',
'#placeholder' => $this
->t('Enter title…'),
'#required' => TRUE,
'#states' => $state_disabled,
],
$composite_key . '__placeholder' => [
'#type' => 'textfield',
'#title' => $this
->t('@title placeholder', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('The placeholder will be shown in the element until the user starts entering a value.'),
'#description_display' => 'invisible',
'#placeholder' => $this
->t('Enter placeholder…'),
'#states' => $state_disabled,
],
$composite_key . '__help' => [
'#type' => 'textarea',
'#title' => $this
->t('@title help text', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('A short description of the element used as help for the user when they use the webform.'),
'#description_display' => 'invisible',
'#rows' => 2,
'#placeholder' => $this
->t('Enter help text…'),
'#states' => $state_disabled,
],
$composite_key . '__description' => [
'#type' => 'textarea',
'#title' => $this
->t('@title description', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('A tooltip displayed after the title.'),
'#description_display' => 'invisible',
'#rows' => 2,
'#placeholder' => $this
->t('Enter description…'),
'#states' => $state_disabled,
],
$composite_key . '__title_display' => [
'#type' => 'select',
'#title' => $this
->t('@title title display', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('A tooltip displayed after the title.'),
'#description_display' => 'invisible',
'#options' => [
'before' => $this
->t('Before'),
'after' => $this
->t('After'),
'inline' => $this
->t('Inline'),
'invisible' => $this
->t('Invisible'),
],
'#empty_option' => $this
->t('Select title display… '),
'#states' => $state_disabled,
],
],
];
}
else {
$row['title_and_description'] = [
'data' => [
'',
],
];
}
// Type and options.
// Using if/else instead of switch/case because of complex conditions.
$row['settings'] = [];
// Required.
if ($type) {
$row['settings']['data'][$composite_key . '__required'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Required'),
'#description' => $this
->t('Check this option if the user must enter a value.'),
'#description_display' => 'invisible',
'#return_value' => TRUE,
'#states' => $state_disabled,
'#wrapper_attributes' => [
'style' => 'white-space: nowrap',
],
'#suffix' => '<hr/>',
];
}
if ($type === 'tel') {
$row['settings']['data'][$composite_key . '__type'] = [
'#type' => 'select',
'#title' => $this
->t('@title type', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('The type of element to be displayed.'),
'#description_display' => 'invisible',
'#required' => TRUE,
'#options' => [
'tel' => $this
->t('Telephone'),
'textfield' => $this
->t('Text field'),
],
'#states' => $state_disabled,
];
}
elseif (in_array($type, [
'select',
'webform_select_other',
'radios',
'webform_radios_other',
])) {
// Get base type (select or radios).
$base_type = preg_replace('/webform_(select|radios)_other/', '\\1', $type);
// Get type options.
switch ($base_type) {
case 'radios':
$settings = [
'radios' => $this
->t('Radios'),
'webform_radios_other' => $this
->t('Radios other'),
'textfield' => $this
->t('Text field'),
];
break;
case 'select':
default:
$settings = [
'select' => $this
->t('Select'),
'webform_select_other' => $this
->t('Select other'),
'textfield' => $this
->t('Text field'),
];
break;
}
$row['settings']['data'][$composite_key . '__type'] = [
'#type' => 'select',
'#title' => $this
->t('@title type', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('The type of element to be displayed.'),
'#description_display' => 'invisible',
'#required' => TRUE,
'#options' => $settings,
'#states' => $state_disabled,
];
$composite_options = $this
->getCompositeElementOptions($composite_key);
// Make sure custom options defined via the YAML source are not
// deleted when a composite element is edited via the UI.
/** @var \Drupal\webform_ui\Form\WebformUiElementEditForm $form_object */
$form_object = $form_state
->getFormObject();
$element = $form_object
->getElement();
$composite_options_default_value = isset($element['#' . $composite_key . '__options']) ? $element['#' . $composite_key . '__options'] : NULL;
if ($composite_options_default_value && (is_array($composite_options_default_value) || !isset($composite_options[$composite_options_default_value]))) {
$webform = $form_object
->getWebform();
if ($this->currentUser
->hasPermission('edit webform source') && $webform
->hasLinkTemplate('source-form')) {
$t_args = [
':href' => $webform
->toUrl('source-form')
->toString(),
];
$message = $this
->t('Custom options can only be updated via the <a href=":href">YAML source</a>.', $t_args);
}
else {
$message = $this
->t('Custom options can only be updated via the YAML source.');
}
$row['settings']['data'][$composite_key . '__options'] = [
'#type' => 'value',
'#suffix' => '<em>' . $message . '</em>',
];
}
elseif ($composite_options) {
$row['settings']['data'][$composite_key . '__options'] = [
'#type' => 'select',
'#title' => $this
->t('@title options', $t_args),
'#title_display' => 'invisible',
'#description' => $this
->t('Please select predefined options.'),
'#description_display' => 'invisible',
'#options' => $composite_options,
'#required' => TRUE,
'#attributes' => [
'style' => 'width: 100%;',
],
'#states' => $state_disabled + [
'invisible' => [
':input[name="properties[' . $composite_key . '__type]"]' => [
'value' => 'textfield',
],
],
],
];
}
else {
$row['settings']['data'][$composite_key . '__options'] = [
'#type' => 'value',
];
}
}
else {
$row['settings']['data'][$composite_key . '__type'] = [
'#type' => 'textfield',
'#access' => FALSE,
];
$row['settings']['data']['markup'] = [
'#type' => 'container',
'#markup' => $this->elementManager
->getElementInstance($composite_element)
->getPluginLabel(),
'#access' => TRUE,
];
}
$rows[$composite_key] = $row;
}
return [
'#type' => 'table',
'#header' => $header,
] + $rows;
}
/**
* {@inheritdoc}
*/
public function getConfigurationFormProperties(array &$form, FormStateInterface $form_state) {
$properties = parent::getConfigurationFormProperties($form, $form_state);
foreach ($properties as $key => $value) {
// Convert composite element access and required to boolean value.
if (preg_match('/__(access|required)$/', $key)) {
$properties[$key] = (bool) $value;
}
}
return $properties;
}
/****************************************************************************/
// Composite element methods.
/****************************************************************************/
/**
* Initialize and cache #webform_composite_elements.
*
* @param array $element
* A composite element.
*/
public function initializeCompositeElements(array &$element) {
/** @var \Drupal\webform\Element\WebformCompositeInterface $class */
$class = $this
->getFormElementClassDefinition();
$element['#webform_composite_elements'] = $class::initializeCompositeElements($element);
$this
->initializeCompositeElementsRecursive($element, $element['#webform_composite_elements']);
}
/**
* Initialize a composite's elements recursively.
*
* @param array $element
* A render array for the current element.
* @param array $composite_elements
* A render array containing a composite's elements.
*/
protected function initializeCompositeElementsRecursive(array &$element, array &$composite_elements) {
foreach ($composite_elements as $composite_key => &$composite_element) {
if (WebformElementHelper::property($composite_key)) {
continue;
}
// Set composite id, key, and parent key.
// @see \Drupal\webform\Entity\Webform::initElementsRecursive
if (isset($element['#webform_id'])) {
$composite_element['#webform_composite_id'] = $element['#webform_id'] . '--' . $composite_key;
}
if (isset($element['#webform_key'])) {
$composite_element['#webform_composite_key'] = $element['#webform_key'] . '__' . $composite_key;
$composite_element['#webform_composite_parent_key'] = $element['#webform_key'];
}
$this
->initializeCompositeElementsRecursive($element, $composite_element);
}
}
/**
* Get composite element.
*
* @return array
* An array of composite sub-elements or a specific composite sub element key.
*/
public function getCompositeElements() {
$class = $this
->getFormElementClassDefinition();
return $class::getCompositeElements([]);
}
/**
* Get initialized composite element.
*
* @param array $element
* A composite element.
* @param string $composite_key
* (Optional) Composite sub element key.
*
* @return array
* The initialized composite element or a specific composite sub element key.
*
* @see \Drupal\webform\Plugin\WebformElement\WebformCompositeBase::initialize
*/
public function getInitializedCompositeElement(array $element, $composite_key = NULL) {
$composite_elements = $element['#webform_composite_elements'];
if (isset($composite_key)) {
return isset($composite_elements[$composite_key]) ? $composite_elements[$composite_key] : NULL;
}
else {
return $composite_elements;
}
}
/**
* Get webform option keys for composite element based on the composite element's key.
*
* @param string $composite_key
* A composite element's key.
*
* @return array
* An array webform options.
*/
protected function getCompositeElementOptions($composite_key) {
/** @var \Drupal\webform\WebformOptionsInterface[] $webform_options */
$webform_options = WebformOptions::loadMultiple();
$options = [];
foreach ($webform_options as $key => $webform_option) {
if (strpos($key, $composite_key) === 0) {
$options[$key] = $webform_option
->label();
}
}
return $options;
}
/****************************************************************************/
// Composite managed file methods.
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function postSave(array &$element, WebformSubmissionInterface $webform_submission, $update = TRUE) {
$webform = $webform_submission
->getWebform();
if ($webform
->isResultsDisabled() || !$this
->hasManagedFiles($element)) {
return;
}
$original_data = $webform_submission
->getOriginalData();
$data = $webform_submission
->getData();
$composite_elements_managed_files = $this
->getManagedFiles($element);
foreach ($composite_elements_managed_files as $composite_key) {
$original_fids = $this
->getManagedFileIdsFromData($element, $original_data, $composite_key);
$fids = $this
->getManagedFileIdsFromData($element, $data, $composite_key);
// Delete the old file uploads.
$delete_fids = array_diff($original_fids, $fids);
WebformManagedFileBase::deleteFiles($webform_submission, $delete_fids);
// Add new files.
if ($fids) {
$composite_element = $this
->getInitializedCompositeElement($element, $composite_key);
/** @var \Drupal\webform\Plugin\WebformElement\WebformManagedFileBase $composite_element_plugin */
$composite_element_plugin = $this->elementManager
->getElementInstance($composite_element);
$composite_element_plugin
->addFiles($composite_element, $webform_submission, $fids);
}
}
}
/**
* Get composite element's file ids from data array.
*
* @param array $element
* A composite element.
* @param array $data
* A submission data array.
* @param string $composite_key
* The composite sub-element key.
*
* @return array
* An array of file ids.
*/
protected function getManagedFileIdsFromData(array $element, array $data, $composite_key) {
$element_key = $element['#webform_key'];
if (empty($data[$element_key])) {
return [];
}
$fids = [];
$items = $this
->hasMultipleValues($element) ? $data[$element_key] : [
$data[$element_key],
];
foreach ($items as $item) {
if (!empty($item[$composite_key])) {
$fids[] = $item[$composite_key];
}
}
return $fids;
}
/**
* {@inheritdoc}
*/
public function postDelete(array &$element, WebformSubmissionInterface $webform_submission) {
// Uploaded files are deleted via the webform submission.
// This ensures that all files associated with a submission are deleted.
// @see \Drupal\webform\WebformSubmissionStorage::delete
}
/**
* Get composite's managed file elements.
*
* @param array $element
* A composite element.
*
* @return array
* An array of managed file element keys.
*/
public function getManagedFiles(array $element) {
$id = $element['#webform_id'];
if (isset($this->elementsManagedFiles[$id])) {
return $this->elementsManagedFiles[$id];
}
$this->elementsManagedFiles[$id] = [];
$composite_elements = WebformElementHelper::getFlattened($this
->getInitializedCompositeElement($element));
foreach ($composite_elements as $composite_key => $composite_element) {
$composite_element_plugin = $this->elementManager
->getElementInstance($composite_element);
if ($composite_element_plugin instanceof WebformManagedFileBase) {
$this->elementsManagedFiles[$id][$composite_key] = $composite_key;
}
}
return $this->elementsManagedFiles[$id];
}
/****************************************************************************/
// Composite helper methods.
/****************************************************************************/
/**
* Determine if element type is supported by custom composite elements.
*
* @param string $type
* An element type.
*
* @return bool
* TRUE if element type is supported by custom composite elements.
*/
public static function isSupportedElementType($type) {
/** @var \Drupal\webform\Plugin\WebformElementManagerInterface $element_manager */
$element_manager = \Drupal::service('plugin.manager.webform.element');
// Skip element types that are not supported.
$element = [
'#type' => $type,
];
$element_plugin = $element_manager
->getElementInstance($element);
if (!$element_plugin
->isInput($element) || $element_plugin
->isComposite() || $element_plugin
->isContainer($element) || $element_plugin
->hasMultipleValues($element) || $element_plugin instanceof WebformElementEntityReferenceInterface && !$element_plugin instanceof WebformManagedFileBase || $element_plugin instanceof WebformElementComputedInterface) {
return FALSE;
}
// Skip ignored types that are not supported.
$ignored_element_types = [
'hidden',
'value',
'webform_element',
'webform_autocomplete',
'webform_image_select',
'webform_terms_of_service',
];
if (in_array($type, $ignored_element_types)) {
return FALSE;
}
return TRUE;
}
/**
* {@inheritdoc}
*/
public function getAttachments(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$data = $webform_submission
->getData();
// Get file ids.
$fids = [];
$composite_elements_managed_files = $this
->getManagedFiles($element);
foreach ($composite_elements_managed_files as $composite_key) {
$fids = array_merge($fids, $this
->getManagedFileIdsFromData($element, $data, $composite_key));
}
if (!$fids) {
return [];
}
// Get attachments.
$attachments = [];
$files = File::loadMultiple($fids);
foreach ($files as $file) {
$attachments[] = [
'filecontent' => file_get_contents($file
->getFileUri()),
'filename' => $file
->getFilename(),
'filemime' => $file
->getMimeType(),
// File URIs that are not supported return FALSE, when this happens
// still use the file's URI as the file's path.
'filepath' => \Drupal::service('file_system')
->realpath($file
->getFileUri()) ?: $file
->getFileUri(),
// URI is used when debugging or resending messages.
// @see \Drupal\webform\Plugin\WebformHandler\EmailWebformHandler::buildAttachments
'_fileurl' => file_create_url($file
->getFileUri()),
];
}
return $attachments;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
|
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
|
MessengerTrait:: |
public | function | Sets the messenger. | |
|
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
|
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
|
PluginBase:: |
protected | property | The plugin_id. | |
|
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
|
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
|
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. | |
|
TrustedCallbackInterface:: |
constant | Untrusted callbacks throw exceptions. | ||
|
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||
|
TrustedCallbackInterface:: |
constant | Untrusted callbacks trigger E_USER_WARNING errors. | ||
|
WebformCompositeBase:: |
protected | property | Track managed file elements. | |
|
WebformCompositeBase:: |
protected | function | Build the composite elements settings table. | 2 |
|
WebformCompositeBase:: |
public | function |
Form constructor. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Build an element's export header. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get an element's export options webform. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Build an element's export row. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function |
Define default multiple properties used by most elements. Overrides WebformElementBase:: |
1 |
|
WebformCompositeBase:: |
protected | function |
Define an element's default properties. Overrides WebformElementBase:: |
5 |
|
WebformCompositeBase:: |
public | function |
Gets the actual configuration webform array to be built. Overrides WebformElementBase:: |
4 |
|
WebformCompositeBase:: |
protected | function | Format a composite's sub element's value as HTML or plain text. | |
|
WebformCompositeBase:: |
protected | function | Format a composite's sub element's value as HTML. | |
|
WebformCompositeBase:: |
protected | function | Format a composite as a list of HTML items. | |
|
WebformCompositeBase:: |
protected | function | Format a composite's sub element's value as plain text. | |
|
WebformCompositeBase:: |
protected | function | Format a composite as a list of plain text items. | |
|
WebformCompositeBase:: |
protected | function |
Format an element's item using custom HTML or plain text. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Format an element's value as HTML. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function |
Format an element's value as HTML. Overrides WebformElementBase:: |
2 |
|
WebformCompositeBase:: |
protected | function |
Format an element's items as HTML. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function | Format composite element value into lines of text. | 6 |
|
WebformCompositeBase:: |
public | function |
Format an element's table column value. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Format an element's value as plain text. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function |
Format an element's value as text. Overrides WebformElementBase:: |
1 |
|
WebformCompositeBase:: |
protected | function |
Format an element's items as text. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function | Format composite element value into lines of text. | 6 |
|
WebformCompositeBase:: |
public | function |
Get email attachments. Overrides WebformElementAttachmentInterface:: |
|
|
WebformCompositeBase:: |
protected | function | Get webform option keys for composite element based on the composite element's key. | 1 |
|
WebformCompositeBase:: |
public | function | Get composite element. | |
|
WebformCompositeBase:: |
public | function |
Get an associative array of element properties from configuration webform. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get an element's selectors as options. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get an element's selectors source values. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get an element's default export options. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function | Get initialized composite element. | |
|
WebformCompositeBase:: |
public | function |
Get an element's available single value formats. Overrides WebformElementBase:: |
1 |
|
WebformCompositeBase:: |
public | function |
Get an element's default multiple value format name. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get an element's available multiple value formats. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
protected | function | Get composite element's file ids from data array. | |
|
WebformCompositeBase:: |
public | function | Get composite's managed file elements. | |
|
WebformCompositeBase:: |
public | function |
Get related element types. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get element's table column(s) settings. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Get test values for an element. Overrides WebformElementBase:: |
3 |
|
WebformCompositeBase:: |
public | function |
Determine if the element is or includes a managed_file upload element. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Initialize an element to be displayed, rendered, or exported. Overrides WebformElementBase:: |
1 |
|
WebformCompositeBase:: |
public | function | Initialize and cache #webform_composite_elements. | 2 |
|
WebformCompositeBase:: |
protected | function | Initialize a composite's elements recursively. | |
|
WebformCompositeBase:: |
public static | function | Determine if element type is supported by custom composite elements. | |
|
WebformCompositeBase:: |
public | function |
Delete any additional value associated with an element. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Acts on a saved webform submission element before the insert or update hook is invoked. Overrides WebformElementBase:: |
|
|
WebformCompositeBase:: |
public | function |
Prepare an element to be rendered within a webform. Overrides WebformElementBase:: |
2 |
|
WebformCompositeBase:: |
protected | function |
Set multiple element wrapper. Overrides WebformElementBase:: |
1 |
|
WebformCompositeFormElementTrait:: |
public static | function | Adds form element theming to an element if its title or description is set. | 1 |
|
WebformElementBase:: |
protected | property | The configuration factory. | |
|
WebformElementBase:: |
protected | property | The current user. | |
|
WebformElementBase:: |
protected | property | An associative array of an element's default properties names and values. | |
|
WebformElementBase:: |
protected | property | A element info manager. | |
|
WebformElementBase:: |
protected | property | The webform element manager. | |
|
WebformElementBase:: |
protected | property | The entity type manager. | |
|
WebformElementBase:: |
protected | property | The webform libraries manager. | |
|
WebformElementBase:: |
protected | property | A logger instance. | |
|
WebformElementBase:: |
protected | property | The webform submission storage. | |
|
WebformElementBase:: |
protected | property | The token manager. | |
|
WebformElementBase:: |
protected | property | An indexed array of an element's translated properties. | |
|
WebformElementBase:: |
public | function |
Alter an element's associated form. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
protected | function | Build an element as text or HTML. | 4 |
|
WebformElementBase:: |
protected | function | Build configuration form tabs. | 1 |
|
WebformElementBase:: |
public | function |
Build an element as HTML element. Overrides WebformElementInterface:: |
2 |
|
WebformElementBase:: |
public | function |
Build an element as text element. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
protected | function | Checks an access rule against a user account's roles and id. | |
|
WebformElementBase:: |
public | function |
Check element access (rules). Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
2 |
|
WebformElementBase:: |
protected | function | Define default base properties used by all elements. | 4 |
|
WebformElementBase:: |
protected | function | Define an element's translatable properties. | 15 |
|
WebformElementBase:: |
public | function |
Display element disabled warning. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Finalize an element to be rendered within a webform. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
protected | function | Format an element's value as HTML or plain text. | 2 |
|
WebformElementBase:: |
protected | function | Format an element's items using custom HTML or plain text. | |
|
WebformElementBase:: |
public | function |
Get an element's admin label (#admin_title, #title or #webform_key). Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
protected | function | Get configuration property value. | 1 |
|
WebformElementBase:: |
protected | function | Get default base properties used by all elements. | |
|
WebformElementBase:: |
public | function |
Gets the element's default key. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
protected | function | Get default multiple properties used by most elements. | |
|
WebformElementBase:: |
public | function |
Get default properties. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get an element's default property value. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
protected | function | Get a render element's default property. | |
|
WebformElementBase:: |
public | function |
Get an element's property value. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
protected | function | Get an element's (sub)inputs selectors as options. | 9 |
|
WebformElementBase:: |
public | function |
Get an element's (sub)input selector value. Overrides WebformElementInterface:: |
5 |
|
WebformElementBase:: |
public | function |
Get an element's supported states as options. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Get the Webform element's form element class definition. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
protected | function | Get form--inline container which is used for side-by-side element layout. | |
|
WebformElementBase:: |
public | function |
Retrieves the default properties for the defined element type. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get an element's default single value format name. Overrides WebformElementInterface:: |
23 |
|
WebformElementBase:: |
public | function |
Get element's single value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Get element's multiple value format name by looking for '#format' property, global settings, and finally default settings. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get an element's key/name. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get an element's label (#title or #webform_key). Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get configuration form's off-canvas width. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Get link to element's API documentation. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get the URL for the element's API documentation. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Gets the category of the plugin instance. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Gets the description of the plugin instance. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Gets the label of the plugin instance. Overrides WebformElementInterface:: |
3 |
|
WebformElementBase:: |
public | function |
Get an element's submission raw value. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get translatable properties. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Gets the type name (aka id) of the plugin instance with the 'webform_' prefix. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Get an element's submission value. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
protected | function | Determine if the element has a composite field wrapper. | |
|
WebformElementBase:: |
public | function |
Checks if the element value has multiple values. Overrides WebformElementInterface:: |
6 |
|
WebformElementBase:: |
public | function |
Checks if the element uses the 'webform_multiple' element. Overrides WebformElementInterface:: |
3 |
|
WebformElementBase:: |
public | function |
Determine if the element supports a specified property. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Determine if an element's has a submission value. Overrides WebformElementInterface:: |
2 |
|
WebformElementBase:: |
public | function |
Checks if the element has a wrapper. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public static | function | Webform element #after_build callback. | |
|
WebformElementBase:: |
public | function |
Checks if the element is a composite element. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Checks if the element is a container that can contain elements. Overrides WebformElementInterface:: |
9 |
|
WebformElementBase:: |
public | function |
Checks if the element is disabled. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Checks if an empty element is excluded. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Checks if the element is enabled. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Checks if the element is excluded via webform.settings. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
public | function |
Checks if the element is hidden. Overrides WebformElementInterface:: |
2 |
|
WebformElementBase:: |
public | function |
Checks if the element carries a value. Overrides WebformElementInterface:: |
11 |
|
WebformElementBase:: |
public | function |
Checks if the element value could contain multiple lines. Overrides WebformElementInterface:: |
2 |
|
WebformElementBase:: |
public | function |
Checks if the element is a root element. Overrides WebformElementInterface:: |
3 |
|
WebformElementBase:: |
public | function |
Acts on a webform submission element after it is created. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Acts on loaded webform submission. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Changes the values of an entity before it is created. Overrides WebformElementInterface:: |
1 |
|
WebformElementBase:: |
public | function | 1 | |
|
WebformElementBase:: |
protected | function | Prefix an element's export header. | |
|
WebformElementBase:: |
protected | function | Replace Core's composite #pre_render with Webform's composite #pre_render. | |
|
WebformElementBase:: |
protected | function | Prepare an element's pre render callbacks. | 3 |
|
WebformElementBase:: |
protected | function | Prepare an element's validation callbacks. | 8 |
|
WebformElementBase:: |
protected | function | Set an elements #states and flexbox wrapper. | 1 |
|
WebformElementBase:: |
public static | function | Fix flexbox wrapper. | |
|
WebformElementBase:: |
public static | function | Fix state wrapper. | |
|
WebformElementBase:: |
public | function |
Acts on a webform submission element before the presave hook is invoked. Overrides WebformElementInterface:: |
4 |
|
WebformElementBase:: |
public | function |
Generate a renderable preview of the element. Overrides WebformElementInterface:: |
37 |
|
WebformElementBase:: |
public | function |
Replace tokens for all element properties. Overrides WebformElementInterface:: |
|
|
WebformElementBase:: |
protected | function | Set an element's configuration webform element default value. | 2 |
|
WebformElementBase:: |
protected | function | Set configuration webform default values recursively. | |
|
WebformElementBase:: |
public | function |
Set an element's default value using saved data. Overrides WebformElementInterface:: |
7 |
|
WebformElementBase:: |
protected | function | Set element's default callback. | |
|
WebformElementBase:: |
public | function |
Form submission handler. Overrides PluginFormInterface:: |
|
|
WebformElementBase:: |
public | function |
Checks if the element supports multiple values. Overrides WebformElementInterface:: |
8 |
|
WebformElementBase:: |
public static | function |
Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface:: |
1 |
|
WebformElementBase:: |
public | function |
Form validation handler. Overrides PluginFormInterface:: |
6 |
|
WebformElementBase:: |
public static | function | Form API callback. Validate element #minlength value. | |
|
WebformElementBase:: |
public static | function | Form API callback. Validate element #multiple > 1 value. | |
|
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique value. | |
|
WebformElementBase:: |
public static | function | Form API callback. Validate element #unique multiple values. | |
|
WebformElementBase:: |
public | function |
Constructs a WebformElementBase object. Overrides PluginBase:: |
2 |
|
WebformEntityInjectionTrait:: |
protected | property | The webform. | |
|
WebformEntityInjectionTrait:: |
protected | property | The webform submission. | |
|
WebformEntityInjectionTrait:: |
public | function | Get the webform that this handler is attached to. | |
|
WebformEntityInjectionTrait:: |
public | function | Set webform and webform submission entity. | |
|
WebformEntityInjectionTrait:: |
public | function | Reset webform and webform submission entity. | |
|
WebformEntityInjectionTrait:: |
public | function | ||
|
WebformEntityInjectionTrait:: |
public | function | Set the webform that this is handler is attached to. | |
|
WebformEntityInjectionTrait:: |
public | function | Get the webform submission that this handler is handling. |