docs/api/davical/caldav/_inc---caldav-PUT-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 caldav-PUT-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/caldav-PUT-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">CalDAV Server - handle PUT method</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="_vComponent_php"><!-- --></a>
  45 <div class="evenrow">
  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">'vComponent.php'</span>)
  52                         (line <span class="line-number">19</span>)
  53                 </span>
  54         </div>
  55
  56         <!-- ========== Info from phpDoc block ========= -->
  57
  58 </div>
  59 <a name="_WritableCollection_php"><!-- --></a>
  60 <div class="oddrow">
  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">21</span>)
  68                 </span>
  69         </div>
  70
  71         <!-- ========== Info from phpDoc block ========= -->
  72
  73 </div>
  74 <a name="_vCalendar_php"><!-- --></a>
  75 <div class="evenrow">
  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">20</span>)
  83                 </span>
  84         </div>
  85
  86         <!-- ========== Info from phpDoc block ========= -->
  87
  88 </div>
  89 <a name="_AwlCache_php"><!-- --></a>
  90 <div class="oddrow">
  91
  92         <div>
  93                 <img src="../../media/images/Page.png" alt=" " />
  94                 <span class="include-title">
  95                         <span class="include-type">require_once</span>
  96                         (<span class="include-name">'AwlCache.php'</span>)
  97                         (line <span class="line-number">18</span>)
  98                 </span>
  99         </div>
 100
 101         <!-- ========== Info from phpDoc block ========= -->
 102 <p class="short-description">Check if the user wants to put just one VEVENT/VTODO or a whole calendar</p>
 103 <p class="description"><p>if the collection = calendar = $request_container doesn't exist then create it  return true if it's a whole calendar</p></p>
 104
 105 </div>
 106                 </div>
 107         </div>
 108
 109
 110
 111         <a name="sec-functions"></a>
 112         <div class="info-box">
 113                 <div class="info-box-title">Functions</div>
 114                 <div class="nav-bar">
 115                         <a href="#sec-description">Description</a> |
 116                                                                                 <a href="#sec-includes">Includes</a>
 117                                 |                                                                                               <span class="disabled">Functions</span>
 118                 </div>
 119                 <div class="info-box-body">
 120                         <a name="functioncontrolRequestContainer" id="functioncontrolRequestContainer"><!-- --></a>
 121 <div class="evenrow">
 122
 123         <div>
 124                 <img src="../../media/images/Function.png" />
 125                 <span class="method-title">controlRequestContainer</span> (line <span class="line-number">69</span>)
 126         </div>
 127
 128         <!-- ========== Info from phpDoc block ========= -->
 129 <p class="short-description">Work out the location we are doing the PUT to, and check that we have the rights to  do the needful.</p>
 130         <div class="method-signature">
 131                 <span class="method-result">void</span>
 132                 <span class="method-name">
 133                         controlRequestContainer
 134                 </span>
 135                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$username</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$public</span> = <span class="var-default">null</span>])
 136                         </div>
 137
 138                         <ul class="parameters">
 139                                         <li>
 140                                 <span class="var-type">string</span>
 141                                 <span class="var-name">$username</span><span class="var-description">: The name of the destination user</span>                  </li>
 142                                         <li>
 143                                 <span class="var-type">int</span>
 144                                 <span class="var-name">$user_no</span><span class="var-description">: The user making the change</span>                 </li>
 145                                         <li>
 146                                 <span class="var-type">string</span>
 147                                 <span class="var-name">$path</span><span class="var-description">: The DAV path the resource is bing PUT to</span>                      </li>
 148                                         <li>
 149                                 <span class="var-type">boolean</span>
 150                                 <span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span>                       </li>
 151                                         <li>
 152                                 <span class="var-type">boolean</span>
 153                                 <span class="var-name">$public</span><span class="var-description">: Whether the collection will be public, should we need to create it</span>                  </li>
 154                                 </ul>
 155
 156
 157 </div>
 158 <a name="functiondo_scheduling_reply" id="functiondo_scheduling_reply"><!-- --></a>
 159 <div class="oddrow">
 160
 161         <div>
 162                 <img src="../../media/images/Function.png" />
 163                 <span class="method-title">do_scheduling_reply</span> (line <span class="line-number">319</span>)
 164         </div>
 165
 166         <!-- ========== Info from phpDoc block ========= -->
 167 <p class="short-description">Do the scheduling adjustments for a REPLY when an ATTENDEE updates their status.</p>
 168         <div class="method-signature">
 169                 <span class="method-result">void</span>
 170                 <span class="method-name">
 171                         do_scheduling_reply
 172                 </span>
 173                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$organizer</span>)
 174                         </div>
 175
 176                         <ul class="parameters">
 177                                         <li>
 178                                 <span class="var-type">vCalendar</span>
 179                                 <span class="var-name">$resource</span><span class="var-description">: The resource that the ATTENDEE is writing to their calendar</span>                       </li>
 180                                         <li>
 181                                 <span class="var-type">string</span>
 182                                 <span class="var-name">$organizer</span><span class="var-description">: The property which is the event ORGANIZER.</span>                       </li>
 183                                 </ul>
 184
 185
 186 </div>
 187 <a name="functiondo_scheduling_requests" id="functiondo_scheduling_requests"><!-- --></a>
 188 <div class="evenrow">
 189
 190         <div>
 191                 <img src="../../media/images/Function.png" />
 192                 <span class="method-title">do_scheduling_requests</span> (line <span class="line-number">447</span>)
 193         </div>
 194
 195         <!-- ========== Info from phpDoc block ========= -->
 196 <p class="short-description">Create/Update the scheduling requests for this resource.  This includes updating  the scheduled user's default calendar.</p>
 197         <ul class="tags">
 198                                 <li><span class="field">return:</span> If there was any scheduling action</li>
 199                         </ul>
 200         <div class="method-signature">
 201                 <span class="method-result">true</span>
 202                 <span class="method-name">
 203                         do_scheduling_requests
 204                 </span>
 205                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$create</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$old_data</span> = <span class="var-default">null</span>])
 206                         </div>
 207
 208                         <ul class="parameters">
 209                                         <li>
 210                                 <span class="var-type">vComponent</span>
 211                                 <span class="var-name">$resource</span><span class="var-description">: The VEVENT/VTODO/... resource we are scheduling</span>                   </li>
 212                                         <li>
 213                                 <span class="var-type">boolean</span>
 214                                 <span class="var-name">$create</span><span class="var-description">: true if the scheduling requests are being created.</span>                  </li>
 215                                         <li>
 216                                 <span class="var-type"></span>
 217                                 <span class="var-name">$old_data</span>                 </li>
 218                                 </ul>
 219
 220
 221 </div>
 222 <a name="functionGetTZID" id="functionGetTZID"><!-- --></a>
 223 <div class="oddrow">
 224
 225         <div>
 226                 <img src="../../media/images/Function.png" />
 227                 <span class="method-title">GetTZID</span> (line <span class="line-number">168</span>)
 228         </div>
 229
 230         <!-- ========== Info from phpDoc block ========= -->
 231 <p class="short-description">Get a TZID string from this VEVENT/VTODO/... component if we can</p>
 232         <ul class="tags">
 233                                 <li><span class="field">return:</span> TZID value we found, or null</li>
 234                         </ul>
 235         <div class="method-signature">
 236                 <span class="method-result">The</span>
 237                 <span class="method-name">
 238                         GetTZID
 239                 </span>
 240                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$comp</span>)
 241                         </div>
 242
 243                         <ul class="parameters">
 244                                         <li>
 245                                 <span class="var-type">vComponent</span>
 246                                 <span class="var-name">$comp</span>                     </li>
 247                                 </ul>
 248
 249
 250 </div>
 251 <a name="functionhandle_schedule_reply" id="functionhandle_schedule_reply"><!-- --></a>
 252 <div class="evenrow">
 253
 254         <div>
 255                 <img src="../../media/images/Function.png" />
 256                 <span class="method-title">handle_schedule_reply</span> (line <span class="line-number">270</span>)
 257         </div>
 258
 259         <!-- ========== Info from phpDoc block ========= -->
 260 <p class="short-description">Deliver scheduling replies to organizer and other attendees</p>
 261         <ul class="tags">
 262                                 <li><span class="field">return:</span> on error</li>
 263                         </ul>
 264         <div class="method-signature">
 265                 <span class="method-result">false</span>
 266                 <span class="method-name">
 267                         handle_schedule_reply
 268                 </span>
 269                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$ical</span>)
 270                         </div>
 271
 272                         <ul class="parameters">
 273                                         <li>
 274                                 <span class="var-type">vComponent</span>
 275                                 <span class="var-name">$ical</span><span class="var-description">: the VCALENDAR to deliver</span>                      </li>
 276                                 </ul>
 277
 278
 279 </div>
 280 <a name="functionhandle_schedule_request" id="functionhandle_schedule_request"><!-- --></a>
 281 <div class="oddrow">
 282
 283         <div>
 284                 <img src="../../media/images/Function.png" />
 285                 <span class="method-title">handle_schedule_request</span> (line <span class="line-number">181</span>)
 286         </div>
 287
 288         <!-- ========== Info from phpDoc block ========= -->
 289 <p class="short-description">Deliver scheduling requests to attendees</p>
 290         <div class="method-signature">
 291                 <span class="method-result">void</span>
 292                 <span class="method-name">
 293                         handle_schedule_request
 294                 </span>
 295                                         (<span class="var-type">vComponent</span>&nbsp;<span class="var-name">$ical</span>)
 296                         </div>
 297
 298                         <ul class="parameters">
 299                                         <li>
 300                                 <span class="var-type">vComponent</span>
 301                                 <span class="var-name">$ical</span><span class="var-description">: the VCALENDAR to deliver</span>                      </li>
 302                                 </ul>
 303
 304
 305 </div>
 306 <a name="functionimport_addressbook_collection" id="functionimport_addressbook_collection"><!-- --></a>
 307 <div class="evenrow">
 308
 309         <div>
 310                 <img src="../../media/images/Function.png" />
 311                 <span class="method-title">import_addressbook_collection</span> (line <span class="line-number">597</span>)
 312         </div>
 313
 314         <!-- ========== Info from phpDoc block ========= -->
 315 <p class="short-description">This function will import a whole calendar</p>
 316         <div class="method-signature">
 317                 <span class="method-result">void</span>
 318                 <span class="method-name">
 319                         import_addressbook_collection
 320                 </span>
 321                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$vcard_content</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$appending</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$ics_content</span>)
 322                         </div>
 323
 324                         <ul class="parameters">
 325                                         <li>
 326                                 <span class="var-type">string</span>
 327                                 <span class="var-name">$ics_content</span><span class="var-description">: the ics file to import</span>                 </li>
 328                                         <li>
 329                                 <span class="var-type">int</span>
 330                                 <span class="var-name">$user_no</span><span class="var-description">: the user wich will receive this ics file</span>                   </li>
 331                                         <li>
 332                                 <span class="var-type">string</span>
 333                                 <span class="var-name">$path</span><span class="var-description">: the $path where it will be store such as /user_foo/home/</span>                      </li>
 334                                         <li>
 335                                 <span class="var-type">boolean</span>
 336                                 <span class="var-name">$caldav_context</span><span class="var-description">: <p>Whether we are responding via CalDAV or interactively</p><p>Any VEVENTs with the same UID will be concatenated together</p></span>                      </li>
 337                                         <li>
 338                                 <span class="var-type"></span>
 339                                 <span class="var-name">$vcard_content</span>                    </li>
 340                                         <li>
 341                                 <span class="var-type"></span>
 342                                 <span class="var-name">$appending</span>                        </li>
 343                                 </ul>
 344
 345
 346 </div>
 347 <a name="functionimport_calendar_collection" id="functionimport_calendar_collection"><!-- --></a>
 348 <div class="oddrow">
 349
 350         <div>
 351                 <img src="../../media/images/Function.png" />
 352                 <span class="method-title">import_calendar_collection</span> (line <span class="line-number">694</span>)
 353         </div>
 354
 355         <!-- ========== Info from phpDoc block ========= -->
 356 <p class="short-description">This function will import a whole calendar</p>
 357         <div class="method-signature">
 358                 <span class="method-result">void</span>
 359                 <span class="method-name">
 360                         import_calendar_collection
 361                 </span>
 362                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$ics_content</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$appending</span> = <span class="var-default">false</span>])
 363                         </div>
 364
 365                         <ul class="parameters">
 366                                         <li>
 367                                 <span class="var-type">string</span>
 368                                 <span class="var-name">$ics_content</span><span class="var-description">: the ics file to import</span>                 </li>
 369                                         <li>
 370                                 <span class="var-type">int</span>
 371                                 <span class="var-name">$user_no</span><span class="var-description">: the user wich will receive this ics file</span>                   </li>
 372                                         <li>
 373                                 <span class="var-type">string</span>
 374                                 <span class="var-name">$path</span><span class="var-description">: the $path where it will be store such as /user_foo/home/</span>                      </li>
 375                                         <li>
 376                                 <span class="var-type">boolean</span>
 377                                 <span class="var-name">$caldav_context</span><span class="var-description">: <p>Whether we are responding via CalDAV or interactively</p><p>Any VEVENTs with the same UID will be concatenated together</p></span>                      </li>
 378                                         <li>
 379                                 <span class="var-type"></span>
 380                                 <span class="var-name">$appending</span>                        </li>
 381                                 </ul>
 382
 383
 384 </div>
 385 <a name="functionimport_collection" id="functionimport_collection"><!-- --></a>
 386 <div class="evenrow">
 387
 388         <div>
 389                 <img src="../../media/images/Function.png" />
 390                 <span class="method-title">import_collection</span> (line <span class="line-number">561</span>)
 391         </div>
 392
 393         <!-- ========== Info from phpDoc block ========= -->
 394 <p class="short-description">This function will import a whole collection</p>
 395         <div class="method-signature">
 396                 <span class="method-result">void</span>
 397                 <span class="method-name">
 398                         import_collection
 399                 </span>
 400                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$import_content</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$appending</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$ics_content</span>)
 401                         </div>
 402
 403                         <ul class="parameters">
 404                                         <li>
 405                                 <span class="var-type">string</span>
 406                                 <span class="var-name">$ics_content</span><span class="var-description">: the ics file to import</span>                 </li>
 407                                         <li>
 408                                 <span class="var-type">int</span>
 409                                 <span class="var-name">$user_no</span><span class="var-description">: the user wich will receive this ics file</span>                   </li>
 410                                         <li>
 411                                 <span class="var-type">string</span>
 412                                 <span class="var-name">$path</span><span class="var-description">: the $path where it will be store such as /user_foo/home/</span>                      </li>
 413                                         <li>
 414                                 <span class="var-type">boolean</span>
 415                                 <span class="var-name">$caldav_context</span><span class="var-description">: <p>Whether we are responding via CalDAV or interactively</p><p>The work is either done by</p></span>                       </li>
 416                                         <li>
 417                                 <span class="var-type"></span>
 418                                 <span class="var-name">$import_content</span>                   </li>
 419                                         <li>
 420                                 <span class="var-type"></span>
 421                                 <span class="var-name">$appending</span>                        </li>
 422                                 </ul>
 423
 424
 425 </div>
 426 <a name="functionpublic_events_only" id="functionpublic_events_only"><!-- --></a>
 427 <div class="oddrow">
 428
 429         <div>
 430                 <img src="../../media/images/Function.png" />
 431                 <span class="method-title">public_events_only</span> (line <span class="line-number">144</span>)
 432         </div>
 433
 434         <!-- ========== Info from phpDoc block ========= -->
 435 <p class="short-description">Check if this collection should force all events to be PUBLIC.</p>
 436         <ul class="tags">
 437                                 <li><span class="field">return:</span> Return true if public events only are allowed.</li>
 438                         </ul>
 439         <div class="method-signature">
 440                 <span class="method-result">boolean</span>
 441                 <span class="method-name">
 442                         public_events_only
 443                 </span>
 444                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$dav_name</span>)
 445                         </div>
 446
 447                         <ul class="parameters">
 448                                         <li>
 449                                 <span class="var-type">string</span>
 450                                 <span class="var-name">$user_no</span><span class="var-description">: the user that owns the collection</span>                  </li>
 451                                         <li>
 452                                 <span class="var-type">string</span>
 453                                 <span class="var-name">$dav_name</span><span class="var-description">: the collection to check</span>                   </li>
 454                                 </ul>
 455
 456
 457 </div>
 458 <a name="functionrollback_on_error" id="functionrollback_on_error"><!-- --></a>
 459 <div class="evenrow">
 460
 461         <div>
 462                 <img src="../../media/images/Function.png" />
 463                 <span class="method-title">rollback_on_error</span> (line <span class="line-number">38</span>)
 464         </div>
 465
 466         <!-- ========== Info from phpDoc block ========= -->
 467 <p class="short-description">This function launches an error</p>
 468         <div class="method-signature">
 469                 <span class="method-result">void</span>
 470                 <span class="method-name">
 471                         rollback_on_error
 472                 </span>
 473                                         (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$user_no</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">&#039;&#039;</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$error_no</span> = <span class="var-default">500</span>])
 474                         </div>
 475
 476                         <ul class="parameters">
 477                                         <li>
 478                                 <span class="var-type">boolean</span>
 479                                 <span class="var-name">$caldav_context</span><span class="var-description">: Whether we are responding via CalDAV or interactively</span>                       </li>
 480                                         <li>
 481                                 <span class="var-type">int</span>
 482                                 <span class="var-name">$user_no</span><span class="var-description">: the user who will receive this ics file</span>                    </li>
 483                                         <li>
 484                                 <span class="var-type">string</span>
 485                                 <span class="var-name">$path</span><span class="var-description">: the $path where the PUT failed to store such as /user_foo/home/</span>                       </li>
 486                                         <li>
 487                                 <span class="var-type">string</span>
 488                                 <span class="var-name">$message</span><span class="var-description">: An optional error message to return to the client</span>                  </li>
 489                                         <li>
 490                                 <span class="var-type">int</span>
 491                                 <span class="var-name">$error_no</span><span class="var-description">: An optional value for the HTTP error code</span>                 </li>
 492                                 </ul>
 493
 494
 495 </div>
 496 <a name="functionsimple_write_resource" id="functionsimple_write_resource"><!-- --></a>
 497 <div class="oddrow">
 498
 499         <div>
 500                 <img src="../../media/images/Function.png" />
 501                 <span class="method-title">simple_write_resource</span> (line <span class="line-number">1306</span>)
 502         </div>
 503
 504         <!-- ========== Info from phpDoc block ========= -->
 505 <p class="short-description">A slightly simpler version of write_resource which will make more sense for calling from  an external program.  This makes assumptions that the collection and user do exist  and bypasses all checks for whether it is reasonable to write this here.</p>
 506         <ul class="tags">
 507                                 <li><span class="field">return:</span> True for success, false for failure.</li>
 508                         </ul>
 509         <div class="method-signature">
 510                 <span class="method-result">boolean</span>
 511                 <span class="method-name">
 512                         simple_write_resource
 513                 </span>
 514                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$path</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$caldav_data</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$put_action_type</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$write_action_log</span> = <span class="var-default">false</span>])
 515                         </div>
 516
 517                         <ul class="parameters">
 518                                         <li>
 519                                 <span class="var-type">string</span>
 520                                 <span class="var-name">$path</span><span class="var-description">: The path to the resource being written</span>                        </li>
 521                                         <li>
 522                                 <span class="var-type">string</span>
 523                                 <span class="var-name">$caldav_data</span><span class="var-description">: The actual resource to be written</span>                      </li>
 524                                         <li>
 525                                 <span class="var-type">string</span>
 526                                 <span class="var-name">$put_action_type</span><span class="var-description">: INSERT or UPDATE depending on what we are to do</span>                    </li>
 527                                         <li>
 528                                 <span class="var-type"></span>
 529                                 <span class="var-name">$write_action_log</span>                 </li>
 530                                 </ul>
 531
 532
 533 </div>
 534 <a name="functionwrite_alarms" id="functionwrite_alarms"><!-- --></a>
 535 <div class="evenrow">
 536
 537         <div>
 538                 <img src="../../media/images/Function.png" />
 539                 <span class="method-title">write_alarms</span> (line <span class="line-number">915</span>)
 540         </div>
 541
 542         <!-- ========== Info from phpDoc block ========= -->
 543 <p class="short-description">Given a dav_id and an original vCalendar, pull out each of the VALARMs  and write the values into the calendar_alarm table.</p>
 544         <div class="method-signature">
 545                 <span class="method-result">null</span>
 546                 <span class="method-name">
 547                         write_alarms
 548                 </span>
 549                                         (<span class="var-type">int</span>&nbsp;<span class="var-name">$dav_id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ical</span>)
 550                         </div>
 551
 552                         <ul class="parameters">
 553                                         <li>
 554                                 <span class="var-type">int</span>
 555                                 <span class="var-name">$dav_id</span><span class="var-description">: The dav_id of the caldav_data we're processing</span>                      </li>
 556                                         <li>
 557                                 <span class="var-type">vComponent</span>
 558                                 <span class="var-name">$ical</span><span class="var-description">: The VEVENT or VTODO containing the VALARM</span>                     </li>
 559                                 </ul>
 560
 561
 562 </div>
 563 <a name="functionwrite_attendees" id="functionwrite_attendees"><!-- --></a>
 564 <div class="oddrow">
 565
 566         <div>
 567                 <img src="../../media/images/Function.png" />
 568                 <span class="method-title">write_attendees</span> (line <span class="line-number">972</span>)
 569         </div>
 570
 571         <!-- ========== Info from phpDoc block ========= -->
 572 <p class="short-description">Parse out the attendee property and write a row to the  calendar_attendee table for each one.</p>
 573         <div class="method-signature">
 574                 <span class="method-result">null</span>
 575                 <span class="method-name">
 576                         write_attendees
 577                 </span>
 578                                         (<span class="var-type">int</span>&nbsp;<span class="var-name">$dav_id</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ical</span>)
 579                         </div>
 580
 581                         <ul class="parameters">
 582                                         <li>
 583                                 <span class="var-type">int</span>
 584                                 <span class="var-name">$dav_id</span><span class="var-description">: The dav_id of the caldav_data we're processing</span>                      </li>
 585                                         <li>
 586                                 <span class="var-type">vComponent</span>
 587                                 <span class="var-name">$ical</span><span class="var-description">: The VEVENT or VTODO containing the ATTENDEEs</span>                  </li>
 588                                 </ul>
 589
 590
 591 </div>
 592 <a name="functionwrite_resource" id="functionwrite_resource"><!-- --></a>
 593 <div class="evenrow">
 594
 595         <div>
 596                 <img src="../../media/images/Function.png" />
 597                 <span class="method-title">write_resource</span> (line <span class="line-number">1021</span>)
 598         </div>
 599
 600         <!-- ========== Info from phpDoc block ========= -->
 601 <p class="short-description">Actually write the resource to the database.  All checking of whether this is reasonable  should be done before this is called.</p>
 602         <ul class="tags">
 603                                 <li><span class="field">return:</span> True for success, false for failure.</li>
 604                         </ul>
 605         <div class="method-signature">
 606                 <span class="method-result">boolean</span>
 607                 <span class="method-name">
 608                         write_resource
 609                 </span>
 610                                         (<span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$caldav_data</span>, <span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>&nbsp;<span class="var-name">$collection</span>, <span class="var-type">int</span>&nbsp;<span class="var-name">$author</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$etag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$put_action_type</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$caldav_context</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$log_action</span> = <span class="var-default">true</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$weak_etag</span> = <span class="var-default">null</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$etag</span>)
 611                         </div>
 612
 613                         <ul class="parameters">
 614                                         <li>
 615                                 <span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>
 616                                 <span class="var-name">$resource</span><span class="var-description">: The resource being written</span>                        </li>
 617                                         <li>
 618                                 <span class="var-type">string</span>
 619                                 <span class="var-name">$caldav_data</span><span class="var-description">: The actual data to be written</span>                  </li>
 620                                         <li>
 621                                 <span class="var-type"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span>
 622                                 <span class="var-name">$collection</span><span class="var-description">: The collection containing the resource being written</span>                    </li>
 623                                         <li>
 624                                 <span class="var-type">int</span>
 625                                 <span class="var-name">$author</span><span class="var-description">: The user_no who wants to put this resource on the server</span>                    </li>
 626                                         <li>
 627                                 <span class="var-type">string</span>
 628                                 <span class="var-name">$etag</span><span class="var-description">: An etag unique for this event</span>                 </li>
 629                                         <li>
 630                                 <span class="var-type">string</span>
 631                                 <span class="var-name">$put_action_type</span><span class="var-description">: INSERT or UPDATE depending on what we are to do</span>                    </li>
 632                                         <li>
 633                                 <span class="var-type">boolean</span>
 634                                 <span class="var-name">$caldav_context</span><span class="var-description">: True, if we are responding via CalDAV, false for other ways of calling this</span>                 </li>
 635                                         <li>
 636                                 <span class="var-type">string</span>
 637                                 <span class="var-name">$log_action</span><span class="var-description">: Either 'INSERT' or 'UPDATE': the type of action we are doing</span>                    </li>
 638                                         <li>
 639                                 <span class="var-type">string</span>
 640                                 <span class="var-name">$weak_etag</span><span class="var-description">: An etag that is NOT modified on ATTENDEE changes for this event</span>                  </li>
 641                                         <li>
 642                                 <span class="var-type"></span>
 643                                 <span class="var-name">&$etag</span>                    </li>
 644                                 </ul>
 645
 646
 647 </div>
 648                 </div>
 649         </div>
 650
 651         <p class="notes" id="credit">
 652                 Documentation generated on Fri, 13 Jan 2012 23:44:53 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 653         </p>
 654         </div></body>
 655 </html>