function AssertContentTrait::xpath

Same name and namespace in other branches
  1. 11.x core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::xpath()
  2. 10 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::xpath()
  3. 8.9.x core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::xpath()

Performs an xpath search on the contents of the internal browser.

The search is relative to the root element (HTML tag normally) of the page.

Parameters

string $xpath: The xpath string to use in the search.

array $arguments: 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 value

\SimpleXMLElement[]|bool The return value of the xpath search or FALSE on failure. For details on the xpath string format and return values see the SimpleXML documentation.

See also

http://php.net/manual/function.simplexml-element-xpath.php

1 call to AssertContentTrait::xpath()
FieldDisplayTest::testFieldVisualHidden in core/modules/field/tests/src/Kernel/FieldDisplayTest.php
Tests that visually hidden works with core.

File

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

Class

AssertContentTrait
Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function xpath($xpath, array $arguments = []) {
  if ($this->parse()) {
    $xpath = $this->buildXPathQuery($xpath, $arguments);
    $result = $this->elements
      ->xpath($xpath);
    // Some combinations of PHP / libxml versions return an empty array
    // instead of the documented FALSE. Forcefully convert any falsish values
    // to an empty array to allow foreach(...) constructions.
    return $result ?: [];
  }
  return FALSE;
}

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