docs/api/davical/caldav/_inc---schedule-functions.php.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 page schedule-functions.php</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="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/schedule-functions.php</h2>
  13
  14 <a name="sec-description"></a>
  15 <div class="info-box">
  16         <div class="info-box-title">Description</div>
  17         <div class="nav-bar">
  18                                         <span class="disabled">Description</span> |
  19                                                                         <a href="#sec-includes">Includes</a>
  20                         |                                                                                       <a href="#sec-functions">Functions</a>
  21                         </div>
  22         <div class="info-box-body">
  23                 <!-- ========== Info from phpDoc block ========= -->
  24 <p class="short-description">Functions for handling CalDAV Scheduling.</p>
  25         <ul class="tags">
  26                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
  27                                 <li><span class="field">copyright:</span> Morphoss Ltd - http://www.morphoss.com/</li>
  28                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later version</a></li>
  29                         </ul>
  30
  31                         </div>
  32 </div>
  33
  34
  35         <a name="sec-includes"></a>
  36         <div class="info-box">
  37                 <div class="info-box-title">Includes</div>
  38                 <div class="nav-bar">
  39                         <a href="#sec-description">Description</a> |
  40                                                 <span class="disabled">Includes</span>
  41                         |                                                                                                       <a href="#sec-functions">Functions</a>
  42                                         </div>
  43                 <div class="info-box-body">
  44                         <a name="_RRule-v2_php"><!-- --></a>
  45 <div class="oddrow">
  46
  47         <div>
  48                 <img src="../../media/images/Page.png" alt=" " />
  49                 <span class="include-title">
  50                         <span class="include-type">require_once</span>
  51                         (<span class="include-name"><a href="../../awl/caldav/_inc---RRule-v2.php.html">'RRule-v2.php'</a></span>)
  52                         (line <span class="line-number">14</span>)
  53                 </span>
  54         </div>
  55
  56         <!-- ========== Info from phpDoc block ========= -->
  57
  58 </div>
  59 <a name="_WritableCollection_php"><!-- --></a>
  60 <div class="evenrow">
  61
  62         <div>
  63                 <img src="../../media/images/Page.png" alt=" " />
  64                 <span class="include-title">
  65                         <span class="include-type">require_once</span>
  66                         (<span class="include-name"><a href="../../davical/_inc---WritableCollection.php.html">'WritableCollection.php'</a></span>)
  67                         (line <span class="line-number">13</span>)
  68                 </span>
  69         </div>
  70
  71         <!-- ========== Info from phpDoc block ========= -->
  72
  73 </div>
  74 <a name="_vCalendar_php"><!-- --></a>
  75 <div class="oddrow">
  76
  77         <div>
  78                 <img src="../../media/images/Page.png" alt=" " />
  79                 <span class="include-title">
  80                         <span class="include-type">require_once</span>
  81                         (<span class="include-name">'vCalendar.php'</span>)
  82                         (line <span class="line-number">12</span>)
  83                 </span>
  84         </div>
  85
  86         <!-- ========== Info from phpDoc block ========= -->
  87 <p class="short-description">Functions for handling CalDAV Scheduling.</p>
  88         <ul class="tags">
  89                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>&gt;</li>
  90                                 <li><span class="field">copyright:</span> Morphoss Ltd - http://www.morphoss.com/</li>
  91                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later version</a></li>
  92                         </ul>
  93
  94 </div>
  95                 </div>
  96         </div>
  97
  98
  99
 100         <a name="sec-functions"></a>
 101         <div class="info-box">
 102                 <div class="info-box-title">Functions</div>
 103                 <div class="nav-bar">
 104                         <a href="#sec-description">Description</a> |
 105                                                                                 <a href="#sec-includes">Includes</a>
 106                                 |                                                                                               <span class="disabled">Functions</span>
 107                 </div>
 108                 <div class="info-box-body">
 109                         <a name="functiondeliverItipCancel" id="functiondeliverItipCancel"><!-- --></a>
 110 <div class="evenrow">
 111
 112         <div>
 113                 <img src="../../media/images/Function.png" />
 114                 <span class="method-title">deliverItipCancel</span> (line <span class="line-number">312</span>)
 115         </div>
 116
 117         <!-- ========== Info from phpDoc block ========= -->
 118 <p class="short-description">Delivers the iTIP CANCEL message to an ATTENDEE's Scheduling Inbox Collection.</p>
 119 <p class="description"><p>This is pretty simple at present, but could be extended in the future to do the sending  of e-mail to a remote attendee.</p></p>
 120         <div class="method-signature">
 121                 <span class="method-result">void</span>
 122                 <span class="method-name">
 123                         deliverItipCancel
 124                 </span>
 125                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$iTIP</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$attendee</span>, <span class="var-type"><a href="../../davical/Resource/WritableCollection.html">WritableCollection</a></span>&nbsp;<span class="var-name">$attendee_inbox</span>)
 126                         </div>
 127
 128                         <ul class="parameters">
 129                                         <li>
 130                                 <span class="var-type">vCalendar</span>
 131                                 <span class="var-name">$iTIP</span>                     </li>
 132                                         <li>
 133                                 <span class="var-type">vProperty</span>
 134                                 <span class="var-name">$attendee</span>                 </li>
 135                                         <li>
 136                                 <span class="var-type"><a href="../../davical/Resource/WritableCollection.html">WritableCollection</a></span>
 137                                 <span class="var-name">$attendee_inbox</span>                   </li>
 138                                 </ul>
 139
 140
 141 </div>
 142 <a name="functiondoItipAttendeeReply" id="functiondoItipAttendeeReply"><!-- --></a>
 143 <div class="oddrow">
 144
 145         <div>
 146                 <img src="../../media/images/Function.png" />
 147                 <span class="method-title">doItipAttendeeReply</span> (line <span class="line-number">67</span>)
 148         </div>
 149
 150         <!-- ========== Info from phpDoc block ========= -->
 151 <p class="short-description">Do the scheduling adjustments for a REPLY when an ATTENDEE updates their status.</p>
 152         <div class="method-signature">
 153                 <span class="method-result">void</span>
 154                 <span class="method-name">
 155                         doItipAttendeeReply
 156                 </span>
 157                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$partstat</span>, <span class="var-type">vCalendar</span>&nbsp;<span class="var-name">$vcal</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$organizer</span>)
 158                         </div>
 159
 160                         <ul class="parameters">
 161                                         <li>
 162                                 <span class="var-type">vCalendar</span>
 163                                 <span class="var-name">$vcal</span><span class="var-description">: The resource that the ATTENDEE is writing to their calendar</span>                   </li>
 164                                         <li>
 165                                 <span class="var-type">string</span>
 166                                 <span class="var-name">$organizer</span><span class="var-description">: The property which is the event ORGANIZER.</span>                       </li>
 167                                         <li>
 168                                 <span class="var-type">vCalendar</span>
 169                                 <span class="var-name">$resource</span>                 </li>
 170                                         <li>
 171                                 <span class="var-type"></span>
 172                                 <span class="var-name">$partstat</span>                 </li>
 173                                 </ul>
 174
 175
 176 </div>
 177 <a name="functiondoItipOrganizerCancel" id="functiondoItipOrganizerCancel"><!-- --></a>
 178 <div class="evenrow">
 179
 180         <div>
 181                 <img src="../../media/images/Function.png" />
 182                 <span class="method-title">doItipOrganizerCancel</span> (line <span class="line-number">207</span>)
 183         </div>
 184
 185         <!-- ========== Info from phpDoc block ========= -->
 186 <p class="short-description">Handles sending the iTIP CANCEL messages to each ATTENDEE by the ORGANIZER.</p>
 187         <div class="method-signature">
 188                 <span class="method-result">void</span>
 189                 <span class="method-name">
 190                         doItipOrganizerCancel
 191                 </span>
 192                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$vcal</span>)
 193                         </div>
 194
 195                         <ul class="parameters">
 196                                         <li>
 197                                 <span class="var-type">vCalendar</span>
 198                                 <span class="var-name">$vcal</span><span class="var-description">: What's being cancelled.</span>                       </li>
 199                                 </ul>
 200
 201
 202 </div>
 203 <a name="functiondo_scheduling_for_delete" id="functiondo_scheduling_for_delete"><!-- --></a>
 204 <div class="oddrow">
 205
 206         <div>
 207                 <img src="../../media/images/Function.png" />
 208                 <span class="method-title">do_scheduling_for_delete</span> (line <span class="line-number">24</span>)
 209         </div>
 210
 211         <!-- ========== Info from phpDoc block ========= -->
 212 <p class="short-description">Entry point for scheduling on DELETE, for which there are thee outcomes: <ul><li>We don't do scheduling (disabled, no organizer, ...)</li><li>We are an ATTENDEE declining the meeting.</li></ul></p>
 213 <p class="description"><p><ul><li>We are the ORGANIZER canceling the meeting.</li></ul></p></p>
 214         <div class="method-signature">
 215                 <span class="method-result">void</span>
 216                 <span class="method-name">
 217                         do_scheduling_for_delete
 218                 </span>
 219                                         (<span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>&nbsp;<span class="var-name">$deleted_resource</span>)
 220                         </div>
 221
 222                         <ul class="parameters">
 223                                         <li>
 224                                 <span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>
 225                                 <span class="var-name">$deleted_resource</span><span class="var-description">: The resource which has already been deleted</span>                       </li>
 226                                 </ul>
 227
 228
 229 </div>
 230 <a name="functionGetItip" id="functionGetItip"><!-- --></a>
 231 <div class="evenrow">
 232
 233         <div>
 234                 <img src="../../media/images/Function.png" />
 235                 <span class="method-title">GetItip</span> (line <span class="line-number">178</span>)
 236         </div>
 237
 238         <!-- ========== Info from phpDoc block ========= -->
 239         <div class="method-signature">
 240                 <span class="method-result">void</span>
 241                 <span class="method-name">
 242                         GetItip
 243                 </span>
 244                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$vcal</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$method</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$attendee_value</span>)
 245                         </div>
 246
 247                         <ul class="parameters">
 248                                         <li>
 249                                 <span class="var-type">VCalendar</span>
 250                                 <span class="var-name">$vcal</span>                     </li>
 251                                         <li>
 252                                 <span class="var-type"></span>
 253                                 <span class="var-name">$method</span>                   </li>
 254                                         <li>
 255                                 <span class="var-type"></span>
 256                                 <span class="var-name">$attendee_value</span>                   </li>
 257                                 </ul>
 258
 259
 260 </div>
 261 <a name="functionprocessItipCancel" id="functionprocessItipCancel"><!-- --></a>
 262 <div class="oddrow">
 263
 264         <div>
 265                 <img src="../../media/images/Function.png" />
 266                 <span class="method-title">processItipCancel</span> (line <span class="line-number">265</span>)
 267         </div>
 268
 269         <!-- ========== Info from phpDoc block ========= -->
 270 <p class="short-description">Does the actual processing of the iTIP CANCEL message on behalf of an ATTENDEE,  which generally means writing it into the ATTENDEE's default calendar.</p>
 271         <div class="method-signature">
 272                 <span class="method-result">void</span>
 273                 <span class="method-name">
 274                         processItipCancel
 275                 </span>
 276                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$vcal</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$attendee</span>, <span class="var-type"><a href="../../davical/Resource/WritableCollection.html">WritableCollection</a></span>&nbsp;<span class="var-name">$attendee_calendar</span>, <span class="var-type"><a href="../../davical/Principal/Principal.html">Principal</a></span>&nbsp;<span class="var-name">$attendee_principal</span>)
 277                         </div>
 278
 279                         <ul class="parameters">
 280                                         <li>
 281                                 <span class="var-type">vCalendar</span>
 282                                 <span class="var-name">$vcal</span><span class="var-description">: The message.</span>                  </li>
 283                                         <li>
 284                                 <span class="var-type">vProperty</span>
 285                                 <span class="var-name">$attendee</span>                 </li>
 286                                         <li>
 287                                 <span class="var-type"><a href="../../davical/Resource/WritableCollection.html">WritableCollection</a></span>
 288                                 <span class="var-name">$attendee_calendar</span>                        </li>
 289                                         <li>
 290                                 <span class="var-type"><a href="../../davical/Principal/Principal.html">Principal</a></span>
 291                                 <span class="var-name">$attendee_principal</span>                       </li>
 292                                 </ul>
 293
 294
 295 </div>
 296                 </div>
 297         </div>
 298
 299         <p class="notes" id="credit">
 300                 Documentation generated on Wed, 04 Jul 2012 10:13:10 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 301         </p>
 302         </div></body>
 303 </html>