You are here

class WebformElementFormatTest in Webform 8.5

Same name and namespace in other branches
  1. 6.x tests/src/Functional/Element/WebformElementFormatTest.php \Drupal\Tests\webform\Functional\Element\WebformElementFormatTest

Tests for webform submission webform element custom #format support.

@group webform

Hierarchy

Expanded class hierarchy of WebformElementFormatTest

File

tests/src/Functional/Element/WebformElementFormatTest.php, line 16

Namespace

Drupal\Tests\webform\Functional\Element
View source
class WebformElementFormatTest extends WebformElementBrowserTestBase {

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

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

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

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

    /* Format (single) element as HTML and text */

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

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load('test_element_format');
    $sid = $this
      ->postSubmission($webform);

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);

    // Check (single) elements item formatted as HTML.
    $body = $this
      ->getMessageBody($submission, 'email_html');
    $elements = [
      'Checkbox (Value)' => 'Yes',
      'Color (Color swatch)' => '<font color="#ffffcc">█</font> #ffffcc',
      'Email (Link)' => '<a href="mailto:example@example.com">example@example.com</a>',
      'Email confirm (Link)' => '<a href="mailto:example@example.com">example@example.com</a>',
      'Email multiple (Link)' => '<a href="mailto:example@example.com">example@example.com</a>, <a href="mailto:test@test.com">test@test.com</a>, <a href="mailto:random@random.com">random@random.com</a>',
      'Signature (Status)' => '[signed]',
      'Telephone (Link)' => '<a href="tel:+1 212-333-4444">+1 212-333-4444</a>',
      'URL (Link)' => '<a href="http://example.com">http://example.com</a>',
      'Date (Raw value)' => '1942-06-18',
      'Date (Fallback date format)' => '1942-06-18',
      'Date (HTML Date)' => '1942-06-18',
      'Date (HTML Datetime)' => '1942-06-18T00:00:00+1000',
      'Date (HTML Month)' => '1942-06',
      'Date (HTML Time)' => '00:00:00',
      'Date (HTML Week)' => '1942-W25',
      'Date (HTML Year)' => '1942',
      'Date (HTML Yearless date)' => '06-18',
      'Date (Default long date)' => 'Thursday, June 18, 1942 - 00:00',
      'Date (Default medium date)' => 'Thu, 06/18/1942 - 00:00',
      'Date (Default short date)' => '06/18/1942 - 00:00',
      'Time (Value)' => '09:00',
      'Time (Raw value)' => '09:00:00',
    ];
    foreach ($elements as $label => $value) {
      $this
        ->assertStringContainsString('<b>' . $label . '</b><br />' . $value, $body, new FormattableMarkup('Found @label: @value', [
        '@label' => $label,
        '@value' => $value,
      ]));
    }

    // Check code format.
    $this
      ->assertStringContainsString('<pre class="js-webform-codemirror-runmode webform-codemirror-runmode" data-webform-codemirror-mode="text/x-yaml">message: \'Hello World\'</pre>', $body);

    // Check elements formatted as text.
    $body = $this
      ->getMessageBody($submission, 'email_text');
    $elements = [
      'Checkbox (Value): Yes',
      'Color (Color swatch): #ffffcc',
      'Email (Link): example@example.com',
      'Email multiple (Link): example@example.com, test@test.com, random@random.com',
      'URL (Link): http://example.com',
      'Date (Raw value): 1942-06-18',
      'Date (Fallback date format): 1942-06-18',
      'Date (HTML Date): 1942-06-18',
      'Date (HTML Datetime): 1942-06-18T00:00:00+1000',
      'Date (HTML Month): 1942-06',
      'Date (HTML Time): 00:00:00',
      'Date (HTML Week): 1942-W25',
      'Date (HTML Year): 1942',
      'Date (HTML Yearless date): 06-18',
      'Date (Default long date): Thursday, June 18, 1942 - 00:00',
      'Date (Default medium date): Thu, 06/18/1942 - 00:00',
      'Date (Default short date): 06/18/1942 - 00:00',
      'Time (Value): 09:00',
      'Time (Raw value): 09:00:00',
    ];
    foreach ($elements as $value) {
      $this
        ->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', [
        '@value' => $value,
      ]));
    }

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

    /* Format managed file element as HTML and text */

    /**************************************************************************/
    $sid = $this
      ->postSubmissionTest($webform);

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);

    // Check managed file element formatted as HTML.
    $body = $this
      ->getMessageBody($submission, 'email_html');
    $elements = [
      'File (Value)' => $this
        ->getSubmissionFileUrl($submission, 'managed_file_value'),
      'File (Raw value)' => $this
        ->getSubmissionFileUrl($submission, 'managed_file_raw'),
      'File (File)' => '<div><span class="file file--mime-text-plain file--text"><a href="' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_file') . '" type="text/plain; length=43">managed_file_file.txt</a></span>',
      'File (Link)' => '<span class="file file--mime-text-plain file--text"><a href="' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_link') . '" type="text/plain; length=43">managed_file_link.txt</a></span>',
      'File (File ID)' => $submission
        ->getElementData('managed_file_id'),
      'File (File name)' => 'managed_file_name.txt',
      'File (File base name (no extension))' => 'managed_file_basename',
      'File (File extension)' => 'txt',
      'File (URL)' => $this
        ->getSubmissionFileUrl($submission, 'managed_file_url'),
    ];
    foreach ($elements as $label => $value) {

      // @todo Remove once Drupal 9.1.x is only supported.
      if (floatval(\Drupal::VERSION) >= 9.1) {
        $value = str_replace('; length=43', '', $value);
      }
      $this
        ->assertStringContainsString('<b>' . $label . '</b><br />' . $value, $body, new FormattableMarkup('Found @label: @value', [
        '@label' => $label,
        '@value' => $value,
      ]));
    }

    // Check managed file element formatted as text.
    $body = $this
      ->getMessageBody($submission, 'email_text');
    $elements = [
      'File (Value): ' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_value'),
      'File (Raw value): ' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_raw'),
      'File (File): ' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_file'),
      'File (Link): ' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_link'),
      'File (File ID): ' . $submission
        ->getElementData('managed_file_id'),
      'File (File name): managed_file_name.txt',
      'File (URL): ' . $this
        ->getSubmissionFileUrl($submission, 'managed_file_url'),
      'File (File mime type)' => 'text/plain',
      'File (File size (Bytes))' => '43',
      'File (File content (Base64))' => 'dGhpcyBpcyBhIHNhbXBsZSB0eHQgZmlsZQppdCBoYXMgdHdvIGxpbmVzCg==',
    ];
    foreach ($elements as $value) {
      $this
        ->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', [
        '@value' => $value,
      ]));
    }

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

    /* Format multiple element as HTML and text */

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

    /** @var \Drupal\webform\WebformInterface $webforms */
    $webforms = Webform::load('test_element_format_multiple');
    $sid = $this
      ->postSubmission($webforms);
    $webforms_submission = WebformSubmission::load($sid);

    // Check elements (single) item formatted as HTML.
    $body = $this
      ->getMessageBody($webforms_submission, 'email_html');
    $elements = [
      'Text field (Comma)' => 'Loremipsum, Oratione, Dixisset',
      'Text field (Semicolon)' => 'Loremipsum; Oratione; Dixisset',
      'Text field (And)' => 'Loremipsum, Oratione, and Dixisset',
      'Text field (Ordered list)' => '<ol><li>Loremipsum</li><li>Oratione</li><li>Dixisset</li></ol>',
      'Text field (Unordered list)' => '<ul><li>Loremipsum</li><li>Oratione</li><li>Dixisset</li></ul>',
      'Checkboxes (Comma)' => 'One, Two, Three',
      'Checkboxes (Semicolon)' => 'One; Two; Three',
      'Checkboxes (And)' => 'One, Two, and Three',
      'Checkboxes (Ordered list)' => '<ol><li>One</li><li>Two</li><li>Three</li></ol>',
      'Checkboxes (Unordered list)' => '<ul><li>One</li><li>Two</li><li>Three</li></ul>',
      'Checkboxes (Checklist (☑/☐))' => '<span style="font-size: 1.4em; line-height: 1em">☑</span> One<br /><span style="font-size: 1.4em; line-height: 1em">☑</span> Two<br /><span style="font-size: 1.4em; line-height: 1em">☑</span> Three<br />',
    ];
    foreach ($elements as $label => $value) {
      $this
        ->assertStringContainsString('<b>' . $label . '</b><br />' . $value, $body, new FormattableMarkup('Found @label: @value', [
        '@label' => $label,
        '@value' => $value,
      ]));
    }

    // Check elements formatted as text.
    $body = $this
      ->getMessageBody($webforms_submission, 'email_text');
    $elements = [
      'Text field (Comma): Loremipsum, Oratione, Dixisset',
      'Text field (Semicolon): Loremipsum; Oratione; Dixisset',
      'Text field (And): Loremipsum, Oratione, and Dixisset',
      'Text field (Ordered list):
1. Loremipsum
2. Oratione
3. Dixisset',
      'Text field (Unordered list):
- Loremipsum
- Oratione
- Dixisset',
      'Checkboxes (Comma): One, Two, Three',
      'Checkboxes (Semicolon): One; Two; Three',
      'Checkboxes (And): One, Two, and Three',
      'Checkboxes (Ordered list):
1. One
2. Two
3. Three',
      'Checkboxes (Unordered list):
- One
- Two
- Three',
      'Checkboxes (Checklist (☑/☐)):
☑ One
☑ Two
☑ Three',
    ];
    foreach ($elements as $value) {
      $this
        ->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', [
        '@value' => $value,
      ]));
    }

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

    /* Format element using tokens */

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

    /** @var \Drupal\webform\WebformInterface $webform_format_token */
    $webform_format_token = Webform::load('test_element_format_token');
    $sid = $this
      ->postSubmission($webform_format_token);
    $webform_format_token_submission = WebformSubmission::load($sid);

    // Check elements tokens formatted as HTML.
    $body = $this
      ->getMessageBody($webform_format_token_submission, 'email_html');
    $elements = [
      'default:' => 'one, two, three',
      'comma:' => 'one, two, three',
      'semicolon:' => 'one; two; three',
      'and:' => 'one, two, and three',
      'ul:' => '<ul><li>one</li><li>two</li><li>three</li></ul>',
      'ol:' => '<ol><li>one</li><li>two</li><li>three</li></ol>',
      'raw:' => '1, 2, 3',
    ];
    foreach ($elements as $label => $value) {
      $this
        ->assertStringContainsString('<h3>' . $label . '</h3>' . $value . '<hr />', $body, new FormattableMarkup('Found @label: @value', [
        '@label' => $label,
        '@value' => $value,
      ]));
    }

    // Check elements tokens formatted as text.
    $body = $this
      ->getMessageBody($webform_format_token_submission, 'email_text');
    $elements = [
      "default:\none, two, three",
      "comma:\none, two, three",
      "semicolon:\none; two; three",
      "and:\none, two, and three",
      "ul:\n- one\n- two\n- three",
      "ol:\n1. one\n2. two\n3. three",
      "raw:\n1, 2, 3",
    ];
    foreach ($elements as $value) {
      $this
        ->assertStringContainsString($value, $body, new FormattableMarkup('Found @value', [
        '@value' => $value,
      ]));
    }

    // Check element default format item global setting.
    \Drupal::configFactory()
      ->getEditable('webform.settings')
      ->set('format.checkboxes.item', 'raw')
      ->save();
    $body = $this
      ->getMessageBody($webform_format_token_submission, 'email_text');
    $this
      ->assertStringContainsString("default:\n1, 2, 3", $body);

    // Check element default format items global setting.
    \Drupal::configFactory()
      ->getEditable('webform.settings')
      ->set('format.checkboxes.items', 'and')
      ->save();
    $body = $this
      ->getMessageBody($webform_format_token_submission, 'email_text');
    $this
      ->assertStringContainsString("default:\n1, 2, and 3", $body);
  }

  /**
   * Get webform email message body for a webform submission.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $submission
   *   A webform submission.
   * @param string $handler_id
   *   The webform email handler id.
   *
   * @return string
   *   The webform email message body for a webform submission.
   */
  protected function getMessageBody(WebformSubmissionInterface $submission, $handler_id = 'email_html') {

    /** @var \Drupal\webform\Plugin\WebformHandlerMessageInterface $message_handler */
    $message_handler = $submission
      ->getWebform()
      ->getHandler($handler_id);
    $message = $message_handler
      ->getMessage($submission);
    $body = (string) $message['body'];
    $this
      ->verbose($body);
    return $body;
  }

  /**
   * Get submission element's file URL.
   *
   * @param \Drupal\webform\WebformSubmissionInterface $submission
   *   A webform submission.
   * @param string $element_key
   *   The element key.
   *
   * @return string
   *   A submission element's file URL.
   */
  protected function getSubmissionFileUrl(WebformSubmissionInterface $submission, $element_key) {
    $fid = $submission
      ->getElementData($element_key);
    $file = File::load($fid);
    return file_create_url($file
      ->getFileUri());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
WebformAssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebformAssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
WebformAssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
WebformAssertLegacyTrait::assertEqual protected function
WebformAssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
WebformAssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
WebformAssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
WebformAssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
WebformAssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
WebformAssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
WebformAssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
WebformAssertLegacyTrait::assertIdentical protected function
WebformAssertLegacyTrait::assertIdenticalObject protected function
WebformAssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
WebformAssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
WebformAssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebformAssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
WebformAssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
WebformAssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
WebformAssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
WebformAssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
WebformAssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
WebformAssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
WebformAssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
WebformAssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
WebformAssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
WebformAssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertNotEqual protected function
WebformAssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
WebformAssertLegacyTrait::assertNotIdentical protected function
WebformAssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
WebformAssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
WebformAssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
WebformAssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
WebformAssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
WebformAssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code.
WebformAssertLegacyTrait::assertSession abstract public function Returns WebAssert object.
WebformAssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
WebformAssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
WebformAssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
WebformAssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
WebformAssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebformAssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
WebformAssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
WebformAssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
WebformAssertLegacyTrait::getRawContent protected function Gets the current raw content.
WebformAssertLegacyTrait::pass protected function
WebformAssertLegacyTrait::verbose protected function
WebformBrowserTestBase::$defaultTheme protected property Set default theme to stable. Overrides BrowserTestBase::$defaultTheme 1
WebformBrowserTestBase::setUp protected function Overrides BrowserTestBase::setUp 39
WebformBrowserTestBase::tearDown protected function Overrides BrowserTestBase::tearDown
WebformBrowserTestTrait::$basicHtmlFilter protected property Basic HTML filter format.
WebformBrowserTestTrait::$fullHtmlFilter protected property Full HTML filter format.
WebformBrowserTestTrait::assertCssSelect protected function Passes if the CSS selector IS found on the loaded page, fail otherwise.
WebformBrowserTestTrait::assertElementNotVisible protected function Asserts that the element with the given CSS selector is not visible.
WebformBrowserTestTrait::assertElementVisible protected function Asserts that the element with the given CSS selector is visible.
WebformBrowserTestTrait::assertNoCssSelect protected function Passes if the CSS selector IS NOT found on the loaded page, fail otherwise.
WebformBrowserTestTrait::createFilters protected function Create basic HTML filter format.
WebformBrowserTestTrait::createTags protected function Create the 'tags' taxonomy vocabulary.
WebformBrowserTestTrait::createWebform protected function Create a webform.
WebformBrowserTestTrait::debug protected function Logs verbose (debug) message in a text file.
WebformBrowserTestTrait::getExport protected function Request a webform results export CSV.
WebformBrowserTestTrait::getExportColumns protected function Get webform export columns.
WebformBrowserTestTrait::getLastEmail protected function Gets that last email sent during the currently running test case.
WebformBrowserTestTrait::getLastSubmissionId protected function Get the last submission id.
WebformBrowserTestTrait::getWebformSubmitButtonLabel protected function Get a webform's submit button label.
WebformBrowserTestTrait::loadSubmission protected function Load the specified webform submission from the storage.
WebformBrowserTestTrait::loadWebform protected function Lazy load a test webform.
WebformBrowserTestTrait::loadWebforms protected function Lazy load a test webforms.
WebformBrowserTestTrait::placeBlocks protected function Place breadcrumb page, tasks, and actions.
WebformBrowserTestTrait::placeWebformBlocks protected function Place webform test module blocks.
WebformBrowserTestTrait::postSubmission protected function Post a new submission to a webform.
WebformBrowserTestTrait::postSubmissionTest protected function Post a new test submission to a webform.
WebformBrowserTestTrait::purgeSubmissions protected function Purge all submission before the webform.module is uninstalled. 1
WebformBrowserTestTrait::reloadSubmission protected function Reload a test webform submission.
WebformBrowserTestTrait::reloadWebform protected function Reload a test webform.
WebformElementBrowserTestBase::assertElementPreview protected function Assert element preview.
WebformElementFormatTest::$modules public static property Modules to enable. Overrides WebformBrowserTestBase::$modules
WebformElementFormatTest::$testWebforms protected static property Webforms to load. Overrides WebformBrowserTestBase::$testWebforms
WebformElementFormatTest::getMessageBody protected function Get webform email message body for a webform submission.
WebformElementFormatTest::getSubmissionFileUrl protected function Get submission element's file URL.
WebformElementFormatTest::testFormat public function Tests element format.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.