← Back to branch summary

~wenbo/kylin-software-center/ukdlp

« back to all changes in this revision

Viewing changes to CAS-1.1.2RC2/docs/api/classphpCAS.html

  • Committer: wenbo
  • Date: 2018-05-29 07:53:32 UTC
  • Revision ID: wenbo@kylinos.cn-20180529075332-4omip2b16o9rgxuz
ukdlp init 2.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
CAS-1.1.2RC2/docs/api/classphpCAS.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>phpCAS: phpCAS Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.6.3 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul>
 
14
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
16
      <li><a href="modules.html"><span>Modules</span></a></li>
 
17
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
18
      <li><a href="files.html"><span>Files</span></a></li>
 
19
      <li><a href="examples.html"><span>Examples</span></a></li>
 
20
    </ul>
 
21
  </div>
 
22
  <div class="tabs">
 
23
    <ul>
 
24
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
 
25
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
 
26
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
 
27
    </ul>
 
28
  </div>
 
29
</div>
 
30
<div class="contents">
 
31
<h1>phpCAS Class Reference<br/>
 
32
<small>
 
33
[<a class="el" href="group__public.html">User interface</a>]</small>
 
34
</h1><!-- doxytag: class="phpCAS" -->
 
35
<p><a href="classphpCAS-members.html">List of all members.</a></p>
 
36
<table border="0" cellpadding="0" cellspacing="0">
 
37
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
 
38
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicInit.html#gacc9952fabf1ad3d282ebfcb2a7722f04">client</a> ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)</td></tr>
 
39
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicInit.html#ga9926765840fa60ad4a815dc63b79dbe3">proxy</a> ($server_version, $server_hostname, $server_port, $server_uri, $start_session=true)</td></tr>
 
40
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicDebug.html#gad771040b999b544e9da96bcbd86eaf2b">setDebug</a> ($filename= '')</td></tr>
 
41
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga232755cd38f88fb8294db362cb2be107">backtrace</a> ()</td></tr>
 
42
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga8939d840392aa6cf54b57f2e28b77419">trace</a> ($str)</td></tr>
 
43
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga96b9ac0ffbf2ee8c4754c6ca878eb2d6">traceBegin</a> ()</td></tr>
 
44
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#gaa3fbccca1463c53e477a18ecd11b04e8">traceEnd</a> ($res= '')</td></tr>
 
45
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga38887ed1896e7ba9f0e440a3d8ef17ae">traceExit</a> ()</td></tr>
 
46
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicLang.html#ga1bcf4b4f6cb5d5a969c0ebd47c0aa108">setLang</a> ($lang)</td></tr>
 
47
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__public.html#gaba9981b7e9d000cd2023da901c2b71dd">getVersion</a> ()</td></tr>
 
48
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicOutput.html#ga8e807be420013a1089d7b3b29f90212a">setHTMLHeader</a> ($header)</td></tr>
 
49
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicOutput.html#gaa7e83f0e854ede5c6fcdbf69bfa2b268">setHTMLFooter</a> ($footer)</td></tr>
 
50
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicPGTStorage.html#ga563c41191a1a069f1c62d57f33836321">setPGTStorageFile</a> ($format= '', $path= '')</td></tr>
 
51
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicPGTStorage.html#gac813c36dc023e1bfb85601f88620d281">setPGTStorageDB</a> ($user, $password, $database_type= '', $hostname= '', $port=0, $database= '', $table= '')</td></tr>
 
52
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicServices.html#ga4e456e39f1f35df6b3e6b613a698ea1e">serviceWeb</a> ($url, &amp;$err_code, &amp;$output)</td></tr>
 
53
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicServices.html#gac56f9919a058a90c9fef61a07e49db8d">serviceMail</a> ($url, $service, $flags, &amp;$err_code, &amp;$err_msg, &amp;$pt)</td></tr>
 
54
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga0fee5c5f97076e491e3b0ce0eb620a8b">setCacheTimesForAuthRecheck</a> ($n)</td></tr>
 
55
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gaba62986d4729cb8e9ee3b1ad07f295e7">checkAuthentication</a> ()</td></tr>
 
56
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gac9d8abbb3b2d3b2eddf496d805f79649">forceAuthentication</a> ()</td></tr>
 
57
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga62e4c5c20de162ea260d1359c14b54ad">renewAuthentication</a> ()</td></tr>
 
58
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gaa9c3f3e035061c3c920aa9e25f6a86f3">authenticate</a> ()</td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga38f5c54cfbc7009cff06b1c966e24add">isAuthenticated</a> ()</td></tr>
 
60
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gae0f455ca04d3fcf0d285e91a6a795db4">isSessionAuthenticated</a> ()</td></tr>
 
61
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gad145e405b1f4b4e93239a255736df893">getUser</a> ()</td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga1ebdcda2350e4c44aee510db5e8d608d">getAttributes</a> ()</td></tr>
 
63
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga08177ed3360e5772a0d7cfe5463ab945">handleLogoutRequests</a> ($check_client=true, $allowed_clients=false)</td></tr>
 
64
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga6cc82e2084b937d570edd5e7c4f23245">getServerLoginURL</a> ()</td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga2bc1898ecc9f7b2fac015a583c0cd45e">setServerLoginURL</a> ($url= '')</td></tr>
 
66
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gaddd5fc35d30270c1230c334730da0b17">setServerServiceValidateURL</a> ($url= '')</td></tr>
 
67
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gafeda1ee79b77d0ce1d6d2d0be92851d4">setServerProxyValidateURL</a> ($url= '')</td></tr>
 
68
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga06693dae6ae066a7a01155430191c59d">setServerSamlValidateURL</a> ($url= '')</td></tr>
 
69
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga87190fbc1b234e43445d310f0767388e">getServerLogoutURL</a> ()</td></tr>
 
70
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gad448905afe71ee36be6fc20bf9da44b7">setServerLogoutURL</a> ($url= '')</td></tr>
 
71
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga249fefb16da413b4b81fdeb8bd014ad4">logout</a> ($params=&quot;&quot;)</td></tr>
 
72
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga8231548d961e8e15cefa39c8fda9f767">logoutWithRedirectService</a> ($service)</td></tr>
 
73
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gaf78c3a6033369e48a9618144f31a9d01">logoutWithUrl</a> ($url)</td></tr>
 
74
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gab61884d57b47ef7abba326108a2ab690">logoutWithRedirectServiceAndUrl</a> ($service, $url)</td></tr>
 
75
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga3021636349aea23095f207d56626ce59">setFixedCallbackURL</a> ($url= '')</td></tr>
 
76
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gaf3637761775aa2373727bdb1ced7b2c8">setFixedServiceURL</a> ($url)</td></tr>
 
77
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga83b187507ed58d105cc0ac38047747c4">getServiceURL</a> ()</td></tr>
 
78
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga8db51c365c490fa357f464f2a1f40dd4">retrievePT</a> ($target_service, &amp;$err_code, &amp;$err_msg)</td></tr>
 
79
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#ga75c303e6a6489da4c0e256ec707f1d6f">setCasServerCert</a> ($cert)</td></tr>
 
80
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gad614b11ad8e3940dbe46839c51616053">setCasServerCACert</a> ($cert)</td></tr>
 
81
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__publicAuth.html#gacd9bd0c52d0c72a5d746365c4808527a">setNoCasServerValidation</a> ()</td></tr>
 
82
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classphpCAS.html#adc1b2b61a8b7b5119fd7a332d5b52e3a">setExtraCurlOption</a> ($key, $value)</td></tr>
 
83
<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr>
 
84
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga92fcedb5a6fa8bd08bcfdde22d01c1eb">log</a> ($str)</td></tr>
 
85
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__internalDebug.html#ga11258505b061aae4683a3717206c187c">error</a> ($msg)</td></tr>
 
86
</table>
 
87
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
88
<p>The <a class="el" href="classphpCAS.html">phpCAS</a> class is a simple container for the <a class="el" href="classphpCAS.html">phpCAS</a> library. It provides CAS authentication for web applications written in PHP.</p>
 
89
<dl class="author"><dt><b>Author:</b></dt><dd>Pascal Aubry &lt;pascal.aubry at univ-rennes1.fr&gt; </dd></dl>
 
90
<dl><dt><b>Examples: </b></dt><dd>
 
91
<p><a class="el" href="example__custom__urls_8php-example.html#_a6">example_custom_urls.php</a>, <a class="el" href="example__db_8php-example.html#_a6">example_db.php</a>, <a class="el" href="example__file_8php-example.html#_a6">example_file.php</a>, <a class="el" href="example__gateway_8php-example.html#_a7">example_gateway.php</a>, <a class="el" href="example__html_8php-example.html#_a5">example_html.php</a>, <a class="el" href="example__lang_8php-example.html#_a5">example_lang.php</a>, <a class="el" href="example__proxy_8php-example.html#_a4">example_proxy.php</a>, <a class="el" href="example__proxy2_8php-example.html#_a5">example_proxy2.php</a>, <a class="el" href="example__session__proxy_8php-example.html#_a5">example_session_proxy.php</a>, and <a class="el" href="example__simple_8php-example.html#_a5">example_simple.php</a>.</p>
 
92
</dd>
 
93
</dl>
 
94
<p>Definition at line <a class="el" href="CAS_8php_source.html#l00341">341</a> of file <a class="el" href="CAS_8php_source.html">CAS.php</a>.</p>
 
95
<hr/><h2>Member Function Documentation</h2>
 
96
<a class="anchor" id="adc1b2b61a8b7b5119fd7a332d5b52e3a"></a><!-- doxytag: member="phpCAS::setExtraCurlOption" ref="adc1b2b61a8b7b5119fd7a332d5b52e3a" args="($key, $value)" -->
 
97
<div class="memitem">
 
98
<div class="memproto">
 
99
      <table class="memname">
 
100
        <tr>
 
101
          <td class="memname">phpCAS::setExtraCurlOption </td>
 
102
          <td>(</td>
 
103
          <td class="paramtype">$&nbsp;</td>
 
104
          <td class="paramname"> <em>key</em>, </td>
 
105
        </tr>
 
106
        <tr>
 
107
          <td class="paramkey"></td>
 
108
          <td></td>
 
109
          <td class="paramtype">$&nbsp;</td>
 
110
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
 
111
        </tr>
 
112
        <tr>
 
113
          <td></td>
 
114
          <td>)</td>
 
115
          <td></td><td></td><td></td>
 
116
        </tr>
 
117
      </table>
 
118
</div>
 
119
<div class="memdoc">
 
120
<p>Change CURL options. CURL is used to connect through HTTPS to CAS server </p>
 
121
<dl><dt><b>Parameters:</b></dt><dd>
 
122
  <table border="0" cellspacing="2" cellpadding="0">
 
123
    <tr><td valign="top"></td><td valign="top"><em>$key</em>&nbsp;</td><td>the option key </td></tr>
 
124
    <tr><td valign="top"></td><td valign="top"><em>$value</em>&nbsp;</td><td>the value to set </td></tr>
 
125
  </table>
 
126
  </dd>
 
127
</dl>
 
128
 
 
129
<p>Definition at line <a class="el" href="CAS_8php_source.html#l01469">1469</a> of file <a class="el" href="CAS_8php_source.html">CAS.php</a>.</p>
 
130
 
 
131
<p>References <a class="el" href="CAS_8php_source.html#l00544">error()</a>, <a class="el" href="CAS_8php_source.html#l00577">traceBegin()</a>, and <a class="el" href="CAS_8php_source.html#l00604">traceEnd()</a>.</p>
 
132
 
 
133
</div>
 
134
</div>
 
135
</div>
 
136
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Jul 12 08:31:30 2010 for phpCAS by&nbsp;
 
137
<a href="http://www.doxygen.org/index.html">
 
138
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
 
139
</body>
 
140
</html>