You are here

Home » API reference » YAML Form 8 » YamlFormCodeMirror.php

class YamlFormCodeMirror in YAML Form 8

Same name in this branch
  1. 8 src/Element/YamlFormCodeMirror.php \Drupal\yamlform\Element\YamlFormCodeMirror
  2. 8 src/Plugin/YamlFormElement/YamlFormCodeMirror.php \Drupal\yamlform\Plugin\YamlFormElement\YamlFormCodeMirror

Provides a form element for HTML, YAML, or Plain text using CodeMirror.

Plugin annotation

@FormElement("yamlform_codemirror");

Hierarchy

Expanded class hierarchy of YamlFormCodeMirror

1 file declares its use of YamlFormCodeMirror
yamlform.theme.inc in includes/yamlform.theme.inc
Preprocessors and helper functions to make theming easier.
19 #type uses of YamlFormCodeMirror
EmailYamlFormHandler::buildConfigurationForm in src/Plugin/YamlFormHandler/EmailYamlFormHandler.php
Form constructor.
EmailYamlFormHandler::resendMessageForm in src/Plugin/YamlFormHandler/EmailYamlFormHandler.php
Build resend message form.
RemotePostYamlFormHandler::buildConfigurationForm in src/Plugin/YamlFormHandler/RemotePostYamlFormHandler.php
Form constructor.
Table::form in src/Plugin/YamlFormElement/Table.php
Gets the actual configuration form array to be built.
YamlFormAdminSettingsForm::buildForm in src/Form/YamlFormAdminSettingsForm.php
Form constructor.

... See full list

File

src/Element/YamlFormCodeMirror.php, line 15

Namespace

Drupal\yamlform\Element
View source 
class YamlFormCodeMirror extends Textarea {

  /**
   * An associative array of supported CodeMirror modes by type and mime-type.
   *
   * @var array
   */
  protected static $modes = [
    'css' => 'text/css',
    'html' => 'text/html',
    'javascript' => 'text/javascript',
    'text' => 'text/plain',
    'yaml' => 'text/x-yaml',
  ];

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#mode' => 'text',
      '#skip_validation' => FALSE,
      '#cols' => 60,
      '#rows' => 5,
      '#resizable' => 'vertical',
      '#process' => [
        [
          $class,
          'processYamlFormCodeMirror',
        ],
        [
          $class,
          'processAjaxForm',
        ],
        [
          $class,
          'processGroup',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderYamlFormCodeMirror',
        ],
        [
          $class,
          'preRenderGroup',
        ],
      ],
      '#element_validate' => [
        [
          $class,
          'validateYamlFormCodeMirror',
        ],
      ],
      '#theme' => 'textarea',
      '#theme_wrappers' => [
        'form_element',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
    if ($input === FALSE && $element['#mode'] == 'yaml' && isset($element['#default_value'])) {

      // Convert associative array in default value to YAML.
      if (is_array($element['#default_value'])) {
        $element['#default_value'] = YamlFormTidy::tidy(Yaml::encode($element['#default_value']));
      }

      // Convert empty YAML into an empty string.
      if ($element['#default_value'] == '{  }') {
        $element['#default_value'] = '';
      }
      return $element['#default_value'];
    }
    return NULL;
  }

  /**
   * Processes a 'yamlform_codemirror' element.
   */
  public static function processYamlFormCodeMirror(&$element, FormStateInterface $form_state, &$complete_form) {

    // Check that mode is defined and valid, if not default to (plain) text.
    if (empty($element['#mode']) || !isset(self::$modes[$element['#mode']])) {
      $element['#mode'] = 'text';
    }
    return $element;
  }

  /**
   * Prepares a #type 'yamlform_code' render element for theme_element().
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #description, #size, #maxlength,
   *   #placeholder, #required, #attributes.
   *
   * @return array
   *   The $element with prepared variables ready for theme_element().
   */
  public static function preRenderYamlFormCodeMirror($element) {
    static::setAttributes($element, [
      'js-yamlform-codemirror',
      'yamlform-codemirror',
      $element['#mode'],
    ]);
    $element['#attributes']['data-yamlform-codemirror-mode'] = static::getMode($element['#mode']);
    $element['#attached']['library'][] = 'yamlform/yamlform.element.codemirror.' . $element['#mode'];
    return $element;
  }

  /**
   * Form element validation handler for #type 'yamlform_codemirror'.
   */
  public static function validateYamlFormCodeMirror(&$element, FormStateInterface $form_state, &$complete_form) {
    if ($errors = static::getErrors($element, $form_state, $complete_form)) {
      $build = [
        'title' => [
          '#markup' => t('%title is not valid.', [
            '%title' => isset($element['#title']) ? $element['#title'] : t('YAML'),
          ]),
        ],
        'errors' => [
          '#theme' => 'item_list',
          '#items' => $errors,
        ],
      ];
      $form_state
        ->setError($element, \Drupal::service('renderer')
        ->render($build));
    }
    if ($element['#mode'] == 'yaml' && (isset($element['#default_value']) && is_array($element['#default_value']))) {

      // Handle rare case where single array value is not parsed correctly.
      if (preg_match('/^- (.*?)\\s*$/', $element['#value'], $match)) {
        $value = [
          $match[1],
        ];
      }
      else {
        $value = $element['#value'] ? Yaml::decode($element['#value']) : [];
      }
      $form_state
        ->setValueForElement($element, $value);
    }
  }

  /**
   * Get validation errors.
   */
  protected static function getErrors(&$element, FormStateInterface $form_state, &$complete_form) {
    if (!empty($element['#skip_validation'])) {
      return NULL;
    }
    switch ($element['#mode']) {
      case 'html':

        // @see: http://stackoverflow.com/questions/3167074/which-function-in-php-validate-if-the-string-is-valid-html
        // @see: http://stackoverflow.com/questions/5030392/x-html-validator-in-php
        libxml_use_internal_errors(TRUE);
        if (simplexml_load_string('<fragment>' . $element['#value'] . '</fragment>')) {
          return NULL;
        }
        $errors = libxml_get_errors();
        libxml_clear_errors();
        if (!$errors) {
          return NULL;
        }
        $messages = [];
        foreach ($errors as $error) {
          $messages[] = $error->message;
        }
        return $messages;
      case 'yaml':
        try {
          $value = trim($element['#value']);
          $data = Yaml::decode($value);
          if (!is_array($data) && $value) {
            throw new \Exception(t('YAML must contain an associative array of elements.'));
          }
          return NULL;
        } catch (\Exception $exception) {
          return [
            $exception
              ->getMessage(),
          ];
        }
      default:
        return NULL;
    }
  }

  /**
   * Get the CodeMirror mode for specified type.
   *
   * @param string $mode
   *   Mode (text, html, or yaml).
   *
   * @return string
   *   The CodeMirror mode (aka mime type).
   */
  public static function getMode($mode) {
    return isset(static::$modes[$mode]) ? static::$modes[$mode] : static::$modes['text'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
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.
YamlFormCodeMirror::$modes protected static property An associative array of supported CodeMirror modes by type and mime-type.
YamlFormCodeMirror::getErrors protected static function Get validation errors.
YamlFormCodeMirror::getInfo public function Returns the element properties for this element. Overrides Textarea::getInfo
YamlFormCodeMirror::getMode public static function Get the CodeMirror mode for specified type.
YamlFormCodeMirror::preRenderYamlFormCodeMirror public static function Prepares a #type 'yamlform_code' render element for theme_element().
YamlFormCodeMirror::processYamlFormCodeMirror public static function Processes a 'yamlform_codemirror' element.
YamlFormCodeMirror::validateYamlFormCodeMirror public static function Form element validation handler for #type 'yamlform_codemirror'.
YamlFormCodeMirror::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides Textarea::valueCallback