docs/api/davical/DAViCalSession/DAViCalSession.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 DAViCalSession</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"> DAViCalSession</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 creating and holding session information.</p>
  28                 <p class="notes">
  29                         Located in <a class="field" href="_inc---DAViCalSession.php.html">/inc/DAViCalSession.php</a> (line <span class="field">47</span>)
  30                 </p>
  31
  32
  33                 <pre>Session
  34    |
  35    --DAViCalSession</pre>
  36
  37                         </div>
  38 </div>
  39
  40
  41
  42
  43         <a name="sec-method-summary"></a>
  44         <div class="info-box">
  45                 <div class="info-box-title">Method Summary</span></div>
  46                 <div class="nav-bar">
  47                         <a href="#sec-description">Description</a> |
  48                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  49                 </div>
  50                 <div class="info-box-body">
  51                         <div class="method-summary">
  52                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  53                                         <img src="../../media/images/Constructor.png" alt=" "/>
  54                                                                                         <span class="method-result">DAViCalSession</span>
  55                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  56                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$sid</span> = <span class="var-default">''</span>])
  57                                                                         </div>
  58                                                                                                                                 <div class="method-definition">
  59                                         <img src="../../media/images/Method.png" alt=" "/>
  60                                                                                         <span class="method-result">void</span>
  61                                                                                 <a href="#AssignSessionDetails" title="details" class="method-name">AssignSessionDetails</a>
  62                                                                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">$u</span>)
  63                                                                         </div>
  64                                                                                                                                 <div class="method-definition">
  65                                         <img src="../../media/images/Method.png" alt=" "/>
  66                                                                                         <span class="method-result">void</span>
  67                                                                                 <a href="#GetRoles" title="details" class="method-name">GetRoles</a>
  68                                                                                 ()
  69                                                                         </div>
  70                                                                                                                                 <div class="method-definition">
  71                                         <img src="../../media/images/Method.png" alt=" "/>
  72                                                                                         <span class="method-result">boolean</span>
  73                                                                                 <a href="#LoginRequired" title="details" class="method-name">LoginRequired</a>
  74                                                                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$roles</span> = <span class="var-default">''</span>])
  75                                                                         </div>
  76                                                                                         </div>
  77                 </div>
  78         </div>
  79
  80
  81         <a name="sec-methods"></a>
  82         <div class="info-box">
  83                 <div class="info-box-title">Methods</div>
  84                 <div class="nav-bar">
  85                         <a href="#sec-description">Description</a> |
  86                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  87
  88                 </div>
  89                 <div class="info-box-body">
  90                         <A NAME='method_detail'></A>
  91 <a name="method__construct" id="__construct"><!-- --></a>
  92 <div class="oddrow">
  93
  94         <div class="method-header">
  95                 <img src="../../media/images/Constructor.png" />
  96                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">58</span>)
  97         </div>
  98
  99         <!-- ========== Info from phpDoc block ========= -->
 100 <p class="short-description">Create a new DAViCalSession object.</p>
 101 <p class="description"><p>We create a Session and extend it with some additional useful DAViCal  related information.</p></p>
 102
 103         <div class="method-signature">
 104                 <span class="method-result">DAViCalSession</span>
 105                 <span class="method-name">
 106                         __construct
 107                 </span>
 108                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$sid</span> = <span class="var-default">''</span>])
 109                         </div>
 110
 111                         <ul class="parameters">
 112                                         <li>
 113                                 <span class="var-type">string</span>
 114                                 <span class="var-name">$sid</span><span class="var-description">: A session identifier.</span>                  </li>
 115                                 </ul>
 116
 117
 118         </div>
 119 <a name="methodAssignSessionDetails" id="AssignSessionDetails"><!-- --></a>
 120 <div class="evenrow">
 121
 122         <div class="method-header">
 123                 <img src="../../media/images/Method.png" />
 124                 <span class="method-title">AssignSessionDetails</span> (line <span class="line-number">67</span>)
 125         </div>
 126
 127         <!-- ========== Info from phpDoc block ========= -->
 128 <p class="short-description">Internal function used to assign the session details to a user's new session.</p>
 129
 130         <div class="method-signature">
 131                 <span class="method-result">void</span>
 132                 <span class="method-name">
 133                         AssignSessionDetails
 134                 </span>
 135                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">$u</span>)
 136                         </div>
 137
 138                         <ul class="parameters">
 139                                         <li>
 140                                 <span class="var-type">object</span>
 141                                 <span class="var-name">$u</span><span class="var-description">: The user+session object we (probably) read from the database.</span>                    </li>
 142                                 </ul>
 143
 144
 145         </div>
 146 <a name="methodGetRoles" id="GetRoles"><!-- --></a>
 147 <div class="oddrow">
 148
 149         <div class="method-header">
 150                 <img src="../../media/images/Method.png" />
 151                 <span class="method-title">GetRoles</span> (line <span class="line-number">87</span>)
 152         </div>
 153
 154         <!-- ========== Info from phpDoc block ========= -->
 155 <p class="short-description">Method used to get the user's roles</p>
 156
 157         <div class="method-signature">
 158                 <span class="method-result">void</span>
 159                 <span class="method-name">
 160                         GetRoles
 161                 </span>
 162                                 ()
 163                         </div>
 164
 165
 166
 167         </div>
 168 <a name="methodLoginRequired" id="LoginRequired"><!-- --></a>
 169 <div class="evenrow">
 170
 171         <div class="method-header">
 172                 <img src="../../media/images/Method.png" />
 173                 <span class="method-title">LoginRequired</span> (line <span class="line-number">108</span>)
 174         </div>
 175
 176         <!-- ========== Info from phpDoc block ========= -->
 177 <p class="short-description">Checks that this user is logged in, and presents a login screen if they aren't.</p>
 178 <p class="description"><p>The function can optionally confirm whether they are a member of one of a list  of roles, and deny access if they are not a member of any of them.</p></p>
 179         <ul class="tags">
 180                                 <li><span class="field">return:</span> Whether or not the user is logged in and is a member of one of the required roles.</li>
 181                         </ul>
 182
 183         <div class="method-signature">
 184                 <span class="method-result">boolean</span>
 185                 <span class="method-name">
 186                         LoginRequired
 187                 </span>
 188                                         ([<span class="var-type">string</span>&nbsp;<span class="var-name">$roles</span> = <span class="var-default">''</span>])
 189                         </div>
 190
 191                         <ul class="parameters">
 192                                         <li>
 193                                 <span class="var-type">string</span>
 194                                 <span class="var-name">$roles</span><span class="var-description">: The list of roles that the user must be a member of one of to be allowed to proceed.</span>                 </li>
 195                                 </ul>
 196
 197
 198         </div>
 199
 200                 </div>
 201         </div>
 202
 203
 204         <p class="notes" id="credit">
 205                 Documentation generated on Tue, 27 Sep 2011 11:30:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 206         </p>
 207         </div></body>
 208 </html>