Home Explore Help
Sign In
project
/
farm
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 7a2270befc
Branches Tags
farm
/
mazephp
/
.svn
/
pristine
/
d7
/
d77e785a0126410428f48d4b35bedd93bc16a8e4.svn-base

d77e785a0126410428f48d4b35bedd93bc16a8e4.svn-base 24 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    5. 

  5. <title>PHP Simple HTML DOM Parser: Manual</title>
    6. 

  6. <link href="css/default.css" rel="stylesheet" type="text/css">
    7. 

  7. <link rel="stylesheet" href="css/ui.tabs.css" type="text/css" media="print, projection, screen">
    8. 

  8. <script type="text/javascript" src="js/jquery-1.2.3.pack.js"></script>
    9. 

  9. <script type="text/javascript" src="js/ui.tabs.pack.js"></script>
    10. 

  10. <script language="JavaScript" type="text/JavaScript">
    11. 

  11. 	$(document).ready(function(){
    12. 

  12. 		$(function() {$('#container_quickstart > ul').tabs();});
    13. 

  13. 		$(function() {$('#container_create > ul').tabs();});
    14. 

  14. 		$(function() {$('#container_find > ul').tabs();});
    15. 

  15. 		$(function() {$('#container_access > ul').tabs();});
    16. 

  16. 		$(function() {$('#container_traverse > ul').tabs();});
    17. 

  17. 		$(function() {$('#container_dump > ul').tabs();});
    18. 

  18. 		$(function() {$('#container_callback > ul').tabs();});
    19. 

  19. 	});
    20. 

  20. </script>
    21. 

  21. </head>
    22. 

  22. <body>
    23. 

  23. <h1><a name="top"></a>PHP Simple HTML DOM Parser Manual</h1>
    24. 

  24. <div id="content">
    25. 

  25.   <h2>Index</h2>
    26. 

  26.   <ul>
    27. 

  27. 		<li><a href="#section_quickstart">Quick Start</a></li>
    28. 

  28.     <li><a href="#section_create">How to create HTML DOM object?</a></li>
    29. 

  29.     <li><a href="#section_find">How to find HTML elements?</a></li>
    30. 

  30.     <li><a href="#section_access">How to access the HTML element's attributes?</a> </li>
    31. 

  31.     <li><a href="#section_traverse">How to traverse the DOM tree?</a></li>
    32. 

  32.     <li><a href="#section_dump">How to dump contents of DOM object?</a></li>
    33. 

  33. 		<li><a href="#section_callback">How to customize the parsing behavior?</a></li>
    34. 

  34.     <li><a href="manual_api.htm">API Reference</a></li>
    35. 

  35.     <li><a href="manual_faq.htm">FAQ</a></li>
    36. 

  36.   </ul>
    37. 

  37. 	
    38. 

  38. 	<a name="section_quickstart"></a>
    39. 

  39.   <h2>Quick Start</h2>
    40. 

  40.   <a class="top" href="#top">Top</a>
    41. 

  41. 	<div id="container_quickstart">
    42. 

  42.     <ul>
    43. 

  43.       <li><a href="#fragment-11"><span>Get HTML elements</span></a></li>
    44. 

  44.       <li><a href="#fragment-12"><span>Modify HTML elements</span></a></li>
    45. 

  45.       <li><a href="#fragment-13"><span>Extract contents from HTML</span></a></li>
    46. 

  46.       <li><a href="#fragment-14"><span>Scraping Slashdot!</span></a></li>
    47. 

  47.     </ul>
    48. 

  48.     <div id="fragment-11">
    49. 

  49.       <div class="code">
    50. 

  50.         <span class="comment">// Create DOM from URL or file</span><br>
    51. 

  51.         $html = <strong>file_get_html</strong>(<span class="var">'http://www.google.com/'</span>);<br>
    52. 

  52.         <br>
    53. 

  53.         <span class="comment">// Find all images </span><br>
    54. 

  54.         foreach($html-&gt;<strong>find</strong>(<span class="var">'img'</span>) as $element) <br>
    55. 

  55. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; echo $element-&gt;<strong>src</strong> . <span class="var">'&lt;br&gt;'</span>;<br>
    56. 

  56. <br>
    57. 

  57. <span class="comment">// Find all links </span><br>
    58. 

  58. foreach($html-&gt;<strong>find</strong>(<span class="var">'a'</span>) as $element) <br>
    59. 

  59. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; echo $element-&gt;<strong>href</strong> . <span class="var">'&lt;br&gt;'</span>;      </div>
    60. 

  60.     </div>
    61. 

  61.     <div id="fragment-12">
    62. 

  62.       <div class="code">
    63. 

  63.         <span class="comment">// Create DOM from string</span><br>
    64. 

  64.         $html = <strong>str_get_html</strong>(<span class="var">'&lt;div id=&quot;hello&quot;&gt;Hello&lt;/div&gt;&lt;div id=&quot;world&quot;&gt;World&lt;/div&gt;'</span>);<span class="comment"><br>
    65. 

  65.         <br>
    66. 

  66.         </span>
    67. 

  67.         
    68. 

  68. $html-&gt;<strong>find</strong>(<span class="var">'div', 1</span>)-&gt;<strong>class</strong> = <span class="var">'bar'</span>;<br>
    69. 

  69. <br>
    70. 

  70. $html-&gt;<strong>find</strong>(<span class="var">'div[id=hello]', 0</span>)-&gt;<strong>innertext</strong> = <span class="var">'foo'</span>;<br>
    71. 

  71.         <br>
    72. 

  72.         echo $html; <span class="comment">// Output: &lt;div id=&quot;hello&quot;&gt;<strong>foo</strong>&lt;/div&gt;&lt;div id=&quot;world&quot; <strong>class=&quot;bar&quot;</strong>&gt;World&lt;/div&gt;</span> </div>
    73. 

  73.     </div>
    74. 

  74.     <div id="fragment-13">
    75. 

  75.       <div class="code"><br>
    76. 

  76.         <span class="comment">// Dump contents (without tags) from HTML</span><br>
    77. 

  77.         echo <strong>file_get_html</strong>(<span class="var">'http://www.google.com/'</span>)-&gt;<strong>plaintext</strong>;
    78. 

  78. 				<br>
    79. 

  79. 				<br>
    80. 

  80.       </div>
    81. 

  81.     </div>
    82. 

  82.     <div id="fragment-14">
    83. 

  83.       <div class="code">
    84. 

  84.         <span class="comment">// Create DOM from URL</span><br>
    85. 

  85.         $html = <strong>file_get_html</strong>(<span class="var">'http://slashdot.org/'</span>);<br>
    86. 

  86.         <br>
    87. 

  87.         <span class="comment">// Find all article blocks</span><br>
    88. 

  88.         foreach($html-&gt;<strong>find</strong>(<span class="var">'div.article'</span>) as $article) {<br>
    89. 

  89. &nbsp;&nbsp;&nbsp;&nbsp;$item[<span class="var">'title'</span>]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;= $article-&gt;<strong>find</strong>(<span class="var">'div.title'</span>, <span class="var">0</span>)-&gt;<strong>plaintext</strong>;<br>
    90. 

  90. &nbsp;&nbsp;&nbsp;&nbsp;$item[<span class="var">'intro'</span>]&nbsp;&nbsp;&nbsp;&nbsp;= $article-&gt;<strong>find</strong>(<span class="var">'div.intro'</span>, <span class="var">0</span>)-&gt;<strong>plaintext</strong>;<br>
    91. 

  91. &nbsp;&nbsp;&nbsp;&nbsp;$item[<span class="var">'details'</span>]&nbsp;= $article-&gt;<strong>find</strong>(<span class="var">'div.details'</span>, <span class="var">0</span>)-&gt;<strong>plaintext</strong>;<br>
    92. 

  92. &nbsp;&nbsp;&nbsp;&nbsp;$articles[] = $item;<br>
    93. 

  93.         }<br>
    94. 

  94.         <br>
    95. 

  95.         print_r($articles);
    96. 

  96.       </div>
    97. 

  97.     </div>
    98. 

  98.   </div>
    99. 

  99. 	
    100. 

  100.   <a name="section_create"></a>
    101. 

  101.   <h2>How to create HTML DOM object?</h2>
    102. 

  102.   <a class="top" href="#top">Top</a>
    103. 

  103.   <div id="container_create">
    104. 

  104.     <ul>
    105. 

  105.       <li><a href="#frag_create_quick"><span>Quick way</span></a></li>
    106. 

  106.       <li><a href="#frag_create_oo"><span>Object-oriented way</span></a></li>
    107. 

  107.     </ul>
    108. 

  108.     <div id="frag_create_quick">
    109. 

  109.       <div class="code"><span class="comment">// Create a DOM object from a string</span><br>
    110. 

  110.         $html = <strong>str_get_html</strong>(<span class="var">'&lt;html&gt;&lt;body&gt;Hello!&lt;/body&gt;&lt;/html&gt;'</span>);<br>
    111. 

  111.         <br>
    112. 

  112.         <span class="comment">// Create a DOM object from a URL</span><br>
    113. 

  113.         $html = <strong>file_get_html</strong>(<span class="var">'http://www.google.com/'</span>);<br>
    114. 

  114.         <br>
    115. 

  115.         <span class="comment">// Create a DOM object from a HTML file</span><br>
    116. 

  116.         $html = <strong>file_get_html</strong>(<span class="var">'test.htm'</span>);<span class="comment"><br>
    117. 

  117.         </span></div>
    118. 

  118.     </div>
    119. 

  119.     <div id="frag_create_oo">
    120. 

  120.       <div class="code"><span class="comment">// Create a DOM object</span><br>
    121. 

  121.         $html = new <strong>simple_html_dom</strong>();<br>
    122. 

  122.         <br>
    123. 

  123.         <span class="comment">// Load HTML from a string</span><br>
    124. 

  124.         $html-&gt;<strong>load</strong>(<span class="var">'&lt;html&gt;&lt;body&gt;Hello!&lt;/body&gt;&lt;/html&gt;'</span>);<br>
    125. 

  125.         <br>
    126. 

  126.         <span class="comment">// Load HTML from a URL </span> <br>
    127. 

  127.         $html-&gt;<strong>load_file</strong>(<span class="var">'http://www.google.com/'</span>);<br>
    128. 

  128.         <br>
    129. 

  129.         <span class="comment">// Load HTML from a HTML file</span> <br>
    130. 

  130.         $html-&gt;<strong>load_file</strong>(<span class="var">'test.htm'</span>);</div>
    131. 

  131.     </div>
    132. 

  132.   </div>
    133. 

  133.   <a name="section_find"></a>
    134. 

  134.   <h2>How to find HTML elements?</h2>
    135. 

  135.   <a class="top" href="#top">Top</a>
    136. 

  136.   <div id="container_find">
    137. 

  137.     <ul>
    138. 

  138.       <li><a href="#frag_find_basic"><span>Basics</span></a></li>
    139. 

  139.       <li><a href="#frag_find_advanced"><span>Advanced</span></a></li>
    140. 

  140.       <li><a href="#frag_find_chain"><span>Descendant selectors</span></a></li>
    141. 

  141.       <li><a href="#frag_find_nested"><span>Nested selectors</span></a></li>
    142. 

  142.       <li><a href="#frag_find_attr"><span>Attribute Filters</span></a></li>
    143. 

  143.       <li><a href="#frag_find_textcomment"><span>Text &amp; Comments</span></a></li>
    144. 

  144.     </ul>
    145. 

  145.     <div id="frag_find_basic">
    146. 

  146.       <div class="code"> <span class="comment">// Find all <strong>anchors</strong>, returns a <strong>array</strong> of element objects</span><br>
    147. 

  147.         $ret = $html-&gt;find(<span class="var">'<strong>a</strong>'</span>);<br>
    148. 

  148.         <br>
    149. 

  149.         <span class="comment">// Find <strong>(N)th</strong>  <strong>anchor</strong>, returns element object or <strong>null</strong> if not found</span> <span class="comment">(zero based)</span><br>
    150. 

  150.         $ret = $html-&gt;find(<span class="var">'<strong>a</strong>', <strong>0</strong></span>);<br>
    151. 

  151.         <br>
    152. 

  152.         <span class="comment">// Find <strong>lastest</strong> <strong>anchor</strong>, returns element object or <strong>null</strong> if not found</span> <span class="comment">(zero based)</span><br>
    153. 

  153. $ret = $html-&gt;find(<span class="var">'<strong>a</strong>', <strong>-1</strong></span>);        <br>
    154. 

  154.         <br>
    155. 

  155.         <span class="comment">// Find all <strong>&lt;div&gt;</strong> with the <strong>id</strong> attribute</span><br>
    156. 

  156. $ret = $html-&gt;find(<span class="var">'<strong>div[id]</strong>'</span>);<br>        
    157. 

  157. <br>
    158. 

  158.         <span class="comment">// Find all <strong>&lt;div&gt;</strong> which attribute <strong>id=foo</strong></span><br>
    159. 

  159. $ret = $html-&gt;find(<span class="var">'<strong>div[id=foo]</strong>'</span>);        <br>
    160. 

  160.       </div>
    161. 

  161.     </div>
    162. 

  162.     <div id="frag_find_advanced">
    163. 

  163.       <div class="code"><span class="comment">// Find all element which <strong>id</strong>=foo</span><br>
    164. 

  164.         $ret = $html-&gt;find(<span class="var">'<strong>#foo</strong>'</span>);<br>
    165. 

  165.         <br>
    166. 

  166.         <span class=comment>// Find all element which <strong>class</strong>=foo</span><br>
    167. 

  167.         $ret = $html-&gt;find(<span class=var>'<strong>.foo</strong>'</span>);<br>
    168. 

  168.         <br>
    169. 

  169.         <span class="comment">// Find all element has attribute<strong> id</strong></span><br>
    170. 

  170. $ret = $html-&gt;find(<span class="var">'<strong>*[id]</strong>'</span>);        <br>
    171. 

  171.         <br>
    172. 

  172.         <span class="comment">// Find all <strong>anchors</strong> and <strong>images</strong> </span><br>
    173. 

  173. $ret = $html-&gt;find(<span class="var">'<strong>a, img</strong>'</span>);        <br>
    174. 

  174.         <br>
    175. 

  175.         <span class="comment">// Find all <strong>anchors</strong> and <strong>images</strong> with the "title" attribute</span><br>
    176. 

  176. 				$ret = $html-&gt;find(<span class="var">'<strong>a[title], img[title]</strong>'</span>);<br>
    177. 

  177.       </div>
    178. 

  178.     </div>
    179. 

  179.     <div id="frag_find_attr">
    180. 

  180.       <div class="code">
    181. 

  181. 				Supports these operators in attribute selectors:<br><br>
    182. 

  182.         <table cellpadding="1" cellspacing="1">
    183. 

  183.           <tr>
    184. 

  184.             <th width="25%">Filter</th>
    185. 

  185.             <th width="75%">Description</th>
    186. 

  186.           </tr>
    187. 

  187.           <tr>
    188. 

  188.             <td>[attribute]</td>
    189. 

  189.             <td>Matches elements that <strong>have</strong> the specified attribute.</td>
    190. 

  190.           </tr>
    191. 

  191.           <tr>
    192. 

  192.               <td>[!attribute]</td>
    193. 

  193.               <td>Matches elements that <strong>don't have</strong> the specified attribute.</td>
    194. 

  194.           </tr>
    195. 

  195.           <tr>
    196. 

  196.             <td>[attribute=value]</td>
    197. 

  197.             <td>Matches elements that have the specified attribute with a <strong>certain value</strong>.</td>
    198. 

  198.           </tr>
    199. 

  199.           <tr>
    200. 

  200.             <td>[attribute!=value]</td>
    201. 

  201.             <td>Matches elements that <strong>don't have</strong> the specified attribute with a certain value.</td>
    202. 

  202.           </tr>
    203. 

  203.           <tr>
    204. 

  204.             <td>[attribute^=value]</td>
    205. 

  205.             <td>Matches elements that have the specified attribute and it <strong>starts</strong> with a certain value.</td>
    206. 

  206.           </tr>
    207. 

  207.           <tr>
    208. 

  208.             <td>[attribute$=value]</td>
    209. 

  209.             <td>Matches elements that have the specified attribute and it <strong>ends</strong> with a certain value.</td>
    210. 

  210.           </tr>
    211. 

  211.           <tr>
    212. 

  212.             <td>[attribute*=value]</td>
    213. 

  213.             <td>Matches elements that have the specified attribute and it <strong>contains</strong> a certain value.</td>
    214. 

  214.           </tr>
    215. 

  215.         </table>
    216. 

  216.       </div>
    217. 

  217.     </div>
    218. 

  218.     <div id="frag_find_chain">
    219. 

  219.       <div class="code"><span class="comment">// Find all &lt;li&gt; in &lt;ul&gt; </span><br>
    220. 

  220.         $es = $html-&gt;find(<span class="var">'<strong>ul li</strong>'</span>);<br>
    221. 

  221.         <br>
    222. 

  222.         <span class="comment">// Find Nested &lt;div&gt; </span><span class="comment">tags</span><br>
    223. 

  223.         $es = $html-&gt;find(<span class="var">'<strong>div div div</strong>'</span>); <br>
    224. 

  224.         <br>
    225. 

  225.         <span class="comment">// Find all &lt;td&gt; in &lt;table&gt; which class=hello </span><br>
    226. 

  226.         $es = $html-&gt;find(<span class="var">'<strong>table.hello td</strong>'</span>);<br>
    227. 

  227.         <br>
    228. 

  228.         <span class="comment">// Find all td tags with attribite align=center in table tags </span><br>
    229. 

  229.         $es = $html-&gt;find(<span class="var">''<strong>table</strong><strong> td[align=center]</strong>'</span>);<br>
    230. 

  230.       </div>
    231. 

  231.     </div>
    232. 

  232.     <div id="frag_find_textcomment">
    233. 

  233.       <div class="code"><span class="comment"> // Find all text blocks </span><br>
    234. 

  234.         $es = $html-&gt;find(<span class="var">'<strong>text</strong>'</span>);<br>
    235. 

  235.         <br>
    236. 

  236.         <span class="comment">// Find all comment (&lt;!--...--&gt;) blocks </span><br>
    237. 

  237.         $es = $html-&gt;find(<span class="var">'<strong>comment</strong>'</span>);<br>
    238. 

  238.       </div>
    239. 

  239.     </div>
    240. 

  240.     <div id="frag_find_nested">
    241. 

  241.       <div class="code"> <span class="comment">// Find all &lt;li&gt; in &lt;ul&gt; </span><br>
    242. 

  242.         foreach($html-&gt;find(<span class="var">'<strong>ul</strong>'</span>) as $ul) <br>
    243. 

  243.         {<br>
    244. 

  244. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; foreach($ul-&gt;find(<span class="var">'<strong>li</strong>'</span>) as $li) <br>
    245. 

  245. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; {<br>
    246. 

  246. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <span class="comment">// do something...</span><br>
    247. 

  247. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; }<br>
    248. 

  248.         }<br>
    249. 

  249.         <br>
    250. 

  250.         <span class="comment">// Find first &lt;li&gt; in first &lt;ul&gt;</span> <br>
    251. 

  251.         $e = $html-&gt;find(<span class="var">'<strong>ul</strong>', <strong>0</strong></span>)-&gt;find(<span class="var">'<strong>li</strong>', <strong>0</strong></span>);<br>
    252. 

  252.       </div>
    253. 

  253.     </div>
    254. 

  254.   </div>
    255. 

  255.   <a name="section_access"></a>
    256. 

  256.   <h2>How to access the HTML element's attributes?</h2>
    257. 

  257.   <a class="top" href="#top">Top</a>
    258. 

  258.   <div id="container_access">
    259. 

  259.     <ul>
    260. 

  260.       <li><a href="#frag_access_attr"><span>Get, Set and Remove attributes</span></a></li>
    261. 

  261.       <li><a href="#frag_access_special"><span>Magic attributes</span></a></li>
    262. 

  262.       <li><a href="#frag_access_tips"><span>Tips</span></a></li>
    263. 

  263.     </ul>
    264. 

  264.     <div id="frag_access_attr">
    265. 

  265.       <div class="code"> 
    266. 

  266.         <span class="comment">// <strong>Get</strong> a attribute ( If the attribute is <strong>non-value</strong> attribute (eg. checked, selected...), it will returns <strong>true</strong> or <strong>false</strong>)</span><br>
    267. 

  267.         $value = $e-&gt;<strong>href</strong>;<br>
    268. 

  268.         <br>
    269. 

  269.         <span class="comment">// <strong>Set</strong> a attribute(If the attribute is <strong>non-value</strong> attribute (eg. checked, selected...), set it's value as <strong>true</strong> or <strong>false</strong>)</span><br>
    270. 

  270.         $e-&gt;<strong>href</strong> = <span class="var">'my link'</span>;<br>
    271. 

  271.         <br>
    272. 

  272.         <span class="comment">// <strong>Remove</strong> a attribute, set it's value as null! </span><br>
    273. 

  273.         $e-&gt;<strong>href</strong> = <strong><span class="var">null</span></strong>;<br>
    274. 

  274.         <br>
    275. 

  275.         <span class="comment">// <strong>Determine</strong> whether a attribute exist?</span> <br>
    276. 

  276. if(isset($e-&gt;<strong>href</strong>)) <br>
    277. 

  277. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;echo <span class="var">'href exist!'</span>;<br>
    278. 

  278.       </div>
    279. 

  279.     </div>
    280. 

  280.     <div id="frag_access_special">
    281. 

  281.       <div class="code"> <span class="comment">// Example</span><br>
    282. 

  282.         <span class="hl-var">$</span><span class="hl-code">html = </span>str_get_html<span class="hl-brackets">(</span><span class="var">&quot;&lt;div&gt;foo &lt;b&gt;bar&lt;/b&gt;&lt;/div&gt;&quot;</span><span class="hl-brackets">)</span><span class="hl-code">;</span> <br>
    283. 

  283.         $e = $html-&gt;find(<span class="var">&quot;div&quot;</span>, <span class="var">0</span>);<br>
    284. 

  284.         <br>
    285. 

  285.         echo $e-&gt;<strong>tag</strong>; <span class="comment">// Returns: &quot; <strong>div</strong>&quot;</span><br>
    286. 

  286.         echo $e-&gt;<strong>outertext</strong>; <span class="comment">// Returns: &quot; <strong>&lt;div&gt;foo &lt;b&gt;bar&lt;/b&gt;&lt;/div&gt;</strong>&quot;</span><br>
    287. 

  287.         echo $e-&gt;<strong>innertext</strong>; <span class="comment">// Returns: &quot; <strong>foo &lt;b&gt;bar&lt;/b&gt;</strong>&quot;</span><br>
    288. 

  288.         echo $e-&gt;<strong>plaintext</strong>; <span class="comment">// Returns: &quot; <strong>foo </strong><strong>bar</strong>&quot;<br>
    289. 

  289.         <br>
    290. 

  290.         </span>
    291. 

  291.         <table cellspacing="1" cellpadding="1">
    292. 

  292.           <tr bgcolor="#CCCCCC">
    293. 

  293.             <th width="25%">Attribute Name</th>
    294. 

  294.             <th width="75%">Usage</th>
    295. 

  295.           </tr>
    296. 

  296.           <tr>
    297. 

  297.             <td>$e-&gt;<strong>tag</strong></td>
    298. 

  298.             <td>Read or write the <strong>tag name</strong> of element.</td>
    299. 

  299.           </tr>
    300. 

  300.           <tr>
    301. 

  301.             <td>$e-&gt;<strong>outertext</strong></td>
    302. 

  302.             <td>Read or write the <strong>outer HTML text </strong> of element.</td>
    303. 

  303.           </tr>
    304. 

  304.           <tr>
    305. 

  305.             <td>$e-&gt;<strong>innertext</strong></td>
    306. 

  306.             <td>Read or write the <strong>inner HTML text </strong> of element.</td>
    307. 

  307.           </tr>
    308. 

  308.           <tr>
    309. 

  309.             <td>$e-&gt;<strong>plaintext</strong></td>
    310. 

  310.             <td>Read or write the <strong>plain text </strong> of element.</td>
    311. 

  311.           </tr>
    312. 

  312.         </table>
    313. 

  313.       </div>
    314. 

  314.     </div>
    315. 

  315.     <div id="frag_access_tips">
    316. 

  316.       <div class="code"><span class="comment">// <strong>Extract</strong> contents from HTML </span><br>
    317. 

  317. echo <strong>$html</strong>-&gt;<strong>plaintext</strong>;<br>
    318. 

  318. <br> 
    319. 

  319. <span class="comment">
    320. 

  320.         // <strong>Wrap</strong> a element</span><br>
    321. 

  321.         $e-&gt;<strong>outertext</strong> = <span class="var">'&lt;div class=&quot;wrap&quot;&gt;'</span> . $e-&gt;<strong>outertext</strong> . <span class="var">'&lt;div&gt;</span>';<br>
    322. 

  322.         <br>
    323. 

  323.         <span class="comment">// <strong>Remove</strong> a element, set it's outertext as an empty string </span><br>
    324. 

  324.         $e-&gt;<strong>outertext</strong> = <span class="var">''</span>;<br>
    325. 

  325.         <br>
    326. 

  326.         <span class="comment">// <strong>Append</strong> a element</span><br>
    327. 

  327. $e-&gt;<strong>outertext</strong> = $e-&gt;<strong>outertext</strong> . <span class="var">'&lt;div&gt;foo</span><span class="var">&lt;div&gt;</span>';<br>
    328. 

  328. <br>
    329. 

  329. <span class="comment">// <strong>Insert</strong> a element</span><br>
    330. 

  330. $e-&gt;<strong>outertext</strong> = <span class="var">'&lt;div&gt;foo</span><span class="var">&lt;div&gt;</span>' . $e-&gt;<strong>outertext</strong>;<br>
    331. 

  331.       </div>
    332. 

  332.     </div>
    333. 

  333.   </div>
    334. 

  334.   <a name="section_traverse"></a>
    335. 

  335.   <h2>How to traverse the DOM tree?</h2>
    336. 

  336.   <a class="top" href="#top">Top</a>
    337. 

  337.   <div id="container_traverse">
    338. 

  338.     <ul>
    339. 

  339.       <li><a href="#frag_traverse_background"><span>Background Knowledge</span></a></li>
    340. 

  340.       <li><a href="#frag_traverse_traverse"><span>Traverse the DOM tree</span></a></li>
    341. 

  341.     </ul>
    342. 

  342.     <div id="frag_traverse_background">
    343. 

  343.       <div class="code"> <span class="comment">// If you are not so familiar with HTML DOM, check this <a href="http://php.net/manual/en/book.dom.php" target="_blank"><span class="var">link</span></a> to learn more... </span><br>
    344. 

  344.         <br>
    345. 

  345.         <span class="comment">// Example</span><br>
    346. 

  346.         echo $html-&gt;<strong>find</strong>(<span class="var">&quot;#div1&quot;, 0</span>)-&gt;<strong>children</strong>(<span class="var">1</span>)-&gt;<strong>children</strong>(<span class="var">1</span>)-&gt;<strong>children</strong>(<span class="var">2</span>)-&gt;<span class="var">id</span>;<br>
    347. 

  347.         <span class="comment">// or</span> <br>
    348. 

  348.         echo $html-&gt;<strong>getElementById</strong>(<span class="var">&quot;div1&quot;</span>)-&gt;<strong>childNodes</strong>(<span class="var">1</span>)-&gt;<strong>childNodes</strong>(<span class="var">1</span>)-&gt;<strong>childNodes</strong>(<span class="var">2</span>)-&gt;<strong>getAttribute</strong>(<span class="var">'id'</span>); </div>
    349. 

  349.     </div>
    350. 

  350.     <div id="frag_traverse_traverse">
    351. 

  351.       <div class="code">You can also call methods with <a href="manual_api.htm#camel"><span class="var">Camel naming convertions</span></a>.<br>
    352. 

  352.         <table cellspacing="1" cellpadding="1">
    353. 

  353.           <tr>
    354. 

  354.             <th> Method </th>
    355. 

  355.             <th> Description</th>
    356. 

  356.           </tr>
    357. 

  357.           <tr>
    358. 

  358.             <td>
    359. 

  359.               <div class="returns">mixed</div>$e-&gt;<strong>children</strong> ( <span class="var">[int $index]</span> ) </td>
    360. 

  360.             <td>Returns the Nth <strong>child object</strong> if <strong>index</strong> is set, otherwise return an <strong>array of children</strong>. </td>
    361. 

  361.           </tr>
    362. 

  362.           <tr>
    363. 

  363.             <td>
    364. 

  364.               <div class="returns">element</div>$e-&gt;<strong>parent</strong> () </td>
    365. 

  365.             <td>Returns the <strong>parent</strong> of element. </td>
    366. 

  366.           </tr>
    367. 

  367.           <tr>
    368. 

  368.             <td>
    369. 

  369.               <div class="returns">element</div>$e-&gt;<strong>first_child</strong> () </td>
    370. 

  370.             <td>Returns the <strong>first child</strong> of element, or <strong>null</strong> if not found. </td>
    371. 

  371.           </tr>
    372. 

  372.           <tr>
    373. 

  373.             <td>
    374. 

  374.               <div class="returns">element</div>$e-&gt;<strong>last_child</strong> () </td>
    375. 

  375.             <td>Returns the <strong>last child</strong> of element, or <strong>null</strong> if not found. </td>
    376. 

  376.           </tr>
    377. 

  377.           <tr>
    378. 

  378.             <td>
    379. 

  379.               <div class="returns">element</div>$e-&gt;<strong>next_sibling</strong> () </td>
    380. 

  380.             <td>Returns the <strong>next sibling</strong> of element, or<strong> null</strong> if not found. </td>
    381. 

  381.           </tr>
    382. 

  382.           <tr>
    383. 

  383.             <td>
    384. 

  384.               <div class="returns">element</div>$e-&gt;<strong>prev_sibling</strong> () </td>
    385. 

  385.             <td>Returns the <strong>previous sibling</strong> of element, or <strong>null</strong> if not found. </td>
    386. 

  386.           </tr>
    387. 

  387.         </table>
    388. 

  388.       </div>
    389. 

  389.     </div>
    390. 

  390.     
    391. 

  391.   </div>
    392. 

  392.   <a name="section_dump"></a>
    393. 

  393.   <h2>How to dump contents of DOM object?</h2>
    394. 

  394.   <a class="top" href="#top">Top</a>
    395. 

  395.   <div id="container_dump">
    396. 

  396.     <ul>
    397. 

  397.       <li><a href="#frag_dump_quick"><span>Quick way</span></a></li>
    398. 

  398.       <li><a href="#frag_dump_oo"><span>Object-oriented way</span></a></li>
    399. 

  399.     </ul>
    400. 

  400.     <div id="frag_dump_oo">
    401. 

  401.       <div class="code"><span class="comment">// </span><span class="comment">Dumps the internal DOM tree back into string </span><br>
    402. 

  402.         $str = $html-&gt;<strong>save</strong>();<br>
    403. 

  403.         <br>
    404. 

  404.         <span class="comment">// Dumps the internal DOM tree back into a file</span> <br>
    405. 

  405.         $html-&gt;<strong>save</strong>(<span class="var">'result.htm'</span>);</div>
    406. 

  406.     </div>
    407. 

  407.     <div id="frag_dump_quick">
    408. 

  408.       <div class="code"><span class="comment">// </span><span class="comment">Dumps the internal DOM tree back into string </span><br>
    409. 

  409.         $str = $html;<br>
    410. 

  410.         <br>
    411. 

  411.         <span class="comment">// Print it!</span><br>
    412. 

  412.         echo $html; <br>
    413. 

  413.       </div>
    414. 

  414.     </div>
    415. 

  415.   </div>
    416. 

  416. 	<a name="section_callback"></a>
    417. 

  417.   <h2>How to customize the parsing behavior?</h2>
    418. 

  418.   <a class="top" href="#top">Top</a>
    419. 

  419.   <div id="container_callback">
    420. 

  420.     <ul>
    421. 

  421.       <li><a href="#frag_callback"><span>Callback function</span></a></li>
    422. 

  422.     </ul>
    423. 

  423.     <div id="frag_callback">
    424. 

  424.       <div class="code"><span class="comment">// Write a function with parameter &quot;<strong>$element</strong>&quot;</span><br>
    425. 

  425.         function my_callback(<span class="var">$element</span>) {<br>
    426. 

  426.         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="comment">// Hide all &lt;b&gt; tags </span><br>
    427. 

  427. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if ($element-&gt;tag==<span class="var">'b'</span>)<br> 
    428. 

  428.         &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;$element-&gt;outertext = '';<br>
    429. 

  429.         } <br>
    430. 

  430.         <br>
    431. 

  431.         <span class="comment">// Register the  callback function with it's <strong>function name</strong></span><br>
    432. 

  432.         $html-&gt;<strong>set_callback</strong>(<span class="var">'my_callback'</span>);<br>
    433. 

  433.         <br>
    434. 

  434.         <span class="comment">// Callback function will be invoked while dumping</span><br>
    435. 

  435.         echo $html;
    436. 

  436.       </div>
    437. 

  437.     </div>
    438. 

  438.   </div>
    439. 

  439. 

  440.   <div><br>
    441. 

  441.     Author: S.C. Chen (me578022@gmail.com)<br>
    442. 

  442. Original idea is from Jose Solorzano's <a href="http://php-html.sourceforge.net/">HTML Parser for PHP 4</a>. <br>
    443. 

  443. Contributions by: Contributions by: Yousuke Kumakura, Vadim Voituk, Antcs<br>
    444. 

  444.   </div>
    445. 

  445. </div>
    446. 

  446. </body>
    447. 

  447. </html>
    448. 

  448. <!--$Rev: 165 $-->
    449.