davical/docs/api/davical/PublicSession/PublicSession.html
2011-10-24 20:27:43 +13:00

139 lines
4.5 KiB
HTML

<?xml version="1.0" encoding="iso-8859-1"?>
<!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>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class PublicSession</title>
<link rel="stylesheet" href="../../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> PublicSession</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A Class for handling a public (anonymous) session</p>
<p class="notes">
Located in <a class="field" href="_inc---PublicSession.php.html">/inc/PublicSession.php</a> (line <span class="field">17</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-result">PublicSession</span>
<a href="#PublicSession" title="details" class="method-name">PublicSession</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">boolean</span>
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodPublicSession" id="PublicSession"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Constructor.png" />
<span class="method-title">Constructor PublicSession</span> (line <span class="line-number">56</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The constructor, which just calls the actual type configured</p>
<div class="method-signature">
<span class="method-result">PublicSession</span>
<span class="method-name">
PublicSession
</span>
()
</div>
</div>
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">AllowedTo</span> (line <span class="line-number">92</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks whether a user is allowed to do something.</p>
<p class="description"><p>The check is performed to see if the user has that role.</p></p>
<ul class="tags">
<li><span class="field">return:</span> Whether or not the user has the specified role.</li>
</ul>
<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
AllowedTo
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$whatever</span><span class="var-description">: The role we want to know if the user has.</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Mon, 24 Oct 2011 20:09:29 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>