MachineName
class MachineName extends Textfield (View source)
Provides a machine name render element.
Provides a form element to enter a machine name, which is validated to ensure that the name is unique and does not contain disallowed characters.
The element may be automatically populated via JavaScript when used in conjunction with a separate "source" form element (typically specifying the human-readable name). As the user types text into the source element, the JavaScript converts all values to lower case, replaces any remaining disallowed characters with a replacement, and populates the associated machine name form element.
Properties:
-
machine_name: An associative array containing:
- exists: A callable to invoke for checking whether a submitted machine name value already exists. The arguments passed to the callback will be:
- The submitted value.
- The element array.
- The form state object. In most cases, an existing API or menu argument loader function can be re-used. The callback is only invoked if the submitted value differs from the element's initial #default_value. The initial #default_value is stored in form state so AJAX forms can be reliably validated.
- source: (optional) The #array_parents of the form element containing the human-readable name (i.e., as contained in the $form structure) to use as source for the machine name. Defaults to array('label').
- label: (optional) Text to display as label for the machine name value after the human-readable name form element. Defaults to t('Machine name').
- replacepattern: (optional) A regular expression (without delimiters) matching disallowed characters in the machine name. Defaults to '[^a-z0-9]+'.
- replace: (optional) A character to replace disallowed characters in the machine name via JavaScript. Defaults to '_' (underscore). When using a different character, 'replace_pattern' needs to be set accordingly.
- error: (optional) A custom form error message string to show, if the machine name contains disallowed characters.
- standalone: (optional) Whether the live preview should stay in its own form element rather than in the suffix of the source element. Defaults to FALSE.
-
maxlength: (optional) Maximum allowed length of the machine name. Defaults
to 64.
-
disabled: (optional) Should be set to TRUE if an existing machine name
must not be changed after initial creation.
Usage example:
Traits
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
Methods
Constructs a \Drupal\Component\Plugin\PluginBase object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Sets a form element's class attribute.
Adds members of this group as actual elements for rendering.
Form element processing handler for the #ajax form property.
Adds Ajax information about an element to communicate with JavaScript.
Arranges elements into groups.
Determines how user input is mapped to an element's #value property.
process callback for #pattern form element property.
element_validate callback for #pattern form element property.
Adds autocomplete functionality to elements.
Returns the element properties for this element.
Prepares a #type 'textfield' render element for input.html.twig.
Processes a machine-readable name form element.
Form element validation handler for machine_name elements.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a \Drupal\Component\Plugin\PluginBase object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
array
getPluginDefinition()
Gets the definition of the plugin implementation.
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
static
setAttributes(array $element, array $class = [])
Sets a form element's class attribute.
Adds 'required' and 'error' classes as needed.
static array
preRenderGroup(array $element)
Adds members of this group as actual elements for rendering.
static array
processAjaxForm(array $element, FormStateInterface $form_state, array $complete_form)
Form element processing handler for the #ajax form property.
This method is useful for non-input elements that can be used in and outside the context of a form.
static array
preRenderAjaxForm(array $element)
Adds Ajax information about an element to communicate with JavaScript.
If #ajax is set on an element, this additional JavaScript is added to the page header to attach the Ajax behaviors. See ajax.js for more information.
static array
processGroup(array $element, FormStateInterface $form_state, array $complete_form)
Arranges elements into groups.
This method is useful for non-input elements that can be used in and outside the context of a form.
static mixed
valueCallback(array $element, mixed $input, FormStateInterface $form_state)
Determines how user input is mapped to an element's #value property.
static array
processPattern(array $element, FormStateInterface $form_state, array $complete_form)
process callback for #pattern form element property.
static
validatePattern($element, FormStateInterface $form_state, array $complete_form)
element_validate callback for #pattern form element property.
static array
processAutocomplete(array $element, FormStateInterface $form_state, array $complete_form)
Adds autocomplete functionality to elements.
This sets up autocomplete functionality for elements with an
autocomplete_route_name property, using the #autocomplete_route_parameters
property if present.
For example, suppose your autocomplete route name is 'mymodule.autocomplete' and its path is '/mymodule/autocomplete/{a}/{b}'. In a form array, you would create a text field with properties:
array
getInfo()
Returns the element properties for this element.
static array
preRenderTextfield(array $element)
Prepares a #type 'textfield' render element for input.html.twig.
static array
processMachineName(array $element, FormStateInterface $form_state, array $complete_form)
Processes a machine-readable name form element.
static
validateMachineName($element, FormStateInterface $form_state, $complete_form)
Form element validation handler for machine_name elements.
Note that #maxlength is validated by _form_validate() already.
This checks that the submitted value:
- Does not contain the replacement character only.
- Does not contain disallowed characters.
- Is unique; i.e., does not already exist.
- Does not exceed the maximum length (via #maxlength).
- Cannot be changed after creation (via #disabled).