## [davical] element index

### Package indexes

- awl

All elements
_
top

__construct
  squidPamDrivers::__construct() in drivers_squid_pam.php
  The constructor
__construct
  ldapDrivers::__construct() in drivers_ldap.php
  Initializes the LDAP connection

a
top

apply_filter
  apply_filter() in caldav-REPORT-calquery.php
  While we can construct our SQL to apply some filters in the query, other filters need to be checked against the retrieved record. This is for handling those ones.
always.php
  always.php in always.php
AuthExternalAWL
  AuthExternalAWL() in auth-functions.php
  Authenticate against a different PostgreSQL database which contains a usr table in the AWL format.
auth-functions.php
  auth-functions.php in auth-functions.php
AssignSessionDetails
  DAViCalSession::AssignSessionDetails() in DAViCalSession.php
  Internal function used to assign the session details to a user's new session.
AllowedTo
  DAViCalUser::AllowedTo() in DAViCalUser.php
  Extend parent definition of what the current user is allowed to do
AllowedTo
  HTTPAuthSession::AllowedTo() in HTTPAuthSession.php
  Checks whether a user is allowed to do something.
AssignSessionDetails
  HTTPAuthSession::AssignSessionDetails() in HTTPAuthSession.php
  Internal function used to assign the session details to a user's new session.
AuthFailedResponse
  HTTPAuthSession::AuthFailedResponse() in HTTPAuthSession.php
  Authorisation failed, so we send some headers to say so.
AsCollection
  CalDAVPrincipal::AsCollection() in CalDAVPrincipal.php
  Returns a representation of the principal as a collection
add_arbitrary_properties
  add_arbitrary_properties() in caldav-PROPFIND.php
  Adds any arbitrary properties that were requested by the PROPFIND into the response.
add_general_properties
  add_general_properties() in caldav-PROPFIND.php
  Handles any properties related to the DAV::PRINCIPAL in the request
add_principal_properties
  add_principal_properties() in caldav-PROPFIND.php
  Handles any properties related to the DAV::PRINCIPAL in the request
add_proxy_response
  add_proxy_response() in caldav-PROPFIND.php
  Add the calendar-proxy-read/write pseudocollections
AllowedTo
  PublicSession::AllowedTo() in PublicSession.php
  Checks whether a user is allowed to do something.
AllowedTo
  CalDAVRequest::AllowedTo() in CalDAVRequest.php
  Are we allowed to do the requested activity

b
top

BuildSqlFilter
  BuildSqlFilter() in caldav-REPORT-calquery.php
  Build an SQL 'WHERE' clause which implements (parts of) the filter. The elements of the filter which are implemented in the SQL will be removed.
BasicAuthSession
  HTTPAuthSession::BasicAuthSession() in HTTPAuthSession.php
  Handle Basic HTTP Authentication (not secure unless https)
$by_email
  CalDAVPrincipal::$by_email in CalDAVPrincipal.php
build_propstat_response
  build_propstat_response() in caldav-PROPFIND.php
  Build the <propstat><prop></prop><status></status></propstat> part of the response

c
top

check_string
  check_string() in check_UTF8.php
ConstructURL
  ConstructURL() in always.php
  Construct a URL from the supplied dav_name. The URL will be urlencoded, except for any '/' characters in it.
collection.php
  collection.php in collection.php
caldav-LOCK.php
  caldav-LOCK.php in caldav-LOCK.php
caldav-REPORT-calquery.php
  caldav-REPORT-calquery.php in caldav-REPORT-calquery.php
caldav-REPORT-freebusy.php
  caldav-REPORT-freebusy.php in caldav-REPORT-freebusy.php
caldav-REPORT-multiget.php
  caldav-REPORT-multiget.php in caldav-REPORT-multiget.php
caldav-REPORT-principal.php
  caldav-REPORT-principal.php in caldav-REPORT-principal.php
check_UTF8.php
  check_UTF8.php in check_UTF8.php
CreateDefaultRelationships
  CreateDefaultRelationships() in auth-functions.php
  Create default relationships
CreateHomeCalendar
  CreateHomeCalendar() in auth-functions.php
  Create a default home calendar for the user.
calendar_to_xml
  calendar_to_xml() in caldav-REPORT.php
  Return XML for a single calendar (or todo) entry from the DB
controlRequestContainer
  controlRequestContainer() in caldav-PUT-functions.php
  Work out the location we are doing the PUT to, and check that we have the rights to do the needful.
create_scheduling_requests
  create_scheduling_requests() in caldav-PUT-functions.php
  Create scheduling requests in the schedule inbox for the
caldav.php
  caldav.php in caldav.php
caldav-DELETE.php
  caldav-DELETE.php in caldav-DELETE.php
caldav-GET.php
  caldav-GET.php in caldav-GET.php
caldav-MKCALENDAR.php
  caldav-MKCALENDAR.php in caldav-MKCALENDAR.php
caldav-OPTIONS.php
  caldav-OPTIONS.php in caldav-OPTIONS.php
caldav-POST.php
  caldav-POST.php in caldav-POST.php
caldav-PROPPATCH.php
  caldav-PROPPATCH.php in caldav-PROPPATCH.php
caldav-PUT-functions.php
  caldav-PUT-functions.php in caldav-PUT-functions.php
caldav-PUT.php
  caldav-PUT.php in caldav-PUT.php
caldav-REPORT.php
  caldav-REPORT.php in caldav-REPORT.php
CheckPassword
  HTTPAuthSession::CheckPassword() in HTTPAuthSession.php
  CheckPassword does all of the password checking and returns a user record object, or false if it all ends in tears.
$calendar_home_set
  CalDAVPrincipal::$calendar_home_set in CalDAVPrincipal.php
CalDAVPrincipal
  CalDAVPrincipal::CalDAVPrincipal() in CalDAVPrincipal.php
  Constructor
CalDAVPrincipal
  CalDAVPrincipal in CalDAVPrincipal.php
  A class for things to do with a DAV Principal
CalDAVPrincipal.php
  CalDAVPrincipal.php in CalDAVPrincipal.php
collection_to_xml
  collection_to_xml() in caldav-PROPFIND.php
  Returns an XML sub-tree for a single collection record from the DB
caldav-PROPFIND.php
  caldav-PROPFIND.php in caldav-PROPFIND.php
$collection_id
  CalDAVRequest::$collection_id in CalDAVRequest.php
  The ID of the collection containing this path, or of this path if it is a collection
$collection_path
  CalDAVRequest::$collection_path in CalDAVRequest.php
  The path corresponding to the collection_id
$collection_type
  CalDAVRequest::$collection_type in CalDAVRequest.php
  The type of collection being requested:
$current_user_principal_xml
  CalDAVRequest::$current_user_principal_xml in CalDAVRequest.php
  The 'current_user_principal_xml' the DAV:current-user-principal answer. An XMLElement object with an <href> or <unauthenticated> fragment.
CalDAVRequest
  CalDAVRequest::CalDAVRequest() in CalDAVRequest.php
  Create a new CalDAVRequest object.
CalDAVRequest
  CalDAVRequest in CalDAVRequest.php
  A class for collecting things to do with this request.
CalDAVRequest.php
  CalDAVRequest.php in CalDAVRequest.php

d
top

$description
  RRuleTest::$description in test-RRULE.php
$dtstart
  RRuleTest::$dtstart in test-RRULE.php
davical_configuration_missing.php
  davical_configuration_missing.php in davical_configuration_missing.php
DAViCalSession
  DAViCalSession::DAViCalSession() in DAViCalSession.php
  Create a new DAViCalSession object.
DAViCalSession
  DAViCalSession in DAViCalSession.php
  A class for creating and holding session information.
DAViCalSession.php
  DAViCalSession.php in DAViCalSession.php
$delete_collection_confirmation_required
  DAViCalUser::$delete_collection_confirmation_required in DAViCalUser.php
$delete_user_confirmation_required
  DAViCalUser::$delete_user_confirmation_required in DAViCalUser.php
DAViCalUser
  DAViCalUser in DAViCalUser.php
  A class for viewing and maintaining DAViCal User records
DAViCalUser
  DAViCalUser::DAViCalUser() in DAViCalUser.php
  Constructor - nothing fancy as yet.
DAViCalUser.php
  DAViCalUser.php in DAViCalUser.php
DigestAuthSession
  HTTPAuthSession::DigestAuthSession() in HTTPAuthSession.php
  Handle Digest HTTP Authentication (no passwords were harmed in this transaction!)
drivers_ldap.php
  drivers_ldap.php in drivers_ldap.php
drivers_squid_pam.php
  drivers_squid_pam.php in drivers_squid_pam.php
$depth
  CalDAVRequest::$depth in CalDAVRequest.php
  The depth parameter from the request headers, coerced into a valid integer: 0, 1 or DEPTH_INFINITY which is defined above. The default is set per various RFCs.
DepthRegexTail
  CalDAVRequest::DepthRegexTail() in CalDAVRequest.php
  Returns the tail of a Regex appropriate for this Depth, when appended to
DEPTH_INFINITY
  DEPTH_INFINITY in CalDAVRequest.php
DoResponse
  CalDAVRequest::DoResponse() in CalDAVRequest.php
  Utility function we call when we have a simple status-based response to return to the client. Possibly

f
top

freebusy.php
  freebusy.php in freebusy.php
freebusy-GET.php
  freebusy-GET.php in freebusy-GET.php
FailIfLocked
  CalDAVRequest::FailIfLocked() in CalDAVRequest.php
  This will either (a) return false if no locks apply, or (b) return the lock_token which the request successfully included to open the lock, or: (c) respond directly to the client with the failure.

g
top

getStatusMessage
  getStatusMessage() in always.php
  Return the HTTP status code description for a given code. Hopefully this is an efficient way to code this.
getUserByID
  getUserByID() in always.php
  Return a user record identified by a user_no, caching it for any subsequent lookup
getUserByName
  getUserByName() in always.php
  Return a user record identified by a username, caching it for any subsequent lookup
GetRelationships
  DAViCalSession::GetRelationships() in DAViCalSession.php
  Method used to get the user's relationships
GetRoles
  DAViCalSession::GetRoles() in DAViCalSession.php
  Method used to get the user's roles
GetRoles
  HTTPAuthSession::GetRoles() in HTTPAuthSession.php
  Internal function used to get the user's roles from the database.
getAllUsers
  ldapDrivers::getAllUsers() in drivers_ldap.php
  Retrieve all users from the LDAP directory
getStaticLdap
  getStaticLdap() in drivers_ldap.php
  A generic function to create and fetch static objects
$group_membership
  CalDAVPrincipal::$group_membership in CalDAVPrincipal.php
$group_member_set
  CalDAVPrincipal::$group_member_set in CalDAVPrincipal.php
get_collection
  get_collection() in caldav-PROPFIND.php
  Get XML response for a single collection. If Depth is >0 then
get_collection_contents
  get_collection_contents() in caldav-PROPFIND.php
  Get XML response for items in the collection If '/' is requested, a list of visible users is given, otherwise a list of calendars for the user which are parented by this path.
get_item
  get_item() in caldav-PROPFIND.php
  Get XML response for a single item. Depth is irrelevant for this.
GetDepthName
  CalDAVRequest::GetDepthName() in CalDAVRequest.php
  Returns the name for this depth: 0, 1, infinity
GetLockDetails
  CalDAVRequest::GetLockDetails() in CalDAVRequest.php
  Returns the DB object associated with a lock token, or false.
GetLockRow
  CalDAVRequest::GetLockRow() in CalDAVRequest.php
  Returns the locked row, either from the cache or from the database

h
top

help.php
  help.php in help.php
handle_cancel_request
  handle_cancel_request() in caldav-POST.php
handle_freebusy_request
  handle_freebusy_request() in caldav-POST.php
HandleAction
  DAViCalUser::HandleAction() in DAViCalUser.php
  Handle any unusual actions we might invent
HTTPAuthSession
  HTTPAuthSession::HTTPAuthSession() in HTTPAuthSession.php
  The constructor, which just calls the actual type configured
HTTPAuthSession
  HTTPAuthSession in HTTPAuthSession.php
  A Class for handling a session using HTTP Basic Authentication
HTTPAuthSession.php
  HTTPAuthSession.php in HTTPAuthSession.php
href_set_from_paths
  href_set_from_paths() in caldav-PROPFIND.php
  Returns a set of hrefs from a set of urls

i
top

index.php
  index.php in index.php
interactive-page.php
  interactive-page.php in interactive-page.php
ISODateToHTTPDate
  ISODateToHTTPDate() in always.php
  Convert a date from ISO format into the sad old HTTP format.
import_collection
  import_collection() in caldav-PUT-functions.php
  This function will import a whole calendar
importFromDirectory
  Tools::importFromDirectory() in tools.php
InitialiseRecord
  CalDAVPrincipal::InitialiseRecord() in CalDAVPrincipal.php
  Initialise the Principal object from a $usr record from the DB.
item_to_xml
  item_to_xml() in caldav-PROPFIND.php
  Return XML for a single data item from the DB
IsCalendar
  CalDAVRequest::IsCalendar() in CalDAVRequest.php
  Returns true if the URL referenced by this request points at a calendar collection.
IsCollection
  CalDAVRequest::IsCollection() in CalDAVRequest.php
  Returns true if the URL referenced by this request points at a collection.
IsInfiniteDepth
  CalDAVRequest::IsInfiniteDepth() in CalDAVRequest.php
  Returns true if the request asked for infinite depth
IsLocked
  CalDAVRequest::IsLocked() in CalDAVRequest.php
  Checks whether the resource is locked, returning any lock token, or false
IsPrincipal
  CalDAVRequest::IsPrincipal() in CalDAVRequest.php
  Returns true if the URL referenced by this request points at a principal.
IsProxyRequest
  CalDAVRequest::IsProxyRequest() in CalDAVRequest.php
  Returns true if the URL referenced by this request is within a proxy URL
IsPublic
  CalDAVRequest::IsPublic() in CalDAVRequest.php
  Checks whether the collection is public

l
top

local_session_sql
  local_session_sql() in DAViCalSession.php
LoginRequired
  DAViCalSession::LoginRequired() in DAViCalSession.php
  Checks that this user is logged in, and presents a login screen if they aren't.
ldapDrivers
  ldapDrivers::ldapDrivers() in drivers_ldap.php
  Constructor.
ldapDrivers
  ldapDrivers in drivers_ldap.php
LDAP_check
  LDAP_check() in drivers_ldap.php
  Check the username / password against the LDAP server
log_caldav_action.php
  log_caldav_action.php in log_caldav_action.php
log_caldav_action
  log_caldav_action() in log_caldav_action.php
  Log the action

m
top

make_help_link
  make_help_link() in page-header.php
$method
  CalDAVRequest::$method in CalDAVRequest.php
  The HTTP request method: PROPFIND, LOCK, REPORT, OPTIONS, etc...

o
top

other_translated_strings.php
  other_translated_strings.php in other_translated_strings.php
$options
  CalDAVRequest::$options in CalDAVRequest.php

p
top

page-footer.php
  page-footer.php in page-footer.php
page-header.php
  page-header.php in page-header.php
PHPTest
  RRuleTest::PHPTest() in test-RRULE.php
public.php
  public.php in public.php
public_events_only
  public_events_only() in caldav-PUT-functions.php
  Check if this collection should force all events to be PUBLIC.
putCalendarResource
  putCalendarResource() in caldav-PUT-functions.php
  Put the resource from this request - does some checking of things before calling write_event to do the actual writing (without any checking).
ParseDigestHeader
  HTTPAuthSession::ParseDigestHeader() in HTTPAuthSession.php
  Parse the HTTP Digest Auth Header
privileges
  privileges() in caldav-PROPFIND.php
  Returns the array of privilege names converted into XMLElements
PublicSession.php
  PublicSession.php in PublicSession.php
PublicSession
  PublicSession::PublicSession() in PublicSession.php
  The constructor, which just calls the actual type configured
PublicSession
  PublicSession in PublicSession.php
  A Class for handling a public (anonymous) session
$principal
  CalDAVRequest::$principal in CalDAVRequest.php
  The 'principal' (user/resource/...) which this request seeks to access

r
top

$recur
  RRuleTest::$recur in test-RRULE.php
$result_description
  RRuleTest::$result_description in test-RRULE.php
relationship_types.php
  relationship_types.php in relationship_types.php
roles.php
  roles.php in roles.php
RRuleTest
  RRuleTest in test-RRULE.php
RRuleTest
  RRuleTest::RRuleTest() in test-RRULE.php
rollback_on_error
  rollback_on_error() in caldav-PUT-functions.php
  This function launches an error
render
  Tools::render() in tools.php
renderImportFromDirectory
  Tools::renderImportFromDirectory() in tools.php
renderSyncLDAP
  Tools::renderSyncLDAP() in tools.php
Render
  DAViCalUser::Render() in DAViCalUser.php
  Render the form / viewer as HTML to show the user
RenderCollections
  DAViCalUser::RenderCollections() in DAViCalUser.php
  Render the user's collections
RenderRelationshipsFrom
  DAViCalUser::RenderRelationshipsFrom() in DAViCalUser.php
  Render the user's relationships to other users & resources
RenderRelationshipsTo
  DAViCalUser::RenderRelationshipsTo() in DAViCalUser.php
  Render the user's relationships to other users & resources
requestUser
  ldapDrivers::requestUser() in drivers_ldap.php
  Returns the result of the LDAP query
$read_proxy_for
  CalDAVPrincipal::$read_proxy_for in CalDAVPrincipal.php
$read_proxy_group
  CalDAVPrincipal::$read_proxy_group in CalDAVPrincipal.php
RenderAsXML
  CalDAVPrincipal::RenderAsXML() in CalDAVPrincipal.php
  Render XML for a single Principal (user) from the DB
$raw_post
  CalDAVRequest::$raw_post in CalDAVRequest.php
  The raw data sent along with the request
RenderPrivileges
  CalDAVRequest::RenderPrivileges() in CalDAVRequest.php
  Returns the array of privilege names converted into XMLElements
RenderSupportedPrivileges
  CalDAVRequest::RenderSupportedPrivileges() in CalDAVRequest.php
  Returns the array of supported privileges converted into XMLElements

s
top

send_page_header
  send_page_header() in page-header.php
SqlFilterFragment
  SqlFilterFragment() in caldav-REPORT-calquery.php
  Process a filter fragment returning an SQL fragment
SQLTest
  RRuleTest::SQLTest() in test-RRULE.php
simple_write_resource
  simple_write_resource() in caldav-PUT-functions.php
  A slightly simpler version of write_resource which will make more sense for calling from an external program. This makes assumptions that the collection and user do exist and bypasses all checks for whether it is reasonable to write this here.
$session The session object is global.
  $session The session object is global. in DAViCalSession.php
squidPamDrivers
  squidPamDrivers::squidPamDrivers() in drivers_squid_pam.php
  Constructor.
squidPamDrivers
  squidPamDrivers in drivers_squid_pam.php
SQUID_PAM_check
  SQUID_PAM_check() in drivers_squid_pam.php
  Check the username / password against the PAM system
sync_LDAP
  sync_LDAP() in drivers_ldap.php
  sync LDAP against the DB
sync_user_from_LDAP
  sync_user_from_LDAP() in drivers_ldap.php
  Synchronise a cached user with one from LDAP
$schedule_inbox_url
  CalDAVPrincipal::$schedule_inbox_url in CalDAVPrincipal.php
$schedule_outbox_url
  CalDAVPrincipal::$schedule_outbox_url in CalDAVPrincipal.php
$supported_privileges
  CalDAVRequest::$supported_privileges in CalDAVRequest.php
  A static structure of supported privileges.
ServerProperty
  CalDAVRequest::ServerProperty() in CalDAVRequest.php
  Return general server-related properties for this URL
setPermissions
  CalDAVRequest::setPermissions() in CalDAVRequest.php
  Permissions are controlled as follows:
SupportedPrivileges
  CalDAVRequest::SupportedPrivileges() in CalDAVRequest.php
  Return an array of what the DAV privileges are that are supported

t
top

testpdo.php
  testpdo.php in testpdo.php
test-RRULE.php
  test-RRULE.php in test-RRULE.php
translate_relationship_list
  translate_relationship_list() in users.php
  Translate relationship names in the relationship_list for each user. See the documentation for classBrowser::BrowserColumn for the definition of the hook function parameters.
tools.php
  tools.php in tools.php
Tools
  Tools in tools.php

u
top

usr.php
  usr.php in usr.php
unicodeToUtf8
  unicodeToUtf8() in check_UTF8.php
  Takes an array of ints representing the Unicode characters and returns a UTF-8 string. Astral planes are supported ie. the ints in the input can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.
utf8ToUnicode
  utf8ToUnicode() in check_UTF8.php
  Takes an UTF-8 string and returns an array of ints representing the Unicode characters. Astral planes are supported ie. the ints in the output can be > 0xFFFF. Occurrances of the BOM are ignored. Surrogates are not allowed.
users.php
  users.php in users.php
UpdateUserFromExternal
  UpdateUserFromExternal() in auth-functions.php
  Update the local cache of the remote user details
update_scheduling_requests
  update_scheduling_requests() in caldav-PUT-functions.php
  Update scheduling requests in the schedule inbox for the
$url
  CalDAVPrincipal::$url in CalDAVPrincipal.php
UsernameFromEMail
  CalDAVPrincipal::UsernameFromEMail() in CalDAVPrincipal.php
  Work out the username, based on the given e-mail
UsernameFromPath
  CalDAVPrincipal::UsernameFromPath() in CalDAVPrincipal.php
  Work out the username, based on elements of the path.
$user_agent
  CalDAVRequest::$user_agent in CalDAVRequest.php
  The user agent making the request.
UnsupportedRequest
  CalDAVRequest::UnsupportedRequest() in CalDAVRequest.php
  Sometimes it's a perfectly formed request, but we just don't do that :-(
UserFromPath
  CalDAVRequest::UserFromPath() in CalDAVRequest.php
  Work out the user whose calendar we are accessing, based on elements of the path.

v
top

Validate
  DAViCalUser::Validate() in DAViCalUser.php
  Validate the information the user submitted
ValidateLockToken
  CalDAVRequest::ValidateLockToken() in CalDAVRequest.php
  Checks to see whether the lock token given matches one of the ones handed in with the request.

w
top

write_resource
  write_resource() in caldav-PUT-functions.php
  Actually write the resource to the database. All checking of whether this is reasonable should be done before this is called.
write_scheduling_request
  write_scheduling_request() in caldav-PUT-functions.php
  Create a scheduling request in the schedule inbox for the
Write
  DAViCalUser::Write() in DAViCalUser.php
  Write the record to the file
$write_proxy_for
  CalDAVPrincipal::$write_proxy_for in CalDAVPrincipal.php
$write_proxy_group
  CalDAVPrincipal::$write_proxy_group in CalDAVPrincipal.php

x
top

XMLResponse
  CalDAVRequest::XMLResponse() in CalDAVRequest.php
  Send an XML Response. This function will never return.