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 pathAbstract_8php_source.html
More file actions
70 lines (70 loc) · 16.7 KB
/
Copy pathAbstract_8php_source.html
File metadata and controls
70 lines (70 loc) · 16.7 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
<!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/ProxiedService/Abstract.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_3ea6d2ae2c061ed543006d733b30f2af.html">ProxiedService</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Abstract.php</div> </div>
</div><!--header-->
<div class="contents">
<a href="Abstract_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="l00041"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html"> 41</a></span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="classCAS__ProxiedService__Abstract.html">CAS_ProxiedService_Abstract</a></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">implements</span> <a class="code" href="interfaceCAS__ProxiedService.html">CAS_ProxiedService</a>, <a class="code" href="interfaceCAS__ProxiedService__Testable.html">CAS_ProxiedService_Testable</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#ab8c4883fd2ce6a059fdaaba258ecc521"> 49</a></span>  <span class="keyword">private</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#ab8c4883fd2ce6a059fdaaba258ecc521">$_proxyTicket</a>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#a98f8a839194f72d7d6ab05931b9878dc"> 61</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#a98f8a839194f72d7d6ab05931b9878dc">setProxyTicket</a> ($proxyTicket)</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">if</span> (empty($proxyTicket)) {</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classCAS__InvalidArgumentException.html">CAS_InvalidArgumentException</a>(</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="stringliteral">'Trying to initialize with an empty proxy ticket.'</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  );</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keywordflow">if</span> (!empty($this->_proxyTicket)) {</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classCAS__OutOfSequenceException.html">CAS_OutOfSequenceException</a>(</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="stringliteral">'Already initialized, cannot change the proxy ticket.'</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  );</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  }</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  $this->_proxyTicket = $proxyTicket;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div><div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#ae0935c6797975015804403ea217b8c9a"> 83</a></span>  <span class="keyword">protected</span> <span class="keyword">function</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#ae0935c6797975015804403ea217b8c9a">getProxyTicket</a> ()</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">if</span> (empty($this->_proxyTicket)) {</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classCAS__OutOfSequenceException.html">CAS_OutOfSequenceException</a>(</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="stringliteral">'No proxy ticket yet. Call $this->initializeProxyTicket() to aquire the proxy ticket.'</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  );</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="keywordflow">return</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#ab8c4883fd2ce6a059fdaaba258ecc521">$this->_proxyTicket</a>;</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00097"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#aa0ae0bb2854d179f8d72756fe7894394"> 97</a></span>  <span class="keyword">private</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#aa0ae0bb2854d179f8d72756fe7894394">$_casClient</a>;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#a8287e46abc27c66a92f3c5162b586310"> 112</a></span>  <span class="keyword">public</span> <span class="keyword">function</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#a8287e46abc27c66a92f3c5162b586310">setCasClient</a> (<a class="code" href="classCAS__Client.html">CAS_Client</a> $casClient)</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  {</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="keywordflow">if</span> (!empty($this->_proxyTicket)) {</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classCAS__OutOfSequenceException.html">CAS_OutOfSequenceException</a>(</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="stringliteral">'Already initialized, cannot change the CAS_Client.'</span></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="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  $this->_casClient = $casClient;</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  }</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="classCAS__ProxiedService__Abstract.html#a8d16ba3f8db0c521f88440b685746693"> 133</a></span>  <span class="keyword">protected</span> <span class="keyword">function</span> <a class="code" href="classCAS__ProxiedService__Abstract.html#a8d16ba3f8db0c521f88440b685746693">initializeProxyTicket</a>()</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  {</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  <span class="keywordflow">if</span> (!empty($this->_proxyTicket)) {</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="classCAS__OutOfSequenceException.html">CAS_OutOfSequenceException</a>(</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="stringliteral">'Already initialized, cannot initialize again.'</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  );</div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  }</div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="comment">// Allow usage of a particular CAS_Client for unit testing.</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  <span class="keywordflow">if</span> (empty($this->_casClient)) {</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <a class="code" href="group__publicServices.html#ga36fd2939c6bb0d45567512de80994569">phpCAS::initializeProxiedService</a>($this);</div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  $this->_casClient->initializeProxiedService($this);</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  }</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  }</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> }</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> ?></div><div class="ttc" id="classCAS__ProxiedService__Abstract_html_ab8c4883fd2ce6a059fdaaba258ecc521"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#ab8c4883fd2ce6a059fdaaba258ecc521">CAS_ProxiedService_Abstract\$_proxyTicket</a></div><div class="ttdeci">$_proxyTicket</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00049">Abstract.php:49</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html_a8287e46abc27c66a92f3c5162b586310"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#a8287e46abc27c66a92f3c5162b586310">CAS_ProxiedService_Abstract\setCasClient</a></div><div class="ttdeci">setCasClient(CAS_Client $casClient)</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00112">Abstract.php:112</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html_a8d16ba3f8db0c521f88440b685746693"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#a8d16ba3f8db0c521f88440b685746693">CAS_ProxiedService_Abstract\initializeProxyTicket</a></div><div class="ttdeci">initializeProxyTicket()</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00133">Abstract.php:133</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html">CAS_ProxiedService_Abstract</a></div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00041">Abstract.php:41</a></div></div>
<div class="ttc" id="interfaceCAS__ProxiedService_html"><div class="ttname"><a href="interfaceCAS__ProxiedService.html">CAS_ProxiedService</a></div><div class="ttdef"><b>Definition:</b> <a href="ProxiedService_8php_source.html#l00047">ProxiedService.php:47</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html_a98f8a839194f72d7d6ab05931b9878dc"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#a98f8a839194f72d7d6ab05931b9878dc">CAS_ProxiedService_Abstract\setProxyTicket</a></div><div class="ttdeci">setProxyTicket($proxyTicket)</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00061">Abstract.php:61</a></div></div>
<div class="ttc" id="classCAS__OutOfSequenceException_html"><div class="ttname"><a href="classCAS__OutOfSequenceException.html">CAS_OutOfSequenceException</a></div><div class="ttdef"><b>Definition:</b> <a href="OutOfSequenceException_8php_source.html#l00044">OutOfSequenceException.php:44</a></div></div>
<div class="ttc" id="classCAS__InvalidArgumentException_html"><div class="ttname"><a href="classCAS__InvalidArgumentException.html">CAS_InvalidArgumentException</a></div><div class="ttdef"><b>Definition:</b> <a href="InvalidArgumentException_8php_source.html#l00040">InvalidArgumentException.php:40</a></div></div>
<div class="ttc" id="group__publicServices_html_ga36fd2939c6bb0d45567512de80994569"><div class="ttname"><a href="group__publicServices.html#ga36fd2939c6bb0d45567512de80994569">phpCAS\initializeProxiedService</a></div><div class="ttdeci">static initializeProxiedService(CAS_ProxiedService $proxiedService)</div><div class="ttdef"><b>Definition:</b> <a href="CAS_8php_source.html#l00943">CAS.php:943</a></div></div>
<div class="ttc" id="interfaceCAS__ProxiedService__Testable_html"><div class="ttname"><a href="interfaceCAS__ProxiedService__Testable.html">CAS_ProxiedService_Testable</a></div><div class="ttdef"><b>Definition:</b> <a href="Testable_8php_source.html#l00056">Testable.php:56</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html_ae0935c6797975015804403ea217b8c9a"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#ae0935c6797975015804403ea217b8c9a">CAS_ProxiedService_Abstract\getProxyTicket</a></div><div class="ttdeci">getProxyTicket()</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00083">Abstract.php:83</a></div></div>
<div class="ttc" id="classCAS__Client_html"><div class="ttname"><a href="classCAS__Client.html">CAS_Client</a></div><div class="ttdef"><b>Definition:</b> <a href="Client_8php_source.html#l00053">Client.php:53</a></div></div>
<div class="ttc" id="classCAS__ProxiedService__Abstract_html_aa0ae0bb2854d179f8d72756fe7894394"><div class="ttname"><a href="classCAS__ProxiedService__Abstract.html#aa0ae0bb2854d179f8d72756fe7894394">CAS_ProxiedService_Abstract\$_casClient</a></div><div class="ttdeci">$_casClient</div><div class="ttdef"><b>Definition:</b> <a href="Abstract_8php_source.html#l00097">Abstract.php:97</a></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.