Merge branch 'develop'

zendframework · Oct 14, 2015 · c89f2d8 · c89f2d8
2 parents 46caa59 + c359837
commit c89f2d8
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file, in reverse chronological order by release.
 
+## 2.6.0 - TBD
+
+### Added
+
+- [#2](https://github.com/zendframework/zend-dom/pull/4) ads context node
+  support for DOMXPath->query that supports querying in the context of a
+  specific node.
+
+### Deprecated
+
+- Nothing.
+
+### Removed
+
+- Nothing.
+
+### Fixed
+
+- Nothing.
+
 ## 2.5.2 - TBD
 
 ### Added

diff --git a/src/DOMXPath.php b/src/DOMXPath.php
@@ -27,15 +27,20 @@ class DOMXPath extends \DOMXPath
      * raising an error
      *
      * @param string $expression The XPath expression to evaluate.
+     * @param \DOMNode $contextNode
      * @return \DOMNodeList
      * @throws ErrorException
      */
-    public function queryWithErrorException($expression)
+    public function queryWithErrorException($expression, \DOMNode $contextNode = null)
     {
         $this->errors = [null];
 
-        set_error_handler([$this, 'addError'], E_WARNING);
-        $nodeList = $this->query($expression);
+        if ($contextNode === null) {
+            $contextNode = $this->document->documentElement;
+        }
+
+        set_error_handler([$this, 'addError'], \E_WARNING);
+        $nodeList = $this->query($expression, $contextNode);
         restore_error_handler();
 
         $exception = array_pop($this->errors);

diff --git a/src/Document/Query.php b/src/Document/Query.php
@@ -30,9 +30,10 @@ class Query
      * @param  string    $expression CSS selector or XPath query
      * @param  Document  $document   Document to query
      * @param  string    $type       The type of $expression
+     * @param  \DOMNode  $contextNode
      * @return NodeList
      */
-    public static function execute($expression, Document $document, $type = self::TYPE_XPATH)
+    public static function execute($expression, Document $document, $type = self::TYPE_XPATH, \DOMNode $contextNode = null)
     {
         // Expression check
         if ($type === static::TYPE_CSS) {
@@ -50,7 +51,7 @@ public static function execute($expression, Document $document, $type = self::TY
             ($xpathPhpfunctions === true) ? $xpath->registerPHPFunctions() : $xpath->registerPHPFunctions($xpathPhpfunctions);
         }
 
-        $nodeList = $xpath->queryWithErrorException($expression);
+        $nodeList = $xpath->queryWithErrorException($expression, $contextNode);
         return new NodeList($nodeList);
     }
 

diff --git a/src/NodeList.php b/src/NodeList.php
@@ -51,20 +51,27 @@ class NodeList implements Iterator, Countable, ArrayAccess
      */
     protected $xpathQuery;
 
+    /**
+     * @var DOMNode|null
+     */
+    protected $contextNode;
+
     /**
      * Constructor
      *
      * @param string       $cssQuery
      * @param string|array $xpathQuery
      * @param DOMDocument  $document
      * @param DOMNodeList  $nodeList
+     * @param DOMNode|null $contextNode
      */
-    public function __construct($cssQuery, $xpathQuery, DOMDocument $document, DOMNodeList $nodeList)
+    public function __construct($cssQuery, $xpathQuery, DOMDocument $document, DOMNodeList $nodeList, DOMNode $contextNode = null)
     {
-        $this->cssQuery   = $cssQuery;
-        $this->xpathQuery = $xpathQuery;
-        $this->document   = $document;
-        $this->nodeList   = $nodeList;
+        $this->cssQuery    = $cssQuery;
+        $this->xpathQuery  = $xpathQuery;
+        $this->document    = $document;
+        $this->nodeList    = $nodeList;
+        $this->contextNode = $contextNode;
     }
 
     /**
@@ -97,6 +104,16 @@ public function getDocument()
         return $this->document;
     }
 
+    /**
+     * Retrieve context node
+     *
+     * @return DOMNode
+     */
+    public function getContextNode()
+    {
+        return $this->contextNode;
+    }
+
     /**
      * Iterator: rewind to first element
      *

diff --git a/src/Query.php b/src/Query.php
@@ -206,23 +206,25 @@ public function getDocumentErrors()
      * Perform a CSS selector query
      *
      * @param  string $query
+     * @param  DOMNode $contextNode
      * @return NodeList
      */
-    public function execute($query)
+    public function execute($query, DOMNode $contextNode = null)
     {
         $xpathQuery = Document\Query::cssToXpath($query);
-        return $this->queryXpath($xpathQuery, $query);
+        return $this->queryXpath($xpathQuery, $query, $contextNode);
     }
 
     /**
      * Perform an XPath query
      *
      * @param  string|array $xpathQuery
      * @param  string|null  $query      CSS selector query
+     * @param  DOMNode $contextNode $contextNode
      * @throws Exception\RuntimeException
      * @return NodeList
      */
-    public function queryXpath($xpathQuery, $query = null)
+    public function queryXpath($xpathQuery, $query = null, DOMNode $contextNode = null)
     {
         if (null === ($document = $this->getDocument())) {
             throw new Exception\RuntimeException('Cannot query; no document registered');
@@ -266,8 +268,8 @@ public function queryXpath($xpathQuery, $query = null)
             throw new Exception\RuntimeException(sprintf('Error parsing document (type == %s)', $type));
         }
 
-        $nodeList   = $this->getNodeList($domDoc, $xpathQuery);
-        return new NodeList($query, $xpathQuery, $domDoc, $nodeList);
+        $nodeList   = $this->getNodeList($domDoc, $xpathQuery, $contextNode);
+        return new NodeList($query, $xpathQuery, $domDoc, $nodeList, $contextNode);
     }
 
     /**
@@ -297,10 +299,11 @@ public function registerXpathPhpFunctions($xpathPhpFunctions = true)
      *
      * @param  DOMDocument $document
      * @param  string|array $xpathQuery
+     * @param  DOMNode $contextNode
      * @return \DOMNodeList
      * @throws \ErrorException If query cannot be executed
      */
-    protected function getNodeList($document, $xpathQuery)
+    protected function getNodeList($document, $xpathQuery, DOMNode $contextNode = null)
     {
         $xpath      = new DOMXPath($document);
         foreach ($this->xpathNamespaces as $prefix => $namespaceUri) {
@@ -314,7 +317,7 @@ protected function getNodeList($document, $xpathQuery)
         }
         $xpathQuery = (string) $xpathQuery;
 
-        $nodeList = $xpath->queryWithErrorException($xpathQuery);
+        $nodeList = $xpath->queryWithErrorException($xpathQuery, $contextNode);
         return $nodeList;
     }
 }
diff --git a/test/DocumentTest.php b/test/DocumentTest.php
@@ -360,4 +360,13 @@ public function testLoadingXmlContainingDoctypeShouldFailToPreventXxeAndXeeAttac
         $this->setExpectedException(RuntimeException::class);
         Document\Query::execute('/', $this->document);
     }
+
+    public function testContextNode()
+    {
+        $this->loadHtml();
+        $results = Document\Query::execute('//div[@id="subnav"]', $this->document, Document\Query::TYPE_XPATH);
+        $contextNode = $results[0];
+        $results = Document\Query::execute('.//li', $this->document, Document\Query::TYPE_XPATH, $contextNode);
+        $this->assertSame('Item 1', $results[0]->nodeValue);
+    }
 }