DAViCal
 All Classes Namespaces Functions Variables Pages
WritableCollection Class Reference
Inheritance diagram for WritableCollection:
Collaboration diagram for WritableCollection:

Public Member Functions

 WriteCalendarMember (vCalendar $vcal, $create_resource, $do_scheduling=false, $segment_name=null, $log_action=false)
 
 WriteMember ($resource, $create_resource, $segment_name=null, $log_action=true)
 
 WriteCalendarAlarms ($dav_id, vCalendar $vcal)
 
 WriteCalendarAttendees ($dav_id, vCalendar $vcal)
 
 actualDeleteCalendarMember ($member_dav_name)
 
 whatChangedSince ($some_old_token)
 
- Public Member Functions inherited from DAVResource
 __construct ($parameters=null)
 
 FromRow ($row)
 
 FromPath ($inpath)
 
 GetParentContainer ()
 
 FetchParentContainer ()
 
 Privileges ()
 
 HavePrivilegeTo ($do_what, $any=null)
 
 NeedPrivilege ($privilege, $any=null)
 
 BuildPrivileges ($privilege_names=null, &$xmldoc=null)
 
 FetchSupportedMethods ()
 
 BuildSupportedMethods ()
 
 FetchSupportedReports ()
 
 BuildSupportedReports (&$reply)
 
 FetchTickets ()
 
 BuildTicketinfo (&$reply)
 
 IsLocked ($depth=0)
 
 IsCollection ()
 
 IsPrincipal ()
 
 IsCalendar ()
 
 IsProxyCollection ($type= 'any')
 
 IsSchedulingCollection ($type= 'any')
 
 IsInSchedulingCollection ($type= 'any')
 
 IsAddressbook ()
 
 IsBinding ()
 
 IsExternal ()
 
 Exists ()
 
 ContainerExists ()
 
 url ()
 
 dav_name ()
 
 bound_from ()
 
 set_bind_location ($new_dav_name)
 
 parent_path ()
 
 principal_url ()
 
 user_no ()
 
 collection_id ()
 
 resource ()
 
 unique_tag ()
 
 resource_id ()
 
 sync_token ($cachedOK=true)
 
 IsPublic ()
 
 IsPublicOnly ()
 
 ContainerType ()
 
 BuildACE (&$xmldoc, $privs, $principal)
 
 GetACL (&$xmldoc)
 
 GetProperty ($name)
 
 DAV_AllProperties ()
 
 ResourceProperty ($tag, $prop, &$reply, &$denied)
 
 GetPropStat ($properties, &$reply, $props_only=false)
 
 RenderAsXML ($properties, &$reply, $bound_parent_path=null)
 

Static Private Member Functions

static GetTZID (vComponent $comp)
 

Additional Inherited Members

- Static Public Member Functions inherited from DAVResource
static BuildDeadPropertyXML ($property_name, $raw_string)
 
- Protected Member Functions inherited from DAVResource
 FetchCollection ()
 
 FetchPrincipal ()
 
 FetchResource ()
 
 FetchDeadProperties ()
 
 FetchPrivileges ()
 
- Protected Attributes inherited from DAVResource
 $dav_name
 
 $exists
 
 $unique_tag
 
 $resource
 
 $parent
 
 $resourcetypes
 
 $contenttype
 
 $bound_from
 

Detailed Description

Definition at line 4 of file WritableCollection.php.

Member Function Documentation

WritableCollection::actualDeleteCalendarMember (   $member_dav_name)

Writes the data to a member in the collection and returns the segment_name of the resource in our internal namespace.

Parameters
vCalendar$member_dav_nameThe path to the resource to be deleted.
Returns
boolean Success is true, or false on failure.

Definition at line 416 of file WritableCollection.php.

static WritableCollection::GetTZID ( vComponent  $comp)
staticprivate

Get a TZID string from this VEVENT/VTODO/... component if we can

Parameters
vComponent$comp
Returns
The TZID value we found, or null

Definition at line 11 of file WritableCollection.php.

WritableCollection::whatChangedSince (   $some_old_token)
Parameters
unknown_type$some_old_token

Definition at line 454 of file WritableCollection.php.

WritableCollection::WriteCalendarAlarms (   $dav_id,
vCalendar  $vcal 
)

Given a dav_id and an original vCalendar, pull out each of the VALARMs and write the values into the calendar_alarm table.

Returns
null

Definition at line 315 of file WritableCollection.php.

WritableCollection::WriteCalendarAttendees (   $dav_id,
vCalendar  $vcal 
)

Parse out the attendee property and write a row to the calendar_attendee table for each one.

Parameters
int$dav_idThe dav_id of the caldav_data we're processing
vComponentThe VEVENT or VTODO containing the ATTENDEEs
Returns
null
Todo:
work out why we get duplicate ATTENDEE on one VEVENT

Definition at line 378 of file WritableCollection.php.

WritableCollection::WriteCalendarMember ( vCalendar  $vcal,
  $create_resource,
  $do_scheduling = false,
  $segment_name = null,
  $log_action = false 
)

Writes the data to a member in the collection and returns the segment_name of the resource in our internal namespace.

Parameters
vCalendar$vcalThe resource to be written.
boolean$create_resourceTrue if this is a new resource.
boolean$do_schedulingTrue if we should also do scheduling for this write. Default false.
string$segment_nameThe name of the resource within the collection, or null if this call should invent one based on the UID of the vCalendar.
boolean$log_actionWhether to log this action. Defaults to false since this is normally called in situations where one is writing secondary data.
Returns
string The segment_name of the resource within the collection, as written, or false on failure.

From RFC2445 4.6.1: For cases where a "VEVENT" calendar component specifies a "DTSTART" property with a DATE data type but no "DTEND" property, the events non-inclusive end is the end of the calendar date specified by the "DTSTART" property. For cases where a "VEVENT" calendar component specifies a "DTSTART" property with a DATE-TIME data type but no "DTEND" property, the event ends on the same calendar date and time of day specified by the "DTSTART" property.

So we're looking for 'VALUE=DATE', to identify the duration, effectively.

Calculate what timezone to set, first, if possible

Definition at line 33 of file WritableCollection.php.

WritableCollection::WriteMember (   $resource,
  $create_resource,
  $segment_name = null,
  $log_action = true 
)

Writes the data to a member in the collection and returns the segment_name of the resource in our internal namespace.

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.

Parameters
$resourcemixed The resource to be written.
$create_resourceboolean True if this is a new resource.
$segment_nameThe name of the resource within the collection, or false on failure.
boolean$log_actionWhether to log this action. Defaults to true since this is normally called in situations where one is writing primary data.
Returns
string The segment_name that was given, or one that was assigned if null was given.

Definition at line 288 of file WritableCollection.php.


The documentation for this class was generated from the following file: