PageRenderTime 58ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/phpincludes/CAS/docs/api/group__internalBasic.html

https://github.com/blahblahblah5038/EECS341
HTML | 273 lines | 250 code | 22 blank | 1 comment | 0 complexity | 7effe511eae48a2baf9adc9894c87efa MD5 | raw file
    

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

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

  3. <head>
    4. 

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

  5. <title>phpCAS: CAS Basic client features (CAS 1.0, Service Tickets)</title>
    6. 

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

  7. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <!-- Generated by Doxygen 1.7.1 -->
    11. 

  11. <div class="navigation" id="top">
    12. 

  12.   <div class="tabs">
    13. 

  13.     <ul class="tablist">
    14. 

  14.       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    15. 

  15.       <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
    16. 

  16.       <li><a href="modules.html"><span>Modules</span></a></li>
    17. 

  17.       <li><a href="annotated.html"><span>Classes</span></a></li>
    18. 

  18.       <li><a href="files.html"><span>Files</span></a></li>
    19. 

  19.       <li><a href="examples.html"><span>Examples</span></a></li>
    20. 

  20.     </ul>
    21. 

  21.   </div>
    22. 

  22. </div>
    23. 

  23. <div class="header">
    24. 

  24.   <div class="summary">
    25. 

  25. <a href="#func-members">Functions</a> &#124;
    26. 

  26. <a href="#var-members">Variables</a>  </div>
    27. 

  27.   <div class="headertitle">
    28. 

  28. <h1>CAS Basic client features (CAS 1.0, Service Tickets)<br/>
    29. 

  29. <small>
    30. 

  30. [<a class="el" href="group__internal.html">Implementation</a>]</small>
    31. 

  31. </h1>  </div>
    32. 

  32. </div>
    33. 

  33. <div class="contents">
    34. 

  34. <table class="memberdecls">
    35. 

  35. <tr><td colspan="2"><h2><a name="func-members"></a>
    36. 

  36. Functions</h2></td></tr>
    37. 

  37. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga13a1fac978baa6cc99f6a443bdb7f402">CAS_Client::getST</a> ()</td></tr>
    38. 

  38. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga7baa4852ccb4e30280e825d95b496952">CAS_Client::setST</a> ($st)</td></tr>
    39. 

  39. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga4acc5e4ed6e778f942c36273dd9c8766">CAS_Client::hasST</a> ()</td></tr>
    40. 

  40. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga548bebec55f195988aba071ddc340596">CAS_Client::setCasServerCACert</a> ($cert)</td></tr>
    41. 

  41. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gafa13a188b0b07c1f0631c0f844cdd11f">CAS_Client::setNoCasServerValidation</a> ()</td></tr>
    42. 

  42. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga0a9d9d436a1b2b101ebe767617ac62ad">CAS_Client::validateST</a> ($validate_url, &amp;$text_response, &amp;$tree_response)</td></tr>
    43. 

  43. <tr><td colspan="2"><h2><a name="var-members"></a>
    44. 

  44. Variables</h2></td></tr>
    45. 

  45. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga0dbca451ba0b1bddbf02f5663ca83d1f">CAS_Client::$_st</a></td></tr>
    46. 

  46. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#ga17f31ab4f36a637672e5f23c895c4acf">CAS_Client::$_cas_server_ca_cert</a></td></tr>
    47. 

  47. <tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalBasic.html#gad410c54bdfd9b65f063bc9d52afae72d">CAS_Client::$_no_cas_server_validation</a></td></tr>
    48. 

  48. </table>
    49. 

  49. <hr/><h2>Function Documentation</h2>
    50. 

  50. <a class="anchor" id="ga13a1fac978baa6cc99f6a443bdb7f402"></a><!-- doxytag: member="CAS_Client::getST" ref="ga13a1fac978baa6cc99f6a443bdb7f402" args="()" -->
    51. 

  51. <div class="memitem">
    52. 

  52. <div class="memproto">
    53. 

  53.       <table class="memname">
    54. 

  54.         <tr>
    55. 

  55.           <td class="memname">CAS_Client::getST </td>
    56. 

  56.           <td>(</td>
    57. 

  57.           <td class="paramname"></td>
    58. 

  58.           <td>&nbsp;)&nbsp;</td>
    59. 

  59.           <td><code> [inherited]</code></td>
    60. 

  60.         </tr>
    61. 

  61.       </table>
    62. 

  62. </div>
    63. 

  63. <div class="memdoc">
    64. 

  64. <p>This method returns the Service Ticket provided in the URL of the request. </p>
    65. 

  65. <dl class="return"><dt><b>Returns:</b></dt><dd>The service ticket. </dd></dl>
    66. 

  66. 

  67. <p>Definition at line <a class="el" href="Client_8php_source.html#l01418">1418</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    68. 

  68. 

  69. <p>Referenced by <a class="el" href="Client_8php_source.html#l01052">CAS_Client::isAuthenticated()</a>, and <a class="el" href="Client_8php_source.html#l01489">CAS_Client::validateST()</a>.</p>
    70. 

  70. 

  71. </div>
    72. 

  72. </div>
    73. 

  73. <a class="anchor" id="ga4acc5e4ed6e778f942c36273dd9c8766"></a><!-- doxytag: member="CAS_Client::hasST" ref="ga4acc5e4ed6e778f942c36273dd9c8766" args="()" -->
    74. 

  74. <div class="memitem">
    75. 

  75. <div class="memproto">
    76. 

  76.       <table class="memname">
    77. 

  77.         <tr>
    78. 

  78.           <td class="memname">CAS_Client::hasST </td>
    79. 

  79.           <td>(</td>
    80. 

  80.           <td class="paramname"></td>
    81. 

  81.           <td>&nbsp;)&nbsp;</td>
    82. 

  82.           <td><code> [inherited]</code></td>
    83. 

  83.         </tr>
    84. 

  84.       </table>
    85. 

  85. </div>
    86. 

  86. <div class="memdoc">
    87. 

  87. <p>This method tells if a Service Ticket was stored. </p>
    88. 

  88. <dl class="return"><dt><b>Returns:</b></dt><dd>TRUE if a Service Ticket has been stored. </dd></dl>
    89. 

  89. 

  90. <p>Definition at line <a class="el" href="Client_8php_source.html#l01432">1432</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    91. 

  91. 

  92. <p>Referenced by <a class="el" href="Client_8php_source.html#l01052">CAS_Client::isAuthenticated()</a>.</p>
    93. 

  93. 

  94. </div>
    95. 

  95. </div>
    96. 

  96. <a class="anchor" id="ga548bebec55f195988aba071ddc340596"></a><!-- doxytag: member="CAS_Client::setCasServerCACert" ref="ga548bebec55f195988aba071ddc340596" args="($cert)" -->
    97. 

  97. <div class="memitem">
    98. 

  98. <div class="memproto">
    99. 

  99.       <table class="memname">
    100. 

  100.         <tr>
    101. 

  101.           <td class="memname">CAS_Client::setCasServerCACert </td>
    102. 

  102.           <td>(</td>
    103. 

  103.           <td class="paramtype">$&nbsp;</td>
    104. 

  104.           <td class="paramname"> <em>cert</em></td>
    105. 

  105.           <td>&nbsp;)&nbsp;</td>
    106. 

  106.           <td><code> [inherited]</code></td>
    107. 

  107.         </tr>
    108. 

  108.       </table>
    109. 

  109. </div>
    110. 

  110. <div class="memdoc">
    111. 

  111. <p>Set the CA certificate of the CAS server.</p>
    112. 

  112. <dl><dt><b>Parameters:</b></dt><dd>
    113. 

  113.   <table border="0" cellspacing="2" cellpadding="0">
    114. 

  114.     <tr><td valign="top"></td><td valign="top"><em>$cert</em>&nbsp;</td><td>the PEM certificate of the CA that emited the cert of the server </td></tr>
    115. 

  115.   </table>
    116. 

  116.   </dd>
    117. 

  117. </dl>
    118. 

  118. 

  119. <p>Definition at line <a class="el" href="Client_8php_source.html#l01465">1465</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    120. 

  120. 

  121. </div>
    122. 

  122. </div>
    123. 

  123. <a class="anchor" id="gafa13a188b0b07c1f0631c0f844cdd11f"></a><!-- doxytag: member="CAS_Client::setNoCasServerValidation" ref="gafa13a188b0b07c1f0631c0f844cdd11f" args="()" -->
    124. 

  124. <div class="memitem">
    125. 

  125. <div class="memproto">
    126. 

  126.       <table class="memname">
    127. 

  127.         <tr>
    128. 

  128.           <td class="memname">CAS_Client::setNoCasServerValidation </td>
    129. 

  129.           <td>(</td>
    130. 

  130.           <td class="paramname"></td>
    131. 

  131.           <td>&nbsp;)&nbsp;</td>
    132. 

  132.           <td><code> [inherited]</code></td>
    133. 

  133.         </tr>
    134. 

  134.       </table>
    135. 

  135. </div>
    136. 

  136. <div class="memdoc">
    137. 

  137. <p>Set no SSL validation for the CAS server. </p>
    138. 

  138. 

  139. <p>Definition at line <a class="el" href="Client_8php_source.html#l01473">1473</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    140. 

  140. 

  141. </div>
    142. 

  142. </div>
    143. 

  143. <a class="anchor" id="ga7baa4852ccb4e30280e825d95b496952"></a><!-- doxytag: member="CAS_Client::setST" ref="ga7baa4852ccb4e30280e825d95b496952" args="($st)" -->
    144. 

  144. <div class="memitem">
    145. 

  145. <div class="memproto">
    146. 

  146.       <table class="memname">
    147. 

  147.         <tr>
    148. 

  148.           <td class="memname">CAS_Client::setST </td>
    149. 

  149.           <td>(</td>
    150. 

  150.           <td class="paramtype">$&nbsp;</td>
    151. 

  151.           <td class="paramname"> <em>st</em></td>
    152. 

  152.           <td>&nbsp;)&nbsp;</td>
    153. 

  153.           <td><code> [inherited]</code></td>
    154. 

  154.         </tr>
    155. 

  155.       </table>
    156. 

  156. </div>
    157. 

  157. <div class="memdoc">
    158. 

  158. <p>This method stores the Service Ticket. </p>
    159. 

  159. <dl><dt><b>Parameters:</b></dt><dd>
    160. 

  160.   <table border="0" cellspacing="2" cellpadding="0">
    161. 

  161.     <tr><td valign="top"></td><td valign="top"><em>$st</em>&nbsp;</td><td>The Service Ticket. </td></tr>
    162. 

  162.   </table>
    163. 

  163.   </dd>
    164. 

  164. </dl>
    165. 

  165. 

  166. <p>Definition at line <a class="el" href="Client_8php_source.html#l01425">1425</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    167. 

  167. 

  168. <p>Referenced by <a class="el" href="Client_8php_source.html#l01176">CAS_Client::wasPreviouslyAuthenticated()</a>.</p>
    169. 

  169. 

  170. </div>
    171. 

  171. </div>
    172. 

  172. <a class="anchor" id="ga0a9d9d436a1b2b101ebe767617ac62ad"></a><!-- doxytag: member="CAS_Client::validateST" ref="ga0a9d9d436a1b2b101ebe767617ac62ad" args="($validate_url, &amp;$text_response, &amp;$tree_response)" -->
    173. 

  173. <div class="memitem">
    174. 

  174. <div class="memproto">
    175. 

  175.       <table class="memname">
    176. 

  176.         <tr>
    177. 

  177.           <td class="memname">CAS_Client::validateST </td>
    178. 

  178.           <td>(</td>
    179. 

  179.           <td class="paramtype">$&nbsp;</td>
    180. 

  180.           <td class="paramname"> <em>validate_url</em>, </td>
    181. 

  181.         </tr>
    182. 

  182.         <tr>
    183. 

  183.           <td class="paramkey"></td>
    184. 

  184.           <td></td>
    185. 

  185.           <td class="paramtype">&amp;$&nbsp;</td>
    186. 

  186.           <td class="paramname"> <em>text_response</em>, </td>
    187. 

  187.         </tr>
    188. 

  188.         <tr>
    189. 

  189.           <td class="paramkey"></td>
    190. 

  190.           <td></td>
    191. 

  191.           <td class="paramtype">&amp;$&nbsp;</td>
    192. 

  192.           <td class="paramname"> <em>tree_response</em></td><td>&nbsp;</td>
    193. 

  193.         </tr>
    194. 

  194.         <tr>
    195. 

  195.           <td></td>
    196. 

  196.           <td>)</td>
    197. 

  197.           <td></td><td></td><td><code> [inherited]</code></td>
    198. 

  198.         </tr>
    199. 

  199.       </table>
    200. 

  200. </div>
    201. 

  201. <div class="memdoc">
    202. 

  202. <p>This method is used to validate a ST; halt on failure, and sets $validate_url, $text_reponse and $tree_response on success. These parameters are used later by CAS_Client::validatePGT() for CAS proxies. Used for all CAS 1.0 validations </p>
    203. 

  203. <dl><dt><b>Parameters:</b></dt><dd>
    204. 

  204.   <table border="0" cellspacing="2" cellpadding="0">
    205. 

  205.     <tr><td valign="top"></td><td valign="top"><em>$validate_url</em>&nbsp;</td><td>the URL of the request to the CAS server. </td></tr>
    206. 

  206.     <tr><td valign="top"></td><td valign="top"><em>$text_response</em>&nbsp;</td><td>the response of the CAS server, as is (XML text). </td></tr>
    207. 

  207.     <tr><td valign="top"></td><td valign="top"><em>$tree_response</em>&nbsp;</td><td>the response of the CAS server, as a DOM XML tree.</td></tr>
    208. 

  208.   </table>
    209. 

  209.   </dd>
    210. 

  210. </dl>
    211. 

  211. <dl class="return"><dt><b>Returns:</b></dt><dd>bool TRUE when successfull, halt otherwise by calling CAS_Client::authError(). </dd></dl>
    212. 

  212. 

  213. <p>Definition at line <a class="el" href="Client_8php_source.html#l01489">1489</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    214. 

  214. 

  215. <p>References <a class="el" href="Client_8php_source.html#l03009">CAS_Client::authError()</a>, <a class="el" href="Client_8php_source.html#l01912">CAS_Client::getCallbackURL()</a>, <a class="el" href="Client_8php_source.html#l00418">CAS_Client::getServerServiceValidateURL()</a>, <a class="el" href="Client_8php_source.html#l01418">CAS_Client::getST()</a>, <a class="el" href="Client_8php_source.html#l01809">CAS_Client::isProxy()</a>, <a class="el" href="Client_8php_source.html#l02690">CAS_Client::readExtraAttributesCas20()</a>, <a class="el" href="Client_8php_source.html#l02264">CAS_Client::readURL()</a>, <a class="el" href="Client_8php_source.html#l00876">CAS_Client::setUser()</a>, <a class="el" href="CAS_8php_source.html#l00538">phpCAS::trace()</a>, and <a class="el" href="CAS_8php_source.html#l00546">phpCAS::traceBegin()</a>.</p>
    216. 

  216. 

  217. </div>
    218. 

  218. </div>
    219. 

  219. <hr/><h2>Variable Documentation</h2>
    220. 

  220. <a class="anchor" id="ga17f31ab4f36a637672e5f23c895c4acf"></a><!-- doxytag: member="CAS_Client::$_cas_server_ca_cert" ref="ga17f31ab4f36a637672e5f23c895c4acf" args="" -->
    221. 

  221. <div class="memitem">
    222. 

  222. <div class="memproto">
    223. 

  223.       <table class="memname">
    224. 

  224.         <tr>
    225. 

  225.           <td class="memname">CAS_Client::$_cas_server_ca_cert<code> [private, inherited]</code></td>
    226. 

  226.         </tr>
    227. 

  227.       </table>
    228. 

  228. </div>
    229. 

  229. <div class="memdoc">
    230. 

  230. <p>the certificate of the CAS server CA. </p>
    231. 

  231. 

  232. <p>Definition at line <a class="el" href="Client_8php_source.html#l01450">1450</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    233. 

  233. 

  234. </div>
    235. 

  235. </div>
    236. 

  236. <a class="anchor" id="gad410c54bdfd9b65f063bc9d52afae72d"></a><!-- doxytag: member="CAS_Client::$_no_cas_server_validation" ref="gad410c54bdfd9b65f063bc9d52afae72d" args="" -->
    237. 

  237. <div class="memitem">
    238. 

  238. <div class="memproto">
    239. 

  239.       <table class="memname">
    240. 

  240.         <tr>
    241. 

  241.           <td class="memname">CAS_Client::$_no_cas_server_validation<code> [private, inherited]</code></td>
    242. 

  242.         </tr>
    243. 

  243.       </table>
    244. 

  244. </div>
    245. 

  245. <div class="memdoc">
    246. 

  246. <p>Set to true not to validate the CAS server. </p>
    247. 

  247. 

  248. <p>Definition at line <a class="el" href="Client_8php_source.html#l01457">1457</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    249. 

  249. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <a class="anchor" id="ga0dbca451ba0b1bddbf02f5663ca83d1f"></a><!-- doxytag: member="CAS_Client::$_st" ref="ga0dbca451ba0b1bddbf02f5663ca83d1f" args="" -->
    253. 

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

  254. <div class="memproto">
    255. 

  255.       <table class="memname">
    256. 

  256.         <tr>
    257. 

  257.           <td class="memname">CAS_Client::$_st<code> [private, inherited]</code></td>
    258. 

  258.         </tr>
    259. 

  259.       </table>
    260. 

  260. </div>
    261. 

  261. <div class="memdoc">
    262. 

  262. <p>the Service Ticket provided in the URL of the request if present (empty otherwise). Written by CAS_Client::CAS_Client(), read by CAS_Client::getST() and CAS_Client::hasPGT(). </p>
    263. 

  263. 

  264. <p>Definition at line <a class="el" href="Client_8php_source.html#l01412">1412</a> of file <a class="el" href="Client_8php_source.html">Client.php</a>.</p>
    265. 

  265. 

  266. </div>
    267. 

  267. </div>
    268. 

  268. </div>
    269. 

  269. <hr class="footer"/><address class="footer"><small>Generated on Sun Jun 5 2011 19:05:26 for phpCAS by&nbsp;
    270. 

  270. <a href="http://www.doxygen.org/index.html">
    271. 

  271. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
    272. 

  272. </body>
    273. 

  273. </html>
    274. 

  274.