From cdcc6333f72b037aeb8956f04b769f72ac428e47 Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Thu, 24 Dec 2009 22:14:29 +1300 Subject: [PATCH] New / old files in the built docs. --- docs/api/awl/PdoQuery/PdoDatabase.html | 575 -------------- docs/api/awl/PdoQuery/PdoDialect.html | 315 -------- docs/api/awl/PdoQuery/PdoQuery.html | 304 ------- .../api/awl/PdoQuery/_inc---PdoQuery.php.html | 95 --- docs/api/awl/caldav/CalendarInfo.html | 257 ++++++ .../caldav/_inc---caldav-client-v2.php.html} | 67 +- .../davical/RSCDSSession/RSCDSSession.html | 236 ------ docs/api/davical/RSCDSSession/Tools.html | 181 ----- .../RSCDSSession/_htdocs---tools.php.html | 193 ----- .../RSCDSSession/_inc---RSCDSSession.php.html | 192 ----- docs/api/davical/RSCDSUser/RSCDSUser.html | 493 ------------ ...ical.php.html => _htdocs---admin.php.html} | 6 +- docs/api/davical/_htdocs---browse.php.html | 152 ---- docs/api/davical/_htdocs---edit.php.html | 152 ---- docs/api/davical/_inc---pubsub.php.html | 63 ++ .../_inc---ui---principal-view.php.html | 34 - ...AR.php.html => _inc---caldav-ACL.php.html} | 24 +- docs/api/davical/xmpp.html | 746 ++++++++++++++++++ 18 files changed, 1102 insertions(+), 2983 deletions(-) delete mode 100644 docs/api/awl/PdoQuery/PdoDatabase.html delete mode 100644 docs/api/awl/PdoQuery/PdoDialect.html delete mode 100644 docs/api/awl/PdoQuery/PdoQuery.html delete mode 100644 docs/api/awl/PdoQuery/_inc---PdoQuery.php.html create mode 100644 docs/api/awl/caldav/CalendarInfo.html rename docs/api/{davical/RSCDSUser/_inc---RSCDSUser.php.html => awl/caldav/_inc---caldav-client-v2.php.html} (55%) delete mode 100644 docs/api/davical/RSCDSSession/RSCDSSession.html delete mode 100644 docs/api/davical/RSCDSSession/Tools.html delete mode 100644 docs/api/davical/RSCDSSession/_htdocs---tools.php.html delete mode 100644 docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html delete mode 100644 docs/api/davical/RSCDSUser/RSCDSUser.html rename docs/api/davical/{_htdocs---davical.php.html => _htdocs---admin.php.html} (93%) delete mode 100644 docs/api/davical/_htdocs---browse.php.html delete mode 100644 docs/api/davical/_htdocs---edit.php.html create mode 100644 docs/api/davical/_inc---pubsub.php.html delete mode 100644 docs/api/davical/_inc---ui---principal-view.php.html rename docs/api/davical/caldav/{_inc---caldav-MKCALENDAR.php.html => _inc---caldav-ACL.php.html} (67%) create mode 100644 docs/api/davical/xmpp.html diff --git a/docs/api/awl/PdoQuery/PdoDatabase.html b/docs/api/awl/PdoQuery/PdoDatabase.html deleted file mode 100644 index c9208ab5..00000000 --- a/docs/api/awl/PdoQuery/PdoDatabase.html +++ /dev/null @@ -1,575 +0,0 @@ - - - - - - Docs For Class PdoDatabase - - - - -
-

 Class PdoDatabase

- - -
-
Description
- -
- -

Typically there will only be a single instance of the database level class in an application.

-

- Located in /inc/PdoQuery.php (line 218) -

- - -

-	
-			
-
- - - - -
-
Variable Summary
- -
-
-
-  - mixed - $querycount -
-
-  - mixed - $querytime -
-
-  - mixed - $txnstate -
-
-
-
- - -
-
Method Summary
- -
-
-
-  - PdoDatabase - __construct - (string $connection_string, [string $dbuser = null], [string $dbpass = null], [array $options = null]) -
-
-  - void - Begin - () -
-
-  - void - Commit - () -
-
-  - mixed - Exec - (string $sql_query_string, mixed 1) -
-
-  - void - GetFields - ( $tablename_string) -
-
-  - void - Prepare - (string $sql_query_string, mixed 1) -
-
-  - void - PrepareTranslated - () -
-
-  - void - Rollback - () -
-
-  - void - TotalDuration - () -
-
-  - void - TotalQueries - () -
-
-  - void - TransactionState - () -
-
-  - void - TranslateAll - ( $onoff_boolean) -
-
-
-
- - -
-
Variables
- -
- - -
- -
- - - mixed - $querycount - = 0 (line 241) - -
- - -

Holds the count of queries executed so far

-
    -
  • access: protected
  • -
- - - - - -
- -
- -
- - - mixed - $querytime - = 0 (line 246) - -
- - -

Holds the total duration of queries executed so far

-
    -
  • access: protected
  • -
- - - - - -
- -
- -
- - - mixed - $txnstate - = 0 (line 236) - -
- - -

Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit

-
    -
  • access: protected
  • -
- - - - - -
- -
-
- - -
-
Methods
- -
- - -
- -
- - 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.

- -
- PdoDatabase - - __construct - - (string $connection_string, [string $dbuser = null], [string $dbpass = null], [array $options = null]) -
- -
    -
  • - string - $connection_string: The PDO connection string, in all it's glory
  • -
  • - string - $dbuser: The database username to connect as
  • -
  • - string - $dbpass: The database password to connect with
  • -
  • - array - $options: An array of driver options
  • -
- - -
- -
- -
- - Begin (line 303) -
- - -

Begin a transaction.

- -
- void - - Begin - - () -
- - - -
- -
- -
- - Commit (line 317) -
- - -

Complete a transaction.

- -
- void - - Commit - - () -
- - - -
- -
- -
- - Exec (line 287) -
- - -

Construct and execute an SQL statement from the sql_string, replacing the parameters into it.

-
    -
  • return: false on error or number of rows affected. Test failure with === false
  • -
- -
- mixed - - Exec - - (string $sql_query_string, mixed 1) -
- -
    -
  • - string - $sql_query_string: The SQL string containing optional variable replacements
  • -
  • - mixed - 1: ... Subsequent arguments are positionally replaced into the $sql_query_string
  • -
- - -
- -
- -
- - 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.

- -
- void - - GetFields - - ( $tablename_string) -
- -
    -
  • - - $tablename_string
  • -
- - -
- -
- -
- - Prepare (line 273) -
- - -

Returns a PdoQuery object created using this database, the supplied SQL string, and any parameters given.

- -
- void - - Prepare - - (string $sql_query_string, mixed 1) -
- -
    -
  • - string - $sql_query_string: The SQL string containing optional variable replacements
  • -
  • - mixed - 1: ... Subsequent arguments are positionally replaced into the $sql_query_string
  • -
- - -
- -
- -
- - PrepareTranslated (line 376) -
- - -

Operates identically to PdoDatabase::Prepare, except that PdoDialect::Translate() will be called on the query before any processing.

- -
- void - - PrepareTranslated - - () -
- - - -
- -
- -
- - Rollback (line 328) -
- - -

Cancel a transaction in progress.

- -
- void - - Rollback - - () -
- - - -
- -
- -
- - TotalDuration (line 351) -
- - -

Returns the total duration of quries executed so far by this object instance.

- -
- void - - TotalDuration - - () -
- - - -
- -
- -
- - TotalQueries (line 359) -
- - -

Returns the total number of quries executed by this object instance.

- -
- void - - TotalQueries - - () -
- - - -
- -
- -
- - 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.

- -
- void - - TransactionState - - () -
- - - -
- -
- -
- - 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.

- -
- void - - TranslateAll - - ( $onoff_boolean) -
- -
    -
  • - - $onoff_boolean
  • -
- - -
- -
-
- - -

- Documentation generated on Tue, 06 Oct 2009 02:03:10 -0700 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/awl/PdoQuery/PdoDialect.html b/docs/api/awl/PdoQuery/PdoDialect.html deleted file mode 100644 index ed47f728..00000000 --- a/docs/api/awl/PdoQuery/PdoDialect.html +++ /dev/null @@ -1,315 +0,0 @@ - - - - - - Docs For Class PdoDialect - - - - -
-

 Class PdoDialect

- - -
-
Description
- -
- -

The PdoDialect class handles

-

- Located in /inc/PdoQuery.php (line 41) -

- - -

-	
-			
-
- - - - -
-
Variable Summary
- -
-
-
-  - mixed - $dialect -
-
-
-
- - -
-
Method Summary
- -
-
-
-  - PdoDialect - __construct - (string $connection_string) -
-
-  - void - GetFields - (string $tablename_string) -
-
-  - void - Quote - (mixed $value, [string $value_type = null]) -
-
-  - The - ReplaceParameters - (string 0, mixed 1) -
-
-  - void - Translate - ( $sql_string) -
-
-
-
- - -
-
Variables
- -
- - -
- -
- - - mixed - $dialect - (line 49) - -
- - -

Holds the name of the database dialect

-
    -
  • access: protected
  • -
- - - - - -
- -
-
- - -
-
Methods
- -
- - -
- -
- - 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.

- -
- PdoDialect - - __construct - - (string $connection_string) -
- -
    -
  • - string - $connection_string: The full PDO connection string
  • -
- - -
- -
- -
- - 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.

- -
- void - - GetFields - - (string $tablename_string) -
- -
    -
  • - string - $tablename_string: The name of the table we want fields from
  • -
- - -
- -
- -
- - Quote (line 114) -
- - -

Returns $value escaped in an appropriate way for this database dialect.

- -
- void - - Quote - - (mixed $value, [string $value_type = null]) -
- -
    -
  • - mixed - $value: The value to be escaped
  • -
  • - string - $value_type: The type of escaping desired. If blank this will be worked out from gettype($value). The special type of 'identifier' can also be used for escaping of SQL identifiers.
  • -
- - -
- -
- -
- - 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 )".

-
    -
  • return: built query string
  • -
- -
- The - - ReplaceParameters - - (string 0, mixed 1) -
- -
    -
  • - string - 0: The query string with replacable '?' characters.
  • -
  • - mixed - 1: The values to replace into the SQL string.
  • -
- - -
- -
- -
- - 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.

- -
- void - - Translate - - ( $sql_string) -
- -
    -
  • - - $sql_string
  • -
- - -
- -
-
- - -

- Documentation generated on Tue, 06 Oct 2009 02:03:10 -0700 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/awl/PdoQuery/PdoQuery.html b/docs/api/awl/PdoQuery/PdoQuery.html deleted file mode 100644 index 84697d73..00000000 --- a/docs/api/awl/PdoQuery/PdoQuery.html +++ /dev/null @@ -1,304 +0,0 @@ - - - - - - Docs For Class PdoQuery - - - - -
-

 Class PdoQuery

- - -
-
Description
- -
- -

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.

-

- Located in /inc/PdoQuery.php (line 395) -

- - -

-	
-			
-
- - - - - -
-
Method Summary
- -
-
-
-  - PdoQuery - __construct - () -
-
-  - void - Exec - () -
-
-  - void - Fetch - () -
-
-  - void - FetchAll - () -
-
-  - void - FetchArray - () -
-
-  - void - MaxDuration - (double $seconds) -
-
-  - void - Query - () -
-
-  - void - Rows - () -
-
-
-
- - - -
-
Methods
- -
- - -
- -
- - 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.

- -
- PdoQuery - - __construct - - () -
- - - -
- -
- -
- - Exec (line 435) -
- - -

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.

- -
- void - - Exec - - () -
- - - -
- -
- -
- - Fetch (line 449) -
- - -

Will fetch the next row from the query into an object with elements named for the fields in the result.

- -
- void - - Fetch - - () -
- - - -
- -
- -
- - FetchAll (line 466) -
- - -

Will fetch all result rows from the query into an array of objects with elements named for the fields in the result.

- -
- void - - FetchAll - - () -
- - - -
- -
- -
- - FetchArray (line 458) -
- - -

Will fetch the next row from the query into an array with numbered elements and with elements named for the fields in the result.

- -
- void - - FetchArray - - () -
- - - -
- -
- -
- - MaxDuration (line 483) -
- - -

Used to set the maximum duration for this query before it will be logged as a slow query.

- -
- void - - MaxDuration - - (double $seconds) -
- -
    -
  • - double - $seconds: The maximum duration for this statement before logging it as 'slow'
  • -
- - -
- -
- -
- - Query (line 421) -
- - -

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.

- -
- void - - Query - - () -
- - - -
- -
- -
- - Rows (line 474) -
- - -

An accessor for the number of rows affected when the query was executed.

- -
- void - - Rows - - () -
- - - -
- -
-
- - -

- Documentation generated on Tue, 06 Oct 2009 02:03:11 -0700 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/awl/PdoQuery/_inc---PdoQuery.php.html b/docs/api/awl/PdoQuery/_inc---PdoQuery.php.html deleted file mode 100644 index f1bb65c2..00000000 --- a/docs/api/awl/PdoQuery/_inc---PdoQuery.php.html +++ /dev/null @@ -1,95 +0,0 @@ - - - - - - Docs for page PdoQuery.php - - - - -
-

File/inc/PdoQuery.php

- - -
-
Description
- -
- -

PDO 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:

  • All queries are timed, and an expected time can be provided.
  • Parameters replaced into the SQL will be escaped correctly in order to - minimise the chances of SQL injection errors.
  • Queries which fail, or which exceed their expected execution time, will - be logged for potential further analysis.
  • Debug logging of queries may be enabled globally, or restricted to - particular sets of queries.
  • Simple syntax for iterating through a result set.
See http://wiki.davical.org/w/PdoQuery for design and usage information.

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.

- - -
-
- - -
-
Classes
- -
- - - - - - - - - - - - - - - - - -
ClassDescription
-  class - PdoDialect - - The PdoDialect class handles -
-  class - PdoDatabase - - Typically there will only be a single instance of the database level class in an application. -
-  class - 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 Tue, 06 Oct 2009 02:03:10 -0700 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/awl/caldav/CalendarInfo.html b/docs/api/awl/caldav/CalendarInfo.html new file mode 100644 index 00000000..35417635 --- /dev/null +++ b/docs/api/awl/caldav/CalendarInfo.html @@ -0,0 +1,257 @@ + + + + + + Docs For Class CalendarInfo + + + + +
+

 Class CalendarInfo

+ + +
+
Description
+ +
+ +

A class for holding basic calendar information

+

+ Located in /inc/caldav-client-v2.php (line 19) +

+ + +

+	
+			
+
+ + + + +
+
Variable Summary
+ +
+
+
+  + mixed + $displayname +
+
+  + mixed + $getctag +
+
+  + mixed + $url +
+
+
+
+ + +
+
Method Summary
+ +
+
+
+  + CalendarInfo + __construct + ( $url, [ $displayname = null], [ $getctag = null]) +
+
+  + void + __toString + () +
+
+
+
+ + +
+
Variables
+ +
+ + +
+ +
+ + + mixed + $displayname + (line 20) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $getctag + (line 20) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $url + (line 20) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+
+ + +
+
Methods
+ +
+ + +
+ +
+ + Constructor __construct (line 22) +
+ + + +
+ CalendarInfo + + __construct + + ( $url, [ $displayname = null], [ $getctag = null]) +
+ +
    +
  • + + $url
  • +
  • + + $displayname
  • +
  • + + $getctag
  • +
+ + +
+ +
+ +
+ + __toString (line 28) +
+ + + +
+ void + + __toString + + () +
+ + + +
+ +
+
+ + +

+ Documentation generated on Thu, 24 Dec 2009 22:09:49 +1300 by phpDocumentor 1.3.2 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/RSCDSUser/_inc---RSCDSUser.php.html b/docs/api/awl/caldav/_inc---caldav-client-v2.php.html similarity index 55% rename from docs/api/davical/RSCDSUser/_inc---RSCDSUser.php.html rename to docs/api/awl/caldav/_inc---caldav-client-v2.php.html index e861e111..28321166 100644 --- a/docs/api/davical/RSCDSUser/_inc---RSCDSUser.php.html +++ b/docs/api/awl/caldav/_inc---caldav-client-v2.php.html @@ -3,13 +3,13 @@ - Docs for page RSCDSUser.php + Docs for page caldav-client-v2.php
-

File/inc/RSCDSUser.php

+

File/inc/caldav-client-v2.php

@@ -21,11 +21,11 @@
-

User maintain / view with DAViCal specific associated tables

+

A Class for connecting to a caldav server

@@ -50,10 +50,21 @@  class - RSCDSUser + CalendarInfo - A class for viewing and maintaining DAViCal User records + A class for holding basic calendar information + + + + +  class + CalDAVClient + + + A class for accessing DAViCal via CalDAV, as a client @@ -69,56 +80,20 @@ | Includes
- +
-
-  - - require - ("User.php") - (line 12) - -
- - -

User maintain / view with DAViCal specific associated tables

- - -
- -
-
 require_once - ("classBrowser.php") + ('XMLDocument.php') (line 13)
-
- -
- -
-  - - require_once - ("auth-functions.php") - (line 14) - -
- - -
@@ -127,7 +102,7 @@

- Documentation generated on Mon, 22 Jun 2009 21:46:02 +1200 by phpDocumentor 1.3.2 + Documentation generated on Thu, 24 Dec 2009 22:09:48 +1300 by phpDocumentor 1.3.2

\ No newline at end of file diff --git a/docs/api/davical/RSCDSSession/RSCDSSession.html b/docs/api/davical/RSCDSSession/RSCDSSession.html deleted file mode 100644 index 56abe6e2..00000000 --- a/docs/api/davical/RSCDSSession/RSCDSSession.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - Docs For Class RSCDSSession - - - - -
-

 Class RSCDSSession

- - -
-
Description
- -
- -

A class for creating and holding session information.

-

- Located in /inc/RSCDSSession.php (line 50) -

- - -
Session
-   |
-   --RSCDSSession
- -
-
- - - - - -
-
Method Summary
- -
-
-
-  - RSCDSSession - RSCDSSession - ([string $sid = ""]) -
-
-  - void - AssignSessionDetails - (object $u) -
-
-  - void - GetRelationships - () -
-
-  - void - GetRoles - () -
-
-  - boolean - LoginRequired - ([string $roles = ""]) -
-
-
-
- - - -
-
Methods
- -
- - -
- -
- - Constructor RSCDSSession (line 61) -
- - -

Create a new RSCDSSession object.

-

We create a Session and extend it with some additional useful RSCDS related information.

- -
- RSCDSSession - - RSCDSSession - - ([string $sid = ""]) -
- -
    -
  • - string - $sid: A session identifier.
  • -
- - -
- -
- -
- - AssignSessionDetails (line 70) -
- - -

Internal function used to assign the session details to a user's new session.

- -
- void - - AssignSessionDetails - - (object $u) -
- -
    -
  • - object - $u: The user+session object we (probably) read from the database.
  • -
- - -
- -
- -
- - GetRelationships (line 98) -
- - -

Method used to get the user's relationships

- -
- void - - GetRelationships - - () -
- - - -
- -
- -
- - GetRoles (line 83) -
- - -

Method used to get the user's roles

- -
- void - - GetRoles - - () -
- - - -
- -
- -
- - LoginRequired (line 120) -
- - -

Checks that this user is logged in, and presents a login screen if they aren't.

-

The function can optionally confirm whether they are a member of one of a list of roles, and deny access if they are not a member of any of them.

-
    -
  • return: Whether or not the user is logged in and is a member of one of the required roles.
  • -
- -
- boolean - - LoginRequired - - ([string $roles = ""]) -
- -
    -
  • - string - $roles: The list of roles that the user must be a member of one of to be allowed to proceed.
  • -
- - -
- -
-
- - -

- Documentation generated on Mon, 22 Jun 2009 21:46:01 +1200 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/RSCDSSession/Tools.html b/docs/api/davical/RSCDSSession/Tools.html deleted file mode 100644 index 65155cde..00000000 --- a/docs/api/davical/RSCDSSession/Tools.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - Docs For Class Tools - - - - -
-

 Class Tools

- - -
-
Description
- -
- -

- Located in /htdocs/tools.php (line 36) -

- - -

-	
-			
-
- - - - - -
-
Method Summary
- -
-
-
-  - void - importFromDirectory - () -
-
-  - void - render - () -
-
-  - void - renderImportFromDirectory - () -
-
-  - void - renderSyncLDAP - () -
-
-
-
- - - -
-
Methods
- -
- - -
- -
- - importFromDirectory (line 97) -
- - - -
- void - - importFromDirectory - - () -
- - - -
- -
- -
- - render (line 38) -
- - - -
- void - - render - - () -
- - - -
- -
- -
- - renderImportFromDirectory (line 70) -
- - - -
- void - - renderImportFromDirectory - - () -
- - - -
- -
- -
- - renderSyncLDAP (line 46) -
- - - -
- void - - renderSyncLDAP - - () -
- - - -
- -
-
- - -

- Documentation generated on Mon, 22 Jun 2009 21:46:03 +1200 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/RSCDSSession/_htdocs---tools.php.html b/docs/api/davical/RSCDSSession/_htdocs---tools.php.html deleted file mode 100644 index ae14712b..00000000 --- a/docs/api/davical/RSCDSSession/_htdocs---tools.php.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - - Docs for page tools.php - - - - -
-

File/htdocs/tools.php

- - -
-
Description
- -
- -

Tools for manipulating calendars

- - -
-
- - -
-
Classes
- -
- - - - - - - - - -
ClassDescription
-  class - Tools - - -
-
-
- - -
-
Includes
- -
- -
- -
-  - - include - (page-header.php) - (line 32) - -
- - - -
- -
- -
-  - - include - (page-footer.php) - (line 154) - -
- - - -
- -
- -
-  - - require_once - ("DataEntry.php") - (line 16) - -
- - - -
- -
- -
-  - - require_once - ("../inc/always.php") - (line 12) - -
- - -

Tools for manipulating calendars

- - -
- -
- -
-  - - require_once - (interactive-page.php) - (line 17) - -
- - - -
- -
- -
-  - - require_once - ("classBrowser.php") - (line 18) - -
- - - -
- -
- -
-  - - require_once - (RSCDSSession.php) - (line 13) - -
- - - -
-
-
- - - - -

- Documentation generated on Mon, 22 Jun 2009 21:46:03 +1200 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html b/docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html deleted file mode 100644 index 813a71df..00000000 --- a/docs/api/davical/RSCDSSession/_inc---RSCDSSession.php.html +++ /dev/null @@ -1,192 +0,0 @@ - - - - - - Docs for page RSCDSSession.php - - - - -
-

File/inc/RSCDSSession.php

- - -
-
Description
- -
- -

DAViCal extensions to AWL Session handling

- - -
-
- - -
-
Classes
- -
- - - - - - - - - -
ClassDescription
-  class - RSCDSSession - - A class for creating and holding session information. -
-
-
- - -
-
Includes
- -
- -
- -
-  - - require_once - ('PgQuery.php') - (line 15) - -
- - -

All session data is held in the database.

- -
- -
- -
-  - - require_once - ('Session.php') - (line 41) - -
- - -

We extend the AWL Session class.

- -
-
-
- - - -
-
Variables
- -
- -
- -
- - - resource - $session - The session object is global. - (line 22) - -
- - -
    -
  • name: $session - The session object is global.
  • -
- - -
-
-
- - -
-
Functions
- -
- -
- -
- - local_session_sql (line 31) -
- - -
    -
  • todo: Make this a defined constant
  • -
-
- void - - local_session_sql - - () -
- - - -
-
-
- -

- Documentation generated on Mon, 22 Jun 2009 21:46:01 +1200 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/RSCDSUser/RSCDSUser.html b/docs/api/davical/RSCDSUser/RSCDSUser.html deleted file mode 100644 index b057a289..00000000 --- a/docs/api/davical/RSCDSUser/RSCDSUser.html +++ /dev/null @@ -1,493 +0,0 @@ - - - - - - Docs For Class RSCDSUser - - - - -
-

 Class RSCDSUser

- - -
-
Description
- -
- -

A class for viewing and maintaining DAViCal User records

-

- Located in /inc/RSCDSUser.php (line 24) -

- - -
User
-   |
-   --RSCDSUser
- -
-
- - - - -
-
Variable Summary
- - -
- - -
-
Method Summary
- -
-
-
-  - RSCDSUser - RSCDSUser - ( $id, [ $prefix = ""]) -
-
-  - boolean - AllowedTo - (string $whatever) -
-
-  - void - HandleAction - ( $action) -
-
-  - string - Render - ([ $title = ""]) -
-
-  - string - RenderCollections - ( $ef, [ $title = null]) -
-
-  - string - RenderImportIcs - ( $ef, [ $title = null]) -
-
-  - string - RenderRelationshipsFrom - ( $ef, [ $title = null]) -
-
-  - string - RenderRelationshipsTo - ( $ef, [ $title = null]) -
-
-  - boolean - Validate - () -
-
-  - void - Write - () -
-
-
-
- - -
-
Variables
- -
- - -
- -
- - - mixed - $delete_collection_confirmation_required - (line 27) - -
- - - - - - - -
- -
-
- - -
-
Methods
- -
- - -
- -
- - Constructor RSCDSUser (line 32) -
- - -

Constructor - nothing fancy as yet.

- -
- RSCDSUser - - RSCDSUser - - ( $id, [ $prefix = ""]) -
- -
    -
  • - - $id
  • -
  • - - $prefix
  • -
- - -
- -
- -
- - AllowedTo (line 303) -
- - -

Extend parent definition of what the current user is allowed to do

-
    -
  • return: Whether they are allowed to.
  • -
- -
- boolean - - AllowedTo - - (string $whatever) -
- -
    -
  • - string - $whatever: What the user wants to do
  • -
- - -
- -
- -
- - HandleAction (line 331) -
- - -

Handle any unusual actions we might invent

- -
- void - - HandleAction - - ( $action) -
- -
    -
  • - - $action
  • -
- - -
- -
- -
- - Render (line 47) -
- - -

Render the form / viewer as HTML to show the user

-
    -
  • return: An HTML fragment to display in the page.
  • -
- -
- string - - Render - - ([ $title = ""]) -
- -
    -
  • - - $title
  • -
- - -
- -
- -
- - RenderCollections (line 248) -
- - -

Render the user's collections

-
    -
  • return: The string of html to be output
  • -
- -
- string - - RenderCollections - - ( $ef, [ $title = null]) -
- -
    -
  • - - $ef
  • -
  • - - $title
  • -
- - -
- -
- -
- - RenderImportIcs (line 94) -
- - -

Render input file to import ics in calendar user

-
    -
  • return: The string of html to be output
  • -
- -
- string - - RenderImportIcs - - ( $ef, [ $title = null]) -
- -
    -
  • - - $ef
  • -
  • - - $title
  • -
- - -
- -
- -
- - RenderRelationshipsFrom (line 117) -
- - -

Render the user's relationships to other users & resources

-
    -
  • return: The string of html to be output
  • -
- -
- string - - RenderRelationshipsFrom - - ( $ef, [ $title = null]) -
- -
    -
  • - - $ef
  • -
  • - - $title
  • -
- - -
- -
- -
- - RenderRelationshipsTo (line 166) -
- - -

Render the user's relationships to other users & resources

-
    -
  • return: The string of html to be output
  • -
- -
- string - - RenderRelationshipsTo - - ( $ef, [ $title = null]) -
- -
    -
  • - - $ef
  • -
  • - - $title
  • -
- - -
- -
- -
- - Validate (line 293) -
- - -

Validate the information the user submitted

-
    -
  • return: Whether the form data validated OK.
  • -
- -
- boolean - - Validate - - () -
- - - -
- -
- -
- - Write (line 384) -
- - -

Write the record to the file

- -
- void - - Write - - () -
- - - -
- -
-
- - -

- Documentation generated on Mon, 22 Jun 2009 21:46:02 +1200 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/_htdocs---davical.php.html b/docs/api/davical/_htdocs---admin.php.html similarity index 93% rename from docs/api/davical/_htdocs---davical.php.html rename to docs/api/davical/_htdocs---admin.php.html index a3865e8a..41c0c6a6 100644 --- a/docs/api/davical/_htdocs---davical.php.html +++ b/docs/api/davical/_htdocs---admin.php.html @@ -3,13 +3,13 @@ - Docs for page davical.php + Docs for page admin.php
-

File/htdocs/davical.php

+

File/htdocs/admin.php

@@ -206,7 +206,7 @@

- Documentation generated on Tue, 01 Dec 2009 10:37:48 +1300 by phpDocumentor 1.3.2 + Documentation generated on Thu, 24 Dec 2009 22:09:45 +1300 by phpDocumentor 1.3.2

\ No newline at end of file diff --git a/docs/api/davical/_htdocs---browse.php.html b/docs/api/davical/_htdocs---browse.php.html deleted file mode 100644 index 7499613a..00000000 --- a/docs/api/davical/_htdocs---browse.php.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Docs for page browse.php - - - - -
-

File/htdocs/browse.php

- - -
-
Description
- -
- - -
-
- - - -
-
Includes
- -
- -
- -
-  - - include - (page-footer.php) - (line 39) - -
- - -

Page elements could be an array of viewers, browsers or something else that supports the Render() method...

- -
- -
- -
-  - - include - (DAViCalSession.php) - (line 4) - -
- - - -
- -
- -
-  - - include - (page-header.php) - (line 17) - -
- - - -
- -
- -
-  - - include_once - ("components/$component-browse.php") - (line 13) - -
- - - -
- -
- -
-  - - require_once - ('../inc/always.php') - (line 2) - -
- - - -
- -
- -
-  - - require_once - ('classBrowser.php') - (line 3) - -
- - - -
- -
- -
-  - - require_once - ('interactive_page.php') - (line 10) - -
- - - -
-
-
- - - - -

- Documentation generated on Tue, 01 Dec 2009 10:37:46 +1300 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/_htdocs---edit.php.html b/docs/api/davical/_htdocs---edit.php.html deleted file mode 100644 index 7a2916c1..00000000 --- a/docs/api/davical/_htdocs---edit.php.html +++ /dev/null @@ -1,152 +0,0 @@ - - - - - - Docs for page edit.php - - - - -
-

File/htdocs/edit.php

- - -
-
Description
- -
- - -
-
- - - -
-
Includes
- -
- -
- -
-  - - include - (page-footer.php) - (line 38) - -
- - -

Page elements could be an array of viewers, browsers or something else that supports the Render() method...

- -
- -
- -
-  - - include - (DAViCalSession.php) - (line 4) - -
- - - -
- -
- -
-  - - include - (page-header.php) - (line 17) - -
- - - -
- -
- -
-  - - include_once - ("components/$component-edit.php") - (line 13) - -
- - - -
- -
- -
-  - - require_once - ('../inc/always.php') - (line 2) - -
- - - -
- -
- -
-  - - require_once - ('classEditor.php') - (line 3) - -
- - - -
- -
- -
-  - - require_once - ('interactive_page.php') - (line 10) - -
- - - -
-
-
- - - - -

- Documentation generated on Tue, 01 Dec 2009 10:37:48 +1300 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/_inc---pubsub.php.html b/docs/api/davical/_inc---pubsub.php.html new file mode 100644 index 00000000..3865ce00 --- /dev/null +++ b/docs/api/davical/_inc---pubsub.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page pubsub.php + + + + +
+

File/inc/pubsub.php

+ + +
+
Description
+ +
+ + +
+
+ + +
+
Classes
+ +
+ + + + + + + + + +
ClassDescription
+  class + xmpp + + ******************************************************************** +
+
+
+ + + + + +

+ Documentation generated on Thu, 24 Dec 2009 22:09:56 +1300 by phpDocumentor 1.3.2 +

+
+ \ No newline at end of file diff --git a/docs/api/davical/_inc---ui---principal-view.php.html b/docs/api/davical/_inc---ui---principal-view.php.html deleted file mode 100644 index 6319ada8..00000000 --- a/docs/api/davical/_inc---ui---principal-view.php.html +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - Docs for page principal-view.php - - - - -
-

File/inc/ui/principal-view.php

- - -
-
Description
- -
- - -
-
- - - - - - -

- Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by phpDocumentor 1.3.2 -

-
- \ No newline at end of file diff --git a/docs/api/davical/caldav/_inc---caldav-MKCALENDAR.php.html b/docs/api/davical/caldav/_inc---caldav-ACL.php.html similarity index 67% rename from docs/api/davical/caldav/_inc---caldav-MKCALENDAR.php.html rename to docs/api/davical/caldav/_inc---caldav-ACL.php.html index baacc728..48c8b2ee 100644 --- a/docs/api/davical/caldav/_inc---caldav-MKCALENDAR.php.html +++ b/docs/api/davical/caldav/_inc---caldav-ACL.php.html @@ -3,13 +3,13 @@ - Docs for page caldav-MKCALENDAR.php + Docs for page caldav-ACL.php
-

File/inc/caldav-MKCALENDAR.php

+

File/inc/caldav-ACL.php

@@ -20,10 +20,10 @@
-

CalDAV Server - handle MKCALENDAR method

+

CalDAV Server - handle ACL method

@@ -39,23 +39,23 @@ Includes
- +
 require_once - ("XMLDocument.php") - (line 31) + ('DAVResource.php') + (line 13)
-

CalDAV Server - handle MKCALENDAR method

+

CalDAV Server - handle ACL method

@@ -67,7 +67,7 @@

- Documentation generated on Tue, 06 Oct 2009 02:03:06 -0700 by phpDocumentor 1.3.2 + Documentation generated on Thu, 24 Dec 2009 22:09:47 +1300 by phpDocumentor 1.3.2

\ No newline at end of file diff --git a/docs/api/davical/xmpp.html b/docs/api/davical/xmpp.html new file mode 100644 index 00000000..15763a2e --- /dev/null +++ b/docs/api/davical/xmpp.html @@ -0,0 +1,746 @@ + + + + + + Docs For Class xmpp + + + + +
+

 Class xmpp

+ + +
+
Description
+ +
+ +

********************************************************************

+

XMPP PubSub for DAViCal Copyright 2009 Rob Ostensen rob@boxacle.net Licenced http://gnu.org/copyleft/gpl.html GNU GPL v2

*******************************************************************

+

+ Located in /inc/pubsub.php (line 11) +

+ + +

+	
+			
+
+ + + + +
+
Variable Summary
+ +
+
+
+  + mixed + $idle +
+
+  + mixed + $jid +
+
+  + mixed + $password +
+
+  + mixed + $port +
+
+  + mixed + $pubsubLayout +
+
+  + mixed + $resource +
+
+  + mixed + $server +
+
+  + mixed + $status +
+
+  + mixed + $tls +
+
+
+
+ + +
+
Method Summary
+ +
+
+
+  + xmpp + __construct + () +
+
+  + void + addHandler + ( $direction,  $command,  $handler) +
+
+  + void + close + () +
+
+  + void + open + ([ $jid = null], [ $password = null]) +
+
+  + void + pubsubConfig + ( $to,  $type,  $name) +
+
+  + void + pubsubCreate + ( $to,  $type,  $name, [ $configure = null]) +
+
+  + void + pubsubDelete + ( $to,  $type,  $name) +
+
+  + void + pubsubPublish + ( $to,  $type,  $name,  $contents,  $nodeId) +
+
+  + void + pubsubPurge + ( $to,  $type,  $name) +
+
+  + void + sendMessage + ( $to,  $message) +
+
+
+
+ + +
+
Variables
+ +
+ + +
+ +
+ + + mixed + $idle + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $jid + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $password + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $port + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $pubsubLayout + = 'hometree' (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $resource + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $server + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $status + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+ +
+ + + mixed + $tls + (line 23) + +
+ + +
    +
  • access: public
  • +
+ + + + + +
+ +
+
+ + +
+
Methods
+ +
+ + +
+ +
+ + Constructor __construct (line 26) +
+ + +
    +
  • access: public
  • +
+ +
+ xmpp + + __construct + + () +
+ + + +
+ +
+ +
+ + addHandler (line 675) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + addHandler + + ( $direction,  $command,  $handler) +
+ +
    +
  • + + $direction
  • +
  • + + $command
  • +
  • + + $handler
  • +
+ + +
+ +
+ +
+ + close (line 664) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + close + + () +
+ + + +
+ +
+ +
+ + open (line 647) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + open + + ([ $jid = null], [ $password = null]) +
+ +
    +
  • + + $jid
  • +
  • + + $password
  • +
+ + +
+ +
+ +
+ + pubsubConfig (line 295) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + pubsubConfig + + ( $to,  $type,  $name) +
+ +
    +
  • + + $to
  • +
  • + + $type
  • +
  • + + $name
  • +
+ + +
+ +
+ +
+ + pubsubCreate (line 259) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + pubsubCreate + + ( $to,  $type,  $name, [ $configure = null]) +
+ +
    +
  • + + $to
  • +
  • + + $type
  • +
  • + + $name
  • +
  • + + $configure
  • +
+ + +
+ +
+ +
+ + pubsubDelete (line 312) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + pubsubDelete + + ( $to,  $type,  $name) +
+ +
    +
  • + + $to
  • +
  • + + $type
  • +
  • + + $name
  • +
+ + +
+ +
+ +
+ + pubsubPublish (line 346) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + pubsubPublish + + ( $to,  $type,  $name,  $contents,  $nodeId) +
+ +
    +
  • + + $to
  • +
  • + + $type
  • +
  • + + $name
  • +
  • + + $contents
  • +
  • + + $nodeId
  • +
+ + +
+ +
+ +
+ + pubsubPurge (line 329) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + pubsubPurge + + ( $to,  $type,  $name) +
+ +
    +
  • + + $to
  • +
  • + + $type
  • +
  • + + $name
  • +
+ + +
+ +
+ +
+ + sendMessage (line 249) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + sendMessage + + ( $to,  $message) +
+ +
    +
  • + + $to
  • +
  • + + $message
  • +
+ + +
+ +
+
+ + +

+ Documentation generated on Thu, 24 Dec 2009 22:09:56 +1300 by phpDocumentor 1.3.2 +

+
+ \ No newline at end of file