Auth_OpenID_Encoder.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200
  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_Encoder</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_Encoder</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-descendents">Descendents</a>
  19. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  20. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  21. </div>
  22. <div class="info-box-body">
  23. <!-- ========== Info from phpDoc block ========= -->
  24. <p class="short-description">Encode an <a href="../OpenID/Auth_OpenID_ServerResponse.html">Auth_OpenID_ServerResponse</a> to an <a href="../OpenID/Auth_OpenID_WebResponse.html">Auth_OpenID_WebResponse</a>.</p>
  25. <p class="notes">
  26. Located in <a class="field" href="_Auth---OpenID---Server.php.html">/Auth/OpenID/Server.php</a> (line <span class="field">1439</span>)
  27. </p>
  28. <pre></pre>
  29. </div>
  30. </div>
  31. <a name="sec-descendents"></a>
  32. <div class="info-box">
  33. <div class="info-box-title">Direct descendents</div>
  34. <div class="nav-bar">
  35. <a href="#sec-description">Description</a> |
  36. <span class="disabled">Descendents</span>
  37. | <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  38. | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  39. </div>
  40. <div class="info-box-body">
  41. <table cellpadding="2" cellspacing="0" class="class-table">
  42. <tr>
  43. <th class="class-table-header">Class</th>
  44. <th class="class-table-header">Description</th>
  45. </tr>
  46. <tr>
  47. <td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SigningEncoder.html">Auth_OpenID_SigningEncoder</a></td>
  48. <td>
  49. An encoder which also takes care of signing fields when required.
  50. </td>
  51. </tr>
  52. </table>
  53. </div>
  54. </div>
  55. <a name="sec-var-summary"></a>
  56. <div class="info-box">
  57. <div class="info-box-title">Variable Summary</span></div>
  58. <div class="nav-bar">
  59. <a href="#sec-description">Description</a> |
  60. <a href="#sec-descendents">Descendents</a> |
  61. <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  62. |
  63. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  64. </div>
  65. <div class="info-box-body">
  66. <div class="var-summary">
  67. <div class="var-title">
  68. <span class="var-type">mixed</span>
  69. <a href="#$responseFactory" title="details" class="var-name">$responseFactory</a>
  70. </div>
  71. </div>
  72. </div>
  73. </div>
  74. <a name="sec-method-summary"></a>
  75. <div class="info-box">
  76. <div class="info-box-title">Method Summary</span></div>
  77. <div class="nav-bar">
  78. <a href="#sec-description">Description</a> |
  79. <a href="#sec-descendents">Descendents</a> |
  80. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  81. |
  82. <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  83. </div>
  84. <div class="info-box-body">
  85. <div class="method-summary">
  86. <div class="method-definition">
  87. <span class="method-result">void</span>
  88. <a href="#encode" title="details" class="method-name">encode</a>
  89. (<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
  90. </div>
  91. </div>
  92. </div>
  93. </div>
  94. <a name="sec-vars"></a>
  95. <div class="info-box">
  96. <div class="info-box-title">Variables</div>
  97. <div class="nav-bar">
  98. <a href="#sec-description">Description</a> |
  99. <a href="#sec-descendents">Descendents</a> |
  100. <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
  101. |
  102. <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  103. </div>
  104. <div class="info-box-body">
  105. <a name="var$responseFactory" id="$responseFactory"><!-- --></A>
  106. <div class="oddrow">
  107. <div class="var-header">
  108. <span class="var-title">
  109. <span class="var-type">mixed</span>
  110. <span class="var-name">$responseFactory</span>
  111. = <span class="var-default"> 'Auth_OpenID_WebResponse'</span> (line <span class="line-number">1441</span>)
  112. </span>
  113. </div>
  114. <!-- ========== Info from phpDoc block ========= -->
  115. </div>
  116. </div>
  117. </div>
  118. <a name="sec-methods"></a>
  119. <div class="info-box">
  120. <div class="info-box-title">Methods</div>
  121. <div class="nav-bar">
  122. <a href="#sec-description">Description</a> |
  123. <a href="#sec-descendents">Descendents</a> |
  124. <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  125. <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  126. </div>
  127. <div class="info-box-body">
  128. <A NAME='method_detail'></A>
  129. <a name="methodencode" id="encode"><!-- --></a>
  130. <div class="evenrow">
  131. <div class="method-header">
  132. <span class="method-title">encode</span> (line <span class="line-number">1447</span>)
  133. </div>
  134. <!-- ========== Info from phpDoc block ========= -->
  135. <p class="short-description">Encode an <a href="../OpenID/Auth_OpenID_ServerResponse.html">Auth_OpenID_ServerResponse</a> and return an <a href="../OpenID/Auth_OpenID_WebResponse.html">Auth_OpenID_WebResponse</a>.</p>
  136. <div class="method-signature">
  137. <span class="method-result">void</span>
  138. <span class="method-name">
  139. encode
  140. </span>
  141. (<span class="var-type"></span>&nbsp;<span class="var-name">&$response</span>)
  142. </div>
  143. <ul class="parameters">
  144. <li>
  145. <span class="var-type"></span>
  146. <span class="var-name">&$response</span> </li>
  147. </ul>
  148. <hr class="separator" />
  149. <div class="notes">Redefined in descendants as:</div>
  150. <ul class="redefinitions">
  151. <li>
  152. <a href="../OpenID/Auth_OpenID_SigningEncoder.html#methodencode">Auth_OpenID_SigningEncoder::encode()</a>
  153. : Sign an <a href="../OpenID/Auth_OpenID_ServerResponse.html">Auth_OpenID_ServerResponse</a> and return an <a href="../OpenID/Auth_OpenID_WebResponse.html">Auth_OpenID_WebResponse</a>.
  154. </li>
  155. </ul>
  156. </div>
  157. </div>
  158. </div>
  159. <p class="notes" id="credit">
  160. Documentation generated on Tue, 21 Apr 2009 11:31:32 -0700 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
  161. </p>
  162. </div></body>
  163. </html>