Overview

Packages

  • awl
    • caldav-client-v2
    • RRule
  • davical
    • authentication
      • drivers
    • caldav
    • DAViCalSession
    • DAVTicket
    • external-bind
    • feed
    • HTTPAuthSession
    • iSchedule
    • iSchedule-POST
    • logging
    • metrics
    • Principal
    • propfind
    • PublicSession
    • Request
    • Resource
    • tzservice
  • None

Classes

  • WritableCollection

Functions

  • bits_to_privilege
  • ConstructURL
  • DateToISODate
  • DeconstructURL
  • early_catch_fatal_error
  • early_exception_handler
  • getStatusMessage
  • ISODateToHTTPDate
  • privilege_to_bits
  • privileges_to_XML
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class WritableCollection

A class for things to do with a DAV Resource

DAVResource
Extended by WritableCollection
Package: davical
Located at WritableCollection.php
Methods summary
public string
# WriteCalendarMember( vCalendar $vcal, boolean $create_resource, boolean $do_scheduling = false, string $segment_name = null, boolean $log_action = false )

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

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

Parameters

$vcal
The resource to be written.
$create_resource
True if this is a new resource.
$do_scheduling
True if we should also do scheduling for this write. Default false.
$segment_name

The name of the resource within the collection, or null if this call should invent one based on the UID of the vCalendar.

$log_action

Whether 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.
public string
# WriteMember( $resource, $create_resource, $segment_name = null, boolean $log_action = true )

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

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

$resource
The resource to be written.
$create_resource
True if this is a new resource.
$segment_name
name of the resource within the collection, or false on failure.
$log_action

Whether 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.
public null
# 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.

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
public null
# WriteCalendarAttendees( integer $dav_id, vCalendar $vcal )

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

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

Parameters

$dav_id
The dav_id of the caldav_data we're processing
$vcal
VEVENT or VTODO containing the ATTENDEEs

Returns

null
public boolean
# actualDeleteCalendarMember( vCalendar $member_dav_name )

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

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

Parameters

$member_dav_name
The path to the resource to be deleted.

Returns

boolean
Success is true, or false on failure.
public
# whatChangedSince( unknown_type $some_old_token )

Parameters

$some_old_token
Methods inherited from DAVResource
BuildACE(), BuildDeadPropertyXML(), BuildPrivileges(), BuildSupportedMethods(), BuildSupportedReports(), BuildTicketinfo(), ContainerExists(), ContainerType(), DAV_AllProperties(), Exists(), FetchCollection(), FetchDeadProperties(), FetchParentContainer(), FetchPrincipal(), FetchPrivileges(), FetchResource(), FetchSupportedMethods(), FetchSupportedReports(), FetchTickets(), FromPath(), FromRow(), GetACL(), GetParentContainer(), GetPropStat(), GetProperty(), HavePrivilegeTo(), IsAddressbook(), IsBinding(), IsCalendar(), IsCollection(), IsExternal(), IsInSchedulingCollection(), IsLocked(), IsPrincipal(), IsPublic(), IsPublicOnly(), IsSchedulingCollection(), NeedPrivilege(), Privileges(), RenderAsXML(), ResourceProperty(), __construct(), bound_from(), collection_id(), dav_name(), parent_path(), principal_url(), resource(), resource_id(), set_bind_location(), sync_token(), unique_tag(), url(), user_no()
Properties inherited from DAVResource
$bound_from, $contenttype, $dav_name, $exists, $parent, $resource, $resourcetypes, $unique_tag
DAViCal API documentation generated by ApiGen