protected function AssertContentTrait::buildXPathQuery in Drupal 9

Same name and namespace in other branches

1. 8 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::buildXPathQuery()
2. 10 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::buildXPathQuery()

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.

Parameters

string $xpath: An XPath query, possibly with placeholders in the form ':name'.

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 value

string An XPath query with arguments replaced.

4 calls to AssertContentTrait::buildXPathQuery()

AssertContentTrait::constructFieldXpath in core/tests/Drupal/KernelTests/AssertContentTrait.php

Helper: Constructs an XPath for the given set of attributes and value.

AssertContentTrait::xpath in core/tests/Drupal/KernelTests/AssertContentTrait.php

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

FieldRdfaTestBase::xpathContent in core/modules/rdf/tests/src/Kernel/Field/FieldRdfaTestBase.php

Performs an xpath search on a certain content.

FormElementsRenderTest::assertRenderedElement in core/modules/system/tests/src/Kernel/Common/FormElementsRenderTest.php

Tests that elements are rendered properly.

File

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

Class

AssertContentTrait

Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function buildXPathQuery($xpath, array $args = []) {

  // Replace placeholders.
  foreach ($args as $placeholder => $value) {

    // Cast MarkupInterface objects to string.
    if (is_object($value)) {
      $value = (string) $value;
    }

    // XPath 1.0 doesn't support a way to escape single or double quotes in a
    // string literal. We split double quotes out of the string, and encode
    // them separately.
    if (is_string($value)) {

      // Explode the text at the quote characters.
      $parts = explode('"', $value);

      // Quote the parts.
      foreach ($parts as &$part) {
        $part = '"' . $part . '"';
      }

      // Return the string.
      $value = count($parts) > 1 ? 'concat(' . implode(', \'"\', ', $parts) . ')' : $parts[0];
    }

    // Use preg_replace_callback() instead of preg_replace() to prevent the
    // regular expression engine from trying to substitute backreferences.
    $replacement = function ($matches) use ($value) {
      return $value;
    };
    $xpath = preg_replace_callback('/' . preg_quote($placeholder) . '\\b/', $replacement, $xpath);
  }
  return $xpath;
}