Skip to content
Navigation Menu
{{ message }}
forked from apereo/phpCAS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRequestInterface_8php_source.html
More file actions
71 lines (71 loc) · 13.8 KB
/
Copy pathRequestInterface_8php_source.html
File metadata and controls
71 lines (71 loc) · 13.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>phpCAS: CAS/Request/RequestInterface.php Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">phpCAS
 <span id="projectnumber">version 1.4.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d6cb456e360d6a38dbcc12a4401fb45b.html">CAS</a></li><li class="navelem"><a class="el" href="dir_41889cd1e1ce72002501d0383b9b8391.html">Request</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">RequestInterface.php</div> </div>
</div><!--header-->
<div class="contents">
<a href="RequestInterface_8php.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <?php</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div><div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="interfaceCAS__Request__RequestInterface.html"> 40</a></span> <span class="keyword">interface </span><a class="code" href="interfaceCAS__Request__RequestInterface.html">CAS_Request_RequestInterface</a></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> {</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">/*********************************************************</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * Configure the Request</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> *********************************************************/</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a4aee4b78f14270b276d59b2adc50b676">setUrl</a> ($url);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a0f3b9b56bee2f21855860acc1e6f1b57">addCookie</a> ($name, $value);</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a8d54e606f87fe0ddeb65bdb72182af4b">addCookies</a> (array $cookies);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a80112981b949158c5954c817a963a9ac">addHeader</a> ($header);</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a9595247e477d9a1d62b57272973c92a0">addHeaders</a> (array $headers);</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a3fd2685cdd443114cb7294456ced87ba">makePost</a> ();</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#ae65d1295dfc9854e0078719b967e074a">setPostBody</a> ($body);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#ad13f42a9da2454c1d9a873691796f042">setSslCaCert</a> ($caCertPath, $validate_cn = <span class="keyword">true</span>);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="comment">/*********************************************************</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * 2. Send the Request</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> *********************************************************/</span></div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a52d58b96af2fe9cb1c590fe96bc9a24e">send</a> ();</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  <span class="comment">/*********************************************************</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * 3. Access the response</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> *********************************************************/</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#aabb876dadcd46b98a095ccf7a534f95b">getResponseHeaders</a> ();</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> </div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a0294a5b68dc601186e00aecbd611bd9b">getResponseStatusCode</a> ();</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a8b4aeacc8930c2cf242ea0d52f811efb">getResponseBody</a> ();</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> </div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="interfaceCAS__Request__RequestInterface.html#a6d2fec64720b3f744b159055e99e0204">getErrorMessage</a> ();</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> }</div><div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a0294a5b68dc601186e00aecbd611bd9b"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a0294a5b68dc601186e00aecbd611bd9b">CAS_Request_RequestInterface\getResponseStatusCode</a></div><div class="ttdeci">getResponseStatusCode()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html">CAS_Request_RequestInterface</a></div><div class="ttdef"><b>Definition:</b> <a href="RequestInterface_8php_source.html#l00040">RequestInterface.php:40</a></div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_ae65d1295dfc9854e0078719b967e074a"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#ae65d1295dfc9854e0078719b967e074a">CAS_Request_RequestInterface\setPostBody</a></div><div class="ttdeci">setPostBody($body)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a3fd2685cdd443114cb7294456ced87ba"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a3fd2685cdd443114cb7294456ced87ba">CAS_Request_RequestInterface\makePost</a></div><div class="ttdeci">makePost()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a52d58b96af2fe9cb1c590fe96bc9a24e"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a52d58b96af2fe9cb1c590fe96bc9a24e">CAS_Request_RequestInterface\send</a></div><div class="ttdeci">send()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a9595247e477d9a1d62b57272973c92a0"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a9595247e477d9a1d62b57272973c92a0">CAS_Request_RequestInterface\addHeaders</a></div><div class="ttdeci">addHeaders(array $headers)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_ad13f42a9da2454c1d9a873691796f042"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#ad13f42a9da2454c1d9a873691796f042">CAS_Request_RequestInterface\setSslCaCert</a></div><div class="ttdeci">setSslCaCert($caCertPath, $validate_cn=true)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a8b4aeacc8930c2cf242ea0d52f811efb"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a8b4aeacc8930c2cf242ea0d52f811efb">CAS_Request_RequestInterface\getResponseBody</a></div><div class="ttdeci">getResponseBody()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a0f3b9b56bee2f21855860acc1e6f1b57"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a0f3b9b56bee2f21855860acc1e6f1b57">CAS_Request_RequestInterface\addCookie</a></div><div class="ttdeci">addCookie($name, $value)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a4aee4b78f14270b276d59b2adc50b676"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a4aee4b78f14270b276d59b2adc50b676">CAS_Request_RequestInterface\setUrl</a></div><div class="ttdeci">setUrl($url)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_aabb876dadcd46b98a095ccf7a534f95b"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#aabb876dadcd46b98a095ccf7a534f95b">CAS_Request_RequestInterface\getResponseHeaders</a></div><div class="ttdeci">getResponseHeaders()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a8d54e606f87fe0ddeb65bdb72182af4b"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a8d54e606f87fe0ddeb65bdb72182af4b">CAS_Request_RequestInterface\addCookies</a></div><div class="ttdeci">addCookies(array $cookies)</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a6d2fec64720b3f744b159055e99e0204"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a6d2fec64720b3f744b159055e99e0204">CAS_Request_RequestInterface\getErrorMessage</a></div><div class="ttdeci">getErrorMessage()</div></div>
<div class="ttc" id="interfaceCAS__Request__RequestInterface_html_a80112981b949158c5954c817a963a9ac"><div class="ttname"><a href="interfaceCAS__Request__RequestInterface.html#a80112981b949158c5954c817a963a9ac">CAS_Request_RequestInterface\addHeader</a></div><div class="ttdeci">addHeader($header)</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
You can’t perform that action at this time.