trait AssertLegacyTrait
Same name in this branch
- 8.9.x core/tests/Drupal/KernelTests/AssertLegacyTrait.php \Drupal\KernelTests\AssertLegacyTrait
Same name in other branches
- 9 core/tests/Drupal/KernelTests/AssertLegacyTrait.php \Drupal\KernelTests\AssertLegacyTrait
- 9 core/tests/Drupal/FunctionalTests/AssertLegacyTrait.php \Drupal\FunctionalTests\AssertLegacyTrait
Provides convenience methods for assertions in browser tests.
Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use the methods on \Drupal\Tests\WebAssert instead, for example
$this->assertSession()
->statusCodeEquals(200);
@todo https://www.drupal.org/project/drupal/issues/3114617 Note that deprecations in this file do not use the @ symbol in Drupal 8 because this will be removed in Drupal 10.0.0. Adding the @ back should re-enable coding standards checks.
Hierarchy
- trait \Drupal\FunctionalTests\AssertLegacyTrait uses \Drupal\KernelTests\AssertLegacyTrait
2 files declare their use of AssertLegacyTrait
- AssertLegacyTraitTest.php in core/
tests/ Drupal/ Tests/ Core/ Assert/ AssertLegacyTraitTest.php - BrowserTestBase.php in core/
tests/ Drupal/ Tests/ BrowserTestBase.php
File
-
core/
tests/ Drupal/ FunctionalTests/ AssertLegacyTrait.php, line 26
Namespace
Drupal\FunctionalTestsView source
trait AssertLegacyTrait {
use BaseAssertLegacyTrait;
/**
* Asserts that the element with the given CSS selector is present.
*
* @param string $css_selector
* The CSS selector identifying the element to check.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->elementExists() instead.
*/
protected function assertElementPresent($css_selector) {
$this->assertSession()
->elementExists('css', $css_selector);
}
/**
* Asserts that the element with the given CSS selector is not present.
*
* @param string $css_selector
* The CSS selector identifying the element to check.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->elementNotExists() instead.
*/
protected function assertElementNotPresent($css_selector) {
$this->assertSession()
->elementNotExists('css', $css_selector);
}
/**
* Passes if the page (with HTML stripped) contains the text.
*
* Note that stripping HTML tags also removes their attributes, such as
* the values of text fields.
*
* @param string $text
* Plain text to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* - $this->assertSession()->responseContains() for non-HTML responses,
* like XML or Json.
* - $this->assertSession()->pageTextContains() for HTML responses. Unlike
* the deprecated assertText(), the passed text should be HTML decoded,
* exactly as a human sees it in the browser.
*/
protected function assertText($text) {
// Cast MarkupInterface to string.
$text = (string) $text;
$content_type = $this->getSession()
->getResponseHeader('Content-type');
// In case of a Non-HTML response (example: XML) check the original
// response.
if (strpos($content_type, 'html') === FALSE) {
$this->assertSession()
->responseContains($text);
}
else {
$this->assertTextHelper($text, FALSE);
}
}
/**
* Passes if the page (with HTML stripped) does not contains the text.
*
* Note that stripping HTML tags also removes their attributes, such as
* the values of text fields.
*
* @param string $text
* Plain text to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* - $this->assertSession()->responseNotContains() for non-HTML responses,
* like XML or Json.
* - $this->assertSession()->pageTextNotContains() for HTML responses.
* Unlike the deprecated assertNoText(), the passed text should be HTML
* decoded, exactly as a human sees it in the browser.
*/
protected function assertNoText($text) {
// Cast MarkupInterface to string.
$text = (string) $text;
$content_type = $this->getSession()
->getResponseHeader('Content-type');
// In case of a Non-HTML response (example: XML) check the original
// response.
if (strpos($content_type, 'html') === FALSE) {
$this->assertSession()
->responseNotContains($text);
}
else {
$this->assertTextHelper($text);
}
}
/**
* Helper for assertText and assertNoText.
*
* @param string $text
* Plain text to look for.
* @param bool $not_exists
* (optional) TRUE if this text should not exist, FALSE if it should.
* Defaults to TRUE.
*
* @return bool
* TRUE on pass, FALSE on fail.
*/
protected function assertTextHelper($text, $not_exists = TRUE) {
$args = [
'@text' => $text,
];
$message = $not_exists ? new FormattableMarkup('"@text" not found', $args) : new FormattableMarkup('"@text" found', $args);
$raw_content = $this->getSession()
->getPage()
->getContent();
// Trying to simulate what the user sees, given that it removes all text
// inside the head tags, removes inline Javascript, fix all HTML entities,
// removes dangerous protocols and filtering out all HTML tags, as they are
// not visible in a normal browser.
$raw_content = preg_replace('@<head>(.+?)</head>@si', '', $raw_content);
$page_text = Xss::filter($raw_content, []);
$actual = $not_exists == (strpos($page_text, (string) $text) === FALSE);
$this->assertTrue($actual, $message);
return $actual;
}
/**
* Passes if the text is found ONLY ONCE on the text version of the page.
*
* The text version is the equivalent of what a user would see when viewing
* through a web browser. In other words the HTML has been filtered out of
* the contents.
*
* @param string|\Drupal\Component\Render\MarkupInterface $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). If left blank, a default message will be displayed.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->getSession()->getPage()->getText() and substr_count() instead.
*/
protected function assertUniqueText($text, $message = NULL) {
// Cast MarkupInterface objects to string.
$text = (string) $text;
$message = $message ?: "'{$text}' found only once on the page";
$page_text = $this->getSession()
->getPage()
->getText();
$nr_found = substr_count($page_text, $text);
$this->assertSame(1, $nr_found, $message);
}
/**
* Passes if the text is found MORE THAN ONCE on the text version of the page.
*
* The text version is the equivalent of what a user would see when viewing
* through a web browser. In other words the HTML has been filtered out of
* the contents.
*
* @param string|\Drupal\Component\Render\MarkupInterface $text
* Plain text to look for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). If left blank, a default message will be displayed.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->getSession()->getPage()->getText() and substr_count() instead.
*/
protected function assertNoUniqueText($text, $message = '') {
// Cast MarkupInterface objects to string.
$text = (string) $text;
$message = $message ?: "'{$text}' found more than once on the page";
$page_text = $this->getSession()
->getPage()
->getText();
$nr_found = substr_count($page_text, $text);
$this->assertGreaterThan(1, $nr_found, $message);
}
/**
* Asserts the page responds with the specified response code.
*
* @param int $code
* Response code. For example 200 is a successful page request. For a list
* of all codes see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->statusCodeEquals() instead.
*/
protected function assertResponse($code) {
$this->assertSession()
->statusCodeEquals($code);
}
/**
* Asserts that a field exists with the given name and value.
*
* @param string $name
* Name of field to assert.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldExists() or
* $this->assertSession()->buttonExists() or
* $this->assertSession()->fieldValueEquals() instead.
*/
protected function assertFieldByName($name, $value = NULL) {
$this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value);
}
/**
* Asserts that a field does not exist with the given name and value.
*
* @param string $name
* Name of field to assert.
* @param string $value
* (optional) Value for the field, to assert that the field's value on the
* page does not match it. You may pass in NULL to skip checking the
* value, while still checking that the field does not exist. However, the
* default value ('') asserts that the field value is not an empty string.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldNotExists() or
* $this->assertSession()->buttonNotExists() or
* $this->assertSession()->fieldValueNotEquals() instead.
*/
protected function assertNoFieldByName($name, $value = '') {
$this->assertNoFieldByXPath($this->constructFieldXpath('name', $name), $value);
}
/**
* Asserts that a field exists with the given ID and value.
*
* @param string $id
* ID of field to assert.
* @param string|\Drupal\Component\Render\MarkupInterface $value
* (optional) Value for the field to assert. You may pass in NULL to skip
* checking the value, while still checking that the field exists.
* However, the default value ('') asserts that the field value is an empty
* string.
*
* @throws \Behat\Mink\Exception\ElementNotFoundException
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldExists() or
* $this->assertSession()->buttonExists() or
* $this->assertSession()->fieldValueEquals() instead.
*/
protected function assertFieldById($id, $value = '') {
$this->assertFieldByXPath($this->constructFieldXpath('id', $id), $value);
}
/**
* Asserts that a field exists with the given name or ID.
*
* @param string $field
* Name or ID of field to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldExists() or
* $this->assertSession()->buttonExists() instead.
*/
protected function assertField($field) {
$this->assertFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));
}
/**
* Asserts that a field does NOT exist with the given name or ID.
*
* @param string $field
* Name or ID of field to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldNotExists() or
* $this->assertSession()->buttonNotExists() instead.
*/
protected function assertNoField($field) {
$this->assertNoFieldByXPath($this->constructFieldXpath('name', $field) . '|' . $this->constructFieldXpath('id', $field));
}
/**
* Passes if the raw text IS found on the loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseContains() instead.
*/
protected function assertRaw($raw) {
$this->assertSession()
->responseContains($raw);
}
/**
* Passes if the raw text IS not found on the loaded page, fail otherwise.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseNotContains() instead.
*/
protected function assertNoRaw($raw) {
$this->assertSession()
->responseNotContains($raw);
}
/**
* Pass if the page title is the given string.
*
* @param string $expected_title
* The string the page title should be.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->titleEquals() instead.
*/
protected function assertTitle($expected_title) {
// Cast MarkupInterface to string.
$expected_title = (string) $expected_title;
return $this->assertSession()
->titleEquals($expected_title);
}
/**
* Passes if a link with the specified label is found.
*
* An optional link index may be passed.
*
* @param string|\Drupal\Component\Render\MarkupInterface $label
* Text between the anchor tags.
* @param int $index
* Link position counting from zero.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->linkExists() instead.
*/
protected function assertLink($label, $index = 0) {
return $this->assertSession()
->linkExists($label, $index);
}
/**
* Passes if a link with the specified label is not found.
*
* @param string|\Drupal\Component\Render\MarkupInterface $label
* Text between the anchor tags.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->linkNotExists() instead.
*/
protected function assertNoLink($label) {
return $this->assertSession()
->linkNotExists($label);
}
/**
* Passes if a link containing a given href (part) is found.
*
* @param string $href
* The full or partial value of the 'href' attribute of the anchor tag.
* @param int $index
* Link position counting from zero.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->linkByHrefExists() instead.
*/
protected function assertLinkByHref($href, $index = 0) {
$this->assertSession()
->linkByHrefExists($href, $index);
}
/**
* Passes if a link containing a given href (part) is not found.
*
* @param string $href
* The full or partial value of the 'href' attribute of the anchor tag.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->linkByHrefNotExists() instead.
*/
protected function assertNoLinkByHref($href) {
$this->assertSession()
->linkByHrefNotExists($href);
}
/**
* Asserts that a field does not exist with the given ID and value.
*
* @param string $id
* ID of field to assert.
* @param string $value
* (optional) Value for the field, to assert that the field's value on the
* page doesn't match it. You may pass in NULL to skip checking the value,
* while still checking that the field doesn't exist. However, the default
* value ('') asserts that the field value is not an empty string.
*
* @throws \Behat\Mink\Exception\ExpectationException
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->fieldNotExists() or
* $this->assertSession()->buttonNotExists() or
* $this->assertSession()->fieldValueNotEquals() instead.
*/
protected function assertNoFieldById($id, $value = '') {
$this->assertNoFieldByXPath($this->constructFieldXpath('id', $id), $value);
}
/**
* Passes if the internal browser's URL matches the given path.
*
* @param \Drupal\Core\Url|string $path
* The expected system path or URL.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->addressEquals() instead.
*/
protected function assertUrl($path) {
$this->assertSession()
->addressEquals($path);
}
/**
* Asserts that a select option in the current page exists.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->optionExists() instead.
*/
protected function assertOption($id, $option) {
return $this->assertSession()
->optionExists($id, $option);
}
/**
* Asserts that a select option with the visible text exists.
*
* @param string $id
* The ID of the select field to assert.
* @param string $text
* The text for the option tag to assert.
*
* Deprecated in drupal:8.4.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->optionExists() instead.
*/
protected function assertOptionByText($id, $text) {
return $this->assertSession()
->optionExists($id, $text);
}
/**
* Asserts that a select option does NOT exist in the current page.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->optionNotExists() instead.
*/
protected function assertNoOption($id, $option) {
return $this->assertSession()
->optionNotExists($id, $option);
}
/**
* Asserts that a select option in the current page is checked.
*
* @param string $id
* ID of select field to assert.
* @param string $option
* Option to assert.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t(). If left blank, a default message will be displayed.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->optionExists() instead and check the
* "selected" attribute yourself.
*/
protected function assertOptionSelected($id, $option, $message = NULL) {
$option_field = $this->assertSession()
->optionExists($id, $option);
$message = $message ?: "Option {$option} for field {$id} is selected.";
$this->assertTrue($option_field->hasAttribute('selected'), $message);
}
/**
* Asserts that a checkbox field in the current page is checked.
*
* @param string $id
* ID of field to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->checkboxChecked() instead.
*/
protected function assertFieldChecked($id) {
$this->assertSession()
->checkboxChecked($id);
}
/**
* Asserts that a checkbox field in the current page is not checked.
*
* @param string $id
* ID of field to assert.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->checkboxNotChecked() instead.
*/
protected function assertNoFieldChecked($id) {
$this->assertSession()
->checkboxNotChecked($id);
}
/**
* Asserts that a field exists in the current page by the given XPath.
*
* @param string $xpath
* XPath used to find the field.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default)
* to skip checking the actual value, while still checking that the field
* exists.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t().
*
* Deprecated in drupal:8.3.0 and is removed from drupal:10.0.0. Use
* $this->xpath() instead and check the values directly in the test.
*/
protected function assertFieldByXPath($xpath, $value = NULL, $message = '') {
$fields = $this->xpath($xpath);
$this->assertFieldsByValue($fields, $value, $message);
}
/**
* Asserts that a field does not exist or its value does not match, by XPath.
*
* @param string $xpath
* XPath used to find the field.
* @param string $value
* (optional) Value of the field, to assert that the field's value on the
* page does not match it.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t().
*
* @throws \Behat\Mink\Exception\ExpectationException
*
* Deprecated in drupal:8.3.0 and is removed from drupal:10.0.0. Use
* $this->xpath() instead and assert that the result is empty.
*/
protected function assertNoFieldByXPath($xpath, $value = NULL, $message = '') {
$fields = $this->xpath($xpath);
if (!empty($fields)) {
if (isset($value)) {
$found = FALSE;
try {
$this->assertFieldsByValue($fields, $value);
$found = TRUE;
} catch (\Exception $e) {
}
if ($found) {
throw new ExpectationException(sprintf('The field resulting from %s was found with the provided value %s.', $xpath, $value), $this->getSession()
->getDriver());
}
}
else {
throw new ExpectationException(sprintf('The field resulting from %s was found.', $xpath), $this->getSession()
->getDriver());
}
}
}
/**
* Asserts that a field exists in the current page with a given Xpath result.
*
* @param \Behat\Mink\Element\NodeElement[] $fields
* Xml elements.
* @param string $value
* (optional) Value of the field to assert. You may pass in NULL (default) to skip
* checking the actual value, while still checking that the field exists.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages with t().
*
* Deprecated in drupal:8.3.0 and is removed from drupal:10.0.0. Use
* iteration over the fields yourself instead and directly check the values
* in the test.
*/
protected function assertFieldsByValue($fields, $value = NULL, $message = '') {
// If value specified then check array for match.
$found = TRUE;
if (isset($value)) {
$found = FALSE;
if ($fields) {
foreach ($fields as $field) {
if ($field->getAttribute('type') == 'checkbox') {
if (is_bool($value)) {
$found = $field->isChecked() == $value;
}
else {
$found = TRUE;
}
}
elseif ($field->getAttribute('value') == $value) {
// Input element with correct value.
$found = TRUE;
}
elseif ($field->find('xpath', '//option[@value = ' . (new Escaper())->escapeLiteral($value) . ' and @selected = "selected"]')) {
// Select element with an option.
$found = TRUE;
}
elseif ($field->getTagName() === 'textarea' && $field->getValue() == $value) {
// Text area with correct text. Use getValue() here because
// getText() would remove any newlines in the value.
$found = TRUE;
}
elseif ($field->getTagName() !== 'input' && $field->getText() == $value) {
$found = TRUE;
}
}
}
}
$this->assertTrue($fields && $found, $message);
}
/**
* 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.
*
* @param string $raw
* Raw (HTML) string to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->assertEscaped() instead.
*/
protected function assertEscaped($raw) {
$this->assertSession()
->assertEscaped($raw);
}
/**
* Passes if the raw text is not found escaped on the loaded page.
*
* Raw text refers to the raw HTML that the page generated.
*
* @param string $raw
* Raw (HTML) string to look for.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->assertNoEscaped() instead.
*/
protected function assertNoEscaped($raw) {
$this->assertSession()
->assertNoEscaped($raw);
}
/**
* Triggers a pass if the Perl regex pattern is found in the raw content.
*
* @param string $pattern
* Perl regex to look for including the regex delimiters.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseMatches() instead.
*/
protected function assertPattern($pattern) {
$this->assertSession()
->responseMatches($pattern);
}
/**
* Triggers a pass if the Perl regex pattern is not found in the raw content.
*
* @param string $pattern
* Perl regex to look for including the regex delimiters.
*
* Deprecated in drupal:8.4.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseNotMatches() instead.
*
* @see https://www.drupal.org/node/3129738
*/
protected function assertNoPattern($pattern) {
@trigger_error('AssertLegacyTrait::assertNoPattern() is deprecated in drupal:8.4.0 and is removed from drupal:10.0.0. Use $this->assertSession()->responseNotMatches() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
$this->assertSession()
->responseNotMatches($pattern);
}
/**
* Asserts whether an expected cache tag was present in the last response.
*
* @param string $expected_cache_tag
* The expected cache tag.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseHeaderContains() instead.
*/
protected function assertCacheTag($expected_cache_tag) {
$this->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $expected_cache_tag);
}
/**
* Asserts whether an expected cache tag was absent in the last response.
*
* @param string $cache_tag
* The cache tag to check.
*
* Deprecated in drupal:8.4.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseHeaderNotContains() instead.
*
* @see https://www.drupal.org/node/3129738
*/
protected function assertNoCacheTag($cache_tag) {
@trigger_error('AssertLegacyTrait::assertNoCacheTag() is deprecated in drupal:8.4.0 and is removed from drupal:10.0.0. Use $this->assertSession()->responseHeaderNotContains() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
$this->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', $cache_tag);
}
/**
* Checks that current response header equals value.
*
* @param string $name
* Name of header to assert.
* @param string $value
* Value of the header to assert
*
* Deprecated in drupal:8.3.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->responseHeaderEquals() instead.
*/
protected function assertHeader($name, $value) {
$this->assertSession()
->responseHeaderEquals($name, $value);
}
/**
* Returns WebAssert object.
*
* @param string $name
* (optional) Name of the session. Defaults to the active session.
*
* @return \Drupal\Tests\WebAssert
* A new web-assert option for asserting the presence of elements with.
*/
public abstract function assertSession($name = NULL);
/**
* Builds an XPath query.
*
* Builds an XPath query by replacing placeholders in the query by the value
* of the arguments.
*
* XPath 1.0 (the version supported by libxml2, the underlying XML library
* used by PHP) doesn't support any form of quotation. This function
* simplifies the building of XPath expression.
*
* @param string $xpath
* An XPath query, possibly with placeholders in the form ':name'.
* @param array $args
* An array of arguments with keys in the form ':name' matching the
* placeholders in the query. The values may be either strings or numeric
* values.
*
* @return string
* An XPath query with arguments replaced.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->assertSession()->buildXPathQuery() instead.
*/
protected function buildXPathQuery($xpath, array $args = []) {
return $this->assertSession()
->buildXPathQuery($xpath, $args);
}
/**
* Helper: Constructs an XPath for the given set of attributes and value.
*
* @param string $attribute
* Field attributes.
* @param string $value
* Value of field.
*
* @return string
* XPath for specified values.
*
* Deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use
* $this->getSession()->getPage()->findField() instead.
*/
protected function constructFieldXpath($attribute, $value) {
$xpath = '//textarea[@' . $attribute . '=:value]|//input[@' . $attribute . '=:value]|//select[@' . $attribute . '=:value]';
return $this->buildXPathQuery($xpath, [
':value' => $value,
]);
}
/**
* Gets the current raw content.
*
* Deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use
* $this->getSession()->getPage()->getContent() instead.
*
* @see https://www.drupal.org/node/3129738
*/
protected function getRawContent() {
@trigger_error('AssertLegacyTrait::getRawContent() is deprecated in drupal:8.2.0 and is removed from drupal:10.0.0. Use $this->getSession()->getPage()->getContent() instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
return $this->getSession()
->getPage()
->getContent();
}
/**
* Get all option elements, including nested options, in a select.
*
* @param \Behat\Mink\Element\NodeElement $element
* The element for which to get the options.
*
* @return \Behat\Mink\Element\NodeElement[]
* Option elements in select.
*
* Deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use
* $element->findAll('xpath', 'option') instead.
*
* @see https://www.drupal.org/node/3129738
*/
protected function getAllOptions(NodeElement $element) {
@trigger_error('AssertLegacyTrait::getAllOptions() is deprecated in drupal:8.5.0 and is removed from drupal:10.0.0. Use $element->findAll(\'xpath\', \'option\') instead. See https://www.drupal.org/node/3129738', E_USER_DEPRECATED);
return $element->findAll('xpath', '//option');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
AssertLegacyTrait::assert | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. |
|
AssertLegacyTrait::assertCacheTag | protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait::assertElementNotPresent | protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait::assertElementPresent | protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait::assertEqual | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. |
|
AssertLegacyTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait::assertHeader | protected | function | Checks that current response header equals value. | |
AssertLegacyTrait::assertIdentical | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. |
|
AssertLegacyTrait::assertIdenticalObject | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. |
|
AssertLegacyTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait::assertNoCacheTag | protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait::assertNoEscaped | protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait::assertNoField | protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait::assertNoOption | protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait::assertNoPattern | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait::assertNoRaw | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait::assertNotEqual | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. |
|
AssertLegacyTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | 1 |
AssertLegacyTrait::assertNotIdentical | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. |
|
AssertLegacyTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | 1 |
AssertLegacyTrait::assertResponse | protected | function | Asserts the page responds with the specified response code. | 1 |
AssertLegacyTrait::assertSession | abstract public | function | Returns WebAssert object. | 1 |
AssertLegacyTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | 1 |
AssertLegacyTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait::assertTitle | protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait::assertUrl | protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait::buildXPathQuery | protected | function | Builds an XPath query. | |
AssertLegacyTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait::getRawContent | protected | function | Gets the current raw content. | |
AssertLegacyTrait::pass | protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. |
|
AssertLegacyTrait::verbose | protected | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.