diff --git a/VERSION b/VERSION index 1cfa3d76..72a56680 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.9.6.2 +0.9.6.3 diff --git a/docs/api/awl/PdoQuery/PdoDatabase.html b/docs/api/awl/PdoQuery/PdoDatabase.html new file mode 100644 index 00000000..dedf29a1 --- /dev/null +++ b/docs/api/awl/PdoQuery/PdoDatabase.html @@ -0,0 +1,575 @@ + + + +
+ +
PdoDatabaseTypically there will only be a single instance of the database level class in an application.
++ Located in /inc/PdoQuery.php (line 218) +
+ + + + +
+ PdoDatabase
+ __construct
+ (string $connection_string, [string $dbuser = null], [string $dbpass = null], [array $options = null])
+
+
+ mixed
+ $querycount
+ = 0 (line 241)
+
+ Holds the count of queries executed so far
+ + + + + + +
+
+ mixed
+ $querytime
+ = 0 (line 246)
+
+ Holds the total duration of queries executed so far
+ + + + + + +
+
+ mixed
+ $txnstate
+ = 0 (line 236)
+
+ Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit
+ + + + + + +
+ Constructor __construct (line 262)
+ 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.
+The database object will also initialise and hold an PdoDialect object which will be used to provide database specific SQL for some queries, as well as translation hooks for instances where it is necessary to modify the SQL in transit to support additional databases.
+ +
+ Begin (line 303)
+ Begin a transaction.
+ +
+ Commit (line 317)
+ Complete a transaction.
+ +
+ Exec (line 287)
+ Construct and execute an SQL statement from the sql_string, replacing the parameters into it.
+ + +
+ GetFields (line 368)
+ 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.
+ +
+ Prepare (line 273)
+ Returns a PdoQuery object created using this database, the supplied SQL string, and any parameters given.
+ +
+ PrepareTranslated (line 376)
+ Operates identically to PdoDatabase::Prepare, except that PdoDialect::Translate() will be called on the query before any processing.
+ +
+ Rollback (line 328)
+ Cancel a transaction in progress.
+ +
+ TotalDuration (line 351)
+ Returns the total duration of quries executed so far by this object instance.
+ +
+ TotalQueries (line 359)
+ Returns the total number of quries executed by this object instance.
+ +
+ TransactionState (line 343)
+ 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 (line 384)
+ Switches on or off the processing flag controlling whether subsequent calls to PdoDatabase::Prepare are translated as if PrepareTranslated() had been called.
+ ++ Documentation generated on Fri, 10 Apr 2009 23:45:53 +1200 by phpDocumentor 1.3.2 +
+
PdoDialectThe PdoDialect class handles
++ Located in /inc/PdoQuery.php (line 41) +
+ + + + +
+ Constructor __construct (line 60)
+ 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.
+ +
+ GetFields (line 76)
+ 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.
+ +
+ Quote (line 114)
+ Returns $value escaped in an appropriate way for this database dialect.
+ +
+ ReplaceParameters (line 167)
+ Replaces query parameters with appropriately escaped substitutions.
+The function takes a variable number of arguments, the first is the SQL string, with replaceable '?' characters (a la DBI). The subsequent parameters being the values to replace into the SQL string.
The values passed to the routine are analyzed for type, and quoted if they appear to need quoting. This can go wrong for (e.g.) NULL or other special SQL values which are not straightforwardly identifiable as needing quoting (or not). In such cases the parameter can be forced to be inserted unquoted by passing it as "array( 'plain' => $param )".
+ + +
+ Translate (line 101)
+ 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.
+The actual translation to other SQL dialects will usually be application-specific, so that any routines called by this will usually be external to this library, or will use resources external to this library.
+ ++ Documentation generated on Fri, 10 Apr 2009 23:45:53 +1200 by phpDocumentor 1.3.2 +
+
PdoQueryA 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.
++ Located in /inc/PdoQuery.php (line 395) +
+ + + + +
+ Constructor __construct (line 406)
+ 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.
+ +
+ Exec (line 433)
+ If there are (some) positional parameters in the prepared query, now is the last chance to supply them...
+before the query is executed. Returns true on success and false on error.
+ +
+ Fetch (line 447)
+ Will fetch the next row from the query into an object with elements named for the fields in the result.
+ +
+ FetchAll (line 464)
+ Will fetch all result rows from the query into an array of objects with elements named for the fields in the result.
+ +
+ FetchArray (line 456)
+ Will fetch the next row from the query into an array with numbered elements and with elements named for the fields in the result.
+ +
+ MaxDuration (line 481)
+ Used to set the maximum duration for this query before it will be logged as a slow query.
+ +
+ Query (line 419)
+ 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.
+ +
+ Rows (line 472)
+ An accessor for the number of rows affected when the query was executed.
+ ++ Documentation generated on Fri, 10 Apr 2009 23:45:54 +1200 by phpDocumentor 1.3.2 +
+
/inc/PdoQuery.phpPDO query class and associated functions
+This subpackage provides some functions that are useful around database activity and a PdoDialect, PdoDatabase and PdoQuery classes to simplify handling of database queries and provide some access for a limited ability to handle varying database dialects.
The class is intended to be a very lightweight wrapper with some features that have proved useful in developing and debugging web-based applications:
If not already connected, PdoQuery will attempt to connect to the database, successively applying connection parameters from the array in $c->pdo_connect.
We will die if the database is not currently connected and we fail to find a working connection.
+ + +| Class | +Description | +
|---|---|
+
+ PdoDialect
+ |
+ + The PdoDialect class handles + | +
+
+ PdoDatabase
+ |
+ + Typically there will only be a single instance of the database level class in an application. + | +
+
+ PdoQuery
+ |
+ + 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. + | +
+ Documentation generated on Fri, 10 Apr 2009 23:45:53 +1200 by phpDocumentor 1.3.2 +
+A class for accessing DAViCal via CalDAV, as a client
- Located in /inc/caldav-client.php (line 55) + Located in /inc/caldav-client.php (line 21)
@@ -50,7 +50,7 @@
CalDAVClient
CalDAVClient
@@ -121,7 +156,7 @@
array
DoCalendarQuery
- (string $filter, [string $relative_url = ''], [ $reponse_type = 'data'], string $report_type)
+ (string $filter, [string $relative_url = ''], string $report_type)
@@ -175,7 +210,19 @@
array
GetEvents
- (timestamp $start, timestamp $finish, [string $relative_url = ''])
+ ([timestamp $start = null], [timestamp $finish = null], [string $relative_url = ''])
+
@@ -184,6 +231,24 @@
(timestamp $start, timestamp $finish, [boolean $completed = false], [boolean $cancelled = false], [string $relative_url = ""])
Server, username, password, calendar, $entry
+Server, username, password, calendar
@@ -253,7 +318,7 @@ mixed $body - = "" (line 71) + = "" (line 37)
-
- resource
- $curl
- (line 78)
-
- Our cURL connection
- - - - -
mixed
$entry
- (line 61)
+ (line 27)
mixed
$headers
- = array() (line 70)
+ = array() (line 36)
+
+
+
+ mixed
+ $httpRequest
+ = "" (line 39)
+
+
+
+ mixed
+ $httpResponse
+ = "" (line 41)
mixed
$pass
- (line 61)
+ (line 27)
+
+
+
+ mixed
+ $port
+ (line 27)
+
+
+
+ mixed
+ $protocol
+ (line 27)
+
+
+
+ mixed
+ $requestMethod
+ = "GET" (line 38)
+
+
+
+ mixed
+ $server
+ (line 27)
mixed
$user
- (line 61)
+ (line 27)
string
$user_agent
- = 'DAViCalClient' (line 68)
+ = 'DAViCalClient' (line 34)
+
+ mixed
+ $xmlRequest
+ = "" (line 40)
+
+
+
+ mixed
+ $xmlResponse
+ = "" (line 42)
+
+
- Constructor CalDAVClient (line 89)
+ Constructor CalDAVClient (line 52)
- DoCalendarQuery (line 301)
+ DoCalendarQuery (line 312)
- DoDELETERequest (line 274)
+ DoDELETERequest (line 286)
- DoGETRequest (line 229)
+ DoGETRequest (line 243)
- DoOptionsRequest (line 192)
+ DoOptionsRequest (line 209)
- DoPUTRequest (line 246)
+ DoPUTRequest (line 259)
- DoRequest (line 151)
+ DoRequest (line 172)
- DoXMLRequest (line 213)
+ DoXMLRequest (line 229)
- GetEntryByHref (line 457)
+ GetEntryByHref (line 468)
- GetEntryByUid (line 430)
+ GetEntryByUid (line 441)
- GetEvents (line 360)
+ GetEvents (line 369)
+ GetHttpRequest (line 137)
+ Output http request headers
+ + +
- GetTodos (line 393)
+ GetHttpResponse (line 145)
+ Output http response headers
+ + +
+ GetTodos (line 404)
+ GetXmlRequest (line 153)
+ Output xml request
+ + +
+ GetXmlResponse (line 161)
+ Output xml response
+ + +
+ ParseResponse (line 121)
+ Split response into httpResponse and xmlResponse
+ +
- SetContentType (line 139)
+ SetContentType (line 112)
- SetDepth (line 120)
+ SetDepth (line 93)
- SetMatch (line 111)
+ SetMatch (line 84)
- SetUserAgent (line 129)
+ SetUserAgent (line 102)
- Documentation generated on Tue, 18 Nov 2008 18:28:53 +1300 by phpDocumentor 1.3.2 + Documentation generated on Fri, 10 Apr 2009 23:45:50 +1200 by phpDocumentor 1.3.2