abstract class TextBase in YAML Form 8

Provides a base 'text' (field) class.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\yamlform\YamlFormElementBase implements YamlFormElementInterface uses StringTranslationTrait
  - class \Drupal\yamlform\Plugin\YamlFormElement\TextBase

Expanded class hierarchy of TextBase

File

src/Plugin/YamlFormElement/TextBase.php, line 13

Namespace

Drupal\yamlform\Plugin\YamlFormElement

View source

abstract class TextBase extends YamlFormElementBase {

  /**
   * {@inheritdoc}
   */
  public function getDefaultProperties() {
    return parent::getDefaultProperties() + [
      'size' => '',
      'maxlength' => '',
      'placeholder' => '',
      'pattern' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, YamlFormSubmissionInterface $yamlform_submission) {
    parent::prepare($element, $yamlform_submission);

    // Counter.
    if (!empty($element['#counter_type']) && !empty($element['#counter_maximum'])) {
      $element['#attributes']['data-counter-type'] = $element['#counter_type'];
      $element['#attributes']['data-counter-limit'] = $element['#counter_maximum'];
      if (!empty($element['#counter_message'])) {
        $element['#attributes']['data-counter-message'] = $element['#counter_message'];
      }
      $element['#attributes']['class'][] = 'js-yamlform-counter';
      $element['#attributes']['class'][] = 'yamlform-counter';
      $element['#attached']['library'][] = 'yamlform/yamlform.element.counter';
      $element['#element_validate'][] = [
        get_class($this),
        'validateCounter',
      ];
    }

    // Input mask.
    if (!empty($element['#input_mask'])) {

      // See if the element mask is JSON by looking for 'name':, else assume it
      // is a mask pattern.
      $input_mask = $element['#input_mask'];
      if (preg_match("/^'[^']+'\\s*:/", $input_mask)) {
        $element['#attributes']['data-inputmask'] = $input_mask;
      }
      else {
        $element['#attributes']['data-inputmask-mask'] = $input_mask;
      }
      $element['#attributes']['class'][] = 'js-yamlform-element-mask';
      $element['#attached']['library'][] = 'yamlform/yamlform.element.inputmask';
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);

    // Input mask.
    $form['form']['input_mask'] = [
      '#type' => 'yamlform_select_other',
      '#title' => $this
        ->t('Input masks'),
      '#description' => $this
        ->t('An <a href=":href">inputmask</a> helps the user with the element by ensuring a predefined format.', [
        ':href' => 'https://github.com/RobinHerbots/jquery.inputmask',
      ]),
      '#other__option_label' => $this
        ->t('Custom...'),
      '#other__placeholder' => $this
        ->t('Enter input mask...'),
      '#other__description' => $this
        ->t('(9 = numeric; a = alphabetical; * = alphanumeric)'),
      '#options' => [
        '' => '',
        'Basic' => [
          "'alias': 'currency'" => $this
            ->t('Currency - @format', [
            '@format' => '$ 9.99',
          ]),
          "'alias': 'mm/dd/yyyy'" => $this
            ->t('Date - @format', [
            '@format' => 'mm/dd/yyyy',
          ]),
          "'alias': 'email'" => $this
            ->t('Email - @format', [
            '@format' => 'example@example.com',
          ]),
          "'alias': 'percentage'" => $this
            ->t('Percentage - @format', [
            '@format' => '99%',
          ]),
          '(999) 999-9999' => $this
            ->t('Phone - @format', [
            '@format' => '(999) 999-9999',
          ]),
          '99999[-9999]' => $this
            ->t('Zip code - @format', [
            '@format' => '99999[-9999]',
          ]),
        ],
        'Advanced' => [
          "'alias': 'ip'" => 'IP address - 255.255.255.255',
          '[9-]AAA-999' => 'License plate - [9-]AAA-999',
          "'alias': 'mac'" => 'MAC addresses - 99-99-99-99-99-99',
          '999-99-9999' => 'SSN - 999-99-9999',
          "'alias': 'vin'" => 'VIN (Vehicle identification number)',
        ],
      ],
    ];

    // Pattern.
    $form['validation']['pattern'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pattern'),
      '#description' => $this
        ->t('A <a href=":href">regular expression</a> that the element\'s value is checked against.', [
        ':href' => 'http://www.w3schools.com/js/js_regexp.asp',
      ]),
    ];

    // Counter.
    $form['validation']['counter_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Count'),
      '#description' => $this
        ->t('Limit entered value to a maximum number of characters or words.'),
      '#options' => [
        '' => '',
        'character' => $this
          ->t('Characters'),
        'word' => $this
          ->t('Words'),
      ],
    ];
    $form['validation']['counter_maximum'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Count maximum'),
      '#min' => 1,
      '#states' => [
        'invisible' => [
          ':input[name="properties[counter_type]"]' => [
            'value' => '',
          ],
        ],
        'optional' => [
          ':input[name="properties[counter_type]"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    $form['validation']['counter_message'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Count message'),
      '#description' => $this
        ->t('Defaults to: %value', [
        '%value' => $this
          ->t('X characters/word(s) left'),
      ]),
      '#states' => [
        'invisible' => [
          ':input[name="properties[counter_type]"]' => [
            'value' => '',
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * Form API callback. Validate (word/charcter) counter.
   */
  public static function validateCounter(array &$element, FormStateInterface $form_state) {
    $name = $element['#name'];
    $value = $form_state
      ->getValue($name);
    $type = $element['#counter_type'];
    $limit = $element['#counter_maximum'];

    // Validate character count.
    if ($type == 'character' && Unicode::strlen($value) <= $limit) {
      return;
    }
    elseif ($type == 'word' && str_word_count($value) <= $limit) {
      return;
    }

    // Display error.
    $t_args = [
      '%name' => $name,
      '@limit' => $limit,
      '@type' => $type == 'character' ? t('characters') : t('words'),
    ];
    $form_state
      ->setError($element, t('%name must be less than @limit @type.', $t_args));
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::validateConfigurationForm($form, $form_state);
    $properties = $this
      ->getConfigurationFormProperties($form, $form_state);

    // Validate #pattern's regular expression.
    // @see \Drupal\Core\Render\Element\FormElement::validatePattern
    // @see http://stackoverflow.com/questions/4440626/how-can-i-validate-regex
    if (!empty($properties['#pattern'])) {
      set_error_handler('_yamlform_entity_element_validate_rendering_error_handler');
      if (preg_match('{^(?:' . $properties['#pattern'] . ')$}', NULL) === FALSE) {
        $form_state
          ->setErrorByName('pattern', t('Pattern %pattern is not a valid regular expression.', [
          '%pattern' => $properties['#pattern'],
        ]));
      }
      set_error_handler('_drupal_error_handler');
    }

    // Validate #counter_maximum.
    if (!empty($properties['#counter_type']) && empty($properties['#counter_maximum'])) {
      $form_state
        ->setErrorByName('counter_maximum', t('Counter maximum is required.'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TextBase::form	public	function	Gets the actual configuration form array to be built. Overrides YamlFormElementBase::form	2
TextBase::getDefaultProperties	public	function	Only a few elements don't inherit these default properties. Overrides YamlFormElementBase::getDefaultProperties	4
TextBase::prepare	public	function	Prepare an element to be rendered within a form. Overrides YamlFormElementBase::prepare	1
TextBase::validateConfigurationForm	public	function	Form validation handler. Overrides YamlFormElementBase::validateConfigurationForm
TextBase::validateCounter	public static	function	Form API callback. Validate (word/charcter) counter.
YamlFormElementBase::$configFactory	protected	property	The configuration factory.
YamlFormElementBase::$currentUser	protected	property	The current user.
YamlFormElementBase::$elementInfo	protected	property	A element info manager.
YamlFormElementBase::$elementManager	protected	property	The form element manager.
YamlFormElementBase::$entityTypeManager	protected	property	The entity type manager.
YamlFormElementBase::$logger	protected	property	A logger instance.
YamlFormElementBase::$tokenManager	protected	property	The token manager.
YamlFormElementBase::build	protected	function	Build an element as text or HTML.	2
YamlFormElementBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	1
YamlFormElementBase::buildExportHeader	public	function	Build an element's export header. Overrides YamlFormElementInterface::buildExportHeader	3
YamlFormElementBase::buildExportOptionsForm	public	function	Get an element's export options form. Overrides YamlFormElementInterface::buildExportOptionsForm	4
YamlFormElementBase::buildExportRecord	public	function	Build an element's export row. Overrides YamlFormElementInterface::buildExportRecord	5
YamlFormElementBase::buildHtml	public	function	Build an element as HTML element. Overrides YamlFormElementInterface::buildHtml	1
YamlFormElementBase::buildText	public	function	Build an element as text element. Overrides YamlFormElementInterface::buildText	1
YamlFormElementBase::checkAccessRules	public	function	Check element access (rules). Overrides YamlFormElementInterface::checkAccessRules
YamlFormElementBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
YamlFormElementBase::displayDisabledWarning	public	function	Display element disabled warning. Overrides YamlFormElementInterface::displayDisabledWarning	1
YamlFormElementBase::formatHtml	public	function	Format an element's value as HTML. Overrides YamlFormElementInterface::formatHtml	15
YamlFormElementBase::formatTableColumn	public	function	Format an element's table column value. Overrides YamlFormElementInterface::formatTableColumn	2
YamlFormElementBase::formatText	public	function	Format an element's value as plain text. Overrides YamlFormElementInterface::formatText	13
YamlFormElementBase::getAdminLabel	public	function	Get an element's admin label (#admin_title, #title or #yamlform_key). Overrides YamlFormElementInterface::getAdminLabel
YamlFormElementBase::getConfigurationFormProperties	public	function	Get an associative array of element properties from configuration form. Overrides YamlFormElementInterface::getConfigurationFormProperties	2
YamlFormElementBase::getConfigurationFormProperty	protected	function	Get configuration property value.	1
YamlFormElementBase::getDefaultBaseProperties	protected	function	Get default base properties used by all elements.
YamlFormElementBase::getDefaultFormat	public	function	Get an element's default format name. Overrides YamlFormElementInterface::getDefaultFormat	17
YamlFormElementBase::getElementSelectorInputsOptions	protected	function	Get an element's (sub)inputs selectors as options.	7
YamlFormElementBase::getElementSelectorOptions	public	function	Get an element's selectors as options. Overrides YamlFormElementInterface::getElementSelectorOptions	11
YamlFormElementBase::getElementStateOptions	public	function	Get an element's supported states as options. Overrides YamlFormElementInterface::getElementStateOptions
YamlFormElementBase::getExportDefaultOptions	public	function	Get an element's default export options. Overrides YamlFormElementInterface::getExportDefaultOptions	4
YamlFormElementBase::getFormat	public	function	Get element's format name by looking for '#format' property, global settings, and finally default settings. Overrides YamlFormElementInterface::getFormat	1
YamlFormElementBase::getFormats	public	function	Get an element's available formats. Overrides YamlFormElementInterface::getFormats	18
YamlFormElementBase::getInfo	public	function	Retrieves the default properties for the defined element type. Overrides YamlFormElementInterface::getInfo
YamlFormElementBase::getKey	public	function	Get an element's key/name. Overrides YamlFormElementInterface::getKey
YamlFormElementBase::getLabel	public	function	Get an element's label (#title or #yamlform_key). Overrides YamlFormElementInterface::getLabel
YamlFormElementBase::getPluginApiLink	public	function	Get link to element's API documentation. Overrides YamlFormElementInterface::getPluginApiLink
YamlFormElementBase::getPluginApiUrl	public	function	Get the URL for the element's API documentation. Overrides YamlFormElementInterface::getPluginApiUrl
YamlFormElementBase::getPluginLabel	public	function	Gets the label of the plugin instance. Overrides YamlFormElementInterface::getPluginLabel
YamlFormElementBase::getRelatedTypes	public	function	Get related element types. Overrides YamlFormElementInterface::getRelatedTypes	3
YamlFormElementBase::getTableColumn	public	function	Get element's table column(s) settings. Overrides YamlFormElementInterface::getTableColumn	3
YamlFormElementBase::getTestValue	public	function	Get test value for an element. Overrides YamlFormElementInterface::getTestValue	7
YamlFormElementBase::getTranslatableProperties	public	function	Get translatable properties. Overrides YamlFormElementInterface::getTranslatableProperties	7
YamlFormElementBase::getTypeName	public	function	Gets the type name (aka id) of the plugin instance with the 'yamlform_' prefix. Overrides YamlFormElementInterface::getTypeName
YamlFormElementBase::hasMultipleValues	public	function	Checks if element value has multiple values. Overrides YamlFormElementInterface::hasMultipleValues	3
YamlFormElementBase::hasProperty	public	function	Determine if an element supports a specified property. Overrides YamlFormElementInterface::hasProperty
YamlFormElementBase::hasWrapper	public	function	Checks if the element has a wrapper. Overrides YamlFormElementInterface::hasWrapper
YamlFormElementBase::initialize	public	function	Initialize an element to be displayed, rendered, or exported. Overrides YamlFormElementInterface::initialize	1
YamlFormElementBase::isComposite	public	function	Checks if element is a composite element. Overrides YamlFormElementInterface::isComposite
YamlFormElementBase::isContainer	public	function	Checks if element is a container that can contain elements. Overrides YamlFormElementInterface::isContainer	3
YamlFormElementBase::isDisabled	public	function	Checks if element is disabled. Overrides YamlFormElementInterface::isDisabled
YamlFormElementBase::isEnabled	public	function	Checks if element is enabled. Overrides YamlFormElementInterface::isEnabled	1
YamlFormElementBase::isHidden	public	function	Checks if element is hidden. Overrides YamlFormElementInterface::isHidden
YamlFormElementBase::isInput	public	function	Checks if the element carries a value. Overrides YamlFormElementInterface::isInput	5
YamlFormElementBase::isMultiline	public	function	Checks if element value could contain multiple lines. Overrides YamlFormElementInterface::isMultiline	3
YamlFormElementBase::isRoot	public	function	Checks if element is a root element. Overrides YamlFormElementInterface::isRoot	1
YamlFormElementBase::postCreate	public	function	Acts on a form submission element after it is created. Overrides YamlFormElementInterface::postCreate	1
YamlFormElementBase::postDelete	public	function	Delete any additional value associated with an element. Overrides YamlFormElementInterface::postDelete	2
YamlFormElementBase::postLoad	public	function	Acts on loaded form submission. Overrides YamlFormElementInterface::postLoad	1
YamlFormElementBase::postSave	public	function	Acts on a saved form submission element before the insert or update hook is invoked. Overrides YamlFormElementInterface::postSave	2
YamlFormElementBase::preCreate	public	function	Changes the values of an entity before it is created. Overrides YamlFormElementInterface::preCreate	1
YamlFormElementBase::preDelete	public	function		1
YamlFormElementBase::prefixExportHeader	protected	function	Prefix an element's export header.
YamlFormElementBase::prepareWrapper	protected	function	Set an elements Flexbox and #states wrapper.	1
YamlFormElementBase::preSave	public	function	Acts on a form submission element before the presave hook is invoked. Overrides YamlFormElementInterface::preSave	2
YamlFormElementBase::setConfigurationFormDefaultValue	protected	function	Set an element's configuration form element default value.	2
YamlFormElementBase::setConfigurationFormDefaultValueRecursive	protected	function	Set configuration form default values recursively.
YamlFormElementBase::setDefaultValue	public	function	Set an element's default value using saved data. Overrides YamlFormElementInterface::setDefaultValue	8
YamlFormElementBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
YamlFormElementBase::validateUnique	public static	function	Form API callback. Validate #unique value.
YamlFormElementBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct

You are here

abstract class TextBase in YAML Form 8

Hierarchy

File

Namespace

Members

API Navigation