## [awl] element index

### Package indexes

- davical

All elements
_
top

_EpochFromParts
  iCalDate::_EpochFromParts() in RRule.php
  Given a local text date, convert it to an epoch
_GMTEpochFromParts
  iCalDate::_GMTEpochFromParts() in RRule.php
  Given a GMT text date, convert it to an epoch
_GMTTextFromEpoch
  iCalDate::_GMTTextFromEpoch() in RRule.php
  Given a GMT epoch date, convert it to text
_PartsFromText
  iCalDate::_PartsFromText() in RRule.php
  Given a text date, convert it to parts
_TextFromEpoch
  iCalDate::_TextFromEpoch() in RRule.php
  Given an epoch date, convert it to text
__construct
  PdoQuery::__construct() in PdoQuery.php
  Where $db is a PdoDatabase object. This constructs the PdoQuery. If there are further parameters they will be in turn, the sql, and any positional parameters to replace into that, and will be passed to $this->Query() before returning.
__construct
  PdoDialect::__construct() in PdoQuery.php
  Parses the connection string to ascertain the database dialect. Returns true if the dialect is supported and fails if the dialect is not supported. All code to support any given database should be within in an external include.
__construct
  PdoDatabase::__construct() in PdoQuery.php
  The connection string is in the standard PDO format. The database won't actually be connected until the first database query is run against it.

a
top

AddDays
  iCalDate::AddDays() in RRule.php
  Add some integer number of days to a date
AddDuration
  iCalDate::AddDuration() in RRule.php
  Add duration
AddMonths
  iCalDate::AddMonths() in RRule.php
  Add some number of months to a date
ApplyBySetPos
  iCalDate::ApplyBySetPos() in RRule.php
  Given set position descriptions like '1', '3', '11', '-3' or '-1' and a set, return the subset matching the list of set positions.

b
top

$base_url
  CalDAVClient::$base_url in caldav-client.php
  Server, username, password, calendar
$body
  CalDAVClient::$body in caldav-client.php
Begin
  PdoDatabase::Begin() in PdoQuery.php
  Begin a transaction.

c
top

$calendar
  CalDAVClient::$calendar in caldav-client.php
CalDAVClient
  CalDAVClient::CalDAVClient() in caldav-client.php
  Constructor, initialises the class
CalDAVClient
  CalDAVClient in caldav-client.php
  A class for accessing DAViCal via CalDAV, as a client
caldav-client.php
  caldav-client.php in caldav-client.php
Commit
  PdoDatabase::Commit() in PdoQuery.php
  Complete a transaction.

d
top

DateDifference
  iCalDate::DateDifference() in RRule.php
  Produce an iCalendar format DURATION for the difference between this an another iCalDate
DaysInMonth
  iCalDate::DaysInMonth() in RRule.php
  No of days in a month 1(Jan) - 12(Dec)
DoCalendarQuery
  CalDAVClient::DoCalendarQuery() in caldav-client.php
  Given XML for a calendar query, return an array of the events (/todos) in the response. Each event in the array will have a 'href', 'etag' and '$response_type' part, where the 'href' is relative to the calendar and the '$response_type' contains the definition of the calendar data in iCalendar format.
DoDELETERequest
  CalDAVClient::DoDELETERequest() in caldav-client.php
  DELETE a text/icalendar resource
DoGETRequest
  CalDAVClient::DoGETRequest() in caldav-client.php
  Get a single item from the server.
DoOptionsRequest
  CalDAVClient::DoOptionsRequest() in caldav-client.php
  Send an OPTIONS request to the server
DoPUTRequest
  CalDAVClient::DoPUTRequest() in caldav-client.php
  PUT a text/icalendar resource, returning the etag
DoRequest
  CalDAVClient::DoRequest() in caldav-client.php
  Send a request to the server
DoXMLRequest
  CalDAVClient::DoXMLRequest() in caldav-client.php
  Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
$dialect
  PdoDialect::$dialect in PdoQuery.php
  Holds the name of the database dialect

e
top

$entry
  CalDAVClient::$entry in caldav-client.php
Exec
  PdoQuery::Exec() in PdoQuery.php
  If there are (some) positional parameters in the prepared query, now is the last chance to supply them...
Exec
  PdoDatabase::Exec() in PdoQuery.php
  Construct and execute an SQL statement from the sql_string, replacing the parameters into it.

f
top

Fetch
  PdoQuery::Fetch() in PdoQuery.php
  Will fetch the next row from the query into an object with elements named for the fields in the result.
FetchAll
  PdoQuery::FetchAll() in PdoQuery.php
  Will fetch all result rows from the query into an array of objects with elements named for the fields in the result.
FetchArray
  PdoQuery::FetchArray() in PdoQuery.php
  Will fetch the next row from the query into an array with numbered elements and with elements named for the fields in the result.

g
top

GetEntryByHref
  CalDAVClient::GetEntryByHref() in caldav-client.php
  Get the calendar entry by HREF
GetEntryByUid
  CalDAVClient::GetEntryByUid() in caldav-client.php
  Get the calendar entry by UID
GetEvents
  CalDAVClient::GetEvents() in caldav-client.php
  Get the events in a range from $start to $finish. The dates should be in the
GetHttpRequest
  CalDAVClient::GetHttpRequest() in caldav-client.php
  Output http request headers
GetHttpResponse
  CalDAVClient::GetHttpResponse() in caldav-client.php
  Output http response headers
GetMonthByDay
  iCalDate::GetMonthByDay() in RRule.php
  Applies any BYDAY to the month to return a set of days
GetMonthByMonthDay
  iCalDate::GetMonthByMonthDay() in RRule.php
  Applies any BYMONTHDAY to the month to return a set of days
GetNext
  RRule::GetNext() in RRule.php
  This is most of the meat of the RRULE processing, where we find the next date.
GetTodos
  CalDAVClient::GetTodos() in caldav-client.php
  Get the todo's in a range from $start to $finish. The dates should be in the
GetWeekByDay
  iCalDate::GetWeekByDay() in RRule.php
  Applies any BYDAY to the week to return a set of days
GetXmlRequest
  CalDAVClient::GetXmlRequest() in caldav-client.php
  Output xml request
GetXmlResponse
  CalDAVClient::GetXmlResponse() in caldav-client.php
  Output xml response
GreaterThan
  iCalDate::GreaterThan() in RRule.php
  Test if $this is greater than the date parameter
GetFields
  PdoDialect::GetFields() in PdoQuery.php
  Returns the SQL for the current database dialect which will return a two-column resultset containing a list of fields and their associated data types.
GetFields
  PdoDatabase::GetFields() in PdoQuery.php
  Returns an associative array of field types, keyed by field name, for the requested named table. Internally this calls PdoDialect::GetFields to get the required SQL and then processes the query in the normal manner.

h
top

$headers
  CalDAVClient::$headers in caldav-client.php
$httpRequest
  CalDAVClient::$httpRequest in caldav-client.php
$httpResponse
  CalDAVClient::$httpResponse in caldav-client.php

i
top

iCalDate
  iCalDate::iCalDate() in RRule.php
  The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.
iCalDate
  iCalDate in RRule.php
  A Class for handling dates in iCalendar format. We do make the simplifying assumption that all date handling in here is normalised to GMT. One day we might provide some functions to do that, but for now it is done externally.

l
top

LessThan
  iCalDate::LessThan() in RRule.php
  Test if $this is less than the date parameter

m
top

MonthDays
  iCalDate::MonthDays() in RRule.php
  Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.
MaxDuration
  PdoQuery::MaxDuration() in PdoQuery.php
  Used to set the maximum duration for this query before it will be logged as a slow query.

p
top

$pass
  CalDAVClient::$pass in caldav-client.php
$port
  CalDAVClient::$port in caldav-client.php
$protocol
  CalDAVClient::$protocol in caldav-client.php
ParseResponse
  CalDAVClient::ParseResponse() in caldav-client.php
  Split response into httpResponse and xmlResponse
PdoQuery.php
  PdoQuery.php in PdoQuery.php
PdoDatabase
  PdoDatabase in PdoQuery.php
  Typically there will only be a single instance of the database level class in an application.
PdoDialect
  PdoDialect in PdoQuery.php
  The PdoDialect class handles
PdoQuery
  PdoQuery in PdoQuery.php
  A variable of this class is normally constructed through a call to PdoDatabase::Query or PdoDatabase::Prepare, associating it on construction with the database which is to be queried.
Prepare
  PdoDatabase::Prepare() in PdoQuery.php
  Returns a PdoQuery object created using this database, the supplied SQL string, and any parameters given.
PrepareTranslated
  PdoDatabase::PrepareTranslated() in PdoQuery.php
  Operates identically to PdoDatabase::Prepare, except that PdoDialect::Translate() will be called on the query before any processing.

q
top

$querycount
  PdoDatabase::$querycount in PdoQuery.php
  Holds the count of queries executed so far
$querytime
  PdoDatabase::$querytime in PdoQuery.php
  Holds the total duration of queries executed so far
Query
  PdoQuery::Query() in PdoQuery.php
  If the sql is supplied then PDO::prepare will be called with that SQL to prepare the query, and if there are positional parameters then they will be replaced into the sql_string (with appropriate escaping) before the call to PDO::prepare. Query preparation time is counted towards total query execution time.
Quote
  PdoDialect::Quote() in PdoQuery.php
  Returns $value escaped in an appropriate way for this database dialect.

r
top

$requestMethod
  CalDAVClient::$requestMethod in caldav-client.php
RRule.php
  RRule.php in RRule.php
Render
  iCalDate::Render() in RRule.php
  Set the day of week used for calculation of week starts
RenderGMT
  iCalDate::RenderGMT() in RRule.php
  Render the date as GMT
RRule
  RRule::RRule() in RRule.php
  The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.
RRule
  RRule in RRule.php
  A Class for handling Events on a calendar which repeat
ReplaceParameters
  PdoDialect::ReplaceParameters() in PdoQuery.php
  Replaces query parameters with appropriately escaped substitutions.
Rollback
  PdoDatabase::Rollback() in PdoQuery.php
  Cancel a transaction in progress.
Rows
  PdoQuery::Rows() in PdoQuery.php
  An accessor for the number of rows affected when the query was executed.

s
top

$server
  CalDAVClient::$server in caldav-client.php
SetContentType
  CalDAVClient::SetContentType() in caldav-client.php
  Add a Content-type: header.
SetDepth
  CalDAVClient::SetDepth() in caldav-client.php
  Add a Depth: header. Valid values are 1 or infinity
SetEpochDate
  iCalDate::SetEpochDate() in RRule.php
  Set the date from an epoch
SetGMTDate
  iCalDate::SetGMTDate() in RRule.php
  Set the date from a text string
SetLocalDate
  iCalDate::SetLocalDate() in RRule.php
  Set the date from a text string
SetMatch
  CalDAVClient::SetMatch() in caldav-client.php
  Adds an If-Match or If-None-Match header
SetMonthDay
  iCalDate::SetMonthDay() in RRule.php
  Set the day in the month to what we have been given
SetUserAgent
  CalDAVClient::SetUserAgent() in caldav-client.php
  Add a Depth: header. Valid values are 1 or infinity
SetWeekStart
  iCalDate::SetWeekStart() in RRule.php
  Set the day of week used for calculation of week starts

t
top

TestByMonth
  iCalDate::TestByMonth() in RRule.php
  Test to see if our _mo matches something in the list of months we have received.
$txnstate
  PdoDatabase::$txnstate in PdoQuery.php
  Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
TotalDuration
  PdoDatabase::TotalDuration() in PdoQuery.php
  Returns the total duration of quries executed so far by this object instance.
TotalQueries
  PdoDatabase::TotalQueries() in PdoQuery.php
  Returns the total number of quries executed by this object instance.
TransactionState
  PdoDatabase::TransactionState() in PdoQuery.php
  Returns the current state of a transaction, indicating if we have begun a transaction, whether the transaction has failed, or if we are not in a transaction.
Translate
  PdoDialect::Translate() in PdoQuery.php
  Translates the given SQL string into a form that will hopefully work for this database dialect. This hook is expected to be used by developers to provide support for differences in database operation by translating the query string in an arbitrary way, such as through a file or database lookup.
TranslateAll
  PdoDatabase::TranslateAll() in PdoQuery.php
  Switches on or off the processing flag controlling whether subsequent calls to PdoDatabase::Prepare are translated as if PrepareTranslated() had been called.

u
top

$user
  CalDAVClient::$user in caldav-client.php
$user_agent
  CalDAVClient::$user_agent in caldav-client.php
  The useragent which is send to the caldav server

w
top

WithinScope
  RRule::WithinScope() in RRule.php
  Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.

x
top

$xmlRequest
  CalDAVClient::$xmlRequest in caldav-client.php
$xmlResponse
  CalDAVClient::$xmlResponse in caldav-client.php