GroupChannelWidget.php in Rocket.Chat 8.2

Namespace

Drupal\rocket_chat_group\Plugin\Field\FieldWidget

File

modules/rocket_chat_group/src/Plugin/Field/FieldWidget/GroupChannelWidget.php

<?php

namespace Drupal\rocket_chat_group\Plugin\Field\FieldWidget;

use Drupal;
use Drupal\Core\Annotation\Translation;
use Drupal\Core\Field\Annotation\FieldWidget;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Field\WidgetBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\TypedData\Exception\MissingDataException;

/**
 * Class GroupChannelWidget
 *
 * @package Drupal\rocket_chat_group\Plugin\Field\FieldWidget
 *
 * @FieldWidget(
 *   id = "GroupChannelWidget",
 *   label = @Translation("Rocket.Chat Channel Widget"),
 *   field_types={
 *      "channel",
 *   },
 *   description= @Translation("Widget to handle Rocket.Chat Channel Names.")
 * )
 */
class GroupChannelWidget extends WidgetBase {

  /**
   * Returns the form for a single field widget.
   *
   * Field widget form elements should be based on the passed-in $element, which
   * contains the base form element properties derived from the field
   * configuration.
   *
   * The BaseWidget methods will set the weight, field name and delta values for
   * each form element. If there are multiple values for this field, the
   * formElement() method will be called as many times as needed.
   *
   * Other modules may alter the form element provided by this function using
   * hook_field_widget_form_alter() or
   * hook_field_widget_WIDGET_TYPE_form_alter().
   *
   * The FAPI element callbacks (such as #process, #element_validate,
   * #value_callback, etc.) used by the widget do not have access to the
   * original $field_definition passed to the widget's constructor. Therefore,
   * if any information is needed from that definition by those callbacks, the
   * widget implementing this method, or a
   * hook_field_widget[_WIDGET_TYPE]_form_alter() implementation, must extract
   * the needed properties from the field definition and set them as ad-hoc
   * $element['#custom'] properties, for later use by its element callbacks.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   *   Array of default values for this field.
   * @param int $delta
   *   The order of this item in the array of sub-elements (0, 1, 2, etc.).
   * @param array $element
   *   A form element array containing basic properties for the widget:
   *   - #field_parents: The 'parents' space for the field in the form. Most
   *       widgets can simply overlook this property. This identifies the
   *       location where the field values are placed within
   *       $form_state->getValues(), and is used to access processing
   *       information for the field through the getWidgetState() and
   *       setWidgetState() methods.
   *   - #title: The sanitized element label for the field, ready for output.
   *   - #description: The sanitized element description for the field, ready
   *     for output.
   *   - #required: A Boolean indicating whether the element value is required;
   *     for required multiple value fields, only the first widget's values are
   *     required.
   *   - #delta: The order of this item in the array of sub-elements; see $delta
   *     above.
   * @param array $form
   *   The form structure where widgets are being attached to. This might be a
   *   full form structure, or a sub-element of a larger form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The form elements for a single widget for this field.
   *
   * @see hook_field_widget_form_alter()
   * @see hook_field_widget_WIDGET_TYPE_form_alter()
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $value = isset($items[$delta]->value) ? $items[$delta]->value : '';
    $element += [
      '#type' => 'textfield',
      '#title' => $this
        ->t("Channel Name"),
      '#default_value' => $value,
      '#size' => 60,
      '#maxlength' => 2048,
      '#description' => "Channel name to use in the chat environment.<br>like: #&lt;" . $this
        ->t("Channel Name") . "&gt;<br><mark>When missing no channel association will be done!</mark>",
      '#placeholder' => $this
        ->t("#GroupName"),
      '#element_validate' => [
        [
          static::class,
          'validate',
        ],
      ],
    ];
    return [
      'value' => $element,
    ];
  }

  /**
   * Validate the channel name field.
   * @param $element
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   * @return bool
   */
  public static function validate($element, FormStateInterface $form_state) {
    $value = $element['#value'];
    if (strlen($value) == 0) {
      $form_state
        ->setValueForElement($element, '');
      Drupal::messenger()
        ->addWarning(t("An empty value will disable Chat."), FALSE);
      return TRUE;
    }
    if (!preg_match('/^[a-zA-Z]+[a-zA-Z0-9\\-_.!?()>\\\\+=\\[\\]{};:|\\t &$%^\'\\",~`]*$/', $value)) {
      $form_state
        ->setError($element, t("Enter a Valid Channel name.<br> Valid Channel names start with a letter[a-z,A-Z] and do than contain only characters of the following set:<br>[a-zA-Z0-9-_.!?()>\\+=\\;:|[:tab:][:space:]&\$%^'\", ~`]"));
      return FALSE;
    }
    return TRUE;
  }

}

Classes

Name	Description
GroupChannelWidget	Class GroupChannelWidget