class Address in Webform 8.5
Same name and namespace in other branches
- 6.x src/Plugin/WebformElement/Address.php \Drupal\webform\Plugin\WebformElement\Address
Provides a 'address' element.
Plugin annotation
@WebformElement(
id = "address",
label = @Translation("Advanced address"),
description = @Translation("Provides advanced element for storing, validating and displaying international postal addresses."),
category = @Translation("Composite elements"),
composite = TRUE,
multiline = TRUE,
states_wrapper = TRUE,
dependencies = {
"address",
}
)
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\WebformElement\Address
- 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 Address
See also
\Drupal\address\Element\Address
4 string references to 'Address'
- WebformAddonsManager::initProjects in src/
WebformAddonsManager.php - Initialize add-on projects.
- WebformAddress::getCompositeElements in src/
Element/ WebformAddress.php - Get a renderable array of webform elements.
- WebformContact::getCompositeElements in src/
Element/ WebformContact.php - Get a renderable array of webform elements.
- WebformLocationBase::getCompositeElements in src/
Element/ WebformLocationBase.php - Get a renderable array of webform elements.
File
- src/
Plugin/ WebformElement/ Address.php, line 34
Namespace
Drupal\webform\Plugin\WebformElementView source
class Address extends WebformCompositeBase {
/**
* {@inheritdoc}
*/
protected function defineDefaultProperties() {
$properties = [
// Element settings.
'title' => '',
'default_value' => [],
// Description/Help.
'help' => '',
'help_title' => '',
'description' => '',
'more' => '',
'more_title' => '',
// Form display.
'title_display' => 'invisible',
'description_display' => '',
'help_display' => '',
// Form validation.
'required' => FALSE,
// Submission display.
'format' => $this
->getItemDefaultFormat(),
'format_html' => '',
'format_text' => '',
'format_items' => $this
->getItemsDefaultFormat(),
'format_items_html' => '',
'format_items_text' => '',
// Address settings.
'available_countries' => [],
'field_overrides' => [],
'langcode_override' => '',
] + $this
->defineDefaultBaseProperties() + $this
->defineDefaultMultipleProperties();
unset($properties['multiple__header']);
return $properties;
}
/****************************************************************************/
/**
* {@inheritdoc}
*/
public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
parent::prepare($element, $webform_submission);
$element['#theme_wrappers'] = [];
// #title display defaults to invisible.
$element += [
'#title_display' => 'invisible',
];
}
/**
* {@inheritdoc}
*/
protected function prepareElementValidateCallbacks(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
parent::prepareElementValidateCallbacks($element, $webform_submission);
$element['#element_validate'][] = [
get_class($this),
'validateAddress',
];
}
/**
* {@inheritdoc}
*/
protected function prepareElementPreRenderCallbacks(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
parent::prepareElementPreRenderCallbacks($element, $webform_submission);
// Replace 'form_element' theme wrapper with composite form element.
// @see \Drupal\Core\Render\Element\PasswordConfirm
$element['#pre_render'] = [
[
get_called_class(),
'preRenderWebformCompositeFormElement',
],
];
}
/**
* {@inheritdoc}
*/
public function getCompositeElements() {
return [];
}
/**
* {@inheritdoc}
*
* @see \Drupal\address\Plugin\Field\FieldType\AddressItem::schema
*/
public function initializeCompositeElements(array &$element) {
$element['#webform_composite_elements'] = [
'given_name' => [
'#title' => $this
->t('Given name'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'family_name' => [
'#title' => $this
->t('Family name'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'additional_name' => [
'#title' => $this
->t('Additional name'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'organization' => [
'#title' => $this
->t('Organization'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'address_line1' => [
'#title' => $this
->t('Address line 1'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'address_line2' => [
'#title' => $this
->t('Address line 2'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'postal_code' => [
'#title' => $this
->t('Postal code'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'locality' => [
'#title' => $this
->t('Locality'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'dependent_locality' => [
'#title' => $this
->t('Dependent_locality'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'administrative_area' => [
'#title' => $this
->t('Administrative area'),
'#type' => 'textfield',
'#maxlength' => 255,
],
'country_code' => [
'#title' => $this
->t('Country code'),
'#type' => 'textfield',
'#maxlength' => 2,
],
'langcode' => [
'#title' => $this
->t('Language code'),
'#type' => 'textfield',
'#maxlength' => 32,
],
'sorting_code' => [
'#title' => $this
->t('Sorting code'),
'#type' => 'textfield',
'#maxlength' => 255,
],
];
}
/**
* {@inheritdoc}
*/
protected function formatHtmlItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemFormat($element);
if ($format === 'value') {
return $this
->buildAddress($element, $webform_submission, $options);
}
else {
return parent::formatHtmlItem($element, $webform_submission, $options);
}
}
/**
* {@inheritdoc}
*/
protected function formatTextItem(array $element, WebformSubmissionInterface $webform_submission, array $options = []) {
$format = $this
->getItemFormat($element);
if ($format === 'value') {
$build = $this
->buildAddress($element, $webform_submission, $options);
$html = \Drupal::service('renderer')
->renderPlain($build);
return trim(MailFormatHelper::htmlToText($html));
}
else {
return parent::formatTextItem($element, $webform_submission, $options);
}
}
/**
* Build formatted address.
*
* The below code is copied form the protected
* AddressDefaultFormatter::viewElements method.
*
* @param array $element
* An element.
* @param \Drupal\webform\WebformSubmissionInterface $webform_submission
* A webform submission.
* @param array $options
* An array of options.
*
* @return array
* A render array containing the formatted address.
*
* @see \Drupal\address\Plugin\Field\FieldFormatter\AddressDefaultFormatter::viewElements
* @see \Drupal\address\Plugin\Field\FieldFormatter\AddressDefaultFormatter::viewElement
*/
protected function buildAddress(array $element, WebformSubmissionInterface $webform_submission, array $options) {
/** @var \CommerceGuys\Addressing\AddressFormat\AddressFormatRepositoryInterface $address_format_repository */
$address_format_repository = \Drupal::service('address.address_format_repository');
/** @var \CommerceGuys\Addressing\Country\CountryRepositoryInterface $country_repository */
$country_repository = \Drupal::service('address.country_repository');
$value = $this
->getValue($element, $webform_submission, $options);
// Skip if value or country code is empty.
if (empty($value) || empty($value['country_code'])) {
return [];
}
// @see \Drupal\address\Plugin\Field\FieldFormatter\AddressDefaultFormatter::viewElements
$build = [
'#prefix' => '<div class="address" translate="no">',
'#suffix' => '</div>',
'#post_render' => [
[
'\\Drupal\\address\\Plugin\\Field\\FieldFormatter\\AddressDefaultFormatter',
'postRender',
],
],
'#cache' => [
'contexts' => [
'languages:' . LanguageInterface::TYPE_INTERFACE,
],
],
];
// @see \Drupal\address\Plugin\Field\FieldFormatter\AddressDefaultFormatter::viewElement
$country_code = $value['country_code'];
$countries = $country_repository
->getList();
$address_format = $address_format_repository
->get($country_code);
$build += [
'#address_format' => $address_format,
'#locale' => 'und',
];
$build['country'] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#attributes' => [
'class' => [
'country',
],
],
'#value' => Html::escape($countries[$country_code]),
'#placeholder' => '%country',
];
foreach ($address_format
->getUsedFields() as $field) {
$property = FieldHelper::getPropertyName($field);
$class = str_replace('_', '-', $property);
$build[$property] = [
'#type' => 'html_tag',
'#tag' => 'span',
'#attributes' => [
'class' => [
$class,
],
],
'#value' => !empty($value[$property]) ? Html::escape($value[$property]) : '',
'#placeholder' => '%' . $field,
];
}
return $build;
}
/**
* {@inheritdoc}
*/
public function form(array $form, FormStateInterface $form_state) {
$form = parent::form($form, $form_state);
// Get field overrider from element properties.
$element_properties = $form_state
->get('element_properties');
$field_overrides = $element_properties['field_overrides'];
unset($element_properties['field_overrides']);
$form_state
->set('element_properties', $element_properties);
$form['address'] = [
'#type' => 'fieldset',
'#title' => $this
->t('Address settings'),
];
/**************************************************************************/
// Copied from: \Drupal\address\Plugin\Field\FieldType\AddressItem::fieldSettingsForm
/**************************************************************************/
$languages = \Drupal::languageManager()
->getLanguages(LanguageInterface::STATE_ALL);
$language_options = [];
foreach ($languages as $langcode => $language) {
if (!$language
->isLocked()) {
$language_options[$langcode] = $language
->getName();
}
}
$form['address']['available_countries'] = [
'#type' => 'select',
'#title' => $this
->t('Available countries'),
'#description' => $this
->t('If no countries are selected, all countries will be available.'),
'#options' => \Drupal::service('address.country_repository')
->getList(),
'#multiple' => TRUE,
'#size' => 10,
'#select2' => TRUE,
];
WebformElementHelper::process($form['address']['available_countries']);
$form['address']['langcode_override'] = [
'#type' => 'select',
'#title' => $this
->t('Language override'),
'#description' => $this
->t('Ensures entered addresses are always formatted in the same language.'),
'#options' => $language_options,
'#empty_option' => $this
->t('- No override -'),
'#access' => \Drupal::languageManager()
->isMultilingual(),
];
$form['address']['field_overrides_title'] = [
'#type' => 'item',
'#title' => $this
->t('Field overrides'),
'#description' => $this
->t('Use field overrides to override the country-specific address format, forcing specific fields to always be hidden, optional, or required.'),
'#access' => TRUE,
];
$form['address']['field_overrides'] = [
'#type' => 'table',
'#header' => [
$this
->t('Field'),
$this
->t('Override'),
],
'#access' => TRUE,
];
foreach (LabelHelper::getGenericFieldLabels() as $field_name => $label) {
$override = isset($field_overrides[$field_name]) ? $field_overrides[$field_name] : '';
$form['address']['field_overrides'][$field_name] = [
'#access' => TRUE,
'field_label' => [
'#access' => TRUE,
'#type' => 'markup',
'#markup' => $label,
],
'override' => [
'#access' => TRUE,
'#type' => 'select',
'#default_value' => $override,
'#options' => [
FieldOverride::HIDDEN => $this
->t('Hidden'),
FieldOverride::OPTIONAL => $this
->t('Optional'),
FieldOverride::REQUIRED => $this
->t('Required'),
],
'#empty_option' => $this
->t('- No override -'),
'#parents' => [
'properties',
'field_overrides',
$field_name,
],
],
];
}
return $form;
}
/**
* {@inheritdoc}
*/
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
$values = $form_state
->getValues();
$values['field_overrides'] = array_filter($values['field_overrides']);
$form_state
->setValues($values);
parent::validateConfigurationForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function getTestValues(array $element, WebformInterface $webform, array $options = []) {
return [
[
'given_name' => 'John',
'family_name' => 'Smith',
'organization' => 'Google Inc.',
'address_line1' => '1098 Alta Ave',
'postal_code' => '94043',
'locality' => 'Mountain View',
'administrative_area' => 'CA',
'country_code' => 'US',
'langcode' => 'en',
],
];
}
/**
* Form API callback. Make sure address element value includes a country code.
*/
public static function validateAddress(array &$element, FormStateInterface $form_state, array &$completed_form) {
$value = $element['#value'];
if (empty($element['#multiple'])) {
if (empty($value['country_code'])) {
$form_state
->setValueForElement($element, NULL);
}
}
else {
foreach ($value as $index => $item) {
if (empty($item['country_code'])) {
unset($value[$index]);
}
}
$value = array_values($value);
$form_state
->setValueForElement($element, $value ?: NULL);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Address:: |
protected | function | Build formatted address. | |
Address:: |
protected | function |
Define an element's default properties. Overrides WebformCompositeBase:: |
|
Address:: |
public | function |
Gets the actual configuration webform array to be built. Overrides WebformCompositeBase:: |
|
Address:: |
protected | function |
Format an element's value as HTML. Overrides WebformCompositeBase:: |
|
Address:: |
protected | function |
Format an element's value as text. Overrides WebformCompositeBase:: |
|
Address:: |
public | function |
Get composite element. Overrides WebformCompositeBase:: |
|
Address:: |
public | function |
Get test values for an element. Overrides WebformCompositeBase:: |
|
Address:: |
public | function |
Overrides WebformCompositeBase:: |
|
Address:: |
public | function |
Prepare an element to be rendered within a webform. Overrides WebformCompositeBase:: |
|
Address:: |
protected | function |
Prepare an element's pre render callbacks. Overrides WebformElementBase:: |
|
Address:: |
protected | function |
Prepare an element's validation callbacks. Overrides WebformElementBase:: |
|
Address:: |
public static | function | Form API callback. Make sure address element value includes a country code. | |
Address:: |
public | function |
Form validation handler. Overrides WebformElementBase:: |
|
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 | 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 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 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 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 |
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:: |
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:: |
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 | 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 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. |