From 8b8d6b6d55826f01cbcafc66f0d6e62e63f3cf1b Mon Sep 17 00:00:00 2001 From: Andrew McMillan Date: Fri, 4 Dec 2009 22:59:38 +1300 Subject: [PATCH] Built docs for new code. --- docs/api/awl/AWLDB/AwlQuery.html | 805 +++++++++++ docs/api/awl/AWLDB/_inc---AwlQuery.php.html | 165 +++ docs/api/awl/AwlDatabase/AwlDBDialect.html | 455 ++++++ docs/api/awl/AwlDatabase/AwlDatabase.html | 425 ++++++ .../AwlDatabase/_inc---AwlDBDialect.php.html | 70 + .../AwlDatabase/_inc---AwlDatabase.php.html | 111 ++ docs/api/davical/Resource/DAVResource.html | 1271 +++++++++++++++++ .../Resource/_inc---DAVResource.php.html | 97 ++ docs/api/davical/_htdocs---browse.php.html | 152 ++ docs/api/davical/_htdocs---davical.php.html | 212 +++ docs/api/davical/_htdocs---edit.php.html | 152 ++ docs/api/davical/_htdocs---setup.php.html | 121 ++ docs/api/davical/_htdocs---test.php.html | 76 + docs/api/davical/_htdocs---upgrade.php.html | 137 ++ docs/api/davical/_inc---auth-famjama.php.html | 74 + ...c---caldav-REPORT-expand-property.php.html | 132 ++ .../_inc---ui---collection-edit.php.html | 34 + .../_inc---ui---principal-browse.php.html | 34 + .../_inc---ui---principal-edit.php.html | 71 + .../_inc---ui---principal-view.php.html | 34 + .../caldav/_inc---caldav-MKCOL.php.html | 73 + .../caldav/_inc---caldav-MOVE.php.html | 107 ++ ...c---caldav-REPORT-sync-collection.php.html | 112 ++ 23 files changed, 4920 insertions(+) create mode 100644 docs/api/awl/AWLDB/AwlQuery.html create mode 100644 docs/api/awl/AWLDB/_inc---AwlQuery.php.html create mode 100644 docs/api/awl/AwlDatabase/AwlDBDialect.html create mode 100644 docs/api/awl/AwlDatabase/AwlDatabase.html create mode 100644 docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html create mode 100644 docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html create mode 100644 docs/api/davical/Resource/DAVResource.html create mode 100644 docs/api/davical/Resource/_inc---DAVResource.php.html create mode 100644 docs/api/davical/_htdocs---browse.php.html create mode 100644 docs/api/davical/_htdocs---davical.php.html create mode 100644 docs/api/davical/_htdocs---edit.php.html create mode 100644 docs/api/davical/_htdocs---setup.php.html create mode 100644 docs/api/davical/_htdocs---test.php.html create mode 100644 docs/api/davical/_htdocs---upgrade.php.html create mode 100644 docs/api/davical/_inc---auth-famjama.php.html create mode 100644 docs/api/davical/_inc---caldav-REPORT-expand-property.php.html create mode 100644 docs/api/davical/_inc---ui---collection-edit.php.html create mode 100644 docs/api/davical/_inc---ui---principal-browse.php.html create mode 100644 docs/api/davical/_inc---ui---principal-edit.php.html create mode 100644 docs/api/davical/_inc---ui---principal-view.php.html create mode 100644 docs/api/davical/caldav/_inc---caldav-MKCOL.php.html create mode 100644 docs/api/davical/caldav/_inc---caldav-MOVE.php.html create mode 100644 docs/api/davical/caldav/_inc---caldav-REPORT-sync-collection.php.html diff --git a/docs/api/awl/AWLDB/AwlQuery.html b/docs/api/awl/AWLDB/AwlQuery.html new file mode 100644 index 00000000..035969be --- /dev/null +++ b/docs/api/awl/AWLDB/AwlQuery.html @@ -0,0 +1,805 @@ + + + + + + Docs For Class AwlQuery + + + + +
+

Class AwlQuery

+ + +
+
Description
+
+ Description | + Vars (details) + | Methods (details) + +
+
+ +

The AwlQuery Class.

+

This class builds and executes SQL Queries and traverses the set of results returned from the query.

Example usage

  1.  $sql = "SELECT * FROM mytable WHERE mytype = ?";
    2. +
  2.  $qry = new AwlQuery( $sql, $myunsanitisedtype );
    3. +
  3.  if ( $qry->Exec("typeselect", __line__, __file__ )
    4. +
  4.       && $qry->rows > 0 )
    5. +
  5.  {
    6. +
  6.    while( $row = $qry->Fetch() ) {
    7. +
  7.      do_something_with($row);
    8. +
  8.    }
    9. +
  9.  }
    10. +

+

+ Located in /inc/AwlQuery.php (line 138) +

+ + + 

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																																																																																								

+					 
+					array
+					$bound_parameters
+				

+																

+					 
+					resource
+					$connection
+				

+																

+					 
+					string
+					$error_info
+				

+																

+					 
+					string
+					$execution_time
+				

+																

+					 
+					string
+					$location
+				

+																

+					 
+					string
+					$querystring
+				

+																

+					 
+					double
+					$query_time_warning
+				

+																

+					 
+					resource
+					$result
+				

+																

+					 
+					int
+					$rownum
+				

+																

+					 
+					int
+					$rows
+				

+																

+					 
+					string
+					$sth
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																								

+					 
+											The
+										__construct
+											(string 0, mixed 1)
+									

+																

+					 
+											void
+										Bind
+										()
+									

+																

+					 
+											resource
+										Exec
+											([string $location = ''], [int $line = 0], [string $file = ''])
+									

+																

+					 
+											mixed
+										Fetch
+											([boolean $as_array = false])
+									

+																

+					 
+											void
+										Parameters
+										()
+									

+																

+					 
+											void
+										Prepare
+										()
+									

+																

+					 
+											void
+										QueryString
+										()
+									

+																

+					 
+											string
+										quote
+											([mixed $str = null])
+									

+																

+					 
+											void
+										rows
+										()
+									

+																

+					 
+											void
+										SetConnection
+											(resource $new_connection)
+									

+																

+					 
+											void
+										_log_query
+											(string $locn, string $tag, string $string, [int $line = 0], [string $file = ""])
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			array
+			$bound_parameters
+						(line 159)
+		
+	

+
+	
+
The current array of bound parameters

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			resource
+			$connection
+						(line 147)
+		
+	

+
+	
+
Our database connection, normally copied from a global one

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			string
+			$error_info
+						(line 189)
+		
+	

+
+	
+
The Database error information, if the query fails.

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			string
+			$execution_time
+						(line 196)
+		
+	

+
+	
+
Stores the query execution time - used to deal with long queries.

+
should be read-only

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			string
+			$location
+						(line 208)
+		
+	

+
+	
+
Where we called this query from so we can find it in our code!  Debugging may also be selectively enabled for a $location.

+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			string
+			$querystring
+						(line 153)
+		
+	

+
+	
+
The original query string

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			double
+			$query_time_warning
+			 =  0.3			(line 217)
+		
+	

+
+	
+
How long the query should take before a warning is issued.

+
This is writable, but a method to set it might be a better interface.  The default is 0.3 seconds.

+	
    
+				
  • access: public
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			resource
+			$result
+						(line 171)
+		
+	

+
+	
+
Result of the last execution

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			int
+			$rownum
+			 =  null			(line 177)
+		
+	

+
+	
+
number of current row - use accessor to get/set

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			int
+			$rows
+						(line 183)
+		
+	

+
+	
+
number of rows from pg_numrows - use accessor to get value

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			string
+			$sth
+						(line 165)
+		
+	

+
+	
+
The PDO statement handle, or null if we don't have one yet.

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+														Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 227)
+	
 
+	
+	
+
Constructor

+	
    
+				
  • return: AwlQuery object
    • 
+			

+	
+	

+		The
+		
+			__construct
+		
+					(string 0, mixed 1)
+			

+	
+			
    
+					
  • 
+				string
+				0: The query string in PDO syntax with replacable '?' characters or bindable parameters.			
    • 
+					
  • 
+				mixed
+				1: The values to replace into the SQL string.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Bind (line 307)
+	
 
+	
+	
+
Bind some parameters

+	
+	

+		void
+		
+			Bind
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		Exec (line 377)
+	
 
+	
+	
+
Execute the query, logging any debugging.

+
Example  So that you can nicely enable/disable the queries for a particular class, you  could use some of PHPs magic constants in your call.  
  1.  $qry->Exec(__CLASS__, __LINE__, __FILE__);
    2. 
+

+	
    
+				
  • return: The actual result of the query (FWIW)
    • 
+			

+	
+	

+		resource
+		
+			Exec
+		
+					([string $location = ''], [int $line = 0], [string $file = ''])
+			

+	
+			
    
+					
  • 
+				string
+				$location: The name of the location for enabling debugging or just                          to help our children find the source of a problem.			
    • 
+					
  • 
+				int
+				$line: The line number where Exec was called			
    • 
+					
  • 
+				string
+				$file: The file where Exec was called			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Fetch (line 440)
+	
 
+	
+	
+
Fetch the next row from the query results

+	
    
+				
  • return: query row
    • 
+			

+	
+	

+		mixed
+		
+			Fetch
+		
+					([boolean $as_array = false])
+			

+	
+			
    
+					
  • 
+				boolean
+				$as_array: True if thing to be returned is array			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Parameters (line 347)
+	
 
+	
+	
+
Return the parameters we are planning to substitute into the query string

+	
+	

+		void
+		
+			Parameters
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		Prepare (line 323)
+	
 
+	
+	
+
Tell the database to prepare the query that we will execute

+	
+	

+		void
+		
+			Prepare
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		QueryString (line 339)
+	
 
+	
+	
+
Return the query string we are planning to execute

+	
+	

+		void
+		
+			QueryString
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		quote (line 295)
+	
 
+	
+	
+
Quote the given string so it can be safely used within string delimiters  in a query.  To be avoided, in general.

+	
    
+				
  • return: NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped
    • 
+			

+	
+	

+		string
+		
+			quote
+		
+					([mixed $str = null])
+			

+	
+			
    
+					
  • 
+				mixed
+				$str: Data to be converted to a string suitable for including as a value in SQL.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		rows (line 355)
+	
 
+	
+	
+
Return the count of rows retrieved/affected

+	
+	

+		void
+		
+			rows
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		SetConnection (line 255)
+	
 
+	
+	
+
Use a different database connection for this query

+	
+	

+		void
+		
+			SetConnection
+		
+					(resource $new_connection)
+			

+	
+			
    
+					
  • 
+				resource
+				$new_connection: The database connection to use.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		_log_query (line 273)
+	
 
+	
+	
+
Log query, optionally with file and line location of the caller.

+
This function should not really be used outside of AwlQuery.  For a more  useful generic logging interface consider calling dbg_error_log(...);

+	
+	

+		void
+		
+			_log_query
+		
+					(string $locn, string $tag, string $string, [int $line = 0], [string $file = ""])
+			

+	
+			
    
+					
  • 
+				string
+				$locn: A string identifying the calling location.			
    • 
+					
  • 
+				string
+				$tag: A tag string, e.g. identifying the type of event.			
    • 
+					
  • 
+				string
+				$string: The information to be logged.			
    • 
+					
  • 
+				int
+				$line: The line number where the logged event occurred.			
    • 
+					
  • 
+				string
+				$file: The file name where the logged event occurred.			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/awl/AWLDB/_inc---AwlQuery.php.html b/docs/api/awl/AWLDB/_inc---AwlQuery.php.html
new file mode 100644
index 00000000..bb4a8f72
--- /dev/null
+++ b/docs/api/awl/AWLDB/_inc---AwlQuery.php.html
@@ -0,0 +1,165 @@
+
+
+  
+		
+			
+			Docs for page AwlQuery.php
+			
+			
+		
+		
+			
			

+
File/inc/AwlQuery.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|							Includes
+			|											Functions
+			

+	
	
+		
+	
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|							Includes
+				|																Functions
+					

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						AwlQuery
+					
+											The AwlQuery Class.
+										

+		

+	

+
+		
+	

+		
Includes

+		

+			Description |
+							Classes
+				|						Includes
+			|													Functions
+					

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			('AwlDatabase.php')
+			(line 11)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+							Classes
+				|										Includes
+				|												Functions
+		

+		
	
+			
+

+	
+	

+		
+		duration (line 107)
+	
 
+
+	
+
A duration (in decimal seconds) between two times which are the result of calls to microtime()

+
This simple function is used by the AwlQuery class because the  microtime function doesn't return a decimal time, so a simple  subtraction is not sufficient.

+	
    
+				
  • return: difference
    • 
+			

+	

+		double
+		
+			duration
+		
+					(microtime $t1, microtime $t2)
+			

+
+			
    
+					
  • 
+				microtime
+				$t1: start time			
    • 
+					
  • 
+				microtime
+				$t2: end time			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		_awl_connect_configured_database (line 40)
+	
 
+
+	
+
Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays

+	

+		void
+		
+			_awl_connect_configured_database
+		
+				()
+			

+
+		
+	
+

+		

+	

+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/awl/AwlDatabase/AwlDBDialect.html b/docs/api/awl/AwlDatabase/AwlDBDialect.html
new file mode 100644
index 00000000..20ad59f6
--- /dev/null
+++ b/docs/api/awl/AwlDatabase/AwlDBDialect.html
@@ -0,0 +1,455 @@
+
+
+  
+		
+			
+			Docs For Class AwlDBDialect
+			
+			
+		
+		
+			
			

+
 Class AwlDBDialect

+
+
+

+	
Description

+	

+					Description |
+							Descendents
+			|											Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+
The AwlDBDialect class handles

+		

+			Located in /inc/AwlDBDialect.php (line 22)
+		

+		
+				
+		

+	
+			

+

+
+	
+	

+		
Direct descendents

+		

+			Description |
+			Descendents
+			|												Vars (details)
+								|															Methods (details)
+							
+								

+		

+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

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

+		

+	

+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+							Descendants |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																

+					 
+					mixed
+					$db
+				

+																

+					 
+					mixed
+					$dialect
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+							Descendants |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																								

+					 
+											AwlDBDialect
+										__construct
+											(string $connection_string, [string $dbuser = null], [string $dbpass = null], [array $options = null])
+									

+																

+					 
+											void
+										GetFields
+											(string $tablename_string)
+									

+																

+					 
+											void
+										GetVersion
+											(handle $pdo)
+									

+																

+					 
+											void
+										Quote
+											(mixed $value, [string $value_type = null])
+									

+																

+					 
+											The
+										ReplaceParameters
+											(string 0, mixed 1)
+									

+																

+					 
+											void
+										SetSearchPath
+											([ $search_path = null])
+									

+																

+					 
+											void
+										TranslateSQL
+											( $sql_string)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+							Descendents |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$db
+						(line 35)
+		
+	

+
+	
+
Holds the PDO database connection

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			mixed
+			$dialect
+						(line 30)
+		
+	

+
+	
+
Holds the name of the database dialect

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+							Descendents |
+															Vars (details)
+														Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 57)
+	
 
+	
+	
+
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.

+
The database will be opened.

+	
+	

+		AwlDBDialect
+		
+			__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			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		GetFields (line 117)
+	
 
+	
+	
+
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			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		GetVersion (line 90)
+	
 
+	
+	
+
Sets the current search path for the database.

+	
+	

+		void
+		
+			GetVersion
+		
+					(handle $pdo)
+			

+	
+			
    
+					
  • 
+				handle
+				$pdo: A handle to an opened database			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Quote (line 160)
+	
 
+	
+	
+
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 250)
+	
 
+	
+	
+
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.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		SetSearchPath (line 72)
+	
 
+	
+	
+
Sets the current search path for the database.

+	
+	

+		void
+		
+			SetSearchPath
+		
+					([ $search_path = null])
+			

+	
+			
    
+					
  • 
+				
+				$search_path			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		TranslateSQL (line 147)
+	
 
+	
+	
+
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.

+
The actual translation to other SQL dialects will be application-specific, so that any routines  called by this will be external to this library, or will use resources loaded from some source  external to this library.
The application developer is expected to use this functionality to solve harder translation problems,  but is less likely to call this directly, hopefully switching ->Prepare to ->PrepareTranslated in those  cases, and then adding that statement to whatever SQL translation infrastructure is in place.

+	
+	

+		void
+		
+			TranslateSQL
+		
+					( $sql_string)
+			

+	
+			
    
+					
  • 
+				
+				$sql_string			
    • 
+				

+		
+			
+	

+						
+		

+	

+
+	
+	

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

+	

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

+
 Class AwlDatabase

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

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

+		

+			Located in /inc/AwlDatabase.php (line 55)
+		

+		
+				
+		
AwlDBDialect
+   |
+   --AwlDatabase

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																								

+					 
+					mixed
+					$txnstate
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																

+					 
+											void
+										Begin
+										()
+									

+																

+					 
+											void
+										Commit
+										()
+									

+																

+					 
+											void
+										prepare
+											( $statement, [array $driver_options = array()], string $sql_query_string)
+									

+																

+					 
+											void
+										PrepareTranslated
+										()
+									

+																

+					 
+											void
+										query
+											( $statement, string $sql_query_string, mixed 1)
+									

+																

+					 
+											void
+										Rollback
+										()
+									

+																

+					 
+											void
+										TransactionState
+										()
+									

+																

+					 
+											void
+										TranslateAll
+											( $onoff_boolean)
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			mixed
+			$txnstate
+			 =  0			(line 63)
+		
+	

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

+	
    
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
							
Inherited Variables

+				
+									
Inherited from AwlDBDialect

+					

+													
+							
+								AwlDBDialect::$db

+							
+													
+							
+								AwlDBDialect::$dialect

+							
+											
 
+										
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+														Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Begin (line 90)
+	
 
+	
+	
+
Begin a transaction.

+	
+	

+		void
+		
+			Begin
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		Commit (line 104)
+	
 
+	
+	
+
Complete a transaction.

+	
+	

+		void
+		
+			Commit
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		prepare (line 72)
+	
 
+	
+	
+
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

+	
+	

+		void
+		
+			prepare
+		
+					( $statement, [array $driver_options = array()], string $sql_query_string)
+			

+	
+			
    
+					
  • 
+				string
+				$sql_query_string: The SQL string containing optional variable replacements			
    • 
+					
  • 
+				array
+				$driver_options: PDO driver options to the prepare statement, commonly to do with cursors			
    • 
+					
  • 
+				
+				$statement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		PrepareTranslated (line 139)
+	
 
+	
+	
+
Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query  before any processing.

+	
+	

+		void
+		
+			PrepareTranslated
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		query (line 82)
+	
 
+	
+	
+
Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.

+	
+	

+		void
+		
+			query
+		
+					( $statement, 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			
    • 
+					
  • 
+				
+				$statement			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		Rollback (line 115)
+	
 
+	
+	
+
Cancel a transaction in progress.

+	
+	

+		void
+		
+			Rollback
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		TransactionState (line 130)
+	
 
+	
+	
+
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 147)
+	
 
+	
+	
+
Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated  as if PrepareTranslated() had been called.

+	
+	

+		void
+		
+			TranslateAll
+		
+					( $onoff_boolean)
+			

+	
+			
    
+					
  • 
+				
+				$onoff_boolean			
    • 
+				

+		
+			
+	

+							
Inherited Methods

+					
+									
+					
Inherited From AwlDBDialect

+					

+													 
+							AwlDBDialect::__construct()

+													 
+							AwlDBDialect::GetFields()

+													 
+							AwlDBDialect::GetVersion()

+													 
+							AwlDBDialect::Quote()

+													 
+							AwlDBDialect::ReplaceParameters()

+													 
+							AwlDBDialect::SetSearchPath()

+													 
+							AwlDBDialect::TranslateSQL()

+											

+										
+		

+	

+
+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html b/docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html
new file mode 100644
index 00000000..da21a4aa
--- /dev/null
+++ b/docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html
@@ -0,0 +1,70 @@
+
+
+  
+		
+			
+			Docs for page AwlDBDialect.php
+			
+			
+		
+		
+			
			

+
File/inc/AwlDBDialect.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+														

+	
	
+		
+
AwlDatabase - support for different SQL dialects

+
This subpackage provides dialect specific support for PostgreSQL, and  may, over time, be extended to provide support for other SQL dialects.
See http://wiki.davical.org/w/Coding/PdoDatabase for design and usage information.

+	
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+																	

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						AwlDBDialect
+					
+											The AwlDBDialect class handles
+										

+		

+	

+
+	
+	
+	
+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html b/docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html
new file mode 100644
index 00000000..449c2e42
--- /dev/null
+++ b/docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html
@@ -0,0 +1,111 @@
+
+
+  
+		
+			
+			Docs for page AwlDatabase.php
+			
+			
+		
+		
+			
			

+
File/inc/AwlDatabase.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|							Includes
+												

+	
	
+		
+
AwlDatabase query/statement class and associated functions

+
This subpackage provides some functions that are useful around database  activity and a AwlDialect, AwlDatabase and AwlStatement 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/AwlDatabase for design and usage information.
If not already connected, AwlDatabase 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

+		

+			Description |
+			Classes
+			|							Includes
+																		

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

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

+		

+	

+
+		
+	

+		
Includes

+		

+			Description |
+							Classes
+				|						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			require
+			('AwlDBDialect.php')
+			(line 37)
+		
+	

+
+	
+
AwlDatabase query/statement class and associated functions

+
This subpackage provides some functions that are useful around database  activity and a AwlDialect, AwlDatabase and AwlStatement 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/AwlDatabase for design and usage information.
If not already connected, AwlDatabase 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.

+	
+	
+

+		

+	

+	
+	
+	
+	
+	

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

+	

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

+
 Class DAVResource

+
+
+

+	
Description

+	

+					Description |
+													Vars (details)
+						|											Methods (details)
+						
+					

+	

+        		
+
A class for things to do with a DAV Resource

+		

+			Located in /inc/DAVResource.php (line 20)
+		

+		
+				
+		

+	
+			

+

+
+
+
+	
+	

+		
Variable Summary

+		

+			Description |
+						Vars (details)
+							| 
+									Methods (details)
+							
+								

+		

+			

+																																																																

+					 
+					The
+					$contenttype
+				

+																

+					 
+					The
+					$dav_name
+				

+																

+					 
+					Boolean:
+					$exists
+				

+																

+					 
+					The
+					$resource
+				

+																

+					 
+					The
+					$resourcetypes
+				

+																

+					 
+					The
+					$unique_tag
+				

+											

+		

+	

+
+	
+	

+		
Method Summary

+		

+			Description |
+																		Vars (details)
+				 
+				|
+						Methods (details)
+		

+		
			
+			

+																																																																																																																																																																																																																																																																																

+					 
+											DAVResource
+										__construct
+											([mixed $parameters = null])
+									

+																

+					 
+											void
+										BuildPrivileges
+											([ $privilege_names = null], [ &$xmldoc = null])
+									

+																

+					 
+											void
+										BuildSupportedMethods
+										()
+									

+																

+					 
+											void
+										BuildSupportedReports
+											( &$reply)
+									

+																

+					 
+											void
+										ContainerType
+										()
+									

+																

+					 
+											void
+										DAV_AllProperties
+										()
+									

+																

+					 
+											void
+										dav_name
+										()
+									

+																

+					 
+											void
+										Exists
+										()
+									

+																

+					 
+											void
+										FetchCollection
+										()
+									

+																

+					 
+											void
+										FetchDeadProperties
+										()
+									

+																

+					 
+											void
+										FetchPrincipal
+										()
+									

+																

+					 
+											void
+										FetchPrivileges
+										()
+									

+																

+					 
+											void
+										FetchResource
+										()
+									

+																

+					 
+											void
+										FetchSupportedMethods
+										()
+									

+																

+					 
+											void
+										FetchSupportedReports
+										()
+									

+																

+					 
+											void
+										FromPath
+											(object $inpath)
+									

+																

+					 
+											void
+										FromRow
+											(object $row)
+									

+																

+					 
+											void
+										GetProperty
+											( $name)
+									

+																

+					 
+											string
+										GetPropStat
+											(array $properties,  &$reply, [ $props_only = false])
+									

+																

+					 
+											void
+										HavePrivilegeTo
+											( $do_what)
+									

+																

+					 
+											void
+										IsAddressbook
+										()
+									

+																

+					 
+											void
+										IsCalendar
+										()
+									

+																

+					 
+											void
+										IsCollection
+										()
+									

+																

+					 
+											void
+										IsLocked
+											([ $depth = 0])
+									

+																

+					 
+											void
+										IsPrincipal
+										()
+									

+																

+					 
+											void
+										IsPublic
+										()
+									

+																

+					 
+											void
+										IsSchedulingCollection
+											([string $type = 'any'])
+									

+																

+					 
+											void
+										principal_url
+										()
+									

+																

+					 
+											void
+										Privileges
+										()
+									

+																

+					 
+											string
+										RenderAsXML
+											(array $properties,  &$reply, [boolean $props_only = false], reference $reply)
+									

+																

+					 
+											void
+										ResourceProperty
+											( $tag,  $prop,  &$reply,  &$denied)
+									

+																

+					 
+											void
+										unique_tag
+										()
+									

+											

+		

+	
		
+
+	
+	

+		
Variables

+		

+			Description |
+										Vars (details)
+						
+			
+										| 
+									Methods (details)
+							
+					

+		

+			
+
+

+
+	

+		
+		
+			The
+			$contenttype
+						(line 50)
+		
+	

+
+	
+	
    
+				
  • var: type of the content
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			The
+			$dav_name
+						(line 25)
+		
+	

+
+	
+	
    
+				
  • var: partial URL of the resource within our namespace
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			Boolean:
+			$exists
+						(line 30)
+		
+	

+
+	
+	
    
+				
  • var: does the resource actually exist yet?
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			The
+			$resource
+						(line 40)
+		
+	

+
+	
+	
    
+				
  • var: actual resource content, if it exists and is not a collection
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			The
+			$resourcetypes
+						(line 45)
+		
+	

+
+	
+	
    
+				
  • var: types of the resource, possibly multiple
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
+

+
+	

+		
+		
+			The
+			$unique_tag
+						(line 35)
+		
+	

+
+	
+	
    
+				
  • var: unique etag associated with the current version of the resource
    • 
+				
  • access: protected
    • 
+			

+	
+	
+		
+		
+
+

+
						
+		

+	

+	
+	
+	

+		
Methods

+		

+			Description |
+															Vars (details)
+														Methods (details)
+						
+		

+		

+			
+
+

+	
+	

+		
+		Constructor __construct (line 118)
+	
 
+	
+	
+
Constructor

+	
+	

+		DAVResource
+		
+			__construct
+		
+					([mixed $parameters = null])
+			

+	
+			
    
+					
  • 
+				mixed
+				$parameters: If null, an empty Resourced is created.      If it is an object then it is expected to be a record that was      read elsewhere.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		BuildPrivileges (line 509)
+	
 
+	
+	
+
Returns the array of privilege names converted into XMLElements

+	
+	

+		void
+		
+			BuildPrivileges
+		
+					([ $privilege_names = null], [ &$xmldoc = null])
+			

+	
+			
    
+					
  • 
+				
+				$privilege_names			
    • 
+					
  • 
+				
+				&$xmldoc			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		BuildSupportedMethods (line 602)
+	
 
+	
+	
+
Returns the array of supported methods converted into XMLElements

+	
+	

+		void
+		
+			BuildSupportedMethods
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		BuildSupportedReports (line 644)
+	
 
+	
+	
+
Returns the array of supported reports converted into XMLElements

+	
+	

+		void
+		
+			BuildSupportedReports
+		
+					( &$reply)
+			

+	
+			
    
+					
  • 
+				
+				&$reply			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		ContainerType (line 801)
+	
 
+	
+	
+
Return the type of whatever contains this resource, or would if it existed.

+	
+	

+		void
+		
+			ContainerType
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		DAV_AllProperties (line 880)
+	
 
+	
+	
+
Return an array which is an expansion of the DAV::allprop

+	
+	

+		void
+		
+			DAV_AllProperties
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		dav_name (line 758)
+	
 
+	
+	
+
Returns the dav_name of the resource in our internal namespace

+	
+	

+		void
+		
+			dav_name
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		Exists (line 740)
+	
 
+	
+	
+
Checks whether this resource actually exists, in the virtual sense, within the hierarchy

+	
+	

+		void
+		
+			Exists
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchCollection (line 257)
+	
 
+	
+	
+
Find the collection associated with this resource.

+	
+	

+		void
+		
+			FetchCollection
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchDeadProperties (line 433)
+	
 
+	
+	
+
Fetch any dead properties for this URL

+	
+	

+		void
+		
+			FetchDeadProperties
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchPrincipal (line 384)
+	
 
+	
+	
+
Find the principal associated with this resource.

+	
+	

+		void
+		
+			FetchPrincipal
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchPrivileges (line 449)
+	
 
+	
+	
+
Build permissions for this URL

+	
+	

+		void
+		
+			FetchPrivileges
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchResource (line 401)
+	
 
+	
+	
+
Retrieve the actual resource.

+	
+	

+		void
+		
+			FetchResource
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchSupportedMethods (line 532)
+	
 
+	
+	
+
Returns the array of supported methods

+	
+	

+		void
+		
+			FetchSupportedMethods
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FetchSupportedReports (line 616)
+	
 
+	
+	
+
Returns the array of supported reports

+	
+	

+		void
+		
+			FetchSupportedReports
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		FromPath (line 237)
+	
 
+	
+	
+
Initialise from a path

+	
+	

+		void
+		
+			FromPath
+		
+					(object $inpath)
+			

+	
+			
    
+					
  • 
+				object
+				$inpath: The path to populate the resource data from			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		FromRow (line 155)
+	
 
+	
+	
+
Initialise from a database row

+	
+	

+		void
+		
+			FromRow
+		
+					(object $row)
+			

+	
+			
    
+					
  • 
+				object
+				$row: The row from the DB.			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		GetProperty (line 835)
+	
 
+	
+	
+
Return general server-related properties, in plain form

+	
+	

+		void
+		
+			GetProperty
+		
+					( $name)
+			

+	
+			
    
+					
  • 
+				
+				$name			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		GetPropStat (line 1064)
+	
 
+	
+	
+
Construct XML propstat fragment for this resource

+	
    
+				
  • return: An XML fragment with the requested properties for this resource
    • 
+			

+	
+	

+		string
+		
+			GetPropStat
+		
+					(array $properties,  &$reply, [ $props_only = false])
+			

+	
+			
    
+					
  • 
+				array
+				$properties: of string $properties The requested properties for this resource			
    • 
+					
  • 
+				
+				&$reply			
    • 
+					
  • 
+				
+				$props_only			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		HavePrivilegeTo (line 498)
+	
 
+	
+	
+
Is the user has the privileges to do what is requested.

+	
+	

+		void
+		
+			HavePrivilegeTo
+		
+					( $do_what)
+			

+	
+			
    
+					
  • 
+				
+				$do_what			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		IsAddressbook (line 732)
+	
 
+	
+	
+
Checks whether this resource is an addressbook

+	
+	

+		void
+		
+			IsAddressbook
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		IsCalendar (line 712)
+	
 
+	
+	
+
Checks whether this resource is a calendar

+	
+	

+		void
+		
+			IsCalendar
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		IsCollection (line 696)
+	
 
+	
+	
+
Checks whether this resource is a collection

+	
+	

+		void
+		
+			IsCollection
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		IsLocked (line 664)
+	
 
+	
+	
+
Checks whether the resource is locked, returning any lock token, or false

+	
    
+				
  • todo: This logic does not catch all locking scenarios.  For example an infinite  depth request should check the permissions for all collections and resources within  that.  At present we only maintain permissions on a per-collection basis though.
    • 
+			

+	
+	

+		void
+		
+			IsLocked
+		
+					([ $depth = 0])
+			

+	
+			
    
+					
  • 
+				
+				$depth			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		IsPrincipal (line 704)
+	
 
+	
+	
+
Checks whether this resource is a principal

+	
+	

+		void
+		
+			IsPrincipal
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		IsPublic (line 793)
+	
 
+	
+	
+
Checks whether the target collection is publicly_readable

+	
+	

+		void
+		
+			IsPublic
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		IsSchedulingCollection (line 721)
+	
 
+	
+	
+
Checks whether this resource is a calendar

+	
+	

+		void
+		
+			IsSchedulingCollection
+		
+					([string $type = 'any'])
+			

+	
+			
    
+					
  • 
+				string
+				$type: The type of scheduling collection, 'read', 'write' or 'any'			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		principal_url (line 767)
+	
 
+	
+	
+
Returns the principal-URL for this resource

+	
+	

+		void
+		
+			principal_url
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		Privileges (line 489)
+	
 
+	
+	
+
Return the privileges bits for the current session user to this resource

+	
+	

+		void
+		
+			Privileges
+		
+				()
+			

+	
+		
+			
+	

+
+

+	
+	

+		
+		RenderAsXML (line 1123)
+	
 
+	
+	
+
Render XML for this resource

+	
    
+				
  • return: An XML fragment with the requested properties for this principal
    • 
+			

+	
+	

+		string
+		
+			RenderAsXML
+		
+					(array $properties,  &$reply, [boolean $props_only = false], reference $reply)
+			

+	
+			
    
+					
  • 
+				array
+				$properties: The requested properties for this principal			
    • 
+					
  • 
+				reference
+				$reply: A reference to the XMLDocument being used for the reply			
    • 
+					
  • 
+				boolean
+				$props_only: Default false.  If true will only return the fragment with the properties, not a full response fragment.			
    • 
+					
  • 
+				
+				&$reply			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		ResourceProperty (line 897)
+	
 
+	
+	
+
Return general server-related properties for this URL

+	
+	

+		void
+		
+			ResourceProperty
+		
+					( $tag,  $prop,  &$reply,  &$denied)
+			

+	
+			
    
+					
  • 
+				
+				$tag			
    • 
+					
  • 
+				
+				$prop			
    • 
+					
  • 
+				
+				&$reply			
    • 
+					
  • 
+				
+				&$denied			
    • 
+				

+		
+			
+	

+
+

+	
+	

+		
+		unique_tag (line 779)
+	
 
+	
+	
+
Returns the principal-URL for this resource

+	
+	

+		void
+		
+			unique_tag
+		
+				()
+			

+	
+		
+			
+	

+						
+		

+	

+
+	
+	

+		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/Resource/_inc---DAVResource.php.html b/docs/api/davical/Resource/_inc---DAVResource.php.html
new file mode 100644
index 00000000..7da4b299
--- /dev/null
+++ b/docs/api/davical/Resource/_inc---DAVResource.php.html
@@ -0,0 +1,97 @@
+
+
+  
+		
+			
+			Docs for page DAVResource.php
+			
+			
+		
+		
+			
			

+
File/inc/DAVResource.php

+
+
+

+	
Description

+	

+					Description |
+							Classes
+			|							Includes
+												

+	
	
+		
+
An object representing a DAV 'resource'

+	
+		
+			

+

+		
+		
+	

+		
Classes

+		

+			Description |
+			Classes
+			|							Includes
+																		

+		
	
+			
+				
+					
+					
+				
+								
+					
+					
+				
+							
ClassDescription

+						 class
+						DAVResource
+					
+											A class for things to do with a DAV Resource
+										

+		

+	

+
+		
+	

+		
Includes

+		

+			Description |
+							Classes
+				|						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			('AwlQuery.php')
+			(line 12)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/_htdocs---browse.php.html b/docs/api/davical/_htdocs---browse.php.html
new file mode 100644
index 00000000..7499613a
--- /dev/null
+++ b/docs/api/davical/_htdocs---browse.php.html
@@ -0,0 +1,152 @@
+
+
+  
+		
+			
+			Docs for page browse.php
+			
+			
+		
+		
+			
			

+
File/htdocs/browse.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			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---davical.php.html b/docs/api/davical/_htdocs---davical.php.html
new file mode 100644
index 00000000..a3865e8a
--- /dev/null
+++ b/docs/api/davical/_htdocs---davical.php.html
@@ -0,0 +1,212 @@
+
+
+  
+		
+			
+			Docs for page davical.php
+			
+			
+		
+		
+			
			

+
File/htdocs/davical.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			include
+			(page-footer.php)
+			(line 50)
+		
+	

+
+	
+
Page elements could be an array of viewers, browsers or something else  that supports the Render() method... or a non-object which we assume is  just a string of text that we echo.

+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-header.php)
+			(line 28)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(DAViCalSession.php)
+			(line 5)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-header.php)
+			(line 23)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-footer.php)
+			(line 24)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include_once
+			($code_file)
+			(line 21)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			require_once
+			('../inc/always.php')
+			(line 2)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			require_once
+			(AwlQuery.php)
+			(line 8)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			require_once
+			('classBrowser.php')
+			(line 4)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			require_once
+			('classEditor.php')
+			(line 3)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			require_once
+			(interactive-page.php)
+			(line 17)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/_htdocs---edit.php.html b/docs/api/davical/_htdocs---edit.php.html
new file mode 100644
index 00000000..7a2916c1
--- /dev/null
+++ b/docs/api/davical/_htdocs---edit.php.html
@@ -0,0 +1,152 @@
+
+
+  
+		
+			
+			Docs for page edit.php
+			
+			
+		
+		
+			
			

+
File/htdocs/edit.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			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/_htdocs---setup.php.html b/docs/api/davical/_htdocs---setup.php.html
new file mode 100644
index 00000000..eda27aa8
--- /dev/null
+++ b/docs/api/davical/_htdocs---setup.php.html
@@ -0,0 +1,121 @@
+
+
+  
+		
+			
+			Docs for page setup.php
+			
+			
+		
+		
+			
			

+
File/htdocs/setup.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			include
+			("../inc/always.php")
+			(line 3)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(DAViCalSession.php)
+			(line 4)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(interactive-page.php)
+			(line 7)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-header.php)
+			(line 8)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-footer.php)
+			(line 25)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/_htdocs---test.php.html b/docs/api/davical/_htdocs---test.php.html
new file mode 100644
index 00000000..8a8cc02d
--- /dev/null
+++ b/docs/api/davical/_htdocs---test.php.html
@@ -0,0 +1,76 @@
+
+
+  
+		
+			
+			Docs for page test.php
+			
+			
+		
+		
+			
			

+
File/htdocs/test.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			include
+			("../inc/always.php")
+			(line 2)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			("iCalendar.php")
+			(line 4)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/_htdocs---upgrade.php.html b/docs/api/davical/_htdocs---upgrade.php.html
new file mode 100644
index 00000000..587c4025
--- /dev/null
+++ b/docs/api/davical/_htdocs---upgrade.php.html
@@ -0,0 +1,137 @@
+
+
+  
+		
+			
+			Docs for page upgrade.php
+			
+			
+		
+		
+			
			

+
File/htdocs/upgrade.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			include
+			("../inc/always.php")
+			(line 10)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			("./caldav.php")
+			(line 6)
+		
+	

+
+	
+
If the request is not a GET or POST then they must really want caldav.php!

+	
+

+
+

+	
+	

+		 
+		
+			include
+			(DAViCalSession.php)
+			(line 11)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(interactive-page.php)
+			(line 14)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-footer.php)
+			(line 69)
+		
+	

+
+	
+	
+

+
+

+	
+	

+		 
+		
+			include
+			(page-header.php)
+			(line 15)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/_inc---auth-famjama.php.html b/docs/api/davical/_inc---auth-famjama.php.html
new file mode 100644
index 00000000..edb4fef1
--- /dev/null
+++ b/docs/api/davical/_inc---auth-famjama.php.html
@@ -0,0 +1,74 @@
+
+
+  
+		
+			
+			Docs for page auth-famjama.php
+			
+			
+		
+		
+			
			

+
File/inc/auth-famjama.php

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		AuthFamjama (line 3)
+	
 
+
+	
+	

+		void
+		
+			AuthFamjama
+		
+					( $username,  $password)
+			

+
+			
    
+					
  • 
+				
+				$username			
    • 
+					
  • 
+				
+				$password			
    • 
+				

+		
+	
+

+		

+	

+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/davical/_inc---caldav-REPORT-expand-property.php.html b/docs/api/davical/_inc---caldav-REPORT-expand-property.php.html
new file mode 100644
index 00000000..824a6621
--- /dev/null
+++ b/docs/api/davical/_inc---caldav-REPORT-expand-property.php.html
@@ -0,0 +1,132 @@
+
+
+  
+		
+			
+			Docs for page caldav-REPORT-expand-property.php
+			
+			
+		
+		
+			
			

+
File/inc/caldav-REPORT-expand-property.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+			|											Functions
+			

+	
	
+		
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+			|													Functions
+					

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			('DAVResource.php')
+			(line 3)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+										Includes
+				|												Functions
+		

+		
	
+			
+

+	
+	

+		
+		expand_properties (line 46)
+	
 
+
+	
+
Expand the properties, recursing as needed

+	

+		void
+		
+			expand_properties
+		
+					( $urls,  $ptree,  &$reply)
+			

+
+			
    
+					
  • 
+				
+				$urls			
    • 
+					
  • 
+				
+				$ptree			
    • 
+					
  • 
+				
+				&$reply			
    • 
+				

+		
+	
+

+
+

+	
+	

+		
+		get_href_containers (line 10)
+	
 
+
+	
+
Given a <response><href>...</href><propstat><prop><someprop/></prop><status>HTTP/1.1 200 OK</status></propstat>...</response>  pull out the content of <someprop>content</someprop> and check to see if it has any href elements.  If it *does* then  recurse into them, looking for the next deeper nesting of properties.

+	

+		void
+		
+			get_href_containers
+		
+					( &$multistatus_response)
+			

+
+			
    
+					
  • 
+				
+				&$multistatus_response			
    • 
+				

+		
+	
+

+		

+	

+	
+	

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

+	

+
\ No newline at end of file
diff --git a/docs/api/davical/_inc---ui---collection-edit.php.html b/docs/api/davical/_inc---ui---collection-edit.php.html
new file mode 100644
index 00000000..62bbef93
--- /dev/null
+++ b/docs/api/davical/_inc---ui---collection-edit.php.html
@@ -0,0 +1,34 @@
+
+
+  
+		
+			
+			Docs for page collection-edit.php
+			
+			
+		
+		
+			
			

+
File/inc/ui/collection-edit.php

+
+
+

+	
Description

+	

+													

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+	
+	

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

+	

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

+
File/inc/ui/principal-browse.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/_inc---ui---principal-edit.php.html b/docs/api/davical/_inc---ui---principal-edit.php.html
new file mode 100644
index 00000000..26128951
--- /dev/null
+++ b/docs/api/davical/_inc---ui---principal-edit.php.html
@@ -0,0 +1,71 @@
+
+
+  
+		
+			
+			Docs for page principal-edit.php
+			
+			
+		
+		
+			
			

+
File/inc/ui/principal-edit.php

+
+
+

+	
Description

+	

+					Description |
+															Functions
+			

+	
	
+		
+		
+			

+

+		
+
+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+															Functions
+		

+		
	
+			
+

+	
+	

+		
+		edit_group_row (line 219)
+	
 
+
+	
+	

+		void
+		
+			edit_group_row
+		
+					( $row_data)
+			

+
+			
    
+					
  • 
+				
+				$row_data			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		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/_inc---ui---principal-view.php.html b/docs/api/davical/_inc---ui---principal-view.php.html
new file mode 100644
index 00000000..6319ada8
--- /dev/null
+++ b/docs/api/davical/_inc---ui---principal-view.php.html
@@ -0,0 +1,34 @@
+
+
+  
+		
+			
+			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-MKCOL.php.html b/docs/api/davical/caldav/_inc---caldav-MKCOL.php.html
new file mode 100644
index 00000000..a988eb47
--- /dev/null
+++ b/docs/api/davical/caldav/_inc---caldav-MKCOL.php.html
@@ -0,0 +1,73 @@
+
+
+  
+		
+			
+			Docs for page caldav-MKCOL.php
+			
+			
+		
+		
+			
			

+
File/inc/caldav-MKCOL.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+												

+	
	
+		
+
CalDAV Server - handle MKCOL and MKCALENDAR method

+	
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+														

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			('XMLDocument.php')
+			(line 38)
+		
+	

+
+	
+
CalDAV Server - handle MKCOL and MKCALENDAR method

+	
+	
+

+		

+	

+	
+	
+	
+	
+	

+		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/caldav/_inc---caldav-MOVE.php.html b/docs/api/davical/caldav/_inc---caldav-MOVE.php.html
new file mode 100644
index 00000000..97cb36bf
--- /dev/null
+++ b/docs/api/davical/caldav/_inc---caldav-MOVE.php.html
@@ -0,0 +1,107 @@
+
+
+  
+		
+			
+			Docs for page caldav-MOVE.php
+			
+			
+		
+		
+			
			

+
File/inc/caldav-MOVE.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+			|											Functions
+			

+	
	
+		
+
CalDAV Server - handle MOVE method

+	
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+			|													Functions
+					

+		
	
+			
+

+	
+	

+		 
+		
+			require_once
+			('DAVResource.php')
+			(line 13)
+		
+	

+
+	
+	
+

+		

+	

+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+										Includes
+				|												Functions
+		

+		
	
+			
+

+	
+	

+		
+		rollback (line 94)
+	
 
+
+	
+
RFC2068, 14.25:  If none of the entity tags match, or if "*" is given and no current  entity exists, the server MUST NOT perform the requested method, and  MUST return a 412 (Precondition Failed) response.

+
RFC2068, 14.26:  If any of the entity tags match the entity tag of the entity that  would have been returned in the response to a similar GET request  (without the If-None-Match header) on that resource, or if "*" is  given and any current entity exists for that resource, then the  server MUST NOT perform the requested method.

+	

+		void
+		
+			rollback
+		
+					([ $response_code = 412])
+			

+
+			
    
+					
  • 
+				
+				$response_code			
    • 
+				

+		
+	
+

+		

+	

+	
+	

+		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/caldav/_inc---caldav-REPORT-sync-collection.php.html b/docs/api/davical/caldav/_inc---caldav-REPORT-sync-collection.php.html
new file mode 100644
index 00000000..8f278e62
--- /dev/null
+++ b/docs/api/davical/caldav/_inc---caldav-REPORT-sync-collection.php.html
@@ -0,0 +1,112 @@
+
+
+  
+		
+			
+			Docs for page caldav-REPORT-sync-collection.php
+			
+			
+		
+		
+			
			

+
File/inc/caldav-REPORT-sync-collection.php

+
+
+

+	
Description

+	

+					Description |
+									Includes
+			|											Functions
+			

+	
	
+		
+
CalDAV Server - handle sync-collection report (draft-daboo-webdav-sync-01)

+	
+		
+			

+

+		
+
+		
+	

+		
Includes

+		

+			Description |
+						Includes
+			|													Functions
+					

+		
	
+			
+

+	
+	

+		 
+		
+			require
+			("DAVResource.php")
+			(line 12)
+		
+	

+
+	
+
CalDAV Server - handle sync-collection report (draft-daboo-webdav-sync-01)

+	
+	
+

+		

+	

+	
+	
+	
+		
+	

+		
Functions

+		

+			Description |
+										Includes
+				|												Functions
+		

+		
	
+			
+

+	
+	

+		
+		display_status (line 33)
+	
 
+
+	
+
Build the array of properties to include in the report output

+	

+		void
+		
+			display_status
+		
+					( $status_code)
+			

+
+			
    
+					
  • 
+				
+				$status_code			
    • 
+				

+		
+	
+

+		

+	

+	
+	

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

+	

+
\ No newline at end of file