ThunderFormFieldTestTrait.php in Thunder 8.2

Namespace

Drupal\Tests\thunder\FunctionalJavascript

File

tests/src/FunctionalJavascript/ThunderFormFieldTestTrait.php

<?php

namespace Drupal\Tests\thunder\FunctionalJavascript;

use Behat\Mink\Element\DocumentElement;

/**
 * Trait for manipulation of form fields.
 *
 * @package Drupal\Tests\thunder\FunctionalJavascript
 */
trait ThunderFormFieldTestTrait {

  /**
   * Set value for group of checkboxes.
   *
   * Existing selection will be cleared before new values are applied.
   *
   * @param \Behat\Mink\Element\DocumentElement $page
   *   Current active page.
   * @param string $fieldName
   *   Field name.
   * @param string $value
   *   Comma separated values for checkboxes.
   */
  protected function setCheckbox(DocumentElement $page, $fieldName, $value) {

    // UnCheck all checkboxes and check defined.
    $this
      ->getSession()
      ->executeScript("jQuery('input[name*=\"{$fieldName}\"]').prop('checked', false);");
    $checkNames = explode(',', $value);
    foreach ($checkNames as $checkName) {
      $checkBoxName = $fieldName . '[' . trim($checkName) . ']';
      $this
        ->scrollElementInView('[name="' . $checkBoxName . '"]');
      $page
        ->checkField($checkBoxName);
    }
  }

  /**
   * Set value for defined field name on current page.
   *
   * @param \Behat\Mink\Element\DocumentElement $page
   *   Current active page.
   * @param string $fieldName
   *   Field name.
   * @param string|array $value
   *   Value for field.
   */
  public function setFieldValue(DocumentElement $page, $fieldName, $value) {

    // If field is checkbox list, then use custom functionality to set values.
    // TODO needs documentation.
    $checkboxes = $page
      ->findAll('xpath', "//input[@type=\"checkbox\" and starts-with(@name, \"{$fieldName}[\")]");
    if (!empty($checkboxes)) {
      $this
        ->setCheckbox($page, $fieldName, $value);
      return;
    }

    // If field is date/time field, then set value directly to field.
    $dateTimeFields = $page
      ->findAll('xpath', "//input[(@type=\"date\" or @type=\"time\") and @name=\"{$fieldName}\"]");
    if (!empty($dateTimeFields)) {
      $this
        ->setRawFieldValue($fieldName, $value);
      return;
    }

    // Handle specific types of form fields.
    $field = $page
      ->findField($fieldName);
    $fieldTag = $field
      ->getTagName();
    if ($fieldTag === 'textarea') {

      // Clear text first, before setting value for "textarea" field.
      $this
        ->getSession()
        ->evaluateScript("jQuery('[name=\"{$fieldName}\"]').val('');");
    }
    elseif ($fieldTag === 'select') {

      // Handling of dropdown list.
      if (!$page
        ->find('css', "[name=\"{$fieldName}\"][class*='select2-widget']")) {
        $page
          ->selectFieldOption($fieldName, $value, TRUE);
      }
      else {
        foreach ($value as $item) {
          $id = is_array($item) ? $item[0] : "\$ID:{$item}";
          $label = is_array($item) ? $item[1] : $item;
          if (!$field
            ->find('named', [
            'option',
            $id,
          ])) {
            $this
              ->getSession()
              ->evaluateScript("jQuery('[name=\"{$fieldName}\"]').append(new Option('{$label}', '{$id}', false, false)).trigger('change')");
            $page
              ->selectFieldOption($fieldName, $id, TRUE);
          }
          else {
            $page
              ->selectFieldOption($fieldName, $id, TRUE);
          }
        }
      }
      return;
    }
    $this
      ->scrollElementInView('[name="' . $fieldName . '"]');
    $page
      ->fillField($fieldName, $value);
    $this
      ->assertSession()
      ->assertWaitOnAjaxRequest();
  }

  /**
   * Set fields on current page.
   *
   * @param \Behat\Mink\Element\DocumentElement $page
   *   Current active page.
   * @param array $fieldValues
   *   Field values as associative array with field names as keys.
   */
  public function setFieldValues(DocumentElement $page, array $fieldValues) {
    foreach ($fieldValues as $fieldName => $value) {
      $this
        ->setFieldValue($page, $fieldName, $value);
    }
  }

}

Traits

Name	Description
ThunderFormFieldTestTrait	Trait for manipulation of form fields.