Home Explore Help
Sign In
usic
/
ums
Watch 2
Star 0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
ums
/
lib
/
php-openid
/
doc
/
OpenID
/
Auth_Yadis_XMLParser.html

Auth_Yadis_XMLParser.html 15 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374 
  1. <?xml version="1.0" encoding="iso-8859-1"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3.   <html xmlns="http://www.w3.org/1999/xhtml">
    4. 

  4. 		<head>
    5. 

  5. 			<!-- template designed by Marco Von Ballmoos -->
    6. 

  6. 			<title>Docs For Class Auth_Yadis_XMLParser</title>
    7. 

  7. 			<link rel="stylesheet" href="../media/stylesheet.css" />
    8. 

  8. 			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
    9. 

  9. 		</head>
    10. 

  10. 		<body>
    11. 

  11. 			<div class="page-body">			
    12. 

  12. <h2 class="class-name">Class Auth_Yadis_XMLParser</h2>
    13. 

  13. 

  14. <a name="sec-description"></a>
    15. 

  15. <div class="info-box">
    16. 

  16. 	<div class="info-box-title">Description</div>
    17. 

  17. 	<div class="nav-bar">
    18. 

  18. 					<span class="disabled">Description</span> |
    19. 

  19. 							<a href="#sec-descendents">Descendents</a>
    20. 

  20. 			|													<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    21. 

  21. 						
    22. 

  22. 					</div>
    23. 

  23. 	<div class="info-box-body">
    24. 

  24.         		<!-- ========== Info from phpDoc block ========= -->
    25. 

  25. <p class="short-description">The base class for wrappers for available PHP XML-parsing</p>
    26. 

  26. <p class="description"><p>extensions.  To work with this Yadis library, subclasses of this  class MUST implement the API as defined in the remarks for this  class.  Subclasses of Auth_Yadis_XMLParser are used to wrap  particular PHP XML extensions such as 'domxml'.  These are used  internally by the library depending on the availability of  supported PHP XML extensions.</p></p>
    27. 

  27. 		<p class="notes">
    28. 

  28. 			Located in <a class="field" href="_Auth---Yadis---XML.php.html">/Auth/Yadis/XML.php</a> (line <span class="field">21</span>)
    29. 

  29. 		</p>
    30. 

  30. 		
    31. 

  31. 				
    32. 

  32. 		<pre></pre>
    33. 

  33. 	
    34. 

  34. 			</div>
    35. 

  35. </div>
    36. 

  36. 

  37. 	<a name="sec-descendents"></a>
    38. 

  38. 	<div class="info-box">
    39. 

  39. 		<div class="info-box-title">Direct descendents</div>
    40. 

  40. 		<div class="nav-bar">
    41. 

  41. 			<a href="#sec-description">Description</a> |
    42. 

  42. 			<span class="disabled">Descendents</span>
    43. 

  43. 			|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
    44. 

  44. 							
    45. 

  45. 								</div>
    46. 

  46. 		<div class="info-box-body">
    47. 

  47. 			<table cellpadding="2" cellspacing="0" class="class-table">
    48. 

  48. 				<tr>
    49. 

  49. 					<th class="class-table-header">Class</th>
    50. 

  50. 					<th class="class-table-header">Description</th>
    51. 

  51. 				</tr>
    52. 

  52. 								<tr>
    53. 

  53. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_Yadis_domxml.html">Auth_Yadis_domxml</a></td>
    54. 

  54. 					<td>
    55. 

  55. 											This concrete implementation of Auth_Yadis_XMLParser implements
    56. 

  56. 										</td>
    57. 

  57. 				</tr>
    58. 

  58. 								<tr>
    59. 

  59. 					<td style="padding-right: 2em"><a href="../OpenID/Auth_Yadis_dom.html">Auth_Yadis_dom</a></td>
    60. 

  60. 					<td>
    61. 

  61. 											This concrete implementation of Auth_Yadis_XMLParser implements
    62. 

  62. 										</td>
    63. 

  63. 				</tr>
    64. 

  64. 							</table>
    65. 

  65. 		</div>
    66. 

  66. 	</div>
    67. 

  67. 

  68. 

  69. 

  70. 	<a name="sec-method-summary"></a>
    71. 

  71. 	<div class="info-box">
    72. 

  72. 		<div class="info-box-title">Method Summary</span></div>
    73. 

  73. 		<div class="nav-bar">
    74. 

  74. 			<a href="#sec-description">Description</a> |
    75. 

  75. 							<a href="#sec-descendents">Descendents</a> |
    76. 

  76. 												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
    77. 

  77. 		</div>
    78. 

  78. 		<div class="info-box-body">			
    79. 

  79. 			<div class="method-summary">
    80. 

  80. 																																																														
    81. 

  81. 				<div class="method-definition">
    82. 

  82. 											<span class="method-result">array</span>
    83. 

  83. 										<a href="#attributes" title="details" class="method-name">attributes</a>
    84. 

  84. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span>)
    85. 

  85. 									</div>
    86. 

  86. 														
    87. 

  87. 				<div class="method-definition">
    88. 

  88. 											<span class="method-result">string</span>
    89. 

  89. 										<a href="#content" title="details" class="method-name">content</a>
    90. 

  90. 											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span>)
    91. 

  91. 									</div>
    92. 

  92. 														
    93. 

  93. 				<div class="method-definition">
    94. 

  94. 											<span class="method-result">array</span>
    95. 

  95. 										<a href="#evalXPath" title="details" class="method-name">&amp;evalXPath</a>
    96. 

  96. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$xpath</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span> = <span class="var-default">null</span>])
    97. 

  97. 									</div>
    98. 

  98. 														
    99. 

  99. 				<div class="method-definition">
    100. 

  100. 											<span class="method-result">boolean</span>
    101. 

  101. 										<a href="#init" title="details" class="method-name">init</a>
    102. 

  102. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml_string</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$namespace_map</span>)
    103. 

  103. 									</div>
    104. 

  104. 														
    105. 

  105. 				<div class="method-definition">
    106. 

  106. 											<span class="method-result">boolean</span>
    107. 

  107. 										<a href="#registerNamespace" title="details" class="method-name">registerNamespace</a>
    108. 

  108. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>)
    109. 

  109. 									</div>
    110. 

  110. 														
    111. 

  111. 				<div class="method-definition">
    112. 

  112. 											<span class="method-result">boolean</span>
    113. 

  113. 										<a href="#setXML" title="details" class="method-name">setXML</a>
    114. 

  114. 											(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml_string</span>)
    115. 

  115. 									</div>
    116. 

  116. 											</div>
    117. 

  117. 		</div>
    118. 

  118. 	</div>		
    119. 

  119. 

  120. 	
    121. 

  121. 	<a name="sec-methods"></a>
    122. 

  122. 	<div class="info-box">
    123. 

  123. 		<div class="info-box-title">Methods</div>
    124. 

  124. 		<div class="nav-bar">
    125. 

  125. 			<a href="#sec-description">Description</a> |
    126. 

  126. 							<a href="#sec-descendents">Descendents</a> |
    127. 

  127. 																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
    128. 

  128. 						
    129. 

  129. 		</div>
    130. 

  130. 		<div class="info-box-body">
    131. 

  131. 			<A NAME='method_detail'></A>
    132. 

  132. <a name="methodattributes" id="attributes"><!-- --></a>
    133. 

  133. <div class="oddrow">
    134. 

  134. 	
    135. 

  135. 	<div class="method-header">
    136. 

  136. 		<span class="method-title">attributes</span> (line <span class="line-number">121</span>)
    137. 

  137. 	</div> 
    138. 

  138. 	
    139. 

  139. 	<!-- ========== Info from phpDoc block ========= -->
    140. 

  140. <p class="short-description">Return the attributes of a specified node.</p>
    141. 

  141. 	<ul class="tags">
    142. 

  142. 				<li><span class="field">return:</span> An array mapping attribute names to  values.</li>
    143. 

  143. 			</ul>
    144. 

  144. 	
    145. 

  145. 	<div class="method-signature">
    146. 

  146. 		<span class="method-result">array</span>
    147. 

  147. 		<span class="method-name">
    148. 

  148. 			attributes
    149. 

  149. 		</span>
    150. 

  150. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span>)
    151. 

  151. 			</div>
    152. 

  152. 	
    153. 

  153. 			<ul class="parameters">
    154. 

  154. 					<li>
    155. 

  155. 				<span class="var-type">mixed</span>
    156. 

  156. 				<span class="var-name">$node</span><span class="var-description">: A node object from a previous call to  $this-&gt;evalXPath().</span>			</li>
    157. 

  157. 				</ul>
    158. 

  158. 		
    159. 

  159. 			
    160. 

  160. 			<hr class="separator" />
    161. 

  161. 		<div class="notes">Redefined in descendants as:</div>
    162. 

  162. 		<ul class="redefinitions">
    163. 

  163. 					<li>
    164. 

  164. 				<a href="../OpenID/Auth_Yadis_domxml.html#methodattributes">Auth_Yadis_domxml::attributes()</a>
    165. 

  165. 							</li>
    166. 

  166. 					<li>
    167. 

  167. 				<a href="../OpenID/Auth_Yadis_dom.html#methodattributes">Auth_Yadis_dom::attributes()</a>
    168. 

  168. 							</li>
    169. 

  169. 				</ul>
    170. 

  170. 	</div>
    171. 

  171. <a name="methodcontent" id="content"><!-- --></a>
    172. 

  172. <div class="evenrow">
    173. 

  173. 	
    174. 

  174. 	<div class="method-header">
    175. 

  175. 		<span class="method-title">content</span> (line <span class="line-number">107</span>)
    176. 

  176. 	</div> 
    177. 

  177. 	
    178. 

  178. 	<!-- ========== Info from phpDoc block ========= -->
    179. 

  179. <p class="short-description">Return the textual content of a specified node.</p>
    180. 

  180. 	<ul class="tags">
    181. 

  181. 				<li><span class="field">return:</span> The content of this node.</li>
    182. 

  182. 			</ul>
    183. 

  183. 	
    184. 

  184. 	<div class="method-signature">
    185. 

  185. 		<span class="method-result">string</span>
    186. 

  186. 		<span class="method-name">
    187. 

  187. 			content
    188. 

  188. 		</span>
    189. 

  189. 					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span>)
    190. 

  190. 			</div>
    191. 

  191. 	
    192. 

  192. 			<ul class="parameters">
    193. 

  193. 					<li>
    194. 

  194. 				<span class="var-type">mixed</span>
    195. 

  195. 				<span class="var-name">$node</span><span class="var-description">: A node object from a previous call to  $this-&gt;evalXPath().</span>			</li>
    196. 

  196. 				</ul>
    197. 

  197. 		
    198. 

  198. 			
    199. 

  199. 			<hr class="separator" />
    200. 

  200. 		<div class="notes">Redefined in descendants as:</div>
    201. 

  201. 		<ul class="redefinitions">
    202. 

  202. 					<li>
    203. 

  203. 				<a href="../OpenID/Auth_Yadis_domxml.html#methodcontent">Auth_Yadis_domxml::content()</a>
    204. 

  204. 							</li>
    205. 

  205. 					<li>
    206. 

  206. 				<a href="../OpenID/Auth_Yadis_dom.html#methodcontent">Auth_Yadis_dom::content()</a>
    207. 

  207. 							</li>
    208. 

  208. 				</ul>
    209. 

  209. 	</div>
    210. 

  210. <a name="methodevalXPath" id="evalXPath"><!-- --></a>
    211. 

  211. <div class="oddrow">
    212. 

  212. 	
    213. 

  213. 	<div class="method-header">
    214. 

  214. 		<span class="method-title">evalXPath</span> (line <span class="line-number">94</span>)
    215. 

  215. 	</div> 
    216. 

  216. 	
    217. 

  217. 	<!-- ========== Info from phpDoc block ========= -->
    218. 

  218. <p class="short-description">Evaluate an XPath expression and return the resulting node  list.  This should be overridden by subclasses.</p>
    219. 

  219. 	<ul class="tags">
    220. 

  220. 				<li><span class="field">return:</span> An array of matching opaque node  objects to be used with other methods of this parser class.</li>
    221. 

  221. 			</ul>
    222. 

  222. 	
    223. 

  223. 	<div class="method-signature">
    224. 

  224. 		<span class="method-result">array</span>
    225. 

  225. 		<span class="method-name">
    226. 

  226. 			&amp;evalXPath
    227. 

  227. 		</span>
    228. 

  228. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$xpath</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$node</span> = <span class="var-default">null</span>])
    229. 

  229. 			</div>
    230. 

  230. 	
    231. 

  231. 			<ul class="parameters">
    232. 

  232. 					<li>
    233. 

  233. 				<span class="var-type">string</span>
    234. 

  234. 				<span class="var-name">$xpath</span><span class="var-description">: The XPath expression to be evaluated.</span>			</li>
    235. 

  235. 					<li>
    236. 

  236. 				<span class="var-type">mixed</span>
    237. 

  237. 				<span class="var-name">$node</span><span class="var-description">: A node object resulting from a previous  evalXPath call.  This node, if specified, provides the context  for the evaluation of this xpath expression.</span>			</li>
    238. 

  238. 				</ul>
    239. 

  239. 		
    240. 

  240. 			
    241. 

  241. 			<hr class="separator" />
    242. 

  242. 		<div class="notes">Redefined in descendants as:</div>
    243. 

  243. 		<ul class="redefinitions">
    244. 

  244. 					<li>
    245. 

  245. 				<a href="../OpenID/Auth_Yadis_domxml.html#methodevalXPath">Auth_Yadis_domxml::evalXPath()</a>
    246. 

  246. 							</li>
    247. 

  247. 					<li>
    248. 

  248. 				<a href="../OpenID/Auth_Yadis_dom.html#methodevalXPath">Auth_Yadis_dom::evalXPath()</a>
    249. 

  249. 							</li>
    250. 

  250. 				</ul>
    251. 

  251. 	</div>
    252. 

  252. <a name="methodinit" id="init"><!-- --></a>
    253. 

  253. <div class="evenrow">
    254. 

  254. 	
    255. 

  255. 	<div class="method-header">
    256. 

  256. 		<span class="method-title">init</span> (line <span class="line-number">33</span>)
    257. 

  257. 	</div> 
    258. 

  258. 	
    259. 

  259. 	<!-- ========== Info from phpDoc block ========= -->
    260. 

  260. <p class="short-description">Initialize an instance of Auth_Yadis_XMLParser with some  XML and namespaces.  This SHOULD NOT be overridden by  subclasses.</p>
    261. 

  261. 	<ul class="tags">
    262. 

  262. 				<li><span class="field">return:</span> True if the initialization and  namespace registration(s) succeeded; false otherwise.</li>
    263. 

  263. 			</ul>
    264. 

  264. 	
    265. 

  265. 	<div class="method-signature">
    266. 

  266. 		<span class="method-result">boolean</span>
    267. 

  267. 		<span class="method-name">
    268. 

  268. 			init
    269. 

  269. 		</span>
    270. 

  270. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml_string</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$namespace_map</span>)
    271. 

  271. 			</div>
    272. 

  272. 	
    273. 

  273. 			<ul class="parameters">
    274. 

  274. 					<li>
    275. 

  275. 				<span class="var-type">string</span>
    276. 

  276. 				<span class="var-name">$xml_string</span><span class="var-description">: A string of XML to be parsed.</span>			</li>
    277. 

  277. 					<li>
    278. 

  278. 				<span class="var-type">array</span>
    279. 

  279. 				<span class="var-name">$namespace_map</span><span class="var-description">: An array of ($ns_name =&gt; $ns_uri)  to be registered with the XML parser.  May be empty.</span>			</li>
    280. 

  280. 				</ul>
    281. 

  281. 		
    282. 

  282. 			
    283. 

  283. 	</div>
    284. 

  284. <a name="methodregisterNamespace" id="registerNamespace"><!-- --></a>
    285. 

  285. <div class="oddrow">
    286. 

  286. 	
    287. 

  287. 	<div class="method-header">
    288. 

  288. 		<span class="method-title">registerNamespace</span> (line <span class="line-number">61</span>)
    289. 

  289. 	</div> 
    290. 

  290. 	
    291. 

  291. 	<!-- ========== Info from phpDoc block ========= -->
    292. 

  292. <p class="short-description">Register a namespace with the XML parser.  This should be  overridden by subclasses.</p>
    293. 

  293. 	<ul class="tags">
    294. 

  294. 				<li><span class="field">return:</span> True if the registration succeeded;  false otherwise.</li>
    295. 

  295. 			</ul>
    296. 

  296. 	
    297. 

  297. 	<div class="method-signature">
    298. 

  298. 		<span class="method-result">boolean</span>
    299. 

  299. 		<span class="method-name">
    300. 

  300. 			registerNamespace
    301. 

  301. 		</span>
    302. 

  302. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$prefix</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$uri</span>)
    303. 

  303. 			</div>
    304. 

  304. 	
    305. 

  305. 			<ul class="parameters">
    306. 

  306. 					<li>
    307. 

  307. 				<span class="var-type">string</span>
    308. 

  308. 				<span class="var-name">$prefix</span><span class="var-description">: The namespace prefix to appear in XML tag  names.</span>			</li>
    309. 

  309. 					<li>
    310. 

  310. 				<span class="var-type">string</span>
    311. 

  311. 				<span class="var-name">$uri</span><span class="var-description">: The namespace URI to be used to identify the  namespace in the XML.</span>			</li>
    312. 

  312. 				</ul>
    313. 

  313. 		
    314. 

  314. 			
    315. 

  315. 			<hr class="separator" />
    316. 

  316. 		<div class="notes">Redefined in descendants as:</div>
    317. 

  317. 		<ul class="redefinitions">
    318. 

  318. 					<li>
    319. 

  319. 				<a href="../OpenID/Auth_Yadis_domxml.html#methodregisterNamespace">Auth_Yadis_domxml::registerNamespace()</a>
    320. 

  320. 							</li>
    321. 

  321. 					<li>
    322. 

  322. 				<a href="../OpenID/Auth_Yadis_dom.html#methodregisterNamespace">Auth_Yadis_dom::registerNamespace()</a>
    323. 

  323. 							</li>
    324. 

  324. 				</ul>
    325. 

  325. 	</div>
    326. 

  326. <a name="methodsetXML" id="setXML"><!-- --></a>
    327. 

  327. <div class="evenrow">
    328. 

  328. 	
    329. 

  329. 	<div class="method-header">
    330. 

  330. 		<span class="method-title">setXML</span> (line <span class="line-number">76</span>)
    331. 

  331. 	</div> 
    332. 

  332. 	
    333. 

  333. 	<!-- ========== Info from phpDoc block ========= -->
    334. 

  334. <p class="short-description">Set this parser object's XML payload.  This should be  overridden by subclasses.</p>
    335. 

  335. 	<ul class="tags">
    336. 

  336. 				<li><span class="field">return:</span> True if the initialization succeeded;  false otherwise.</li>
    337. 

  337. 			</ul>
    338. 

  338. 	
    339. 

  339. 	<div class="method-signature">
    340. 

  340. 		<span class="method-result">boolean</span>
    341. 

  341. 		<span class="method-name">
    342. 

  342. 			setXML
    343. 

  343. 		</span>
    344. 

  344. 					(<span class="var-type">string</span>&nbsp;<span class="var-name">$xml_string</span>)
    345. 

  345. 			</div>
    346. 

  346. 	
    347. 

  347. 			<ul class="parameters">
    348. 

  348. 					<li>
    349. 

  349. 				<span class="var-type">string</span>
    350. 

  350. 				<span class="var-name">$xml_string</span><span class="var-description">: The XML string to pass to this  object's XML parser.</span>			</li>
    351. 

  351. 				</ul>
    352. 

  352. 		
    353. 

  353. 			
    354. 

  354. 			<hr class="separator" />
    355. 

  355. 		<div class="notes">Redefined in descendants as:</div>
    356. 

  356. 		<ul class="redefinitions">
    357. 

  357. 					<li>
    358. 

  358. 				<a href="../OpenID/Auth_Yadis_domxml.html#methodsetXML">Auth_Yadis_domxml::setXML()</a>
    359. 

  359. 							</li>
    360. 

  360. 					<li>
    361. 

  361. 				<a href="../OpenID/Auth_Yadis_dom.html#methodsetXML">Auth_Yadis_dom::setXML()</a>
    362. 

  362. 							</li>
    363. 

  363. 				</ul>
    364. 

  364. 	</div>
    365. 

  365. 						
    366. 

  366. 		</div>
    367. 

  367. 	</div>
    368. 

  368. 

  369. 

  370. 	<p class="notes" id="credit">
    371. 

  371. 		Documentation generated on Tue, 21 Apr 2009 11:31:33 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
    372. 

  372. 	</p>
    373. 

  373. 	</div></body>
    374. 

  374. </html>
    375.