1 backdrop_web_test_case.php protected BackdropWebTestCase::buildXPathQuery($xpath, array $args = array())

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.


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

$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

An XPath query with arguments replaced.:


core/modules/simpletest/backdrop_web_test_case.php, line 2813


Test case for typical Backdrop tests.


protected function buildXPathQuery($xpath, array $args = array()) {
  // Replace placeholders.
  foreach ($args as $placeholder => $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];
    $xpath = preg_replace('/' . preg_quote($placeholder) . '\b/', $value, $xpath);
  return $xpath;