Auth_OpenID_Mapping.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  1. <?xml version="1.0" encoding="iso-8859-1"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <!-- template designed by Marco Von Ballmoos -->
  6. <title>Docs For Class Auth_OpenID_Mapping</title>
  7. <link rel="stylesheet" href="../media/stylesheet.css" />
  8. <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
  9. </head>
  10. <body>
  11. <div class="page-body">
  12. <h2 class="class-name">Class Auth_OpenID_Mapping</h2>
  13. <a name="sec-description"></a>
  14. <div class="info-box">
  15. <div class="info-box-title">Description</div>
  16. <div class="nav-bar">
  17. <span class="disabled">Description</span> |
  18. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  19. </div>
  20. <div class="info-box-body">
  21. <!-- ========== Info from phpDoc block ========= -->
  22. <p class="short-description">An Auth_OpenID_Mapping maintains a mapping from arbitrary keys to arbitrary values. (This is unlike an ordinary PHP array, whose keys may be only simple scalars.)</p>
  23. <p class="notes">
  24. Located in <a class="field" href="_Auth---OpenID---Message.php.html">/Auth/OpenID/Message.php</a> (line <span class="field">125</span>)
  25. </p>
  26. <pre></pre>
  27. </div>
  28. </div>
  29. <a name="sec-method-summary"></a>
  30. <div class="info-box">
  31. <div class="info-box-title">Method Summary</span></div>
  32. <div class="nav-bar">
  33. <a href="#sec-description">Description</a> |
  34. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  35. </div>
  36. <div class="info-box-body">
  37. <div class="method-summary">
  38. <div class="method-definition">
  39. <span class="method-result">Auth_OpenID_Mapping</span>
  40. <a href="#Auth_OpenID_Mapping" title="details" class="method-name">Auth_OpenID_Mapping</a>
  41. ([<span class="var-type"></span>&nbsp;<span class="var-name">$classic_array</span> = <span class="var-default">null</span>])
  42. </div>
  43. <div class="method-definition">
  44. <span class="method-result">void</span>
  45. <a href="#contains" title="details" class="method-name">contains</a>
  46. (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  47. </div>
  48. <div class="method-definition">
  49. <span class="method-result">void</span>
  50. <a href="#del" title="details" class="method-name">del</a>
  51. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
  52. </div>
  53. <div class="method-definition">
  54. <span class="method-result">void</span>
  55. <a href="#get" title="details" class="method-name">get</a>
  56. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  57. </div>
  58. <div class="method-definition">
  59. <span class="method-result">void</span>
  60. <a href="#isA" title="details" class="method-name">isA</a>
  61. (<span class="var-type"></span>&nbsp;<span class="var-name">$thing</span>)
  62. </div>
  63. <div class="method-definition">
  64. <span class="method-result">void</span>
  65. <a href="#items" title="details" class="method-name">items</a>
  66. ()
  67. </div>
  68. <div class="method-definition">
  69. <span class="method-result">void</span>
  70. <a href="#keys" title="details" class="method-name">keys</a>
  71. ()
  72. </div>
  73. <div class="method-definition">
  74. <span class="method-result">void</span>
  75. <a href="#len" title="details" class="method-name">len</a>
  76. ()
  77. </div>
  78. <div class="method-definition">
  79. <span class="method-result">void</span>
  80. <a href="#set" title="details" class="method-name">set</a>
  81. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  82. </div>
  83. <div class="method-definition">
  84. <span class="method-result">void</span>
  85. <a href="#values" title="details" class="method-name">values</a>
  86. ()
  87. </div>
  88. </div>
  89. </div>
  90. </div>
  91. <a name="sec-methods"></a>
  92. <div class="info-box">
  93. <div class="info-box-title">Methods</div>
  94. <div class="nav-bar">
  95. <a href="#sec-description">Description</a> |
  96. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  97. </div>
  98. <div class="info-box-body">
  99. <A NAME='method_detail'></A>
  100. <a name="methodAuth_OpenID_Mapping" id="Auth_OpenID_Mapping"><!-- --></a>
  101. <div class="oddrow">
  102. <div class="method-header">
  103. <span class="method-title">Constructor Auth_OpenID_Mapping</span> (line <span class="line-number">130</span>)
  104. </div>
  105. <!-- ========== Info from phpDoc block ========= -->
  106. <p class="short-description">Initialize a mapping. If $classic_array is specified, its keys and values are used to populate the mapping.</p>
  107. <div class="method-signature">
  108. <span class="method-result">Auth_OpenID_Mapping</span>
  109. <span class="method-name">
  110. Auth_OpenID_Mapping
  111. </span>
  112. ([<span class="var-type"></span>&nbsp;<span class="var-name">$classic_array</span> = <span class="var-default">null</span>])
  113. </div>
  114. <ul class="parameters">
  115. <li>
  116. <span class="var-type"></span>
  117. <span class="var-name">$classic_array</span> </li>
  118. </ul>
  119. </div>
  120. <a name="methodcontains" id="contains"><!-- --></a>
  121. <div class="evenrow">
  122. <div class="method-header">
  123. <span class="method-title">contains</span> (line <span class="line-number">265</span>)
  124. </div>
  125. <!-- ========== Info from phpDoc block ========= -->
  126. <p class="short-description">Returns true if the specified value has a key in the mapping; false if not.</p>
  127. <div class="method-signature">
  128. <span class="method-result">void</span>
  129. <span class="method-name">
  130. contains
  131. </span>
  132. (<span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  133. </div>
  134. <ul class="parameters">
  135. <li>
  136. <span class="var-type"></span>
  137. <span class="var-name">$value</span> </li>
  138. </ul>
  139. </div>
  140. <a name="methoddel" id="del"><!-- --></a>
  141. <div class="oddrow">
  142. <div class="method-header">
  143. <span class="method-title">del</span> (line <span class="line-number">248</span>)
  144. </div>
  145. <!-- ========== Info from phpDoc block ========= -->
  146. <p class="short-description">Deletes a key-value pair from the mapping with the specified key.</p>
  147. <div class="method-signature">
  148. <span class="method-result">void</span>
  149. <span class="method-name">
  150. del
  151. </span>
  152. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>)
  153. </div>
  154. <ul class="parameters">
  155. <li>
  156. <span class="var-type"></span>
  157. <span class="var-name">$key</span> </li>
  158. </ul>
  159. </div>
  160. <a name="methodget" id="get"><!-- --></a>
  161. <div class="evenrow">
  162. <div class="method-header">
  163. <span class="method-title">get</span> (line <span class="line-number">211</span>)
  164. </div>
  165. <!-- ========== Info from phpDoc block ========= -->
  166. <p class="short-description">Gets a specified value from the mapping, associated with the specified key. If the key does not exist in the mapping, $default is returned instead.</p>
  167. <div class="method-signature">
  168. <span class="method-result">void</span>
  169. <span class="method-name">
  170. get
  171. </span>
  172. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$default</span> = <span class="var-default">null</span>])
  173. </div>
  174. <ul class="parameters">
  175. <li>
  176. <span class="var-type"></span>
  177. <span class="var-name">$key</span> </li>
  178. <li>
  179. <span class="var-type"></span>
  180. <span class="var-name">$default</span> </li>
  181. </ul>
  182. </div>
  183. <a name="methodisA" id="isA"><!-- --></a>
  184. <div class="oddrow">
  185. <div class="method-header">
  186. <span class="method-title">isA</span> (line <span class="line-number">146</span>)
  187. </div>
  188. <!-- ========== Info from phpDoc block ========= -->
  189. <p class="short-description">Returns true if $thing is an Auth_OpenID_Mapping object; false if not.</p>
  190. <div class="method-signature">
  191. <span class="method-result">void</span>
  192. <span class="method-name">
  193. isA
  194. </span>
  195. (<span class="var-type"></span>&nbsp;<span class="var-name">$thing</span>)
  196. </div>
  197. <ul class="parameters">
  198. <li>
  199. <span class="var-type"></span>
  200. <span class="var-name">$thing</span> </li>
  201. </ul>
  202. </div>
  203. <a name="methoditems" id="items"><!-- --></a>
  204. <div class="evenrow">
  205. <div class="method-header">
  206. <span class="method-title">items</span> (line <span class="line-number">171</span>)
  207. </div>
  208. <!-- ========== Info from phpDoc block ========= -->
  209. <p class="short-description">Returns an array of (key, value) pairs in the mapping.</p>
  210. <div class="method-signature">
  211. <span class="method-result">void</span>
  212. <span class="method-name">
  213. items
  214. </span>
  215. ()
  216. </div>
  217. </div>
  218. <a name="methodkeys" id="keys"><!-- --></a>
  219. <div class="oddrow">
  220. <div class="method-header">
  221. <span class="method-title">keys</span> (line <span class="line-number">155</span>)
  222. </div>
  223. <!-- ========== Info from phpDoc block ========= -->
  224. <p class="short-description">Returns an array of the keys in the mapping.</p>
  225. <div class="method-signature">
  226. <span class="method-result">void</span>
  227. <span class="method-name">
  228. keys
  229. </span>
  230. ()
  231. </div>
  232. </div>
  233. <a name="methodlen" id="len"><!-- --></a>
  234. <div class="evenrow">
  235. <div class="method-header">
  236. <span class="method-title">len</span> (line <span class="line-number">185</span>)
  237. </div>
  238. <!-- ========== Info from phpDoc block ========= -->
  239. <p class="short-description">Returns the &quot;length&quot; of the mapping, or the number of keys.</p>
  240. <div class="method-signature">
  241. <span class="method-result">void</span>
  242. <span class="method-name">
  243. len
  244. </span>
  245. ()
  246. </div>
  247. </div>
  248. <a name="methodset" id="set"><!-- --></a>
  249. <div class="oddrow">
  250. <div class="method-header">
  251. <span class="method-title">set</span> (line <span class="line-number">194</span>)
  252. </div>
  253. <!-- ========== Info from phpDoc block ========= -->
  254. <p class="short-description">Sets a key-value pair in the mapping. If the key already exists, its value is replaced with the new value.</p>
  255. <div class="method-signature">
  256. <span class="method-result">void</span>
  257. <span class="method-name">
  258. set
  259. </span>
  260. (<span class="var-type"></span>&nbsp;<span class="var-name">$key</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
  261. </div>
  262. <ul class="parameters">
  263. <li>
  264. <span class="var-type"></span>
  265. <span class="var-name">$key</span> </li>
  266. <li>
  267. <span class="var-type"></span>
  268. <span class="var-name">$value</span> </li>
  269. </ul>
  270. </div>
  271. <a name="methodvalues" id="values"><!-- --></a>
  272. <div class="evenrow">
  273. <div class="method-header">
  274. <span class="method-title">values</span> (line <span class="line-number">163</span>)
  275. </div>
  276. <!-- ========== Info from phpDoc block ========= -->
  277. <p class="short-description">Returns an array of values in the mapping.</p>
  278. <div class="method-signature">
  279. <span class="method-result">void</span>
  280. <span class="method-name">
  281. values
  282. </span>
  283. ()
  284. </div>
  285. </div>
  286. </div>
  287. </div>
  288. <p class="notes" id="credit">
  289. Documentation generated on Tue, 21 Apr 2009 11:31:31 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  290. </p>
  291. </div></body>
  292. </html>