docs/api/davical/PublicSession/PublicSession.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3   <html xmlns="http://www.w3.org/1999/xhtml">
   4                 <head>
   5                         <!-- template designed by Marco Von Ballmoos -->
   6                         <title>Docs For Class PublicSession</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9                 </head>
  10                 <body>
  11                         <div class="page-body">
  12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
  13                                                                                                                 alt=" Class"
  14                                                                                                                 title=" Class"
  15                                                                                                                 style="vertical-align: middle"> PublicSession</h2>
  16
  17 <a name="sec-description"></a>
  18 <div class="info-box">
  19         <div class="info-box-title">Description</div>
  20         <div class="nav-bar">
  21                                         <span class="disabled">Description</span> |
  22                                                                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  23
  24                                         </div>
  25         <div class="info-box-body">
  26                         <!-- ========== Info from phpDoc block ========= -->
  27 <p class="short-description">A Class for handling a public (anonymous) session</p>
  28                 <p class="notes">
  29                         Located in <a class="field" href="_inc---PublicSession.php.html">/inc/PublicSession.php</a> (line <span class="field">17</span>)
  30                 </p>
  31
  32
  33                 <pre></pre>
  34
  35                         </div>
  36 </div>
  37
  38
  39
  40
  41         <a name="sec-method-summary"></a>
  42         <div class="info-box">
  43                 <div class="info-box-title">Method Summary</span></div>
  44                 <div class="nav-bar">
  45                         <a href="#sec-description">Description</a> |
  46                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  47                 </div>
  48                 <div class="info-box-body">
  49                         <div class="method-summary">
  50                                                                                                                                                                                                                                                                 <div class="method-definition">
  51                                         <img src="../../media/images/Constructor.png" alt=" "/>
  52                                                                                         <span class="method-result">PublicSession</span>
  53                                                                                 <a href="#PublicSession" title="details" class="method-name">PublicSession</a>
  54                                                                                 ()
  55                                                                         </div>
  56                                                                                                                                 <div class="method-definition">
  57                                         <img src="../../media/images/Method.png" alt=" "/>
  58                                                                                         <span class="method-result">boolean</span>
  59                                                                                 <a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
  60                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
  61                                                                         </div>
  62                                                                                         </div>
  63                 </div>
  64         </div>
  65
  66
  67         <a name="sec-methods"></a>
  68         <div class="info-box">
  69                 <div class="info-box-title">Methods</div>
  70                 <div class="nav-bar">
  71                         <a href="#sec-description">Description</a> |
  72                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  73
  74                 </div>
  75                 <div class="info-box-body">
  76                         <A NAME='method_detail'></A>
  77 <a name="methodPublicSession" id="PublicSession"><!-- --></a>
  78 <div class="oddrow">
  79
  80         <div class="method-header">
  81                 <img src="../../media/images/Constructor.png" />
  82                 <span class="method-title">Constructor PublicSession</span> (line <span class="line-number">56</span>)
  83         </div>
  84
  85         <!-- ========== Info from phpDoc block ========= -->
  86 <p class="short-description">The constructor, which just calls the actual type configured</p>
  87
  88         <div class="method-signature">
  89                 <span class="method-result">PublicSession</span>
  90                 <span class="method-name">
  91                         PublicSession
  92                 </span>
  93                                 ()
  94                         </div>
  95
  96
  97
  98         </div>
  99 <a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
 100 <div class="evenrow">
 101
 102         <div class="method-header">
 103                 <img src="../../media/images/Method.png" />
 104                 <span class="method-title">AllowedTo</span> (line <span class="line-number">92</span>)
 105         </div>
 106
 107         <!-- ========== Info from phpDoc block ========= -->
 108 <p class="short-description">Checks whether a user is allowed to do something.</p>
 109 <p class="description"><p>The check is performed to see if the user has that role.</p></p>
 110         <ul class="tags">
 111                                 <li><span class="field">return:</span> Whether or not the user has the specified role.</li>
 112                         </ul>
 113
 114         <div class="method-signature">
 115                 <span class="method-result">boolean</span>
 116                 <span class="method-name">
 117                         AllowedTo
 118                 </span>
 119                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$whatever</span>)
 120                         </div>
 121
 122                         <ul class="parameters">
 123                                         <li>
 124                                 <span class="var-type">string</span>
 125                                 <span class="var-name">$whatever</span><span class="var-description">: The role we want to know if the user has.</span>                 </li>
 126                                 </ul>
 127
 128
 129         </div>
 130
 131                 </div>
 132         </div>
 133
 134
 135         <p class="notes" id="credit">
 136                 Documentation generated on Tue, 27 Sep 2011 11:30:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 137         </p>
 138         </div></body>
 139 </html>