mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-08-23 17:26:02 +00:00
Built docs for new code.
This commit is contained in:
Andrew McMillan
parent
62e43e1be3
commit
8b8d6b6d55
805
docs/api/awl/AWLDB/AwlQuery.html
Normal file
805
docs/api/awl/AWLDB/AwlQuery.html
Normal file
@ -0,0 +1,805 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class AwlQuery</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> AwlQuery</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The AwlQuery Class.</p>
|
||||
<p class="description"><p>This class builds and executes SQL Queries and traverses the set of results returned from the query.</p><p><strong>Example usage</strong> <div class="src-code"><ol><li><div class="src-line"> <span class="src-var">$sql </span>= <span class="src-str">"SELECT * FROM mytable WHERE mytype = ?"</span><span class="src-sym">;</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-var">$qry </span>= <span class="src-key">new </span><span class="src-id"><a href="../../awl/AWLDB/AwlQuery.html">AwlQuery</a></span><span class="src-sym">( </span><span class="src-var">$sql</span><span class="src-sym">, </span><span class="src-var">$myunsanitisedtype </span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-key">if </span><span class="src-sym">( </span><span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span><span class="src-str">"typeselect"</span><span class="src-sym">, </span>__line__<span class="src-sym">, </span>__file__ <span class="src-sym">)</span></div></li>
|
||||
<li><div class="src-line"> && <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodrows">rows</a> > <span class="src-num">0 </span><span class="src-sym">)</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-sym">{</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-key">while</span><span class="src-sym">( </span><span class="src-var">$row </span>= <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodFetch">Fetch</a><span class="src-sym">(</span><span class="src-sym">) ) </span><span class="src-sym">{</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-id">do_something_with</span><span class="src-sym">(</span><span class="src-var">$row</span><span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-sym">}</span></div></li>
|
||||
<li><div class="src-line"> <span class="src-sym">}</span></div></li>
|
||||
</ol></div></p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---AwlQuery.php.html">/inc/AwlQuery.php</a> (line <span class="field">138</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">array</span>
|
||||
<a href="#$bound_parameters" title="details" class="var-name">$bound_parameters</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">resource</span>
|
||||
<a href="#$connection" title="details" class="var-name">$connection</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$error_info" title="details" class="var-name">$error_info</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$execution_time" title="details" class="var-name">$execution_time</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$location" title="details" class="var-name">$location</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$querystring" title="details" class="var-name">$querystring</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">double</span>
|
||||
<a href="#$query_time_warning" title="details" class="var-name">$query_time_warning</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">resource</span>
|
||||
<a href="#$result" title="details" class="var-name">$result</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">int</span>
|
||||
<a href="#$rownum" title="details" class="var-name">$rownum</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">int</span>
|
||||
<a href="#$rows" title="details" class="var-name">$rows</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">string</span>
|
||||
<a href="#$sth" title="details" class="var-name">$sth</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">The</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">0</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Bind" title="details" class="method-name">Bind</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">resource</span>
|
||||
<a href="#Exec" title="details" class="method-name">Exec</a>
|
||||
([<span class="var-type">string</span> <span class="var-name">$location</span> = <span class="var-default">''</span>], [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">mixed</span>
|
||||
<a href="#Fetch" title="details" class="method-name">Fetch</a>
|
||||
([<span class="var-type">boolean</span> <span class="var-name">$as_array</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Parameters" title="details" class="method-name">Parameters</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Prepare" title="details" class="method-name">Prepare</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#QueryString" title="details" class="method-name">QueryString</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#quote" title="details" class="method-name">quote</a>
|
||||
([<span class="var-type">mixed</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#rows" title="details" class="method-name">rows</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetConnection" title="details" class="method-name">SetConnection</a>
|
||||
(<span class="var-type">resource</span> <span class="var-name">$new_connection</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#_log_query" title="details" class="method-name">_log_query</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$locn</span>, <span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$string</span>, [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
|
||||
<a name="var$bound_parameters" id="$bound_parameters"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$bound_parameters</span>
|
||||
(line <span class="line-number">159</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The current array of bound parameters</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$connection" id="$connection"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">resource</span>
|
||||
<span class="var-name">$connection</span>
|
||||
(line <span class="line-number">147</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Our database connection, normally copied from a global one</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$error_info" id="$error_info"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$error_info</span>
|
||||
(line <span class="line-number">189</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The Database error information, if the query fails.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$execution_time" id="$execution_time"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$execution_time</span>
|
||||
(line <span class="line-number">196</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Stores the query execution time - used to deal with long queries.</p>
|
||||
<p class="description"><p>should be read-only</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$location" id="$location"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$location</span>
|
||||
(line <span class="line-number">208</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Where we called this query from so we can find it in our code! Debugging may also be selectively enabled for a $location.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$querystring" id="$querystring"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$querystring</span>
|
||||
(line <span class="line-number">153</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The original query string</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$query_time_warning" id="$query_time_warning"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">double</span>
|
||||
<span class="var-name">$query_time_warning</span>
|
||||
= <span class="var-default"> 0.3</span> (line <span class="line-number">217</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">How long the query should take before a warning is issued.</p>
|
||||
<p class="description"><p>This is writable, but a method to set it might be a better interface. The default is 0.3 seconds.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$result" id="$result"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">resource</span>
|
||||
<span class="var-name">$result</span>
|
||||
(line <span class="line-number">171</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Result of the last execution</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$rownum" id="$rownum"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$rownum</span>
|
||||
= <span class="var-default"> null</span> (line <span class="line-number">177</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">number of current row - use accessor to get/set</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$rows" id="$rows"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$rows</span>
|
||||
(line <span class="line-number">183</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">number of rows from pg_numrows - use accessor to get value</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$sth" id="$sth"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sth</span>
|
||||
(line <span class="line-number">165</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The PDO statement handle, or null if we don't have one yet.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">227</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> AwlQuery object</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">The</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">0</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">0</span><span class="var-description">: The query string in PDO syntax with replacable '?' characters or bindable parameters.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodBind" id="Bind"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Bind</span> (line <span class="line-number">307</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Bind some parameters</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Bind
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodExec" id="Exec"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Exec</span> (line <span class="line-number">377</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Execute the query, logging any debugging.</p>
|
||||
<p class="description"><p><strong>Example</strong> So that you can nicely enable/disable the queries for a particular class, you could use some of PHPs magic constants in your call. <div class="src-code"><ol><li><div class="src-line"> <span class="src-var">$qry</span><span class="src-sym">-></span><a href="../../awl/AWLDB/AwlQuery.html#methodExec">Exec</a><span class="src-sym">(</span>__CLASS__<span class="src-sym">, </span>__LINE__<span class="src-sym">, </span>__FILE__<span class="src-sym">)</span><span class="src-sym">;</span></div></li>
|
||||
</ol></div></p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The actual result of the query (FWIW)</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">resource</span>
|
||||
<span class="method-name">
|
||||
Exec
|
||||
</span>
|
||||
([<span class="var-type">string</span> <span class="var-name">$location</span> = <span class="var-default">''</span>], [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$location</span><span class="var-description">: The name of the location for enabling debugging or just to help our children find the source of a problem.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$line</span><span class="var-description">: The line number where Exec was called</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$file</span><span class="var-description">: The file where Exec was called</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodFetch" id="Fetch"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Fetch</span> (line <span class="line-number">440</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Fetch the next row from the query results</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> query row</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
Fetch
|
||||
</span>
|
||||
([<span class="var-type">boolean</span> <span class="var-name">$as_array</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$as_array</span><span class="var-description">: True if thing to be returned is array</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodParameters" id="Parameters"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Parameters</span> (line <span class="line-number">347</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return the parameters we are planning to substitute into the query string</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Parameters
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodPrepare" id="Prepare"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Prepare</span> (line <span class="line-number">323</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Tell the database to prepare the query that we will execute</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Prepare
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodQueryString" id="QueryString"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">QueryString</span> (line <span class="line-number">339</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return the query string we are planning to execute</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
QueryString
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodquote" id="quote"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">quote</span> (line <span class="line-number">295</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Quote the given string so it can be safely used within string delimiters in a query. To be avoided, in general.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> NULL, TRUE, FALSE, a plain number, or the original string quoted and with ' and \ characters escaped</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
quote
|
||||
</span>
|
||||
([<span class="var-type">mixed</span> <span class="var-name">$str</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$str</span><span class="var-description">: Data to be converted to a string suitable for including as a value in SQL.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodrows" id="rows"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">rows</span> (line <span class="line-number">355</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return the count of rows retrieved/affected</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
rows
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetConnection" id="SetConnection"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetConnection</span> (line <span class="line-number">255</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Use a different database connection for this query</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetConnection
|
||||
</span>
|
||||
(<span class="var-type">resource</span> <span class="var-name">$new_connection</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">resource</span>
|
||||
<span class="var-name">$new_connection</span><span class="var-description">: The database connection to use.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="method_log_query" id="_log_query"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">_log_query</span> (line <span class="line-number">273</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Log query, optionally with file and line location of the caller.</p>
|
||||
<p class="description"><p>This function should not really be used outside of AwlQuery. For a more useful generic logging interface consider calling dbg_error_log(...);</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_log_query
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$locn</span>, <span class="var-type">string</span> <span class="var-name">$tag</span>, <span class="var-type">string</span> <span class="var-name">$string</span>, [<span class="var-type">int</span> <span class="var-name">$line</span> = <span class="var-default">0</span>], [<span class="var-type">string</span> <span class="var-name">$file</span> = <span class="var-default">""</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$locn</span><span class="var-description">: A string identifying the calling location.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$tag</span><span class="var-description">: A tag string, e.g. identifying the type of event.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$string</span><span class="var-description">: The information to be logged.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$line</span><span class="var-description">: The line number where the logged event occurred.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$file</span><span class="var-description">: The file name where the logged event occurred.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
165
docs/api/awl/AWLDB/_inc---AwlQuery.php.html
Normal file
165
docs/api/awl/AWLDB/_inc---AwlQuery.php.html
Normal file
@ -0,0 +1,165 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page AwlQuery.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/AwlQuery.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../awl/AWLDB/AwlQuery.html">AwlQuery</a>
|
||||
</td>
|
||||
<td>
|
||||
The AwlQuery Class.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_AwlDatabase_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../awl/AwlDatabase/_inc---AwlDatabase.php.html">'AwlDatabase.php'</a></span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionduration" id="functionduration"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">duration</span> (line <span class="line-number">107</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">A duration (in decimal seconds) between two times which are the result of calls to microtime()</p>
|
||||
<p class="description"><p>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.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> difference</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">double</span>
|
||||
<span class="method-name">
|
||||
duration
|
||||
</span>
|
||||
(<span class="var-type">microtime</span> <span class="var-name">$t1</span>, <span class="var-type">microtime</span> <span class="var-name">$t2</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">microtime</span>
|
||||
<span class="var-name">$t1</span><span class="var-description">: start time</span> </li>
|
||||
<li>
|
||||
<span class="var-type">microtime</span>
|
||||
<span class="var-name">$t2</span><span class="var-description">: end time</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="function_awl_connect_configured_database" id="function_awl_connect_configured_database"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">_awl_connect_configured_database</span> (line <span class="line-number">40</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Connect to the database defined in the $c->db_connect[] (or $c->pg_connect) arrays</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
_awl_connect_configured_database
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
455
docs/api/awl/AwlDatabase/AwlDBDialect.html
Normal file
455
docs/api/awl/AwlDatabase/AwlDBDialect.html
Normal file
@ -0,0 +1,455 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class AwlDBDialect</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> AwlDBDialect</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-descendents">Descendents</a>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">The AwlDBDialect class handles</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---AwlDBDialect.php.html">/inc/AwlDBDialect.php</a> (line <span class="field">22</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre></pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-descendents"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Direct descendents</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Descendents</span>
|
||||
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"
|
||||
style="vertical-align: center"/>
|
||||
<a href="../../awl/AwlDatabase/AwlDatabase.html">AwlDatabase</a>
|
||||
</td>
|
||||
<td>
|
||||
Typically there will only be a single instance of the database level class in an application.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendants</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$db" title="details" class="var-name">$db</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$dialect" title="details" class="var-name">$dialect</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendants</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-result">AwlDBDialect</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$connection_string</span>, [<span class="var-type">string</span> <span class="var-name">$dbuser</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$dbpass</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetFields" title="details" class="method-name">GetFields</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$tablename_string</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#GetVersion" title="details" class="method-name">GetVersion</a>
|
||||
(<span class="var-type">handle</span> <span class="var-name">$pdo</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Quote" title="details" class="method-name">Quote</a>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$value</span>, [<span class="var-type">string</span> <span class="var-name">$value_type</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">The</span>
|
||||
<a href="#ReplaceParameters" title="details" class="method-name">ReplaceParameters</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">0</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#SetSearchPath" title="details" class="method-name">SetSearchPath</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$search_path</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#TranslateSQL" title="details" class="method-name">TranslateSQL</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$sql_string</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
|
||||
<a name="var$db" id="$db"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$db</span>
|
||||
(line <span class="line-number">35</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Holds the PDO database connection</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$dialect" id="$dialect"><!-- --></A>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$dialect</span>
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Holds the name of the database dialect</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-descendents">Descendents</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="method__construct" id="__construct"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">57</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
<p class="description"><p>The database will be opened.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">AwlDBDialect</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$connection_string</span>, [<span class="var-type">string</span> <span class="var-name">$dbuser</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$dbpass</span> = <span class="var-default">null</span>], [<span class="var-type">array</span> <span class="var-name">$options</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$connection_string</span><span class="var-description">: The PDO connection string, in all it's glory</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dbuser</span><span class="var-description">: The database username to connect as</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$dbpass</span><span class="var-description">: The database password to connect with</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$options</span><span class="var-description">: An array of driver options</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetFields" id="GetFields"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetFields</span> (line <span class="line-number">117</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetFields
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$tablename_string</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$tablename_string</span><span class="var-description">: The name of the table we want fields from</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodGetVersion" id="GetVersion"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetVersion</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the current search path for the database.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
GetVersion
|
||||
</span>
|
||||
(<span class="var-type">handle</span> <span class="var-name">$pdo</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">handle</span>
|
||||
<span class="var-name">$pdo</span><span class="var-description">: A handle to an opened database</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodQuote" id="Quote"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Quote</span> (line <span class="line-number">160</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns $value escaped in an appropriate way for this database dialect.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Quote
|
||||
</span>
|
||||
(<span class="var-type">mixed</span> <span class="var-name">$value</span>, [<span class="var-type">string</span> <span class="var-name">$value_type</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$value</span><span class="var-description">: The value to be escaped</span> </li>
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$value_type</span><span class="var-description">: 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.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodReplaceParameters" id="ReplaceParameters"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ReplaceParameters</span> (line <span class="line-number">250</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Replaces query parameters with appropriately escaped substitutions.</p>
|
||||
<p class="description"><p>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.</p><p>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 )".</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> built query string</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">The</span>
|
||||
<span class="method-name">
|
||||
ReplaceParameters
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">0</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">0</span><span class="var-description">: The query string with replacable '?' characters.</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">1</span><span class="var-description">: The values to replace into the SQL string.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodSetSearchPath" id="SetSearchPath"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">SetSearchPath</span> (line <span class="line-number">72</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Sets the current search path for the database.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
SetSearchPath
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$search_path</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$search_path</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodTranslateSQL" id="TranslateSQL"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TranslateSQL</span> (line <span class="line-number">147</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
<p class="description"><p>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.</p><p>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.</p></p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
TranslateSQL
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$sql_string</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$sql_string</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
425
docs/api/awl/AwlDatabase/AwlDatabase.html
Normal file
425
docs/api/awl/AwlDatabase/AwlDatabase.html
Normal file
@ -0,0 +1,425 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs For Class AwlDatabase</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="class-name"><img src="../../media/images/Class_logo.png"
|
||||
alt=" Class"
|
||||
title=" Class"
|
||||
style="vertical-align: middle"> AwlDatabase</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Typically there will only be a single instance of the database level class in an application.</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---AwlDatabase.php.html">/inc/AwlDatabase.php</a> (line <span class="field">55</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a>
|
||||
|
|
||||
--AwlDatabase</pre>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-var-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variable Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="var-summary">
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$txnstate" title="details" class="var-name">$txnstate</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-method-summary"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Method Summary</span></div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
|
||||
|
|
||||
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<div class="method-summary">
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Begin" title="details" class="method-name">Begin</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Commit" title="details" class="method-name">Commit</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#prepare" title="details" class="method-name">prepare</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, [<span class="var-type">array</span> <span class="var-name">$driver_options</span> = <span class="var-default">array()</span>], <span class="var-type">string</span> <span class="var-name">$sql_query_string</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#PrepareTranslated" title="details" class="method-name">PrepareTranslated</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#query" title="details" class="method-name">query</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, <span class="var-type">string</span> <span class="var-name">$sql_query_string</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Rollback" title="details" class="method-name">Rollback</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#TransactionState" title="details" class="method-name">TransactionState</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#TranslateAll" title="details" class="method-name">TranslateAll</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$onoff_boolean</span>)
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-vars"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Variables</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
||||
|
||||
|
||||
|
|
||||
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
|
||||
<a name="var$txnstate" id="$txnstate"><!-- --></A>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="var-header">
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">$txnstate</span>
|
||||
= <span class="var-default"> 0</span> (line <span class="line-number">63</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Holds the state of the transaction 0 = not started, 1 = in progress, -1 = error pending rollback/commit</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Variables</h4>
|
||||
<A NAME='inherited_vars'><!-- --></A>
|
||||
<p>Inherited from <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
|
||||
<blockquote>
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$db">AwlDBDialect::$db</a></span><br />
|
||||
</span>
|
||||
<img src="../../media/images/Variable.png" />
|
||||
<span class="var-title">
|
||||
<span class="var-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#var$dialect">AwlDBDialect::$dialect</a></span><br />
|
||||
</span>
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-methods"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Methods</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
||||
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
|
||||
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<A NAME='method_detail'></A>
|
||||
<a name="methodBegin" id="Begin"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Begin</span> (line <span class="line-number">90</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Begin a transaction.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Begin
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodCommit" id="Commit"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Commit</span> (line <span class="line-number">104</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Complete a transaction.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Commit
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodprepare" id="prepare"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">prepare</span> (line <span class="line-number">72</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
prepare
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, [<span class="var-type">array</span> <span class="var-name">$driver_options</span> = <span class="var-default">array()</span>], <span class="var-type">string</span> <span class="var-name">$sql_query_string</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
|
||||
<li>
|
||||
<span class="var-type">array</span>
|
||||
<span class="var-name">$driver_options</span><span class="var-description">: PDO driver options to the prepare statement, commonly to do with cursors</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$statement</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodPrepareTranslated" id="PrepareTranslated"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">PrepareTranslated</span> (line <span class="line-number">139</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Operates identically to AwlDatabase::Prepare, except that $this->Translate() will be called on the query before any processing.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
PrepareTranslated
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodquery" id="query"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">query</span> (line <span class="line-number">82</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Returns a PDOStatement object created using this database, the supplied SQL string, and any parameters given.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
query
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, <span class="var-type">string</span> <span class="var-name">$sql_query_string</span>, <span class="var-type">mixed</span> <span class="var-name">1</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$sql_query_string</span><span class="var-description">: The SQL string containing optional variable replacements</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">1</span><span class="var-description">: ... Subsequent arguments are positionally replaced into the $sql_query_string</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$statement</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRollback" id="Rollback"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Rollback</span> (line <span class="line-number">115</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Cancel a transaction in progress.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Rollback
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodTransactionState" id="TransactionState"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TransactionState</span> (line <span class="line-number">130</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
TransactionState
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodTranslateAll" id="TranslateAll"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TranslateAll</span> (line <span class="line-number">147</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Switches on or off the processing flag controlling whether subsequent calls to AwlDatabase::Prepare are translated as if PrepareTranslated() had been called.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
TranslateAll
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$onoff_boolean</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$onoff_boolean</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<h4>Inherited Methods</h4>
|
||||
<a name='inherited_methods'><!-- --></a>
|
||||
<!-- =========== Summary =========== -->
|
||||
<p>Inherited From <span class="classname"><a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a></span></p>
|
||||
<blockquote>
|
||||
<img src="../../media/images/Constructor.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#method__construct">AwlDBDialect::__construct()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetFields">AwlDBDialect::GetFields()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodGetVersion">AwlDBDialect::GetVersion()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodQuote">AwlDBDialect::Quote()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodReplaceParameters">AwlDBDialect::ReplaceParameters()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodSetSearchPath">AwlDBDialect::SetSearchPath()</a></span><br />
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-name"><a href="../../awl/AwlDatabase/AwlDBDialect.html#methodTranslateSQL">AwlDBDialect::TranslateSQL()</a></span><br />
|
||||
</blockquote>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
70
docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html
Normal file
70
docs/api/awl/AwlDatabase/_inc---AwlDBDialect.php.html
Normal file
@ -0,0 +1,70 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page AwlDBDialect.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/AwlDBDialect.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">AwlDatabase - support for different SQL dialects</p>
|
||||
<p class="description"><p>This subpackage provides dialect specific support for PostgreSQL, and may, over time, be extended to provide support for other SQL dialects.</p><p>See http://wiki.davical.org/w/Coding/PdoDatabase for design and usage information.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../awl/AwlDatabase/AwlDBDialect.html">AwlDBDialect</a>
|
||||
</td>
|
||||
<td>
|
||||
The AwlDBDialect class handles
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
111
docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html
Normal file
111
docs/api/awl/AwlDatabase/_inc---AwlDatabase.php.html
Normal file
@ -0,0 +1,111 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page AwlDatabase.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/AwlDatabase.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">AwlDatabase query/statement class and associated functions</p>
|
||||
<p class="description"><p>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.</p><p>The class is intended to be a very lightweight wrapper with some features that have proved useful in developing and debugging web-based applications: <ul><li>All queries are timed, and an expected time can be provided.</li><li>Parameters replaced into the SQL will be escaped correctly in order to
|
||||
minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
|
||||
be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
|
||||
particular sets of queries.</li><li>Simple syntax for iterating through a result set.</li></ul> See http://wiki.davical.org/w/AwlDatabase for design and usage information.</p><p>If not already connected, AwlDatabase will attempt to connect to the database, successively applying connection parameters from the array in $c->pdo_connect.</p><p>We will die if the database is not currently connected and we fail to find a working connection.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../awl/AwlDatabase/AwlDatabase.html">AwlDatabase</a>
|
||||
</td>
|
||||
<td>
|
||||
Typically there will only be a single instance of the database level class in an application.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_AwlDBDialect_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require</span>
|
||||
(<span class="include-name"><a href="../../awl/AwlDatabase/_inc---AwlDBDialect.php.html">'AwlDBDialect.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">AwlDatabase query/statement class and associated functions</p>
|
||||
<p class="description"><p>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.</p><p>The class is intended to be a very lightweight wrapper with some features that have proved useful in developing and debugging web-based applications: <ul><li>All queries are timed, and an expected time can be provided.</li><li>Parameters replaced into the SQL will be escaped correctly in order to
|
||||
minimise the chances of SQL injection errors.</li><li>Queries which fail, or which exceed their expected execution time, will
|
||||
be logged for potential further analysis.</li><li>Debug logging of queries may be enabled globally, or restricted to
|
||||
particular sets of queries.</li><li>Simple syntax for iterating through a result set.</li></ul> See http://wiki.davical.org/w/AwlDatabase for design and usage information.</p><p>If not already connected, AwlDatabase will attempt to connect to the database, successively applying connection parameters from the array in $c->pdo_connect.</p><p>We will die if the database is not currently connected and we fail to find a working connection.</p></p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
1271
docs/api/davical/Resource/DAVResource.html
Normal file
1271
docs/api/davical/Resource/DAVResource.html
Normal file
File diff suppressed because it is too large
Load Diff
97
docs/api/davical/Resource/_inc---DAVResource.php.html
Normal file
97
docs/api/davical/Resource/_inc---DAVResource.php.html
Normal file
@ -0,0 +1,97 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page DAVResource.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/DAVResource.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">An object representing a DAV 'resource'</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v3 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-classes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Classes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Classes</span>
|
||||
| <a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<table cellpadding="2" cellspacing="0" class="class-table">
|
||||
<tr>
|
||||
<th class="class-table-header">Class</th>
|
||||
<th class="class-table-header">Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding-right: 2em; vertical-align: top; white-space: nowrap">
|
||||
<img src="../../media/images/Class.png"
|
||||
alt=" class"
|
||||
title=" class"/>
|
||||
<a href="../../davical/Resource/DAVResource.html">DAVResource</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for things to do with a DAV Resource
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_AwlQuery_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../awl/AWLDB/_inc---AwlQuery.php.html">'AwlQuery.php'</a></span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
152
docs/api/davical/_htdocs---browse.php.html
Normal file
152
docs/api/davical/_htdocs---browse.php.html
Normal file
@ -0,0 +1,152 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page browse.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/browse.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">39</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Page elements could be an array of viewers, browsers or something else that supports the Render() method...</p>
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">4</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_components/$component-browse_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">"components/$component-browse.php"</span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">'../inc/always.php'</a></span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'classBrowser.php'</span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive_page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'interactive_page.php'</span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
212
docs/api/davical/_htdocs---davical.php.html
Normal file
212
docs/api/davical/_htdocs---davical.php.html
Normal file
@ -0,0 +1,212 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page davical.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/davical.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">50</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">28</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">5</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">24</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_$code_file"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">$code_file</span>)
|
||||
(line <span class="line-number">21</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">'../inc/always.php'</a></span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_AwlQuery_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../awl/AWLDB/_inc---AwlQuery.php.html">AwlQuery.php</a></span>)
|
||||
(line <span class="line-number">8</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'classBrowser.php'</span>)
|
||||
(line <span class="line-number">4</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classEditor_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'classEditor.php'</span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
152
docs/api/davical/_htdocs---edit.php.html
Normal file
152
docs/api/davical/_htdocs---edit.php.html
Normal file
@ -0,0 +1,152 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page edit.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/edit.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Page elements could be an array of viewers, browsers or something else that supports the Render() method...</p>
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">4</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_components/$component-edit_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include_once</span>
|
||||
(<span class="include-name">"components/$component-edit.php"</span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">'../inc/always.php'</a></span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classEditor_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'classEditor.php'</span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive_page_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'interactive_page.php'</span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
121
docs/api/davical/_htdocs---setup.php.html
Normal file
121
docs/api/davical/_htdocs---setup.php.html
Normal file
@ -0,0 +1,121 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page setup.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/setup.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">"../inc/always.php"</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalSession_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">4</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">7</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">8</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">25</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
76
docs/api/davical/_htdocs---test.php.html
Normal file
76
docs/api/davical/_htdocs---test.php.html
Normal file
@ -0,0 +1,76 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page test.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/test.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">"../inc/always.php"</a></span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_iCalendar_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name">"iCalendar.php"</span>)
|
||||
(line <span class="line-number">4</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
137
docs/api/davical/_htdocs---upgrade.php.html
Normal file
137
docs/api/davical/_htdocs---upgrade.php.html
Normal file
@ -0,0 +1,137 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page upgrade.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/upgrade.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/inc/always_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---always.php.html">"../inc/always.php"</a></span>)
|
||||
(line <span class="line-number">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="__/caldav_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/caldav/_htdocs---caldav.php.html">"./caldav.php"</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">If the request is not a GET or POST then they must really want caldav.php!</p>
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalSession_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_interactive-page_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">14</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-footer_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-footer.php.html">page-footer.php</a></span>)
|
||||
(line <span class="line-number">69</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_page-header_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">include</span>
|
||||
(<span class="include-name"><a href="../davical/_inc---page-header.php.html">page-header.php</a></span>)
|
||||
(line <span class="line-number">15</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
74
docs/api/davical/_inc---auth-famjama.php.html
Normal file
74
docs/api/davical/_inc---auth-famjama.php.html
Normal file
@ -0,0 +1,74 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page auth-famjama.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/auth-famjama.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionAuthFamjama" id="functionAuthFamjama"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">AuthFamjama</span> (line <span class="line-number">3</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
AuthFamjama
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$username</span>, <span class="var-type"></span> <span class="var-name">$password</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$username</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
132
docs/api/davical/_inc---caldav-REPORT-expand-property.php.html
Normal file
132
docs/api/davical/_inc---caldav-REPORT-expand-property.php.html
Normal file
@ -0,0 +1,132 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-expand-property.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-expand-property.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_DAVResource_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/Resource/_inc---DAVResource.php.html">'DAVResource.php'</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionexpand_properties" id="functionexpand_properties"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">expand_properties</span> (line <span class="line-number">46</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Expand the properties, recursing as needed</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
expand_properties
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$urls</span>, <span class="var-type"></span> <span class="var-name">$ptree</span>, <span class="var-type"></span> <span class="var-name">&$reply</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$urls</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ptree</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$reply</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionget_href_containers" id="functionget_href_containers"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">get_href_containers</span> (line <span class="line-number">10</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
get_href_containers
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">&$multistatus_response</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">&$multistatus_response</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:47 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
34
docs/api/davical/_inc---ui---collection-edit.php.html
Normal file
34
docs/api/davical/_inc---ui---collection-edit.php.html
Normal file
@ -0,0 +1,34 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page collection-edit.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/ui/collection-edit.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:47 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
34
docs/api/davical/_inc---ui---principal-browse.php.html
Normal file
34
docs/api/davical/_inc---ui---principal-browse.php.html
Normal file
@ -0,0 +1,34 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page principal-browse.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/ui/principal-browse.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
71
docs/api/davical/_inc---ui---principal-edit.php.html
Normal file
71
docs/api/davical/_inc---ui---principal-edit.php.html
Normal file
@ -0,0 +1,71 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page principal-edit.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/ui/principal-edit.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionedit_group_row" id="functionedit_group_row"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">edit_group_row</span> (line <span class="line-number">219</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
edit_group_row
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$row_data</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$row_data</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
34
docs/api/davical/_inc---ui---principal-view.php.html
Normal file
34
docs/api/davical/_inc---ui---principal-view.php.html
Normal file
@ -0,0 +1,34 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page principal-view.php</title>
|
||||
<link rel="stylesheet" href="../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/ui/principal-view.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:49 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
73
docs/api/davical/caldav/_inc---caldav-MKCOL.php.html
Normal file
73
docs/api/davical/caldav/_inc---caldav-MKCOL.php.html
Normal file
@ -0,0 +1,73 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-MKCOL.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-MKCOL.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle MKCOL and MKCALENDAR method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd - http://www.morphoss.com/</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_XMLDocument_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name">'XMLDocument.php'</span>)
|
||||
(line <span class="line-number">38</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle MKCOL and MKCALENDAR method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst IT Ltd, Morphoss Ltd - http://www.morphoss.com/</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
107
docs/api/davical/caldav/_inc---caldav-MOVE.php.html
Normal file
107
docs/api/davical/caldav/_inc---caldav-MOVE.php.html
Normal file
@ -0,0 +1,107 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-MOVE.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-MOVE.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle MOVE method</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@morphoss.com">andrew@morphoss.com</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_DAVResource_php"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require_once</span>
|
||||
(<span class="include-name"><a href="../../davical/Resource/_inc---DAVResource.php.html">'DAVResource.php'</a></span>)
|
||||
(line <span class="line-number">13</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionrollback" id="functionrollback"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">rollback</span> (line <span class="line-number">94</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">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.</p>
|
||||
<p class="description"><p>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.</p></p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
rollback
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$response_code</span> = <span class="var-default">412</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$response_code</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:46 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -0,0 +1,112 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<!-- template designed by Marco Von Ballmoos -->
|
||||
<title>Docs for page caldav-REPORT-sync-collection.php</title>
|
||||
<link rel="stylesheet" href="../../media/stylesheet.css" />
|
||||
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
|
||||
</head>
|
||||
<body>
|
||||
<div class="page-body">
|
||||
<h2 class="file-name"><img src="../../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/inc/caldav-REPORT-sync-collection.php</h2>
|
||||
|
||||
<a name="sec-description"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Description</div>
|
||||
<div class="nav-bar">
|
||||
<span class="disabled">Description</span> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle sync-collection report (draft-daboo-webdav-sync-01)</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd - http://www.morphoss.com/</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-includes"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Includes</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<span class="disabled">Includes</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="_DAVResource_php"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Page.png" alt=" " />
|
||||
<span class="include-title">
|
||||
<span class="include-type">require</span>
|
||||
(<span class="include-name"><a href="../../davical/Resource/_inc---DAVResource.php.html">"DAVResource.php"</a></span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">CalDAV Server - handle sync-collection report (draft-daboo-webdav-sync-01)</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Morphoss Ltd - http://www.morphoss.com/</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<a name="sec-functions"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Functions</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functiondisplay_status" id="functiondisplay_status"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">display_status</span> (line <span class="line-number">33</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Build the array of properties to include in the report output</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
display_status
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$status_code</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$status_code</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 01 Dec 2009 10:37:47 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
Loading…
x
Reference in New Issue
Block a user