[awl] element index

Package indexes

All elements
a b c d e f g h i l m p q r s t u w x _
_
top
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
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.
Method __construct
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.
Method __construct
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
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
Variable $base_url
CalDAVClient::$base_url in caldav-client.php
Server, username, password, calendar
Variable $body
CalDAVClient::$body in caldav-client.php
Method Begin
PdoDatabase::Begin() in PdoQuery.php
Begin a transaction.
c
top
Variable $calendar
CalDAVClient::$calendar in caldav-client.php
Method CalDAVClient
CalDAVClient::CalDAVClient() in caldav-client.php
Constructor, initialises the class
Class CalDAVClient
CalDAVClient in caldav-client.php
A class for accessing DAViCal via CalDAV, as a client
Page caldav-client.php
caldav-client.php in caldav-client.php
Method Commit
PdoDatabase::Commit() in PdoQuery.php
Complete a transaction.
d
top
Method DateDifference
Produce an iCalendar format DURATION for the difference between this an another iCalDate
Method DaysInMonth
No of days in a month 1(Jan) - 12(Dec)
Method 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.
Method DoDELETERequest
CalDAVClient::DoDELETERequest() in caldav-client.php
DELETE a text/icalendar resource
Method DoGETRequest
CalDAVClient::DoGETRequest() in caldav-client.php
Get a single item from the server.
Method DoOptionsRequest
Send an OPTIONS request to the server
Method DoPUTRequest
CalDAVClient::DoPUTRequest() in caldav-client.php
PUT a text/icalendar resource, returning the etag
Method DoRequest
CalDAVClient::DoRequest() in caldav-client.php
Send a request to the server
Method DoXMLRequest
CalDAVClient::DoXMLRequest() in caldav-client.php
Send an XML request to the server (e.g. PROPFIND, REPORT, MKCALENDAR)
Variable $dialect
PdoDialect::$dialect in PdoQuery.php
Holds the name of the database dialect
e
top
Variable $entry
CalDAVClient::$entry in caldav-client.php
Method Exec
PdoQuery::Exec() in PdoQuery.php
If there are (some) positional parameters in the prepared query, now is the last chance to supply them...
Method Exec
PdoDatabase::Exec() in PdoQuery.php
Construct and execute an SQL statement from the sql_string, replacing the parameters into it.
f
top
Method 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.
Method 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.
Method 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
Method GetEntryByHref
CalDAVClient::GetEntryByHref() in caldav-client.php
Get the calendar entry by HREF
Method GetEntryByUid
CalDAVClient::GetEntryByUid() in caldav-client.php
Get the calendar entry by UID
Method GetEvents
CalDAVClient::GetEvents() in caldav-client.php
Get the events in a range from $start to $finish. The dates should be in the
Method GetHttpRequest
CalDAVClient::GetHttpRequest() in caldav-client.php
Output http request headers
Method GetHttpResponse
CalDAVClient::GetHttpResponse() in caldav-client.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 GetTodos
CalDAVClient::GetTodos() in caldav-client.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.php
Output xml request
Method GetXmlResponse
CalDAVClient::GetXmlResponse() in caldav-client.php
Output xml response
Method GreaterThan
Test if $this is greater than the date parameter
Method 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.
Method 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
Variable $headers
CalDAVClient::$headers in caldav-client.php
Variable $httpRequest
CalDAVClient::$httpRequest in caldav-client.php
Variable $httpResponse
CalDAVClient::$httpResponse in caldav-client.php
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.
l
top
Method LessThan
Test if $this is less than the date parameter
m
top
Method MonthDays
Given a MonthDays string like "1MO", "-2WE" return an integer day of the month.
Method 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
Variable $pass
CalDAVClient::$pass in caldav-client.php
Variable $port
CalDAVClient::$port in caldav-client.php
Variable $protocol
CalDAVClient::$protocol in caldav-client.php
Method ParseResponse
CalDAVClient::ParseResponse() in caldav-client.php
Split response into httpResponse and xmlResponse
Page PdoQuery.php
PdoQuery.php in PdoQuery.php
Class PdoDatabase
PdoDatabase in PdoQuery.php
Typically there will only be a single instance of the database level class in an application.
Class PdoDialect
PdoDialect in PdoQuery.php
The PdoDialect class handles
Class 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.
Method Prepare
PdoDatabase::Prepare() in PdoQuery.php
Returns a PdoQuery object created using this database, the supplied SQL string, and any parameters given.
Method PrepareTranslated
Operates identically to PdoDatabase::Prepare, except that PdoDialect::Translate() will be called on the query before any processing.
q
top
Variable $querycount
PdoDatabase::$querycount in PdoQuery.php
Holds the count of queries executed so far
Variable $querytime
PdoDatabase::$querytime in PdoQuery.php
Holds the total duration of queries executed so far
Method 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.
Method Quote
PdoDialect::Quote() in PdoQuery.php
Returns $value escaped in an appropriate way for this database dialect.
r
top
Variable $requestMethod
CalDAVClient::$requestMethod in caldav-client.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
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
Method ReplaceParameters
Replaces query parameters with appropriately escaped substitutions.
Method Rollback
PdoDatabase::Rollback() in PdoQuery.php
Cancel a transaction in progress.
Method Rows
PdoQuery::Rows() in PdoQuery.php
An accessor for the number of rows affected when the query was executed.
s
top
Variable $server
CalDAVClient::$server in caldav-client.php
Method SetContentType
CalDAVClient::SetContentType() in caldav-client.php
Add a Content-type: header.
Method SetDepth
CalDAVClient::SetDepth() in caldav-client.php
Add a Depth: header. Valid values are 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.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 SetUserAgent
CalDAVClient::SetUserAgent() in caldav-client.php
Add a Depth: header. Valid values are 1 or infinity
Method SetWeekStart
Set the day of week used for calculation of week starts
t
top
Method TestByMonth
Test to see if our _mo matches something in the list of months we have received.
Variable $txnstate
PdoDatabase::$txnstate in PdoQuery.php
Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
Method TotalDuration
Returns the total duration of quries executed so far by this object instance.
Method TotalQueries
Returns the total number of quries executed by this object instance.
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 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.
Method TranslateAll
Switches on or off the processing flag controlling whether subsequent calls to PdoDatabase::Prepare are translated as if PrepareTranslated() had been called.
u
top
Variable $user
CalDAVClient::$user in caldav-client.php
Variable $user_agent
CalDAVClient::$user_agent in caldav-client.php
The useragent which is send to the caldav server
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.php
Variable $xmlResponse
CalDAVClient::$xmlResponse in caldav-client.php
a b c d e f g h i l m p q r s t u w x _