class YamlFormUsers in YAML Form 8
Provides a users entity reference form element.
Plugin annotation
@FormElement("yamlform_users");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Entity\Element\EntityAutocomplete
- class \Drupal\yamlform\Element\YamlFormUsers
- class \Drupal\Core\Entity\Element\EntityAutocomplete
- class \Drupal\Core\Render\Element\Textfield
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of YamlFormUsers
2 #type uses of YamlFormUsers
- YamlFormElementBase::form in src/
YamlFormElementBase.php - Gets the actual configuration form array to be built.
- YamlFormEntityAccessForm::form in src/
YamlFormEntityAccessForm.php - Gets the actual form array to be built.
File
- src/
Element/ YamlFormUsers.php, line 15
Namespace
Drupal\yamlform\ElementView source
class YamlFormUsers extends EntityAutocomplete {
/**
* {@inheritdoc}
*/
public function getInfo() {
$info = parent::getInfo();
$class = get_class($this);
$info['#target_type'] = 'user';
$info['#selection_settings'] = [
'include_anonymous' => FALSE,
];
$info['#tags'] = TRUE;
$info['#default_value'] = [];
$info['#element_validate'] = [
[
$class,
'validateEntityAutocomplete',
],
[
$class,
'validateYamlFormUsers',
],
];
return $info;
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($element['#default_value']) {
if (!reset($element['#default_value']) instanceof EntityInterface) {
$element['#default_value'] = User::loadMultiple($element['#default_value']);
}
}
return parent::valueCallback($element, $input, $form_state);
}
/**
* Form element validation handler for yamlform_users elements.
*/
public static function validateYamlFormUsers(array &$element, FormStateInterface $form_state, array &$complete_form) {
$value = $form_state
->getValue($element['#parents'], []);
$uids = [];
if ($value) {
foreach ($value as $item) {
if (isset($item)) {
$uids[] = $item['target_id'];
}
}
}
$form_state
->setValueForElement($element, $uids);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityAutocomplete:: |
public static | function | Extracts the entity ID from the autocompletion result. | |
EntityAutocomplete:: |
public static | function | Converts an array of entity objects into a string of entity labels. | |
EntityAutocomplete:: |
protected static | function | Finds an entity from an autocomplete input without an explicit ID. | |
EntityAutocomplete:: |
public static | function | Adds entity autocomplete functionality to a form element. | |
EntityAutocomplete:: |
public static | function | Form element validation handler for entity_autocomplete elements. | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
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. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 92 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
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. | |
Textfield:: |
public static | function | Prepares a #type 'textfield' render element for input.html.twig. | |
YamlFormUsers:: |
public | function |
Returns the element properties for this element. Overrides EntityAutocomplete:: |
|
YamlFormUsers:: |
public static | function | Form element validation handler for yamlform_users elements. | |
YamlFormUsers:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides EntityAutocomplete:: |