diff --git a/docs/api/awl/AWLDB/AwlQuery.html b/docs/api/awl/AWLDB/AwlQuery.html deleted file mode 100644 index bcd32a24..00000000 --- a/docs/api/awl/AWLDB/AwlQuery.html +++ /dev/null @@ -1,805 +0,0 @@ - - - - - - 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 453)
-	
 
-	
-	
-
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 Thu, 25 Feb 2010 11:39:17 +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
deleted file mode 100644
index f91a7c6f..00000000
--- a/docs/api/awl/AWLDB/_inc---AwlQuery.php.html
+++ /dev/null
@@ -1,165 +0,0 @@
-
-
-  
-		
-			
-			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 Thu, 25 Feb 2010 11:39:17 +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
deleted file mode 100644
index 23b670c5..00000000
--- a/docs/api/awl/AwlDatabase/AwlDBDialect.html
+++ /dev/null
@@ -1,496 +0,0 @@
-
-
-  
-		
-			
-			Docs For Class AwlDBDialect
-			
-			
-		
-		
-			
			

-
 Class AwlDBDialect

-
-
-

-	
Description

-	

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

-	

-        		
-
The AwlDBDialect class handles 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.
If you are looking for the place to add support for other SQL dialects,  this is the class that you should be looking at.  You might also look at  the AwlDatabase class which extends this one, but these are the core  capabilities which most probably need attention.

-		

-			Located in /inc/AwlDBDialect.php (line 33)
-		

-		
-				
-		

-	
-			

-

-
-	
-	

-		
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
-										ReplaceNamedParameters
-											(string 0, mixed 1)
-									

-																

-					 
-											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 46)
-		
-	

-
-	
-
Holds the PDO database connection

-	
    
-				
  • access: protected
    • 
-			

-	
-	
-		
-		
-
-

-
-

-
-	

-		
-		
-			mixed
-			$dialect
-						(line 41)
-		
-	

-
-	
-
Holds the name of the database dialect

-	
    
-				
  • access: protected
    • 
-			

-	
-	
-		
-		
-
-

-
						
-		

-	

-	
-	
-	

-		
Methods

-		

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

-		

-			
-
-

-	
-	

-		
-		Constructor __construct (line 68)
-	
 
-	
-	
-
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 134)
-	
 
-	
-	
-
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 105)
-	
 
-	
-	
-
Sets the current search path for the database.

-	
-	

-		void
-		
-			GetVersion
-		
-					(handle $pdo)
-			

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

-		
-			
-	

-
-

-	
-	

-		
-		Quote (line 178)
-	
 
-	
-	
-
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 the type of the $value.  The special type                 of 'identifier' can also be used for escaping of SQL identifiers.			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		ReplaceNamedParameters (line 322)
-	
 
-	
-	
-
Replaces named query parameters of the form :name with appropriately  escaped substitutions.

-
The function takes a variable number of arguments, the first is the  SQL string, with replaceable ':name' 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).

-	
    
-				
  • return: built query string
    • 
-			

-	
-	

-		The
-		
-			ReplaceNamedParameters
-		
-					(string 0, mixed 1)
-			

-	
-			
    
-					
  • 
-				string
-				0: The query string with replacable ':name' identifiers			
    • 
-					
  • 
-				mixed
-				1: A ':name' => 'value' hash of values to replace into the  SQL string.			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		ReplaceParameters (line 266)
-	
 
-	
-	
-
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 87)
-	
 
-	
-	
-
Sets the current search path for the database.

-	
-	

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

-	
-			
    
-					
  • 
-				
-				$search_path			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		TranslateSQL (line 164)
-	
 
-	
-	
-
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 Sat, 17 Apr 2010 12:32:23 +1200 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
deleted file mode 100644
index 376ce115..00000000
--- a/docs/api/awl/AwlDatabase/AwlDatabase.html
+++ /dev/null
@@ -1,490 +0,0 @@
-
-
-  
-		
-			
-			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 58)
-		

-		
-				
-		
AwlDBDialect
-   |
-   --AwlDatabase

-	
-			

-

-
-
-
-	
-	

-		
Variable Summary

-		

-			Description |
-						Vars (details)
-							| 
-									Methods (details)
-							
-								

-		

-			

-																																

-					 
-					mixed
-					$translate_all
-				

-																

-					 
-					mixed
-					$txnstate
-				

-											

-		

-	

-
-	
-	

-		
Method Summary

-		

-			Description |
-																		Vars (details)
-				 
-				|
-						Methods (details)
-		

-		
			
-			

-																																																																																								

-					 
-											void
-										Begin
-										()
-									

-																

-					 
-											void
-										Commit
-										()
-									

-																

-					 
-											void
-										ErrorInfo
-										()
-									

-																

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

-																

-					 
-											void
-										PrepareTranslated
-											( $statement, [ $driver_options = array()])
-									

-																

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

-																

-					 
-											void
-										Rollback
-										()
-									

-																

-					 
-											void
-										TransactionState
-										()
-									

-																

-					 
-											void
-										TranslateAll
-											( $onoff_boolean)
-									

-											

-		

-	
		
-
-	
-	

-		
Variables

-		

-			Description |
-										Vars (details)
-						
-			
-										| 
-									Methods (details)
-							
-					

-		

-			
-
-

-
-	

-		
-		
-			mixed
-			$translate_all
-			 =  false			(line 71)
-		
-	

-
-	
-
Holds whether we are translating all statements.

-	
    
-				
  • access: protected
    • 
-			

-	
-	
-		
-		
-
-

-
-

-
-	

-		
-		
-			mixed
-			$txnstate
-			 =  0			(line 66)
-		
-	

-
-	
-
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 101)
-	
 
-	
-	
-
Begin a transaction.

-	
-	

-		void
-		
-			Begin
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		Commit (line 116)
-	
 
-	
-	
-
Complete a transaction.

-	
-	

-		void
-		
-			Commit
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		ErrorInfo (line 172)
-	
 
-	
-	
-	
-	

-		void
-		
-			ErrorInfo
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		prepare (line 80)
-	
 
-	
-	
-
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 153)
-	
 
-	
-	
-
Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query  before any processing.

-	
-	

-		void
-		
-			PrepareTranslated
-		
-					( $statement, [ $driver_options = array()])
-			

-	
-			
    
-					
  • 
-				
-				$statement			
    • 
-					
  • 
-				
-				$driver_options			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		query (line 93)
-	
 
-	
-	
-
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 128)
-	
 
-	
-	
-
Cancel a transaction in progress.

-	
-	

-		void
-		
-			Rollback
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		TransactionState (line 144)
-	
 
-	
-	
-
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 163)
-	
 
-	
-	
-
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::ReplaceNamedParameters()

-													 
-							AwlDBDialect::ReplaceParameters()

-													 
-							AwlDBDialect::SetSearchPath()

-													 
-							AwlDBDialect::TranslateSQL()

-											

-										
-		

-	

-
-	
-	

-		Documentation generated on Sat, 17 Apr 2010 12:32:22 +1200 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
deleted file mode 100644
index a6a6aa71..00000000
--- a/docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html
+++ /dev/null
@@ -1,98 +0,0 @@
-
-
-  
-		
-			
-			Docs for page AwlDBDialect.php
-			
-			
-		
-		
-			
			

-
File/inc/AwlDBDialect.php

-
-
-

-	
Description

-	

-					Description |
-							Classes
-			|									Constants
-										

-	
	
-		
-
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/AwlQuery for design and usage information.

-	
-		
-			

-

-		
-		
-	

-		
Classes

-		

-			Description |
-			Classes
-			|										Constants
-															

-		
	
-			
-				
-					
-					
-				
-								
-					
-					
-				
-							
ClassDescription

-						 class
-						AwlDBDialect
-					
-											The AwlDBDialect class handles support for different SQL dialects
-										

-		

-	

-
-	
-		
-	

-		
Constants

-		

-			Description |
-							Classes
-				|									Constants
-											

-		
	
-			
-

-	
-	

-		
-		
-			E_USER_ERROR = 256
-			(line 18)
-		
-	

-	
-	
-	
-		
-

-		

-	

-	
-	
-	
-	

-		Documentation generated on Sat, 17 Apr 2010 12:32:23 +1200 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
deleted file mode 100644
index 255d9d79..00000000
--- a/docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html
+++ /dev/null
@@ -1,101 +0,0 @@
-
-
-  
-		
-			
-			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 AwlDBDialect, 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)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Sat, 17 Apr 2010 12:32:22 +1200 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/users.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-			|											Functions
-			

-	
	
-		
-
Display a list of all users

-	
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-			|													Functions
-					

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 65)
-		
-	

-
-	
-	
-

-
-

-	
-	

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

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 12)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('classBrowser.php')
-			(line 38)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('../inc/always.php')
-			(line 11)
-		
-	

-
-	
-
Display a list of all users

-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(interactive-page.php)
-			(line 15)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-		
-	

-		
Functions

-		

-			Description |
-										Includes
-				|												Functions
-		

-		
	
-			
-

-	
-	

-		
-		translate_relationship_list (line 22)
-	
 
-
-	
-
Translate relationship names in the relationship_list for each user. See  the documentation for classBrowser::BrowserColumn for the definition of  the hook function parameters.

-	

-		void
-		
-			translate_relationship_list
-		
-					( $value,  $field,  $row)
-			

-
-			
    
-					
  • 
-				
-				$value			
    • 
-					
  • 
-				
-				$field			
    • 
-					
  • 
-				
-				$row			
    • 
-				

-		
-	
-

-		

-	

-	
-	

-		Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
 Class DAViCalUser

-
-
-

-	
Description

-	

-					Description |
-													Vars (details)
-						|											Methods (details)
-						
-					

-	

-        		
-
A class for viewing and maintaining DAViCal User records

-		

-			Located in /inc/DAViCalUser.php (line 27)
-		

-		
-				
-		
User
-   |
-   --DAViCalUser

-	
-			

-

-
-
-
-	
-	

-		
Variable Summary

-		

-			Description |
-						Vars (details)
-							| 
-									Methods (details)
-							
-								

-		

-			

-																																

-					 
-					mixed
-					$delete_collection_confirmation_required
-				

-																

-					 
-					mixed
-					$delete_user_confirmation_required
-				

-											

-		

-	

-
-	
-	

-		
Method Summary

-		

-			Description |
-																		Vars (details)
-				 
-				|
-						Methods (details)
-		

-		
			
-			

-																																																																																								

-					 
-											DAViCalUser
-										DAViCalUser
-											( $id, [ $prefix = ''])
-									

-																

-					 
-											boolean
-										AllowedTo
-											(string $whatever)
-									

-																

-					 
-											void
-										HandleAction
-											( $action)
-									

-																

-					 
-											string
-										Render
-											([ $title = ''])
-									

-																

-					 
-											string
-										RenderCollections
-											( $ef, [ $title = null])
-									

-																

-					 
-											string
-										RenderRelationshipsFrom
-											( $ef, [ $title = null])
-									

-																

-					 
-											string
-										RenderRelationshipsTo
-											( $ef, [ $title = null])
-									

-																

-					 
-											boolean
-										Validate
-										()
-									

-																

-					 
-											void
-										Write
-										()
-									

-											

-		

-	
		
-
-	
-	

-		
Variables

-		

-			Description |
-										Vars (details)
-						
-			
-										| 
-									Methods (details)
-							
-					

-		

-			
-
-

-
-	

-		
-		
-			mixed
-			$delete_collection_confirmation_required
-						(line 30)
-		
-	

-
-	
-	
-	
-		
-		
-
-

-
-

-
-	

-		
-		
-			mixed
-			$delete_user_confirmation_required
-						(line 31)
-		
-	

-
-	
-	
-	
-		
-		
-
-

-
						
-		

-	

-	
-	
-	

-		
Methods

-		

-			Description |
-															Vars (details)
-														Methods (details)
-						
-		

-		

-			
-
-

-	
-	

-		
-		Constructor DAViCalUser (line 36)
-	
 
-	
-	
-
Constructor - nothing fancy as yet.

-	
-	

-		DAViCalUser
-		
-			DAViCalUser
-		
-					( $id, [ $prefix = ''])
-			

-	
-			
    
-					
  • 
-				
-				$id			
    • 
-					
  • 
-				
-				$prefix			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		AllowedTo (line 321)
-	
 
-	
-	
-
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 349)
-	
 
-	
-	
-
Handle any unusual actions we might invent

-	
-	

-		void
-		
-			HandleAction
-		
-					( $action)
-			

-	
-			
    
-					
  • 
-				
-				$action			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		Render (line 52)
-	
 
-	
-	
-
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 242)
-	
 
-	
-	
-
Render the user's collections

-	
    
-				
  • return: The string of html to be output
    • 
-			

-	
-	

-		string
-		
-			RenderCollections
-		
-					( $ef, [ $title = null])
-			

-	
-			
    
-					
  • 
-				
-				$ef			
    • 
-					
  • 
-				
-				$title			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		RenderRelationshipsFrom (line 109)
-	
 
-	
-	
-
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 158)
-	
 
-	
-	
-
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 311)
-	
 
-	
-	
-
Validate the information the user submitted

-	
    
-				
  • return: Whether the form data validated OK.
    • 
-			

-	
-	

-		boolean
-		
-			Validate
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		Write (line 424)
-	
 
-	
-	
-
Write the record to the file

-	
-	

-		void
-		
-			Write
-		
-				()
-			

-	
-		
-			
-	

-						
-		

-	

-
-	
-	

-		Documentation generated on Thu, 25 Feb 2010 11:39:19 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/inc/DAViCalUser.php

-
-
-

-	
Description

-	

-					Description |
-							Classes
-			|							Includes
-												

-	
	
-		
-
User maintain / view with DAViCal specific associated tables

-	
-		
-			

-

-		
-		
-	

-		
Classes

-		

-			Description |
-			Classes
-			|							Includes
-																		

-		
	
-			
-				
-					
-					
-				
-								
-					
-					
-				
-							
ClassDescription

-						 class
-						DAViCalUser
-					
-											A class for viewing and maintaining DAViCal User records
-										

-		

-	

-
-		
-	

-		
Includes

-		

-			Description |
-							Classes
-				|						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			require
-			('caldav-PUT-functions.php')
-			(line 17)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require
-			('User.php')
-			(line 14)
-		
-	

-
-	
-
User maintain / view with DAViCal specific associated tables

-	
-	
-

-
-

-	
-	

-		 
-		
-			require
-			('check_UTF8.php')
-			(line 16)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('classBrowser.php')
-			(line 15)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Thu, 25 Feb 2010 11:39:19 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/collection.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 44)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			(page-footer.php)
-			(line 13)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 12)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			(page-footer.php)
-			(line 48)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("../inc/always.php")
-			(line 2)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("classBrowser.php")
-			(line 17)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(interactive-page.php)
-			(line 6)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 3)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Thu, 25 Feb 2010 11:39:19 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/relationship_types.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 98)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			(page-footer.php)
-			(line 108)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(interactive-page.php)
-			(line 6)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("../inc/always.php")
-			(line 2)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 3)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("DataUpdate.php")
-			(line 9)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("classBrowser.php")
-			(line 10)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("DataEntry.php")
-			(line 8)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Thu, 25 Feb 2010 11:39:21 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/roles.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 36)
-		
-	

-
-	
-	
-

-
-

-	
-	

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

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("../inc/always.php")
-			(line 2)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 3)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("classBrowser.php")
-			(line 9)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(interactive-page.php)
-			(line 6)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Tue, 23 Feb 2010 23:26:38 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/testpdo.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			require
-			(AwlQuery.php)
-			(line 8)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("../inc/always.php")
-			(line 2)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 3)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/htdocs/usr.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			(page-header.php)
-			(line 65)
-		
-	

-
-	
-
Handle any actions, such as 'delete_relation'

-	
-

-
-

-	
-	

-		 
-		
-			include
-			(page-footer.php)
-			(line 67)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			("../inc/always.php")
-			(line 2)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalSession.php)
-			(line 3)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(DAViCalUser.php)
-			(line 9)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			(interactive-page.php)
-			(line 7)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by phpDocumentor 1.3.2
-	

-	

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

-
File/inc/always.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-			|							Constants
-			|									Functions
-			

-	
	
-		
-	
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-			|							Constants
-				|													Functions
-					

-		
	
-			
-

-	
-	

-		 
-		
-			include
-			('../config/config.php')
-			(line 104)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			('davical_configuration_missing.php')
-			(line 107)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			('/etc/davical/config.php')
-			(line 95)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			('/usr/local/etc/davical/config.php')
-			(line 101)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			include
-			('/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php')
-			(line 92)
-		
-	

-
-	
-
We use @file_exists because things like open_basedir might noisily deny  access which could break DAViCal completely by causing output to start  too early.

-	
-

-
-

-	
-	

-		 
-		
-			include
-			('/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php')
-			(line 98)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('AWLUtilities.php')
-			(line 63)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('PgQuery.php')
-			(line 149)
-		
-	

-
-	
-
Force the domain name to what was in the configuration file

-	
-

-		

-	

-	
-		
-	

-		
Constants

-		

-			Description |
-										Includes
-				|						Constants
-			|										Functions
-					

-		
	
-			
-

-	
-	

-		
-		
-			DAVICAL_MAXPRIV = "65535"
-			(line 357)
-		
-	

-	
-	
-
Given a privilege string, or an array of privilege strings, return a bit mask  of the privileges.

-	
    
-				
  • return: A bit mask of the privileges.
    • 
-			

-	
-		
-

-		

-	

-	
-	
-		
-	

-		
Functions

-		

-			Description |
-										Includes
-				|										Constants
-				|									Functions
-		

-		
	
-			
-

-	
-	

-		
-		bits_to_privilege (line 408)
-	
 
-
-	
-
Given a bit mask of the privileges, will return an array of the  text values of privileges.

-	
    
-				
  • return: The string (or array of strings) of privilege names
    • 
-			

-	

-		mixed
-		
-			bits_to_privilege
-		
-					(integer $raw_bits)
-			

-
-			
    
-					
  • 
-				integer
-				$raw_bits: A bit mask of the privileges.			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		ConstructURL (line 278)
-	
 
-
-	
-
Construct a URL from the supplied dav_name.  The URL will be urlencoded,  except for any '/' characters in it.

-	

-		void
-		
-			ConstructURL
-		
-					(string $partial_path, [ $force_script = false])
-			

-
-			
    
-					
  • 
-				string
-				$partial_path: The part of the path after the script name			
    • 
-					
  • 
-				
-				$force_script			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		DateToISODate (line 346)
-	
 
-
-	
-
Convert a date into ISO format into the sparkly new ISO format.

-	

-		void
-		
-			DateToISODate
-		
-					(string $indate)
-			

-
-			
    
-					
  • 
-				string
-				$indate: The date to convert			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		DeconstructURL (line 306)
-	
 
-
-	
-
Deconstruct a dav_name from the supplied URL.  The dav_name will be urldecoded.

-	

-		void
-		
-			DeconstructURL
-		
-					( $url, [ $force_script = false], string $partial_path)
-			

-
-			
    
-					
  • 
-				string
-				$partial_path: The part of the path after the script name			
    • 
-					
  • 
-				
-				$url			
    • 
-					
  • 
-				
-				$force_script			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		early_exception_handler (line 17)
-	
 
-
-	
-	

-		void
-		
-			early_exception_handler
-		
-					( $exception)
-			

-
-			
    
-					
  • 
-				
-				$exception			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		getStatusMessage (line 221)
-	
 
-
-	
-
Return the HTTP status code description for a given code. Hopefully  this is an efficient way to code this.

-	
    
-				
  • return: The text for a give HTTP status code, in english
    • 
-			

-	

-		string
-		
-			getStatusMessage
-		
-					( $status)
-			

-
-			
    
-					
  • 
-				
-				$status			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		getUserByID (line 199)
-	
 
-
-	
-
Return a user record identified by a user_no, caching it for any subsequent lookup

-	

-		void
-		
-			getUserByID
-		
-					(int $user_no, [boolean $use_cache = true])
-			

-
-			
    
-					
  • 
-				int
-				$user_no: The ID of the record to retrieve			
    • 
-					
  • 
-				boolean
-				$use_cache: Whether or not to use the cache (default: yes)			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		getUserByName (line 174)
-	
 
-
-	
-
Return a user record identified by a username, caching it for any subsequent lookup

-	

-		void
-		
-			getUserByName
-		
-					(string $username, [boolean $use_cache = true])
-			

-
-			
    
-					
  • 
-				string
-				$username: The username of the record to retrieve			
    • 
-					
  • 
-				boolean
-				$use_cache: Whether or not to use the cache (default: yes)			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		ISODateToHTTPDate (line 337)
-	
 
-
-	
-
Convert a date from ISO format into the sad old HTTP format.

-	

-		void
-		
-			ISODateToHTTPDate
-		
-					(string $isodate)
-			

-
-			
    
-					
  • 
-				string
-				$isodate: The date to convert			
    • 
-				

-		
-	
-

-
-

-	
-	

-		
-		privilege_to_bits (line 358)
-	
 
-
-	
-	

-		void
-		
-			privilege_to_bits
-		
-					( $raw_privs)
-			

-
-			
    
-					
  • 
-				
-				$raw_privs			
    • 
-				

-		
-	
-

-		

-	

-	
-	

-		Documentation generated on Thu, 25 Feb 2010 11:39:17 +1300 by phpDocumentor 1.3.2
-	

-	

-
\ No newline at end of file
diff --git a/docs/api/davical/_inc---freebusy-GET.php.html b/docs/api/davical/_inc---freebusy-GET.php.html
deleted file mode 100644
index 8d883943..00000000
--- a/docs/api/davical/_inc---freebusy-GET.php.html
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
-  
-		
-			
-			Docs for page freebusy-GET.php
-			
-			
-		
-		
-			
			

-
File/inc/freebusy-GET.php

-
-
-

-	
Description

-	

-					Description |
-									Includes
-												

-	
	
-		
-		
-			

-

-		
-
-		
-	

-		
Includes

-		

-			Description |
-						Includes
-														

-		
	
-			
-

-	
-	

-		 
-		
-			include_once
-			('RRule.php')
-			(line 3)
-		
-	

-
-	
-	
-

-
-

-	
-	

-		 
-		
-			require_once
-			('iCalendar.php')
-			(line 2)
-		
-	

-
-	
-	
-

-		

-	

-	
-	
-	
-	
-	

-		Documentation generated on Sat, 17 Apr 2010 12:32:28 +1200 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
deleted file mode 100644
index f702d70e..00000000
--- a/docs/api/davical/xmpp.html
+++ /dev/null
@@ -1,746 +0,0 @@
-
-
-  
-		
-			
-			Docs For Class xmpp
-			
-			
-		
-		
-			
			

-
 Class xmpp

-
-
-

-	
Description

-	

-					Description |
-													Vars (details)
-						|											Methods (details)
-						
-					

-	

-        		
-
********************************************************************

-
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

-		

-			Description |
-						Vars (details)
-							| 
-									Methods (details)
-							
-								

-		

-			

-																																																																																								

-					 
-					mixed
-					$idle
-				

-																

-					 
-					mixed
-					$jid
-				

-																

-					 
-					mixed
-					$password
-				

-																

-					 
-					mixed
-					$port
-				

-																

-					 
-					mixed
-					$pubsubLayout
-				

-																

-					 
-					mixed
-					$resource
-				

-																

-					 
-					mixed
-					$server
-				

-																

-					 
-					mixed
-					$status
-				

-																

-					 
-					mixed
-					$tls
-				

-											

-		

-	

-
-	
-	

-		
Method Summary

-		

-			Description |
-																		Vars (details)
-				 
-				|
-						Methods (details)
-		

-		
			
-			

-																																																																																																

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

-		

-			Description |
-										Vars (details)
-						
-			
-										| 
-									Methods (details)
-							
-					

-		

-			
-
-

-
-	

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

-		

-			Description |
-															Vars (details)
-														Methods (details)
-						
-		

-		

-			
-
-

-	
-	

-		
-		Constructor __construct (line 26)
-	
 
-	
-	
-	
    
-				
  • access: public
    • 
-			

-	
-	

-		xmpp
-		
-			__construct
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		addHandler (line 673)
-	
 
-	
-	
-	
    
-				
  • access: public
    • 
-			

-	
-	

-		void
-		
-			addHandler
-		
-					( $direction,  $command,  $handler)
-			

-	
-			
    
-					
  • 
-				
-				$direction			
    • 
-					
  • 
-				
-				$command			
    • 
-					
  • 
-				
-				$handler			
    • 
-				

-		
-			
-	

-
-

-	
-	

-		
-		close (line 662)
-	
 
-	
-	
-	
    
-				
  • access: public
    • 
-			

-	
-	

-		void
-		
-			close
-		
-				()
-			

-	
-		
-			
-	

-
-

-	
-	

-		
-		open (line 645)
-	
 
-	
-	
-	
    
-				
  • 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 Sat, 17 Apr 2010 12:32:28 +1200 by phpDocumentor 1.3.2
-	

-	

-
\ No newline at end of file