[awl] element index

Package indexes

All elements
a b c d e f g h i k l m n p q r s t u v w x y _
_
top
Method __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.
Function _awl_connect_configured_database
Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays
Method _log_query
AwlQuery::_log_query() in AwlQuery.php
Log query, optionally with file and line location of the caller.
Method __construct
AwlQuery::__construct() in AwlQuery.php
Constructor
Method _EpochFromParts
Given a local text date, convert it to an epoch
Method _GMTEpochFromParts
Given a GMT text date, convert it to an epoch
Method _GMTTextFromEpoch
Given a GMT epoch date, convert it to text
Method _PartsFromText
Given a text date, convert it to parts
Method _TextFromEpoch
Given an epoch date, convert it to text
Method __construct
Method __construct
CalendarInfo::__construct() in caldav-client-v2.php
Method __construct
Method __construct
CalDAVClient::__construct() in caldav-client-v2.php
Constructor, initialises the class
Method __toString
Method __toString
CalendarInfo::__toString() in caldav-client-v2.php
a
top
Class AwlDatabase
AwlDatabase in AwlDatabase.php
Typically there will only be a single instance of the database level class in an application.
Class AwlDBDialect
AwlDBDialect in AwlDBDialect.php
The AwlDBDialect class handles
Page AwlDatabase.php
AwlDatabase.php in AwlDatabase.php
Page AwlDBDialect.php
AwlDBDialect.php in AwlDBDialect.php
Class AwlQuery
AwlQuery in AwlQuery.php
The AwlQuery Class.
Page AwlQuery.php
AwlQuery.php in AwlQuery.php
Method AddDays
iCalDate::AddDays() in RRule.php
Add some integer number of days to a date
Method AddDuration
Add duration
Method AddMonths
Add some number of months to a date
Method ApplyBySetPos
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
Method Begin
AwlDatabase::Begin() in AwlDatabase.php
Begin a transaction.
Variable $bound_parameters
The current array of bound parameters
Method Begin
AwlQuery::Begin() in AwlQuery.php
Wrap the parent DB class Begin() so we can $qry->Begin() sometime before we $qry->Exec()
Method Bind
AwlQuery::Bind() in AwlQuery.php
Bind some parameters
Variable $base_url
CalDAVClient::$base_url in caldav-client-v2.php
Server, username, password, calendar
Variable $body
CalDAVClient::$body in caldav-client-v2.php
c
top
Method Commit
AwlDatabase::Commit() in AwlDatabase.php
Complete a transaction.
Variable $connection
AwlQuery::$connection in AwlQuery.php
Our database connection, normally copied from a global one
Method Commit
AwlQuery::Commit() in AwlQuery.php
Wrap the parent DB class Commit() so we can $qry->Commit() sometime after we $qry->Exec()
Variable $calendar_home_set
CalDAVClient::$calendar_home_set in caldav-client-v2.php
The calendar-home-set we're using
Variable $calendar_url
CalDAVClient::$calendar_url in caldav-client-v2.php
The calendar-URL we're using
Variable $calendar_urls
CalDAVClient::$calendar_urls in caldav-client-v2.php
The calendar_urls we have discovered
Class CalDAVClient
CalDAVClient in caldav-client-v2.php
A class for accessing DAViCal via CalDAV, as a client
Method CalendarHomeSet
CalDAVClient::CalendarHomeSet() in caldav-client-v2.php
Get/Set the calendar-home-set URL
Class CalendarInfo
CalendarInfo in caldav-client-v2.php
A class for holding basic calendar information
Method CalendarUrls
CalDAVClient::CalendarUrls() in caldav-client-v2.php
Get/Set the calendar-home-set URL
Method current
RepeatRule::current() in RRule-v2.php
Page caldav-client-v2.php
caldav-client-v2.php in caldav-client-v2.php
Page caldav-client.php
caldav-client.php in caldav-client.php
d
top
Variable $db
AwlDBDialect::$db in AwlDBDialect.php
Holds the PDO database connection
Variable $dialect
AwlDBDialect::$dialect in AwlDBDialect.php
Holds the name of the database dialect
Function duration
duration() in AwlQuery.php
A duration (in decimal seconds) between two times which are the result of calls to microtime()
Variable $displayname
CalendarInfo::$displayname in caldav-client-v2.php
Method DateDifference
Produce an iCalendar format DURATION for the difference between this an another iCalDate
Method date_mask
RepeatRule::date_mask() in RRule-v2.php
Method day
Method DaysInMonth
No of days in a month 1(Jan) - 12(Dec)
Method 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.
Method DoDELETERequest
CalDAVClient::DoDELETERequest() in caldav-client-v2.php
DELETE a text/icalendar resource
Method DoGETRequest
CalDAVClient::DoGETRequest() in caldav-client-v2.php
Get a single item from the server.
Method DoOptionsRequest
CalDAVClient::DoOptionsRequest() in caldav-client-v2.php
Send an OPTIONS request to the server
Method DoPROPFINDRequest
CalDAVClient::DoPROPFINDRequest() in caldav-client-v2.php
Get a single item from the server.
Method DoPUTRequest
CalDAVClient::DoPUTRequest() in caldav-client-v2.php
PUT a text/icalendar resource, returning the etag
Method DoRequest
CalDAVClient::DoRequest() in caldav-client-v2.php
Send a request to the server
Method DoXMLRequest
CalDAVClient::DoXMLRequest() in caldav-client-v2.php
Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
e
top
Method ErrorInfo
AwlDatabase::ErrorInfo() in AwlDatabase.php
Constant E_USER_ERROR
E_USER_ERROR in AwlDBDialect.php
AwlDatabase - support for different SQL dialects
Variable $error_info
AwlQuery::$error_info in AwlQuery.php
The Database error information, if the query fails.
Variable $execution_time
Stores the query execution time - used to deal with long queries.
Method Exec
AwlQuery::Exec() in AwlQuery.php
Execute the query, logging any debugging.
Variable $entry
CalDAVClient::$entry in caldav-client-v2.php
f
top
Method Fetch
AwlQuery::Fetch() in AwlQuery.php
Fetch the next row from the query results
Variable $Format
Method FindCalendarHome
CalDAVClient::FindCalendarHome() in caldav-client-v2.php
Attack the given URL in an attempt to find a principal URL
Method FindCalendars
CalDAVClient::FindCalendars() in caldav-client-v2.php
Find the calendars, from the calendar_home_set
Method FindPrincipal
CalDAVClient::FindPrincipal() in caldav-client-v2.php
Attack the given URL in an attempt to find a principal URL
g
top
Method 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.
Method GetVersion
AwlDBDialect::GetVersion() in AwlDBDialect.php
Sets the current search path for the database.
Variable $getctag
CalendarInfo::$getctag in caldav-client-v2.php
Method GetEntryByHref
CalDAVClient::GetEntryByHref() in caldav-client-v2.php
Get the calendar entry by HREF
Method GetEntryByUid
CalDAVClient::GetEntryByUid() in caldav-client-v2.php
Get the calendar entry by UID
Method GetEvents
CalDAVClient::GetEvents() in caldav-client-v2.php
Get the events in a range from $start to $finish. The dates should be in the
Method GetHttpRequest
CalDAVClient::GetHttpRequest() in caldav-client-v2.php
Output http request headers
Method GetHttpResponse
CalDAVClient::GetHttpResponse() in caldav-client-v2.php
Output http response headers
Method GetMonthByDay
Applies any BYDAY to the month to return a set of days
Method GetMonthByMonthDay
Applies any BYMONTHDAY to the month to return a set of days
Method GetNext
RRule::GetNext() in RRule.php
This is most of the meat of the RRULE processing, where we find the next date.
Method GetOKProps
CalDAVClient::GetOKProps() in caldav-client-v2.php
Return the <prop> ... </prop> of a propstat where the status is OK
Method 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
Method GetWeekByDay
Applies any BYDAY to the week to return a set of days
Method GetXmlRequest
CalDAVClient::GetXmlRequest() in caldav-client-v2.php
Output xml request
Method GetXmlResponse
CalDAVClient::GetXmlResponse() in caldav-client-v2.php
Output xml response
Method GreaterThan
Test if $this is greater than the date parameter
h
top
Variable $headers
CalDAVClient::$headers in caldav-client-v2.php
Variable $httpRequest
CalDAVClient::$httpRequest in caldav-client-v2.php
Variable $httpResponse
CalDAVClient::$httpResponse in caldav-client-v2.php
Method hour
Method HrefForResourcetype
CalDAVClient::HrefForResourcetype() in caldav-client-v2.php
Return the href which has a resourcetype of the specified type
Method HrefValueInside
CalDAVClient::HrefValueInside() in caldav-client-v2.php
Return the first occurrence of an href inside the named tag.
i
top
Method iCalDate
The constructor takes either an iCalendar date, a text string formatted as an iCalendar date, or epoch seconds.
Class 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
Method key
RepeatRule::key() in RRule-v2.php
l
top
Variable $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.
Method LessThan
Test if $this is less than the date parameter
m
top
Method minute
Method month
Method MonthDays
Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.
n
top
Method next
RepeatRule::next() in RRule-v2.php
p
top
Method prepare
AwlDatabase::prepare() in AwlDatabase.php
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
Method PrepareTranslated
Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.
Method Parameters
AwlQuery::Parameters() in AwlQuery.php
Return the parameters we are planning to substitute into the query string
Method Prepare
AwlQuery::Prepare() in AwlQuery.php
Tell the database to prepare the query that we will execute
Variable $parser
CalDAVClient::$parser in caldav-client-v2.php
Variable $pass
CalDAVClient::$pass in caldav-client-v2.php
Variable $port
CalDAVClient::$port in caldav-client-v2.php
Variable $principal_url
CalDAVClient::$principal_url in caldav-client-v2.php
The principal-URL we're using
Variable $protocol
CalDAVClient::$protocol in caldav-client-v2.php
Method ParseResponse
CalDAVClient::ParseResponse() in caldav-client-v2.php
Split response into httpResponse and xmlResponse
Method PrincipalURL
CalDAVClient::PrincipalURL() in caldav-client-v2.php
Get/Set the Principal URL
q
top
Method query
AwlDatabase::query() in AwlDatabase.php
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.
Method Quote
AwlDBDialect::Quote() in AwlDBDialect.php
Returns $value escaped in an appropriate way for this database dialect.
Variable $querystring
AwlQuery::$querystring in AwlQuery.php
The original query string
Variable $query_time_warning
How long the query should take before a warning is issued.
Method 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...
Method QueryString
AwlQuery::QueryString() in AwlQuery.php
Return the query string we are planning to execute
Method 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.
r
top
Method ReplaceParameters
Replaces query parameters with appropriately escaped substitutions.
Method Rollback
AwlDatabase::Rollback() in AwlDatabase.php
Cancel a transaction in progress.
Variable $result
AwlQuery::$result in AwlQuery.php
Result of the last execution
Variable $rownum
AwlQuery::$rownum in AwlQuery.php
number of current row - use accessor to get/set
Variable $rows
AwlQuery::$rows in AwlQuery.php
number of rows from pg_numrows - use accessor to get value
Method Rollback
AwlQuery::Rollback() in AwlQuery.php
Wrap the parent DB class Rollback() so we can $qry->Rollback() sometime after we $qry->Exec()
Method rows
AwlQuery::rows() in AwlQuery.php
Return the count of rows retrieved/affected
Variable $requestMethod
CalDAVClient::$requestMethod in caldav-client-v2.php
Page RRule-v2.php
RRule-v2.php in RRule-v2.php
Page RRule.php
RRule.php in RRule.php
Method Render
iCalDate::Render() in RRule.php
Set the day of week used for calculation of week starts
Method RenderGMT
Render the date as GMT
Class RepeatRule
RepeatRule in RRule-v2.php
Class RepeatRuleDateTime
RepeatRuleDateTime in RRule-v2.php
Class for parsing RRule and getting us the dates
Method rewind
RepeatRule::rewind() in RRule-v2.php
Method RFC5545
Method RRule
RRule::RRule() in RRule.php
The constructor takes a start date and an RRULE definition. Both of these follow the iCalendar standard.
Class RRule
RRule in RRule.php
A Class for handling Events on a calendar which repeat
s
top
Method SetSearchPath
AwlDBDialect::SetSearchPath() in AwlDBDialect.php
Sets the current search path for the database.
Variable $sth
AwlQuery::$sth in AwlQuery.php
The PDO statement handle, or null if we don't have one yet.
Method SetConnection
Use a different database connection for this query
Variable $server
CalDAVClient::$server in caldav-client-v2.php
Method second
Method SetContentType
CalDAVClient::SetContentType() in caldav-client-v2.php
Add a Content-type: header.
Method setDate
Method SetDepth
CalDAVClient::SetDepth() in caldav-client-v2.php
Add a Depth: header. Valid values are 0, 1 or infinity
Method SetEpochDate
Set the date from an epoch
Method SetGMTDate
Set the date from a text string
Method SetLocalDate
Set the date from a text string
Method SetMatch
CalDAVClient::SetMatch() in caldav-client-v2.php
Adds an If-Match or If-None-Match header
Method SetMonthDay
Set the day in the month to what we have been given
Method setTimeZone
Method SetUserAgent
CalDAVClient::SetUserAgent() in caldav-client-v2.php
Add a Depth: header. Valid values are 1 or infinity
Method SetWeekStart
Set the day of week used for calculation of week starts
Method set_timezone
Method Start
RepeatRule::Start() in RRule-v2.php
t
top
Variable $txnstate
AwlDatabase::$txnstate in AwlDatabase.php
Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
Method TransactionState
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.
Method 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.
Method 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.
Method TestByMonth
Test to see if our _mo matches something in the list of months we have received.
u
top
Variable $url
CalendarInfo::$url in caldav-client-v2.php
Variable $user
CalDAVClient::$user in caldav-client-v2.php
Variable $user_agent
CalDAVClient::$user_agent in caldav-client-v2.php
The useragent which is send to the caldav server
Method UTC
v
top
Method valid
RepeatRule::valid() in RRule-v2.php
w
top
Method WithinScope
Processes the array of $relative_days to $base and removes any which are not within the scope of our rule.
x
top
Variable $xmlRequest
CalDAVClient::$xmlRequest in caldav-client-v2.php
Variable $xmlResponse
CalDAVClient::$xmlResponse in caldav-client-v2.php
y
top
Method year
a b c d e f g h i k l m n p q r s t u v w x y _