## [awl] element index

### Package indexes

- davical

All elements
_
top

_awl_connect_configured_database
  _awl_connect_configured_database() in AwlQuery.php
  Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays
_log_query
  AwlQuery::_log_query() in AwlQuery.php
  Log query, optionally with file and line location of the caller.
__construct
  AwlUpgrader::__construct() in AwlUpgrader.php
  Constructor
__construct
  AwlQuery::__construct() in AwlQuery.php
  Constructor
__construct
  AwlDBDialect::__construct() in AwlDBDialect.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.
_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
  RepeatRuleTimeZone::__construct() in RRule-v2.php
__construct
  RepeatRuleDateTime::__construct() in RRule-v2.php
__construct
  CalendarInfo::__construct() in caldav-client-v2.php
__construct
  RepeatRule::__construct() in RRule-v2.php
__construct
  CalDAVClient::__construct() in caldav-client-v2.php
  Constructor, initialises the class
__toString
  RepeatRuleDateTime::__toString() in RRule-v2.php
__toString
  CalendarInfo::__toString() in caldav-client-v2.php

a
top

AwlDatabase
  AwlDatabase in AwlDatabase.php
  Typically there will only be a single instance of the database level class in an application.
AwlDBDialect
  AwlDBDialect in AwlDBDialect.php
  The AwlDBDialect class handles support for different SQL dialects
AwlQuery
  AwlQuery in AwlQuery.php
  The AwlQuery Class.
AwlUpgrader
  AwlUpgrader in AwlUpgrader.php
  The AwlUpgrader Class.
AwlDatabase.php
  AwlDatabase.php in AwlDatabase.php
AwlDBDialect.php
  AwlDBDialect.php in AwlDBDialect.php
AwlQuery.php
  AwlQuery.php in AwlQuery.php
AwlUpgrader.php
  AwlUpgrader.php in AwlUpgrader.php
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.
AsDate
  RepeatRuleDateTime::AsDate() in RRule-v2.php

b
top

$bound_parameters
  AwlQuery::$bound_parameters in AwlQuery.php
  The current array of bound parameters
$bound_querystring
  AwlQuery::$bound_querystring in AwlQuery.php
  The actual query string, after we've replaced parameters in it
Begin
  AwlDatabase::Begin() in AwlDatabase.php
  Begin a transaction.
Begin
  AwlQuery::Begin() in AwlQuery.php
  Wrap the parent DB class Begin() so we can $qry->Begin() sometime before we $qry->Exec()
Bind
  AwlQuery::Bind() in AwlQuery.php
  Bind some parameters. This can be called in three ways:
$base_url
  CalDAVClient::$base_url in caldav-client-v2.php
  Server, username, password, calendar
$body
  CalDAVClient::$body in caldav-client-v2.php

c
top

$connection
  AwlQuery::$connection in AwlQuery.php
  Our database connection, normally copied from a global one
Commit
  AwlQuery::Commit() in AwlQuery.php
  Wrap the parent DB class Commit() so we can $qry->Commit() sometime after we $qry->Exec()
Commit
  AwlDatabase::Commit() in AwlDatabase.php
  Complete a transaction.
$calendar_home_set
  CalDAVClient::$calendar_home_set in caldav-client-v2.php
  The calendar-home-set we're using
$calendar_url
  CalDAVClient::$calendar_url in caldav-client-v2.php
  The calendar-URL we're using
$calendar_urls
  CalDAVClient::$calendar_urls in caldav-client-v2.php
  The calendar_urls we have discovered
CalDAVClient
  CalDAVClient in caldav-client-v2.php
  A class for accessing DAViCal via CalDAV, as a client
CalendarHomeSet
  CalDAVClient::CalendarHomeSet() in caldav-client-v2.php
  Get/Set the calendar-home-set URL
CalendarInfo
  CalendarInfo in caldav-client-v2.php
  A class for holding basic calendar information
CalendarMultiget
  CalDAVClient::CalendarMultiget() in caldav-client-v2.php
  Get a bunch of events for a calendar with a calendar-multiget report
CalendarUrls
  CalDAVClient::CalendarUrls() in caldav-client-v2.php
  Get/Set the calendar-home-set URL
current
  RepeatRule::current() in RRule-v2.php
caldav-client-v2.php
  caldav-client-v2.php in caldav-client-v2.php
caldav-client.php
  caldav-client.php in caldav-client.php

d
top

$db
  AwlDBDialect::$db in AwlDBDialect.php
  Holds the PDO database connection
$dialect
  AwlDBDialect::$dialect in AwlDBDialect.php
  Holds the name of the database dialect
$displayname
  CalendarInfo::$displayname in caldav-client-v2.php
DateDifference
  iCalDate::DateDifference() in RRule.php
  Produce an iCalendar format DURATION for the difference between this an another iCalDate
date_mask
  RepeatRule::date_mask() in RRule-v2.php
day
  RepeatRuleDateTime::day() in RRule-v2.php
DaysInMonth
  iCalDate::DaysInMonth() in RRule.php
  No of days in a month 1(Jan) - 12(Dec)
DoCalendarQuery
  CalDAVClient::DoCalendarQuery() in caldav-client-v2.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-v2.php
  DELETE a text/icalendar resource
DoGETRequest
  CalDAVClient::DoGETRequest() in caldav-client-v2.php
  Get a single item from the server.
DoHEADRequest
  CalDAVClient::DoHEADRequest() in caldav-client-v2.php
  Get the HEAD of a single item from the server.
DoOptionsRequest
  CalDAVClient::DoOptionsRequest() in caldav-client-v2.php
  Send an OPTIONS request to the server
DoPROPFINDRequest
  CalDAVClient::DoPROPFINDRequest() in caldav-client-v2.php
  Get a single item from the server.
DoPUTRequest
  CalDAVClient::DoPUTRequest() in caldav-client-v2.php
  PUT a text/icalendar resource, returning the etag
DoRequest
  CalDAVClient::DoRequest() in caldav-client-v2.php
  Send a request to the server
DoXMLRequest
  CalDAVClient::DoXMLRequest() in caldav-client-v2.php
  Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)

e
top

$error_info
  AwlQuery::$error_info in AwlQuery.php
  The Database error information, if the query fails.
$execution_time
  AwlQuery::$execution_time in AwlQuery.php
  Stores the query execution time - used to deal with long queries.
ErrorInfo
  AwlDatabase::ErrorInfo() in AwlDatabase.php
Exec
  AwlQuery::Exec() in AwlQuery.php
  Execute the query, logging any debugging.
Execute
  AwlQuery::Execute() in AwlQuery.php
  Tell the database to execute the query
E_USER_ERROR
  E_USER_ERROR in AwlDBDialect.php
$entry
  CalDAVClient::$entry in caldav-client-v2.php
epoch
  RepeatRuleDateTime::epoch() in RRule-v2.php

f
top

Fetch
  AwlQuery::Fetch() in AwlQuery.php
  Fetch the next row from the query results
$Format
  RepeatRuleDateTime::$Format in RRule-v2.php
FindCalendarHome
  CalDAVClient::FindCalendarHome() in caldav-client-v2.php
  Attack the given URL in an attempt to find a principal URL
FindCalendars
  CalDAVClient::FindCalendars() in caldav-client-v2.php
  Find the calendars, from the calendar_home_set
FindPrincipal
  CalDAVClient::FindPrincipal() in caldav-client-v2.php
  Attack the given URL in an attempt to find a principal URL

g
top

GetFields
  AwlDBDialect::GetFields() in AwlDBDialect.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.
GetVersion
  AwlDBDialect::GetVersion() in AwlDBDialect.php
  Sets the current search path for the database.
$getctag
  CalendarInfo::$getctag in caldav-client-v2.php
GetCalendarDetails
  CalDAVClient::GetCalendarDetails() in caldav-client-v2.php
  Find the calendars, from the calendar_home_set
GetCollectionETags
  CalDAVClient::GetCollectionETags() in caldav-client-v2.php
  Get all etags for a calendar
GetEntryByHref
  CalDAVClient::GetEntryByHref() in caldav-client-v2.php
  Get the calendar entry by HREF
GetEntryByUid
  CalDAVClient::GetEntryByUid() in caldav-client-v2.php
  Get the calendar entry by UID
GetEvents
  CalDAVClient::GetEvents() in caldav-client-v2.php
  Get the events in a range from $start to $finish. The dates should be in the
GetHttpRequest
  CalDAVClient::GetHttpRequest() in caldav-client-v2.php
  Output http request 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.
GetOKProps
  CalDAVClient::GetOKProps() in caldav-client-v2.php
  Return the <prop> ... </prop> of a propstat where the status is OK
GetResponseBody
  CalDAVClient::GetResponseBody() in caldav-client-v2.php
  Output http response body
GetResponseHeaders
  CalDAVClient::GetResponseHeaders() in caldav-client-v2.php
  Output http response headers
GetTodos
  CalDAVClient::GetTodos() in caldav-client-v2.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-v2.php
  Output xml request
GetXmlResponse
  CalDAVClient::GetXmlResponse() in caldav-client-v2.php
  Output xml response
GreaterThan
  iCalDate::GreaterThan() in RRule.php
  Test if $this is greater than the date parameter

h
top

$headers
  CalDAVClient::$headers in caldav-client-v2.php
$httpRequest
  CalDAVClient::$httpRequest in caldav-client-v2.php
$httpResponse
  CalDAVClient::$httpResponse in caldav-client-v2.php
hour
  RepeatRuleDateTime::hour() in RRule-v2.php
HrefForProp
  CalDAVClient::HrefForProp() in caldav-client-v2.php
  Return the href containing this property. Except only if it's inside a status != 200
HrefForResourcetype
  CalDAVClient::HrefForResourcetype() in caldav-client-v2.php
  Return the href which has a resourcetype of the specified type
HrefValueInside
  CalDAVClient::HrefValueInside() in caldav-client-v2.php
  Return the first occurrence of an href inside the named tag.

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.

k
top

key
  RepeatRule::key() in RRule-v2.php

l
top

$location
  AwlQuery::$location in AwlQuery.php
  Where we called this query from so we can find it in our code! Debugging may also be selectively enabled for a $location.
LessThan
  iCalDate::LessThan() in RRule.php
  Test if $this is less than the date parameter

m
top

minute
  RepeatRuleDateTime::minute() in RRule-v2.php
month
  RepeatRuleDateTime::month() in RRule-v2.php
MonthDays
  iCalDate::MonthDays() in RRule.php
  Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.

n
top

next
  RepeatRule::next() in RRule-v2.php

p
top

Parameters
  AwlQuery::Parameters() in AwlQuery.php
  Return the parameters we are planning to substitute into the query string
prepare
  AwlDatabase::prepare() in AwlDatabase.php
  Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
Prepare
  AwlQuery::Prepare() in AwlQuery.php
  Tell the database to prepare the query that we will execute
PrepareTranslated
  AwlDatabase::PrepareTranslated() in AwlDatabase.php
  Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.
$parser
  CalDAVClient::$parser in caldav-client-v2.php
$pass
  CalDAVClient::$pass in caldav-client-v2.php
$port
  CalDAVClient::$port in caldav-client-v2.php
$principal_url
  CalDAVClient::$principal_url in caldav-client-v2.php
  The principal-URL we're using
$protocol
  CalDAVClient::$protocol in caldav-client-v2.php
ParseResponse
  CalDAVClient::ParseResponse() in caldav-client-v2.php
  Split response into httpResponse and xmlResponse
PrincipalURL
  CalDAVClient::PrincipalURL() in caldav-client-v2.php
  Get/Set the Principal URL

q
top

$querystring
  AwlQuery::$querystring in AwlQuery.php
  The original query string
$query_time_warning
  AwlQuery::$query_time_warning in AwlQuery.php
  How long the query should take before a warning is issued.
QDo
  AwlQuery::QDo() in AwlQuery.php
  Simple QDo() class which will re-use this query for whatever was passed in, and execute it returning the result of the Exec() call. We can't call it Do() since that's a reserved word...
query
  AwlDatabase::query() in AwlDatabase.php
  Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
QueryString
  AwlQuery::QueryString() in AwlQuery.php
  Return the query string we are planning to execute
quote
  AwlQuery::quote() in AwlQuery.php
  Quote the given string so it can be safely used within string delimiters in a query. To be avoided, in general.
Quote
  AwlDBDialect::Quote() in AwlDBDialect.php
  Returns $value escaped in an appropriate way for this database dialect.

r
top

$result
  AwlQuery::$result in AwlQuery.php
  Result of the last execution
$rownum
  AwlQuery::$rownum in AwlQuery.php
  number of current row - use accessor to get/set
$rows
  AwlQuery::$rows in AwlQuery.php
  number of rows from pg_numrows - use accessor to get value
ReplaceNamedParameters
  AwlDBDialect::ReplaceNamedParameters() in AwlDBDialect.php
  Replaces named query parameters of the form :name with appropriately escaped substitutions.
ReplaceParameters
  AwlDBDialect::ReplaceParameters() in AwlDBDialect.php
  Replaces query parameters with appropriately escaped substitutions.
Rollback
  AwlQuery::Rollback() in AwlQuery.php
  Wrap the parent DB class Rollback() so we can $qry->Rollback() sometime after we $qry->Exec()
Rollback
  AwlDatabase::Rollback() in AwlDatabase.php
  Cancel a transaction in progress.
rows
  AwlQuery::rows() in AwlQuery.php
  Return the count of rows retrieved/affected
$requestMethod
  CalDAVClient::$requestMethod in caldav-client-v2.php
RRule-v2.php
  RRule-v2.php in RRule-v2.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
RepeatRule
  RepeatRule in RRule-v2.php
RepeatRuleDateTime
  RepeatRuleDateTime in RRule-v2.php
  Wrap the DateTime class to make it friendlier to passing in random strings from iCalendar objects, and especially the random stuff used to identify timezones. We also add some utility methods and stuff too, in order to simplify some of the operations we need to do with dates.
RepeatRuleTimeZone
  RepeatRuleTimeZone in RRule-v2.php
  Wrap the DateTimeZone class to allow parsing some iCalendar TZID strangenesses
rewind
  RepeatRule::rewind() in RRule-v2.php
RFC5545
  RepeatRuleDateTime::RFC5545() in RRule-v2.php
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

s
top

$sth
  AwlQuery::$sth in AwlQuery.php
  The PDO statement handle, or null if we don't have one yet.
SetConnection
  AwlQuery::SetConnection() in AwlQuery.php
  Use a different database connection for this query
SetSearchPath
  AwlDBDialect::SetSearchPath() in AwlDBDialect.php
  Sets the current search path for the database.
SetSql
  AwlQuery::SetSql() in AwlQuery.php
  Simple SetSql() class which will reset the object with the querystring from the first argument.
$server
  CalDAVClient::$server in caldav-client-v2.php
second
  RepeatRuleDateTime::second() in RRule-v2.php
SetCalendar
  CalDAVClient::SetCalendar() in caldav-client-v2.php
  Set the calendar_url we will be using for a while.
SetContentType
  CalDAVClient::SetContentType() in caldav-client-v2.php
  Add a Content-type: header.
setDate
  RepeatRuleDateTime::setDate() in RRule-v2.php
SetDepth
  CalDAVClient::SetDepth() in caldav-client-v2.php
  Add a Depth: header. Valid values are 0, 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-v2.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
setTimeZone
  RepeatRuleDateTime::setTimeZone() in RRule-v2.php
SetUserAgent
  CalDAVClient::SetUserAgent() in caldav-client-v2.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
set_timezone
  RepeatRule::set_timezone() in RRule-v2.php
Start
  RepeatRule::Start() in RRule-v2.php

t
top

$translate_all
  AwlDatabase::$translate_all in AwlDatabase.php
  Holds whether we are translating all statements.
$txnstate
  AwlDatabase::$txnstate in AwlDatabase.php
  Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
TransactionState
  AwlDatabase::TransactionState() in AwlDatabase.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.
TranslateAll
  AwlDatabase::TranslateAll() in AwlDatabase.php
  Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.
TranslateSQL
  AwlDBDialect::TranslateSQL() in AwlDBDialect.php
  Translates the given SQL string into a form that will hopefully work for this database dialect. This hook is intended 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.
TestByMonth
  iCalDate::TestByMonth() in RRule.php
  Test to see if our _mo matches something in the list of months we have received.
tzid
  RepeatRuleTimeZone::tzid() in RRule-v2.php

u
top

$url
  CalendarInfo::$url in caldav-client-v2.php
$user
  CalDAVClient::$user in caldav-client-v2.php
$user_agent
  CalDAVClient::$user_agent in caldav-client-v2.php
  The useragent which is send to the caldav server
UTC
  RepeatRuleDateTime::UTC() in RRule-v2.php

v
top

valid
  RepeatRule::valid() in RRule-v2.php

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-v2.php
$xmlResponse
  CalDAVClient::$xmlResponse in caldav-client-v2.php

y
top

year
  RepeatRuleDateTime::year() in RRule-v2.php