mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-06-20 06:50:20 +00:00
335 lines
22 KiB
HTML
335 lines
22 KiB
HTML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<!-- template designed by Marco Von Ballmoos -->
|
|
<title>Docs For Class WritableCollection</title>
|
|
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
|
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
|
</head>
|
|
<body>
|
|
<div class="page-body">
|
|
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
|
alt=" Class"
|
|
title=" Class"
|
|
style="vertical-align: middle"> WritableCollection</h2>
|
|
|
|
<a name="sec-description"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Description</div>
|
|
<div class="nav-bar">
|
|
<span class="disabled">Description</span> |
|
|
<a href="#sec-vars">Vars</a>
|
|
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<p class="short-description">A class for things to do with a DAV Resource</p>
|
|
<p class="notes">
|
|
Located in <a class="field" href="_inc---WritableCollection.php.html">/inc/WritableCollection.php</a> (line <span class="field">4</span>)
|
|
</p>
|
|
|
|
|
|
<pre><a href="../../davical/Resource/DAVResource.html">DAVResource</a>
|
|
|
|
|
--WritableCollection</pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<a name="sec-method-summary"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Method Summary</span></div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-vars">Vars</a>
|
|
|
|
|
|
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
|
</div>
|
|
<div class="info-box-body">
|
|
<div class="method-summary">
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#WriteCalendarMember" title="details" class="method-name">WriteCalendarMember</a>
|
|
(<span class="var-type"></span> <span class="var-name">$vcal</span>, <span class="var-type">boolean</span> <span class="var-name">$create_resource</span>, [<span class="var-type">boolean</span> <span class="var-name">$do_scheduling</span> = <span class="var-default">false</span>], [<span class="var-type">string</span> <span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$log_action</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
<div class="method-definition">
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-result">string</span>
|
|
<a href="#WriteMember" title="details" class="method-name">WriteMember</a>
|
|
(<span class="var-type">$resource</span> <span class="var-name">$resource</span>, <span class="var-type">$create_resource</span> <span class="var-name">$create_resource</span>, [<span class="var-type">$segment_name</span> <span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$log_action</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-vars"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Variables</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
|
|
|
|
|
|
|
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
|
|
<h4>Inherited Variables</h4>
|
|
<A NAME='inherited_vars'><!-- --></A>
|
|
<p>Inherited from <span class="classname"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span></p>
|
|
<blockquote>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$bound_from">DAVResource::$bound_from</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$contenttype">DAVResource::$contenttype</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$dav_name">DAVResource::$dav_name</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$exists">DAVResource::$exists</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$parent">DAVResource::$parent</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$resource">DAVResource::$resource</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$resourcetypes">DAVResource::$resourcetypes</a></span><br>
|
|
</span>
|
|
<img src="../../media/images/Variable.png" />
|
|
<span class="var-title">
|
|
<span class="var-name"><a href="../../davical/Resource/DAVResource.html#var$unique_tag">DAVResource::$unique_tag</a></span><br>
|
|
</span>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<a name="sec-methods"></a>
|
|
<div class="info-box">
|
|
<div class="info-box-title">Methods</div>
|
|
<div class="nav-bar">
|
|
<a href="#sec-description">Description</a> |
|
|
<a href="#sec-vars">Vars</a>
|
|
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
|
|
|
</div>
|
|
<div class="info-box-body">
|
|
<A NAME='method_detail'></A>
|
|
<a name="methodWriteCalendarMember" id="WriteCalendarMember"><!-- --></a>
|
|
<div class="evenrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">WriteCalendarMember</span> (line <span class="line-number">33</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<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>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The segment_name of the resource within the collection, as written, or false on failure.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
WriteCalendarMember
|
|
</span>
|
|
(<span class="var-type"></span> <span class="var-name">$vcal</span>, <span class="var-type">boolean</span> <span class="var-name">$create_resource</span>, [<span class="var-type">boolean</span> <span class="var-name">$do_scheduling</span> = <span class="var-default">false</span>], [<span class="var-type">string</span> <span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$log_action</span> = <span class="var-default">false</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">vCalendar</span>
|
|
<span class="var-name">$vcal</span><span class="var-description">: The resource to be written.</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<span class="var-name">$create_resource</span><span class="var-description">: True if this is a new resource.</span> </li>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<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>
|
|
<li>
|
|
<span class="var-type">string</span>
|
|
<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>
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<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>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<a name="methodWriteMember" id="WriteMember"><!-- --></a>
|
|
<div class="oddrow">
|
|
|
|
<div class="method-header">
|
|
<img src="../../media/images/Method.png" />
|
|
<span class="method-title">WriteMember</span> (line <span class="line-number">287</span>)
|
|
</div>
|
|
|
|
<!-- ========== Info from phpDoc block ========= -->
|
|
<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>
|
|
<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>
|
|
<ul class="tags">
|
|
<li><span class="field">return:</span> The segment_name that was given, or one that was assigned if null was given.</li>
|
|
</ul>
|
|
|
|
<div class="method-signature">
|
|
<span class="method-result">string</span>
|
|
<span class="method-name">
|
|
WriteMember
|
|
</span>
|
|
(<span class="var-type">$resource</span> <span class="var-name">$resource</span>, <span class="var-type">$create_resource</span> <span class="var-name">$create_resource</span>, [<span class="var-type">$segment_name</span> <span class="var-name">$segment_name</span> = <span class="var-default">null</span>], [<span class="var-type">boolean</span> <span class="var-name">$log_action</span> = <span class="var-default">true</span>])
|
|
</div>
|
|
|
|
<ul class="parameters">
|
|
<li>
|
|
<span class="var-type">boolean</span>
|
|
<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>
|
|
<li>
|
|
<span class="var-type">$resource</span>
|
|
<span class="var-name">$resource</span><span class="var-description">: mixed The resource to be written.</span> </li>
|
|
<li>
|
|
<span class="var-type">$create_resource</span>
|
|
<span class="var-name">$create_resource</span><span class="var-description">: boolean True if this is a new resource.</span> </li>
|
|
<li>
|
|
<span class="var-type">$segment_name</span>
|
|
<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>
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
<h4>Inherited Methods</h4>
|
|
<a name='inherited_methods'><!-- --></a>
|
|
<!-- =========== Summary =========== -->
|
|
<p>Inherited From <span class="classname"><a href="../../davical/Resource/DAVResource.html">DAVResource</a></span></p>
|
|
<blockquote>
|
|
<img src="../../media/images/Constructor.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#method__construct">DAVResource::__construct()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodbound_from">DAVResource::bound_from()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildACE">DAVResource::BuildACE()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildPrivileges">DAVResource::BuildPrivileges()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildSupportedMethods">DAVResource::BuildSupportedMethods()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildSupportedReports">DAVResource::BuildSupportedReports()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodBuildTicketinfo">DAVResource::BuildTicketinfo()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodcollection_id">DAVResource::collection_id()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodContainerExists">DAVResource::ContainerExists()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodContainerType">DAVResource::ContainerType()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodDAV_AllProperties">DAVResource::DAV_AllProperties()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methoddav_name">DAVResource::dav_name()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodExists">DAVResource::Exists()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchCollection">DAVResource::FetchCollection()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchDeadProperties">DAVResource::FetchDeadProperties()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchParentContainer">DAVResource::FetchParentContainer()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchPrincipal">DAVResource::FetchPrincipal()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchPrivileges">DAVResource::FetchPrivileges()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchResource">DAVResource::FetchResource()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchSupportedMethods">DAVResource::FetchSupportedMethods()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchSupportedReports">DAVResource::FetchSupportedReports()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFetchTickets">DAVResource::FetchTickets()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFromPath">DAVResource::FromPath()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodFromRow">DAVResource::FromRow()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetACL">DAVResource::GetACL()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetParentContainer">DAVResource::GetParentContainer()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetProperty">DAVResource::GetProperty()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodGetPropStat">DAVResource::GetPropStat()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodHavePrivilegeTo">DAVResource::HavePrivilegeTo()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsAddressbook">DAVResource::IsAddressbook()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsBinding">DAVResource::IsBinding()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsCalendar">DAVResource::IsCalendar()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsCollection">DAVResource::IsCollection()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsExternal">DAVResource::IsExternal()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsLocked">DAVResource::IsLocked()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsPrincipal">DAVResource::IsPrincipal()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsPublic">DAVResource::IsPublic()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodIsSchedulingCollection">DAVResource::IsSchedulingCollection()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodNeedPrivilege">DAVResource::NeedPrivilege()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodparent_path">DAVResource::parent_path()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodprincipal_url">DAVResource::principal_url()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodPrivileges">DAVResource::Privileges()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodRenderAsXML">DAVResource::RenderAsXML()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodresource">DAVResource::resource()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodResourceProperty">DAVResource::ResourceProperty()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodresource_id">DAVResource::resource_id()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodset_bind_location">DAVResource::set_bind_location()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodunique_tag">DAVResource::unique_tag()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methodurl">DAVResource::url()</a></span><br>
|
|
<img src="../../media/images/Method.png" alt=" "/>
|
|
<span class="method-name"><a href="../../davical/Resource/DAVResource.html#methoduser_no">DAVResource::user_no()</a></span><br>
|
|
</blockquote>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<p class="notes" id="credit">
|
|
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>
|
|
</p>
|
|
</div></body>
|
|
</html> |