Autocreated docs for new classes.
[davical.git] / docs / api / davical / CalDAVSyncCache.html
blob9f5118f8ca889e9729cdb73eb6f51c9fb964ff6e
2 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
3 <?xml version="1.0" encoding="iso-8859-1"?>
4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5 <html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <!-- template designed by Marco Von Ballmoos -->
8 <title>Docs For Class CalDAVSyncCache</title>
9 <link rel="stylesheet" href="../media/stylesheet.css" />
10 <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
11 </head>
12 <body>
13 <div class="page-body">
14 <h2 class="class-name"><img src="../media/images/Class_logo.png"
15 alt=" Class"
16 title=" Class"
17 style="vertical-align: middle"> CalDAVSyncCache</h2>
19 <a name="sec-description"></a>
20 <div class="info-box">
21 <div class="info-box-title">Description</div>
22 <div class="nav-bar">
23 <span class="disabled">Description</span> |
24 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
26 </div>
27 <div class="info-box-body">
28 <!-- ========== Info from phpDoc block ========= -->
29 <p class="short-description">Our SyncCache holds</p>
30 <p class="notes">
31 Located in <a class="field" href="_inc---CalDAVSyncCache.php.html">/inc/CalDAVSyncCache.php</a> (line <span class="field">11</span>)
32 </p>
35 <pre></pre>
37 </div>
38 </div>
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">CalDAVSyncCache</span>
55 <a href="#__construct" title="details" class="method-name">__construct</a>
56 (<span class="var-type"></span>&nbsp;<span class="var-name">$cache_dir</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$caldav</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$remote_calendar</span>, <span class="var-type"><a href="../davical/Resource/WritableCollection.html">WritableCollection</a></span>&nbsp;<span class="var-name">$local_calendar</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="#applyLocalChangesToRemote" title="details" class="method-name">applyLocalChangesToRemote</a>
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="#applyRemoteChangesToLocal" title="details" class="method-name">applyRemoteChangesToLocal</a>
69 </div>
70 <div class="method-definition">
71 <img src="../media/images/Method.png" alt=" "/>
72 <span class="method-result">void</span>
73 <a href="#deleteRemote" title="details" class="method-name">deleteRemote</a>
74 (<span class="var-type"></span>&nbsp;<span class="var-name">$change</span>)
75 </div>
76 <div class="method-definition">
77 <img src="../media/images/Method.png" alt=" "/>
78 <span class="method-result">void</span>
79 <a href="#finish" title="details" class="method-name">finish</a>
81 </div>
82 <div class="method-definition">
83 <img src="../media/images/Method.png" alt=" "/>
84 <span class="method-result">void</span>
85 <a href="#localChanges" title="details" class="method-name">localChanges</a>
87 </div>
88 <div class="method-definition">
89 <img src="../media/images/Method.png" alt=" "/>
90 <span class="method-result">void</span>
91 <a href="#needsSync" title="details" class="method-name">needsSync</a>
92 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_local_token</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$new_remote_token</span>)
93 </div>
94 <div class="method-definition">
95 <img src="../media/images/Method.png" alt=" "/>
96 <span class="method-result">void</span>
97 <a href="#putRemote" title="details" class="method-name">putRemote</a>
98 (<span class="var-type"></span>&nbsp;<span class="var-name">$change</span>)
99 </div>
100 <div class="method-definition">
101 <img src="../media/images/Method.png" alt=" "/>
102 <span class="method-result">void</span>
103 <a href="#remoteChanges" title="details" class="method-name">remoteChanges</a>
105 </div>
106 <div class="method-definition">
107 <img src="../media/images/Method.png" alt=" "/>
108 <span class="method-result">void</span>
109 <a href="#resolveConflicts" title="details" class="method-name">resolveConflicts</a>
111 </div>
112 <div class="method-definition">
113 <img src="../media/images/Method.png" alt=" "/>
114 <span class="method-result">void</span>
115 <a href="#updateETags" title="details" class="method-name">updateETags</a>
117 </div>
118 </div>
119 </div>
120 </div>
123 <a name="sec-methods"></a>
124 <div class="info-box">
125 <div class="info-box-title">Methods</div>
126 <div class="nav-bar">
127 <a href="#sec-description">Description</a> |
128 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
130 </div>
131 <div class="info-box-body">
133 Strict Standards: Only variables should be passed by reference in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 712
135 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
136 <A NAME='method_detail'></A>
137 <a name="method__construct" id="__construct"><!-- --></a>
138 <div class="oddrow">
140 <div class="method-header">
141 <img src="../media/images/Constructor.png" />
142 <span class="method-title">Constructor __construct</span> (line <span class="line-number">23</span>)
143 </div>
145 <!-- ========== Info from phpDoc block ========= -->
147 <div class="method-signature">
148 <span class="method-result">CalDAVSyncCache</span>
149 <span class="method-name">
150 __construct
151 </span>
152 (<span class="var-type"></span>&nbsp;<span class="var-name">$cache_dir</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$username</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$caldav</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$remote_calendar</span>, <span class="var-type"><a href="../davical/Resource/WritableCollection.html">WritableCollection</a></span>&nbsp;<span class="var-name">$local_calendar</span>)
153 </div>
155 <ul class="parameters">
156 <li>
157 <span class="var-type"></span>
158 <span class="var-name">$cache_dir</span> </li>
159 <li>
160 <span class="var-type"></span>
161 <span class="var-name">$username</span> </li>
162 <li>
163 <span class="var-type"><a href="../awl/caldav/CalDAVSyncClient.html">CalDAVSyncClient</a></span>
164 <span class="var-name">$caldav</span> </li>
165 <li>
166 <span class="var-type"><a href="../awl/CalDAVSyncCalendar.html">CalDAVSyncCalendar</a></span>
167 <span class="var-name">$remote_calendar</span> </li>
168 <li>
169 <span class="var-type"><a href="../davical/Resource/WritableCollection.html">WritableCollection</a></span>
170 <span class="var-name">$local_calendar</span> </li>
171 </ul>
174 </div>
175 <a name="methodapplyLocalChangesToRemote" id="applyLocalChangesToRemote"><!-- --></a>
176 <div class="evenrow">
178 <div class="method-header">
179 <img src="../media/images/Method.png" />
180 <span class="method-title">applyLocalChangesToRemote</span> (line <span class="line-number">89</span>)
181 </div>
183 <!-- ========== Info from phpDoc block ========= -->
184 <p class="short-description">Put/Delete to the remote server as appropriate</p>
186 <div class="method-signature">
187 <span class="method-result">void</span>
188 <span class="method-name">
189 applyLocalChangesToRemote
190 </span>
192 </div>
196 </div>
197 <a name="methodapplyRemoteChangesToLocal" id="applyRemoteChangesToLocal"><!-- --></a>
198 <div class="oddrow">
200 <div class="method-header">
201 <img src="../media/images/Method.png" />
202 <span class="method-title">applyRemoteChangesToLocal</span> (line <span class="line-number">112</span>)
203 </div>
205 <!-- ========== Info from phpDoc block ========= -->
206 <p class="short-description">Apply remote changes to local database</p>
208 <div class="method-signature">
209 <span class="method-result">void</span>
210 <span class="method-name">
211 applyRemoteChangesToLocal
212 </span>
214 </div>
218 </div>
219 <a name="methoddeleteRemote" id="deleteRemote"><!-- --></a>
220 <div class="evenrow">
222 <div class="method-header">
223 <img src="../media/images/Method.png" />
224 <span class="method-title">deleteRemote</span> (line <span class="line-number">80</span>)
225 </div>
227 <!-- ========== Info from phpDoc block ========= -->
228 <p class="short-description">Delete this from the remote server</p>
230 <div class="method-signature">
231 <span class="method-result">void</span>
232 <span class="method-name">
233 deleteRemote
234 </span>
235 (<span class="var-type"></span>&nbsp;<span class="var-name">$change</span>)
236 </div>
238 <ul class="parameters">
239 <li>
240 <span class="var-type"></span>
241 <span class="var-name">$change</span> </li>
242 </ul>
245 </div>
246 <a name="methodfinish" id="finish"><!-- --></a>
247 <div class="oddrow">
249 <div class="method-header">
250 <img src="../media/images/Method.png" />
251 <span class="method-title">finish</span> (line <span class="line-number">41</span>)
252 </div>
254 <!-- ========== Info from phpDoc block ========= -->
256 <div class="method-signature">
257 <span class="method-result">void</span>
258 <span class="method-name">
259 finish
260 </span>
262 </div>
266 </div>
267 <a name="methodlocalChanges" id="localChanges"><!-- --></a>
268 <div class="evenrow">
270 <div class="method-header">
271 <img src="../media/images/Method.png" />
272 <span class="method-title">localChanges</span> (line <span class="line-number">52</span>)
273 </div>
275 <!-- ========== Info from phpDoc block ========= -->
277 <div class="method-signature">
278 <span class="method-result">void</span>
279 <span class="method-name">
280 localChanges
281 </span>
283 </div>
287 </div>
288 <a name="methodneedsSync" id="needsSync"><!-- --></a>
289 <div class="oddrow">
291 <div class="method-header">
292 <img src="../media/images/Method.png" />
293 <span class="method-title">needsSync</span> (line <span class="line-number">56</span>)
294 </div>
296 <!-- ========== Info from phpDoc block ========= -->
298 <div class="method-signature">
299 <span class="method-result">void</span>
300 <span class="method-name">
301 needsSync
302 </span>
303 (<span class="var-type"></span>&nbsp;<span class="var-name">$new_local_token</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$new_remote_token</span>)
304 </div>
306 <ul class="parameters">
307 <li>
308 <span class="var-type"></span>
309 <span class="var-name">$new_local_token</span> </li>
310 <li>
311 <span class="var-type"></span>
312 <span class="var-name">$new_remote_token</span> </li>
313 </ul>
316 </div>
317 <a name="methodputRemote" id="putRemote"><!-- --></a>
318 <div class="evenrow">
320 <div class="method-header">
321 <img src="../media/images/Method.png" />
322 <span class="method-title">putRemote</span> (line <span class="line-number">66</span>)
323 </div>
325 <!-- ========== Info from phpDoc block ========= -->
326 <p class="short-description">Write this change to the remote server</p>
328 <div class="method-signature">
329 <span class="method-result">void</span>
330 <span class="method-name">
331 putRemote
332 </span>
333 (<span class="var-type"></span>&nbsp;<span class="var-name">$change</span>)
334 </div>
336 <ul class="parameters">
337 <li>
338 <span class="var-type"></span>
339 <span class="var-name">$change</span> </li>
340 </ul>
343 </div>
344 <a name="methodremoteChanges" id="remoteChanges"><!-- --></a>
345 <div class="oddrow">
347 <div class="method-header">
348 <img src="../media/images/Method.png" />
349 <span class="method-title">remoteChanges</span> (line <span class="line-number">48</span>)
350 </div>
352 <!-- ========== Info from phpDoc block ========= -->
354 <div class="method-signature">
355 <span class="method-result">void</span>
356 <span class="method-name">
357 remoteChanges
358 </span>
360 </div>
364 </div>
365 <a name="methodresolveConflicts" id="resolveConflicts"><!-- --></a>
366 <div class="evenrow">
368 <div class="method-header">
369 <img src="../media/images/Method.png" />
370 <span class="method-title">resolveConflicts</span> (line <span class="line-number">121</span>)
371 </div>
373 <!-- ========== Info from phpDoc block ========= -->
375 <div class="method-signature">
376 <span class="method-result">void</span>
377 <span class="method-name">
378 resolveConflicts
379 </span>
381 </div>
385 </div>
386 <a name="methodupdateETags" id="updateETags"><!-- --></a>
387 <div class="oddrow">
389 <div class="method-header">
390 <img src="../media/images/Method.png" />
391 <span class="method-title">updateETags</span> (line <span class="line-number">126</span>)
392 </div>
394 <!-- ========== Info from phpDoc block ========= -->
396 <div class="method-signature">
397 <span class="method-result">void</span>
398 <span class="method-name">
399 updateETags
400 </span>
402 </div>
406 </div>
408 </div>
409 </div>
413 Warning: strftime(): It is not safe to rely on the system's timezone settings. You are *required* to use the date.timezone setting or the date_default_timezone_set() function. In case you used any of those methods and you are still getting this warning, you most likely misspelled the timezone identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select your timezone. in /usr/share/php/PhpDocumentor/phpDocumentor/Smarty-2.6.0/libs/Smarty_Compiler.class.php on line 370
414 <p class="notes" id="credit">
415 Documentation generated on Sun, 08 Jul 2012 12:53:47 +0000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
416 </p>
417 </div></body>
418 </html>