Release 0.9.9.6
[davical.git] / docs / api / davical / Resource / WritableCollection.html
blob0bb8200134e406f46963d60625ac00a57e506de9
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 WritableCollection</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"> WritableCollection</h2>
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-vars">Vars</a>
23 | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
25 </div>
26 <div class="info-box-body">
27 <!-- ========== Info from phpDoc block ========= -->
28 <p class="short-description">A class for things to do with a DAV Resource</p>
29 <p class="notes">
30 Located in <a class="field" href="_inc---WritableCollection.php.html">/inc/WritableCollection.php</a> (line <span class="field">4</span>)
31 </p>
34 <pre><a href="../../davical/Resource/DAVResource.html">DAVResource</a>
36 --WritableCollection</pre>
38 </div>
39 </div>
44 <a name="sec-method-summary"></a>
45 <div class="info-box">
46 <div class="info-box-title">Method Summary</span></div>
47 <div class="nav-bar">
48 <a href="#sec-description">Description</a> |
49 <a href="#sec-vars">Vars</a>
52 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
53 </div>
54 <div class="info-box-body">
55 <div class="method-summary">
56 <div class="method-definition">
57 <img src="../../media/images/Method.png" alt=" "/>
58 <span class="method-result">string</span>
59 <a href="#WriteCalendarMember" title="details" class="method-name">WriteCalendarMember</a>
60 (<span class="var-type"></span>&nbsp;<span class="var-name">$vcal</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$create_resource</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$do_scheduling</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$log_action</span> = <span class="var-default">false</span>])
61 </div>
62 <div class="method-definition">
63 <img src="../../media/images/Method.png" alt=" "/>
64 <span class="method-result">string</span>
65 <a href="#WriteMember" title="details" class="method-name">WriteMember</a>
66 (<span class="var-type">$resource</span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type">$create_resource</span>&nbsp;<span class="var-name">$create_resource</span>, [<span class="var-type">$segment_name</span>&nbsp;<span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$log_action</span> = <span class="var-default">true</span>])
67 </div>
68 </div>
69 </div>
70 </div>
72 <a name="sec-vars"></a>
73 <div class="info-box">
74 <div class="info-box-title">Variables</div>
75 <div class="nav-bar">
76 <a href="#sec-description">Description</a> |
77 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
81 <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
83 </div>
84 <div class="info-box-body">
86 <h4>Inherited Variables</h4>
87 <A NAME='inherited_vars'><!-- --></A>
88 <p>Inherited from <span class="classname"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span></p>
89 <blockquote>
90 <img src="../../media/images/Variable.png" />
91 <span class="var-title">
92 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$bound_from">DAVResource::$bound_from</a></span><br>
93 </span>
94 <img src="../../media/images/Variable.png" />
95 <span class="var-title">
96 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$contenttype">DAVResource::$contenttype</a></span><br>
97 </span>
98 <img src="../../media/images/Variable.png" />
99 <span class="var-title">
100 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$dav_name">DAVResource::$dav_name</a></span><br>
101 </span>
102 <img src="../../media/images/Variable.png" />
103 <span class="var-title">
104 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$exists">DAVResource::$exists</a></span><br>
105 </span>
106 <img src="../../media/images/Variable.png" />
107 <span class="var-title">
108 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$parent">DAVResource::$parent</a></span><br>
109 </span>
110 <img src="../../media/images/Variable.png" />
111 <span class="var-title">
112 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$resource">DAVResource::$resource</a></span><br>
113 </span>
114 <img src="../../media/images/Variable.png" />
115 <span class="var-title">
116 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$resourcetypes">DAVResource::$resourcetypes</a></span><br>
117 </span>
118 <img src="../../media/images/Variable.png" />
119 <span class="var-title">
120 <span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$unique_tag">DAVResource::$unique_tag</a></span><br>
121 </span>
122 </blockquote>
124 </div>
125 </div>
127 <a name="sec-methods"></a>
128 <div class="info-box">
129 <div class="info-box-title">Methods</div>
130 <div class="nav-bar">
131 <a href="#sec-description">Description</a> |
132 <a href="#sec-vars">Vars</a>
133 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
135 </div>
136 <div class="info-box-body">
137 <A NAME='method_detail'></A>
138 <a name="methodWriteCalendarMember" id="WriteCalendarMember"><!-- --></a>
139 <div class="evenrow">
141 <div class="method-header">
142 <img src="../../media/images/Method.png" />
143 <span class="method-title">WriteCalendarMember</span> (line <span class="line-number">33</span>)
144 </div>
146 <!-- ========== Info from phpDoc block ========= -->
147 <p class="short-description">Writes the data to a member in the collection and returns the segment_name of the resource in our internal namespace.</p>
148 <ul class="tags">
149 <li><span class="field">return:</span> The segment_name of the resource within the collection, as written, or false on failure.</li>
150 </ul>
152 <div class="method-signature">
153 <span class="method-result">string</span>
154 <span class="method-name">
155 WriteCalendarMember
156 </span>
157 (<span class="var-type"></span>&nbsp;<span class="var-name">$vcal</span>, <span class="var-type">boolean</span>&nbsp;<span class="var-name">$create_resource</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$do_scheduling</span> = <span class="var-default">false</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$log_action</span> = <span class="var-default">false</span>])
158 </div>
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 to be written.</span> </li>
164 <li>
165 <span class="var-type">boolean</span>
166 <span class="var-name">$create_resource</span><span class="var-description">: True if this is a new resource.</span> </li>
167 <li>
168 <span class="var-type">boolean</span>
169 <span class="var-name">$do_scheduling</span><span class="var-description">: True if we should also do scheduling for this write. Default false.</span> </li>
170 <li>
171 <span class="var-type">string</span>
172 <span class="var-name">$segment_name</span><span class="var-description">: The name of the resource within the collection, or null if this call should invent one based on the UID of the vCalendar.</span> </li>
173 <li>
174 <span class="var-type">boolean</span>
175 <span class="var-name">$log_action</span><span class="var-description">: Whether to log this action. Defaults to false since this is normally called in situations where one is writing secondary data.</span> </li>
176 </ul>
179 </div>
180 <a name="methodWriteMember" id="WriteMember"><!-- --></a>
181 <div class="oddrow">
183 <div class="method-header">
184 <img src="../../media/images/Method.png" />
185 <span class="method-title">WriteMember</span> (line <span class="line-number">287</span>)
186 </div>
188 <!-- ========== Info from phpDoc block ========= -->
189 <p class="short-description">Writes the data to a member in the collection and returns the segment_name of the resource in our internal namespace.</p>
190 <p class="description"><p>A caller who wants scheduling not to happen for this write must already know they are dealing with a calendar, so should be calling WriteCalendarMember directly.</p></p>
191 <ul class="tags">
192 <li><span class="field">return:</span> The segment_name that was given, or one that was assigned if null was given.</li>
193 </ul>
195 <div class="method-signature">
196 <span class="method-result">string</span>
197 <span class="method-name">
198 WriteMember
199 </span>
200 (<span class="var-type">$resource</span>&nbsp;<span class="var-name">$resource</span>, <span class="var-type">$create_resource</span>&nbsp;<span class="var-name">$create_resource</span>, [<span class="var-type">$segment_name</span>&nbsp;<span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$log_action</span> = <span class="var-default">true</span>])
201 </div>
203 <ul class="parameters">
204 <li>
205 <span class="var-type">boolean</span>
206 <span class="var-name">$log_action</span><span class="var-description">: Whether to log this action. Defaults to true since this is normally called in situations where one is writing primary data.</span> </li>
207 <li>
208 <span class="var-type">$resource</span>
209 <span class="var-name">$resource</span><span class="var-description">: mixed The resource to be written.</span> </li>
210 <li>
211 <span class="var-type">$create_resource</span>
212 <span class="var-name">$create_resource</span><span class="var-description">: boolean True if this is a new resource.</span> </li>
213 <li>
214 <span class="var-type">$segment_name</span>
215 <span class="var-name">$segment_name</span><span class="var-description">: The name of the resource within the collection, or false on failure.</span> </li>
216 </ul>
219 </div>
220 <h4>Inherited Methods</h4>
221 <a name='inherited_methods'><!-- --></a>
222 <!-- =========== Summary =========== -->
223 <p>Inherited From <span class="classname"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span></p>
224 <blockquote>
225 <img src="../../media/images/Constructor.png" alt=" "/>
226 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#method__construct">DAVResource::__construct()</a></span><br>
227 <img src="../../media/images/Method.png" alt=" "/>
228 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodbound_from">DAVResource::bound_from()</a></span><br>
229 <img src="../../media/images/Method.png" alt=" "/>
230 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildACE">DAVResource::BuildACE()</a></span><br>
231 <img src="../../media/images/Method.png" alt=" "/>
232 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildPrivileges">DAVResource::BuildPrivileges()</a></span><br>
233 <img src="../../media/images/Method.png" alt=" "/>
234 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildSupportedMethods">DAVResource::BuildSupportedMethods()</a></span><br>
235 <img src="../../media/images/Method.png" alt=" "/>
236 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildSupportedReports">DAVResource::BuildSupportedReports()</a></span><br>
237 <img src="../../media/images/Method.png" alt=" "/>
238 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildTicketinfo">DAVResource::BuildTicketinfo()</a></span><br>
239 <img src="../../media/images/Method.png" alt=" "/>
240 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodcollection_id">DAVResource::collection_id()</a></span><br>
241 <img src="../../media/images/Method.png" alt=" "/>
242 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodContainerExists">DAVResource::ContainerExists()</a></span><br>
243 <img src="../../media/images/Method.png" alt=" "/>
244 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodContainerType">DAVResource::ContainerType()</a></span><br>
245 <img src="../../media/images/Method.png" alt=" "/>
246 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodDAV_AllProperties">DAVResource::DAV_AllProperties()</a></span><br>
247 <img src="../../media/images/Method.png" alt=" "/>
248 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methoddav_name">DAVResource::dav_name()</a></span><br>
249 <img src="../../media/images/Method.png" alt=" "/>
250 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodExists">DAVResource::Exists()</a></span><br>
251 <img src="../../media/images/Method.png" alt=" "/>
252 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchCollection">DAVResource::FetchCollection()</a></span><br>
253 <img src="../../media/images/Method.png" alt=" "/>
254 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchDeadProperties">DAVResource::FetchDeadProperties()</a></span><br>
255 <img src="../../media/images/Method.png" alt=" "/>
256 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchParentContainer">DAVResource::FetchParentContainer()</a></span><br>
257 <img src="../../media/images/Method.png" alt=" "/>
258 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchPrincipal">DAVResource::FetchPrincipal()</a></span><br>
259 <img src="../../media/images/Method.png" alt=" "/>
260 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchPrivileges">DAVResource::FetchPrivileges()</a></span><br>
261 <img src="../../media/images/Method.png" alt=" "/>
262 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchResource">DAVResource::FetchResource()</a></span><br>
263 <img src="../../media/images/Method.png" alt=" "/>
264 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchSupportedMethods">DAVResource::FetchSupportedMethods()</a></span><br>
265 <img src="../../media/images/Method.png" alt=" "/>
266 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchSupportedReports">DAVResource::FetchSupportedReports()</a></span><br>
267 <img src="../../media/images/Method.png" alt=" "/>
268 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchTickets">DAVResource::FetchTickets()</a></span><br>
269 <img src="../../media/images/Method.png" alt=" "/>
270 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFromPath">DAVResource::FromPath()</a></span><br>
271 <img src="../../media/images/Method.png" alt=" "/>
272 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFromRow">DAVResource::FromRow()</a></span><br>
273 <img src="../../media/images/Method.png" alt=" "/>
274 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetACL">DAVResource::GetACL()</a></span><br>
275 <img src="../../media/images/Method.png" alt=" "/>
276 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetParentContainer">DAVResource::GetParentContainer()</a></span><br>
277 <img src="../../media/images/Method.png" alt=" "/>
278 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetProperty">DAVResource::GetProperty()</a></span><br>
279 <img src="../../media/images/Method.png" alt=" "/>
280 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetPropStat">DAVResource::GetPropStat()</a></span><br>
281 <img src="../../media/images/Method.png" alt=" "/>
282 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodHavePrivilegeTo">DAVResource::HavePrivilegeTo()</a></span><br>
283 <img src="../../media/images/Method.png" alt=" "/>
284 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsAddressbook">DAVResource::IsAddressbook()</a></span><br>
285 <img src="../../media/images/Method.png" alt=" "/>
286 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsBinding">DAVResource::IsBinding()</a></span><br>
287 <img src="../../media/images/Method.png" alt=" "/>
288 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsCalendar">DAVResource::IsCalendar()</a></span><br>
289 <img src="../../media/images/Method.png" alt=" "/>
290 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsCollection">DAVResource::IsCollection()</a></span><br>
291 <img src="../../media/images/Method.png" alt=" "/>
292 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsExternal">DAVResource::IsExternal()</a></span><br>
293 <img src="../../media/images/Method.png" alt=" "/>
294 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsLocked">DAVResource::IsLocked()</a></span><br>
295 <img src="../../media/images/Method.png" alt=" "/>
296 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsPrincipal">DAVResource::IsPrincipal()</a></span><br>
297 <img src="../../media/images/Method.png" alt=" "/>
298 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsPublic">DAVResource::IsPublic()</a></span><br>
299 <img src="../../media/images/Method.png" alt=" "/>
300 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsSchedulingCollection">DAVResource::IsSchedulingCollection()</a></span><br>
301 <img src="../../media/images/Method.png" alt=" "/>
302 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodNeedPrivilege">DAVResource::NeedPrivilege()</a></span><br>
303 <img src="../../media/images/Method.png" alt=" "/>
304 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodparent_path">DAVResource::parent_path()</a></span><br>
305 <img src="../../media/images/Method.png" alt=" "/>
306 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodprincipal_url">DAVResource::principal_url()</a></span><br>
307 <img src="../../media/images/Method.png" alt=" "/>
308 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodPrivileges">DAVResource::Privileges()</a></span><br>
309 <img src="../../media/images/Method.png" alt=" "/>
310 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodRenderAsXML">DAVResource::RenderAsXML()</a></span><br>
311 <img src="../../media/images/Method.png" alt=" "/>
312 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodresource">DAVResource::resource()</a></span><br>
313 <img src="../../media/images/Method.png" alt=" "/>
314 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodResourceProperty">DAVResource::ResourceProperty()</a></span><br>
315 <img src="../../media/images/Method.png" alt=" "/>
316 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodresource_id">DAVResource::resource_id()</a></span><br>
317 <img src="../../media/images/Method.png" alt=" "/>
318 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodset_bind_location">DAVResource::set_bind_location()</a></span><br>
319 <img src="../../media/images/Method.png" alt=" "/>
320 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodunique_tag">DAVResource::unique_tag()</a></span><br>
321 <img src="../../media/images/Method.png" alt=" "/>
322 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodurl">DAVResource::url()</a></span><br>
323 <img src="../../media/images/Method.png" alt=" "/>
324 <span class="method-name"><a href="../../davical/Resource/DAVResource.html#methoduser_no">DAVResource::user_no()</a></span><br>
325 </blockquote>
327 </div>
328 </div>
331 <p class="notes" id="credit">
332 Documentation generated on Tue, 27 Sep 2011 11:30:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
333 </p>
334 </div></body>
335 </html>