From d619bb8e5e5b4bf98590b040a5357ca943e586f6 Mon Sep 17 00:00:00 2001
From: Peter Cowburn <salathe@php.net>
Date: Mon, 31 Oct 2011 22:59:44 +0000
Subject: [PATCH] document DOMNode::getNodePath()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@318622 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/dom/domnode/getnodepath.xml | 109 ++++++++++++++++++++++++++
 1 file changed, 109 insertions(+)
 create mode 100644 reference/dom/domnode/getnodepath.xml

diff --git a/reference/dom/domnode/getnodepath.xml b/reference/dom/domnode/getnodepath.xml
new file mode 100644
index 0000000000..6d07497008
--- /dev/null
+++ b/reference/dom/domnode/getnodepath.xml
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="domnode.getnodepath" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>DOMNode::getNodePath</refname>
+  <refpurpose>Get an XPath for a node</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>string</type><methodname>DOMNode::getNodePath</methodname>
+   <void />
+  </methodsynopsis>
+  <para>
+   Gets an XPath location path for the node.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a <type>string</type> containing the XPath, or &null; in case of an error.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title><methodname>DOMNode::getNodePath</methodname> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+// Create a new DOMDocument instance
+$dom = new DOMDocument;
+
+// Load the XML
+$dom->loadXML('
+<fruits>
+ <apples>
+  <apple>braeburn</apple>
+  <apple>granny smith</apple>
+ </apples>
+ <pears>
+  <pear>conference</pear>
+ </pears>
+</fruits>
+');
+
+// Print XPath for each element
+foreach ($dom->getElementsByTagName('*') as $node) {
+    echo $node->getNodePath() . "\n";
+}
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+/fruits
+/fruits/apples
+/fruits/apples/apple[1]
+/fruits/apples/apple[2]
+/fruits/pears
+/fruits/pears/pear
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><classname>DOMXPath</classname></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->