Change $dom to $document (DOMDocument) or $fd (FluentDOM::Query)

ThomasWeinert · Jun 28, 2017 · bb675a3 · bb675a3
1 parent cda9ca8
commit bb675a3
Show file tree

Hide file tree

Showing 76 changed files with 1,128 additions and 1,121 deletions.
diff --git a/examples/Creator/Tutorial/06.php b/examples/Creator/Tutorial/06.php
@@ -2,14 +2,14 @@
 <?php
 require(__DIR__.'/../../../vendor/autoload.php');
 
-$dom = new FluentDOM\Document();
-$dom->loadHtml(
+$document = new FluentDOM\Document();
+$document->loadHtml(
   '<!DOCTYPE html>
    <html><body><div id="navigation"/></body></html>'
 );
 
 $_ = FluentDOM::create();
-$dom
+$document
   ->getElementById('navigation')
   ->append(
     $_(
@@ -22,4 +22,4 @@
     )
   );
 
-echo $dom->saveHtml();
+echo $document->saveHtml();
diff --git a/examples/Creator/Tutorial/08.php b/examples/Creator/Tutorial/08.php
@@ -1,8 +1,8 @@
 <?php
 require('../../../vendor/autoload.php');
 
-$dom = new FluentDOM\Document();
-$dom->loadXml(
+$document = new FluentDOM\Document();
+$document->loadXml(
   '<div>
     <ul>
       <li><a href="http://fluentdom.org">FluentDOM</a></li>
@@ -14,4 +14,4 @@
 $_ = FluentDOM::create();
 $_->formatOutput = TRUE;
 
-echo $_('p', $dom('//a'));
+echo $_('p', $document('//a'));
diff --git a/examples/Extended DOM/ArrayAccess.php b/examples/Extended DOM/ArrayAccess.php
@@ -30,11 +30,11 @@
  * Otherwise it will return the attribute value.
  */
 
-$dom = new FluentDOM\Document();
-$dom->preserveWhiteSpace = FALSE;
-$dom->loadXML($xml);
-$dom->registerNamespace('atom', 'http://www.w3.org/2005/Atom');
+$document = new FluentDOM\Document();
+$document->preserveWhiteSpace = FALSE;
+$document->loadXML($xml);
+$document->registerNamespace('atom', 'http://www.w3.org/2005/Atom');
 
-foreach ($dom->evaluate('//atom:entry/atom:link') as $entry) {
+foreach ($document->evaluate('//atom:entry/atom:link') as $entry) {
   echo $entry['href'], "\n";
 }
diff --git a/examples/Extended DOM/Xpath.php b/examples/Extended DOM/Xpath.php
@@ -6,9 +6,9 @@
  * from a location path. It allows you to fetch a single node
  * result as a node (or null).
  */
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml>Hello World</xml>');
-$xpath = new FluentDOM\Xpath($dom);
+$document = new FluentDOM\Document();
+$document->loadXml('<xml>Hello World</xml>');
+$xpath = new FluentDOM\Xpath($document);
 echo $xpath->firstOf('//xml');
 
 /*
@@ -17,9 +17,9 @@
  * the string contains both types of quote characters.
  */
 $value = "World";
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml>Hello World</xml>');
-$xpath = new FluentDOM\Xpath($dom);
+$document = new FluentDOM\Document();
+$document->loadXml('<xml>Hello World</xml>');
+$xpath = new FluentDOM\Xpath($document);
 echo $xpath->evaluate(
   'string(//xml[contains(., '.$xpath->quote($value).')])'
 );
diff --git a/examples/Extended DOM/__toString.php b/examples/Extended DOM/__toString.php
@@ -6,18 +6,18 @@
  * of the node classes, allowing for implicit and explict string casts.
  */
 
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml>Hello World!</xml>');
-echo $dom->documentElement->firstChild;
+$document = new FluentDOM\Document();
+$document->loadXml('<xml>Hello World!</xml>');
+echo $document->documentElement->firstChild;
 
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml><![CDATA[Hello World!]]></xml>');
-echo $dom->documentElement->firstChild;
+$document = new FluentDOM\Document();
+$document->loadXml('<xml><![CDATA[Hello World!]]></xml>');
+echo $document->documentElement->firstChild;
 
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml attr="Hello World!"/>');
-echo $dom->documentElement->getAttributeNode('attr');
+$document = new FluentDOM\Document();
+$document->loadXml('<xml attr="Hello World!"/>');
+echo $document->documentElement->getAttributeNode('attr');
 
-$dom = new FluentDOM\Document();
-$dom->loadXml('<xml><!--Hello World!--></xml>');
-echo $dom->documentElement->firstChild;
+$document = new FluentDOM\Document();
+$document->loadXml('<xml><!--Hello World!--></xml>');
+echo $document->documentElement->firstChild;
diff --git a/examples/Loader/IniLoader.php b/examples/Loader/IniLoader.php
@@ -12,10 +12,10 @@ public function load($source, $contentType = 'text/ini', $options = []) {
         throw new InvalidArgumentException('File not found: '. $source);
       }
       if ($iniFile = parse_ini_file($source)) {
-        $dom = new FluentDOM\Document();
-        $root = $dom->appendChild($dom->createElement('ini'));
-        $this->_arrayToNodes($dom, $root, $iniFile);
-        return $dom;
+        $document = new FluentDOM\Document();
+        $root = $document->appendChild($document->createElement('ini'));
+        $this->_arrayToNodes($document, $root, $iniFile);
+        return $document;
       }
     }
     return FALSE;
@@ -25,32 +25,32 @@ public function loadFragment($source, $contentType = 'text/ini', $options = [])
     throw new \FluentDOM\Exceptions\InvalidFragmentLoader(self::class);
   }
 
-  private function _arrayToNodes(FluentDOM\Document $dom, DOMNode $node, $data) {
+  private function _arrayToNodes(FluentDOM\Document $document, DOMNode $node, $data) {
     if (is_array($data)) {
       foreach ($data as $key => $val) {
         if (preg_match('(^\d+$)', $key)) {
           $nodeName = $node->nodeName;
           if (substr($nodeName, -1) == 's') {
             $nodeName = substr($nodeName, 0, -1);
           }
-          $childNode = $dom->createElement($nodeName);
-          $this->_arrayToNodes($dom, $childNode, $val);
+          $childNode = $document->createElement($nodeName);
+          $this->_arrayToNodes($document, $childNode, $val);
           $node->appendChild($childNode);
         } elseif (is_array($val)) {
-          $childNode = $dom->createElement($key);
-          $this->_arrayToNodes($dom, $childNode, $val);
+          $childNode = $document->createElement($key);
+          $this->_arrayToNodes($document, $childNode, $val);
           $node->appendChild($childNode);
         } elseif (preg_match('([\r\n\t])', $val)) {
-          $childNode = $dom->createElement($key);
-          $textNode = $dom->createTextNode($val);
+          $childNode = $document->createElement($key);
+          $textNode = $document->createTextNode($val);
           $childNode->appendChild($textNode);
           $node->appendChild($childNode);
         } else {
-          $node->appendChild($dom->createElement($key, $val));
+          $node->appendChild($document->createElement($key, $val));
         }
       }
     } elseif (!empty($data)) {
-      $textNode = $dom->createTextNode($data);
+      $textNode = $document->createTextNode($data);
       $node->appendChild($textNode);
     }
   }

diff --git a/examples/Query/Interfaces/ArrayAccess.php b/examples/Query/Interfaces/ArrayAccess.php
@@ -16,5 +16,5 @@
 
 require_once('../../../vendor/autoload.php');
 
-$dom = FluentDOM($xml)->find('//p');
-echo $dom[0], ' ', $dom[2];
+$fd = FluentDOM($xml)->find('//p');
+echo $fd[0], ' ', $fd[2];
diff --git a/examples/Query/Tasks/replaceMarkup.php b/examples/Query/Tasks/replaceMarkup.php
@@ -1,6 +1,6 @@
 <?php
 
-require('../../vendor/autoload.php');
+require('../../../vendor/autoload.php');
 $markup = new FluentDOMMarkupReplacer();
 
 $html = <<<HTML
@@ -124,14 +124,14 @@ public function replaceNode(DOMText $node) {
   /**
   * Create nodes for the given string
   *
-  * @param DOMDocument $dom
+  * @param DOMDocument $document
   * @param string $string
-  * @return DOMElement
+  * @return DOMElement|DOMText
   */
-  private function createNodes($dom, $string) {
+  private function createNodes($document, $string) {
     foreach ($this->_replacements as $pattern => $replacement) {
       if (preg_match($pattern, $string)) {
-        $node = $dom->createElement($replacement[0]);
+        $node = $document->createElement($replacement[0]);
         foreach ($replacement[1] as $attributeName => $attributePattern) {
           $node->setAttribute(
             $attributeName,
@@ -140,7 +140,7 @@ private function createNodes($dom, $string) {
             )
           );
         }
-        $text = $dom->createTextNode(
+        $text = $document->createTextNode(
           preg_replace(
             $pattern, $replacement[2], $string
           )
@@ -149,7 +149,7 @@ private function createNodes($dom, $string) {
         return $node;
       }
     }
-    return $dom->createTextNode(
+    return $document->createTextNode(
       strtr($string, $this->_escapings)
     );
   }

diff --git a/examples/Query/add.php b/examples/Query/add.php
@@ -20,34 +20,34 @@
 XML;
 
 require('../../vendor/autoload.php');
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->find('//p')
   ->add('//p/b')
   ->toggleClass('inB');
 
 echo "\n\n";
 
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->find('//p')
   ->add(
-    $dom->find('//div')
+    $fd->find('//div')
   )
   ->toggleClass('inB');
 
 echo "\n\n";
 
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->add(
-    $dom->find('//div')
+    $fd->find('//div')
   )
   ->toggleClass('inB');
 
 echo "\n\n";
 
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->add('//div')
   ->toggleClass('inB');
diff --git a/examples/Query/addBack.php b/examples/Query/addBack.php
@@ -20,20 +20,20 @@
 XML;
 
 require('../../vendor/autoload.php');
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->find('//p')
   ->find('.//b')
   ->addBack()
   ->toggleClass('inB');
 
 echo "\n\n";
 
-$dom = FluentDOM($xml);
-echo $dom
+$fd = FluentDOM($xml);
+echo $fd
   ->find('//p')
   ->find(
-    $dom->find('//div')
+    $fd->find('//div')
   )
   ->addBack()
   ->toggleClass('inB');

diff --git a/examples/Query/append.php b/examples/Query/append.php
@@ -35,9 +35,9 @@
 
 echo "\n\n";
 
-$dom = FluentDOM($html);
-$items = $dom->find('//group/item');
-echo $dom
+$fd = FluentDOM($html);
+$items = $fd->find('//group/item');
+echo $fd
   ->find('//html/div')
   ->append($items)
   ->formatOutput();
diff --git a/examples/Query/attr.php b/examples/Query/attr.php
@@ -25,8 +25,8 @@
 
 
 echo "Example for function 'attr' using XML namespaces:\n\n";
-$dom = FluentDOM($xml);
-$dom->registerNamespace('h', 'http://www.w3.org/1999/xhtml');
-echo $dom
+$fd = FluentDOM($xml);
+$fd->registerNamespace('h', 'http://www.w3.org/1999/xhtml');
+echo $fd
   ->find('//h:a')
   ->attr('href');
diff --git a/examples/Query/closest.php b/examples/Query/closest.php
@@ -31,8 +31,8 @@
 </html>
 HTML;
 
-$dom = FluentDOM($xml, 'text/html');
-echo $dom
+$fd = FluentDOM($xml, 'text/html');
+echo $fd
   ->find('//u')
   ->closest('self::li')
   ->addClass('foundIt');
diff --git a/examples/Query/is.php b/examples/Query/is.php
@@ -18,9 +18,9 @@
 </html>
 HTML;
 
-$dom = FluentDOM($html, 'text/html');
+$fd = FluentDOM($html, 'text/html');
 var_dump(
-  $dom
+  $fd
     ->find('//input[@type = "checkbox"]')
     ->parent()
     ->is('name() = "form"')

diff --git a/examples/Query/load.php b/examples/Query/load.php
@@ -2,10 +2,10 @@
 
 require_once('../../vendor/autoload.php');
 
-$dom = new DOMDocument();
-$dom->loadXML('<message>Hello World!</message>');
+$document = new DOMDocument();
+$document->loadXML('<message>Hello World!</message>');
 $fd = new FluentDOM\Nodes();
-$fd->load($dom);
+$fd->load($document);
 
 foreach ($fd->find('//message') as $message) {
   echo $message->nodeValue;

diff --git a/examples/Query/map.php b/examples/Query/map.php
@@ -22,13 +22,13 @@
 </html>
 HTML;
 
-$dom = FluentDOM($html);
-echo $dom
+$fd = FluentDOM($html);
+echo $fd
   ->find('//p')
   ->append(
     implode(
       ', ',
-      $dom
+      $fd
         ->find('//input')
         ->map(
           function($node, $index) {