function AssertContentTrait::assertEscaped

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertEscaped()
  2. 10 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertEscaped()
  3. 11.x core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertEscaped()

Passes if the raw text IS found escaped on the loaded page, fail otherwise.

Raw text refers to the raw HTML that the page generated.

Parameters

string $raw: Raw (HTML) string to look for.

string $message: (optional) A message to display with the assertion. Do not translate messages: use \Drupal\Component\Render\FormattableMarkup to embed variables in the message text, not t(). If left blank, a default message will be displayed.

string $group: (optional) The group this message is in, which is displayed in a column in test output. Use 'Debug' to indicate this is debugging output. Do not translate this string. Defaults to 'Other'; most tests do not override this default.

Return value

bool TRUE on pass, FALSE on fail.

5 calls to AssertContentTrait::assertEscaped()
LinkGenerationTest::testHookLinkAlter in core/tests/Drupal/KernelTests/Core/Url/LinkGenerationTest.php
Tests how hook_link_alter() can affect escaping of the link text.
TableTest::testThemeTableTitle in core/tests/Drupal/KernelTests/Core/Render/Element/TableTest.php
Tests that the select/checkbox label is being generated and escaped.
TwigRawTest::testAutoescape in core/modules/system/tests/src/Kernel/Theme/TwigRawTest.php
Tests autoescaping of unsafe content.
ViewsHooksTest::testViewsFormMainFormPreRender in core/modules/views/tests/src/Kernel/ViewsHooksTest.php
Tests how hook_views_form_substitutions() makes substitutions.
ViewsHooksTest::testViewsPreRenderViewsFormViewsForm in core/modules/views/tests/src/Kernel/ViewsHooksTest.php
Tests views_pre_render_views_form_views_form() deprecation.

File

core/tests/Drupal/KernelTests/AssertContentTrait.php, line 500

Class

AssertContentTrait
Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function assertEscaped($raw, $message = '', $group = 'Other') {
    if (!$message) {
        $message = 'Escaped "' . Html::escape($raw) . '" found';
    }
    if ($this instanceof TestCase) {
        $this->assertStringContainsString(Html::escape($raw), $this->getRawContent(), $message);
    }
    else {
        return $this->assert(strpos($this->getRawContent(), Html::escape($raw)) !== FALSE, $message, $group);
    }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.