WebformElementFormatCustomTest.php in Webform 8.5

Namespace

Drupal\Tests\webform\Functional\Element

File

tests/src/Functional/Element/WebformElementFormatCustomTest.php

<?php

namespace Drupal\Tests\webform\Functional\Element;

use Drupal\file\Entity\File;
use Drupal\Tests\TestFileCreationTrait;
use Drupal\webform\Entity\Webform;

/**
 * Tests for webform submission webform element custom #format support.
 *
 * @group webform
 */
class WebformElementFormatCustomTest extends WebformElementBrowserTestBase {
  use TestFileCreationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'file',
    'webform',
  ];

  /**
   * Webforms to load.
   *
   * @var array
   */
  protected static $testWebforms = [
    'test_element_format_custom',
  ];

  /**
   * Tests element custom format.
   */
  public function testFormatCustom() {
    $this
      ->drupalLogin($this->rootUser);

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load('test_element_format_custom');
    $files = $this
      ->getTestFiles('image');
    $this
      ->debug($files[0]);
    $edit = [
      'files[image_custom]' => \Drupal::service('file_system')
        ->realpath($files[0]->uri),
    ];
    $sid = $this
      ->postSubmission($webform, $edit);

    // Retrieves the fid of the last inserted file.
    $fid = (int) \Drupal::database()
      ->query('SELECT MAX(fid) FROM {file_managed}')
      ->fetchField();
    $file = File::load($fid);
    $file_name = $file
      ->getFilename();
    $file_size = $file
      ->getSize();
    $file_url = file_create_url($file
      ->getFileUri());

    /**************************************************************************/

    // Custom HTML.

    /**************************************************************************/
    $this
      ->drupalGet("admin/structure/webform/manage/test_element_format_custom/submission/{$sid}");

    // Check basic custom HTML format.
    $this
      ->assertRaw('<label>textfield_custom</label>');
    $this
      ->assertRaw('<em>{textfield_custom}</em>');

    // Check basic custom token HTML format.
    $this
      ->assertRaw('<label>textfield_custom_token</label>');
    $this
      ->assertRaw('<em>{textfield_custom_token}</em>');

    // Check caught exception is displayed to users with update access.
    // @see \Drupal\webform\Twig\TwigExtension::renderTwigTemplate
    $this
      ->assertRaw('(&quot;The &quot;[webform_submission:values:textfield_custom_token_exception]&quot; is being called recursively.&quot;)');
    $this
      ->assertRaw('<label>textfield_custom_token_exception</label>');
    $this
      ->assertRaw('<em>EXCEPTION</em>');

    // Check multiple custom HTML format.
    $this
      ->assertRaw('<label>textfield_custom</label>');
    $this
      ->assertRaw('<table>');
    $this
      ->assertRaw('<tr ><td>One</td></tr>');
    $this
      ->assertRaw('<tr style="background-color: #ffc"><td>Two</td></tr>');
    $this
      ->assertRaw('<tr ><td>Three</td></tr>');
    $this
      ->assertRaw('<tr style="background-color: #ffc"><td>Four</td></tr>');
    $this
      ->assertRaw('<tr ><td>Five</td></tr>');
    $this
      ->assertRaw('</table>');

    // Check image custom HTML format.
    $this
      ->assertRaw('<label>image_custom</label>');
    $this
      ->assertRaw('value: 1<br/>');
    $this
      ->assertRaw("item['value']: {$file_url}<br/>");
    $this
      ->assertRaw("item['raw']: {$file_url}<br/>");
    $this
      ->assertRaw("item['link']:");

    // @todo Remove once Drupal 9.1.x is only supported.
    if (floatval(\Drupal::VERSION) >= 9.1) {
      $this
        ->assertRaw('<span class="file file--mime-image-png file--image"><a href="' . $file_url . '" type="image/png">' . $file_name . '</a></span>');
    }
    else {
      $this
        ->assertRaw('<span class="file file--mime-image-png file--image"><a href="' . $file_url . '" type="image/png; length=' . $file_size . '">' . $file_name . '</a></span>');
    }
    $this
      ->assertRaw('item[\'id\']: 1<br/>');
    $this
      ->assertRaw("item['url']: {$file_url}<br/>");
    $this
      ->assertRaw('<img class="webform-image-file" alt="' . $file_name . '" title="' . $file_name . '" src="' . $file_url . '" />');

    // Check composite custom HTML format.
    $this
      ->assertRaw('<label>address_custom</label>');
    $this
      ->assertRaw('element.address: {address}<br/>');
    $this
      ->assertRaw('element.address_2: {address_2}<br/>');
    $this
      ->assertRaw('element.city: {city}<br/>');
    $this
      ->assertRaw('element.state_province: {state_province}<br/>');
    $this
      ->assertRaw('element.postal_code: {postal_code}<br/>');
    $this
      ->assertRaw('element.country: {country}<br/>');

    // Check composite multiple custom HTML format.
    $this
      ->assertRaw('<label>address_multiple_custom</label>');
    $this
      ->assertRaw('<div>*****</div>
element.address: {02-address}<br/>
element.address_2: {02-address_2}<br/>
element.city: {02-city}<br/>
element.state_province: {02-state_province}<br/>
element.postal_code: {02-postal_code}<br/>
element.country: {02-country}<br/>
<div>*****</div>');

    // Check fieldset displayed as details.
    $this
      ->assertRaw('<details class="webform-container webform-container-type-details js-form-wrapper form-wrapper" data-webform-element-id="test_element_format_custom--fieldset_custom" id="test_element_format_custom--fieldset_custom" open="open">');
    $this
      ->assertRaw('<summary role="button" aria-controls="test_element_format_custom--fieldset_custom" aria-expanded="true" aria-pressed="true">fieldset_custom</summary>');

    // Check container custom HTML format.
    $this
      ->assertRaw('<h3>fieldset_custom_children</h3>' . PHP_EOL . '<hr />');

    /**************************************************************************/

    // Custom Text.

    /**************************************************************************/
    $this
      ->drupalGet("admin/structure/webform/manage/test_element_format_custom/submission/{$sid}/text");
    $this
      ->assertRaw("textfield_custom: /{textfield_custom}/\ntextfield_custom_token: /{textfield_custom_token}/\ntextfield_custom_token_exception: /EXCEPTION/\ntextfield_custom:\n⦿ One\n⦿ Two\n⦿ Three\n⦿ Four\n⦿ Five\n\n\nimage_custom:\nvalue: 1\nitem['value']: {$file_url}\nitem['raw']: {$file_url}\nitem['link']: {$file_url}\nitem['id']: 1\nitem['url']: {$file_url}\n\naddress_custom:\nelement.address: {address}\nelement.address_2: {address_2}\nelement.city: {city}\nelement.state_province: {state_province}\nelement.postal_code: {postal_code}\nelement.country: {country}\n\naddress_multiple_custom:\n*****\nelement.address: {01-address}\nelement.address_2: {01-address_2}\nelement.city: {01-city}\nelement.state_province: {01-state_province}\nelement.postal_code: {01-postal_code}\nelement.country: {01-country}\n*****\n*****\nelement.address: {02-address}\nelement.address_2: {02-address_2}\nelement.city: {02-city}\nelement.state_province: {02-state_province}\nelement.postal_code: {02-postal_code}\nelement.country: {02-country}\n*****\n\n\nfieldset_custom\n---------------\nfieldset_custom_textfield: {fieldset_custom_textfield}\n\nfieldset_custom_children\n------------------------\nfieldset_custom_children_textfield: {fieldset_custom_children_textfield}\n\n");
  }

}

Classes

Name	Description
WebformElementFormatCustomTest	Tests for webform submission webform element custom #format support.