mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-09-01 18:48:17 +00:00
Remove built docs for files no longer present in DAViCal.
This commit is contained in:
Andrew McMillan
parent
be02f3cd1f
commit
685fec39e8
@ -1,805 +0,0 @@
|
||||
<?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">453</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 Thu, 25 Feb 2010 11:39:17 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,165 +0,0 @@
|
||||
<?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 Thu, 25 Feb 2010 11:39:17 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,496 +0,0 @@
|
||||
<?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 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>If you are looking for the place to add support for other SQL dialects, this is the class that you should be looking at. You might also look at the AwlDatabase class which extends this one, but these are the core capabilities which most probably need attention.</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---AwlDBDialect.php.html">/inc/AwlDBDialect.php</a> (line <span class="field">33</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="#ReplaceNamedParameters" title="details" class="method-name">ReplaceNamedParameters</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">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="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">$db</span>
|
||||
(line <span class="line-number">46</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="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">$dialect</span>
|
||||
(line <span class="line-number">41</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">68</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="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetFields</span> (line <span class="line-number">134</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">GetVersion</span> (line <span class="line-number">105</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="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Quote</span> (line <span class="line-number">178</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 the type of the $value. The special type of 'identifier' can also be used for escaping of SQL identifiers.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodReplaceNamedParameters" id="ReplaceNamedParameters"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ReplaceNamedParameters</span> (line <span class="line-number">322</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Replaces named query parameters of the form :name 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 ':name' 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).</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">
|
||||
ReplaceNamedParameters
|
||||
</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 ':name' identifiers</span> </li>
|
||||
<li>
|
||||
<span class="var-type">mixed</span>
|
||||
<span class="var-name">1</span><span class="var-description">: A ':name' => 'value' hash of values to replace into the SQL string.</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">266</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">87</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">164</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 Sat, 17 Apr 2010 12:32:23 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,490 +0,0 @@
|
||||
<?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">58</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="#$translate_all" title="details" class="var-name">$translate_all</a>
|
||||
</div>
|
||||
<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="#ErrorInfo" title="details" class="method-name">ErrorInfo</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>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, [<span class="var-type"></span> <span class="var-name">$driver_options</span> = <span class="var-default">array()</span>])
|
||||
</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$translate_all" id="$translate_all"><!-- --></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">$translate_all</span>
|
||||
= <span class="var-default"> false</span> (line <span class="line-number">71</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Holds whether we are translating all statements.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> protected</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<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">66</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">101</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">116</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="methodErrorInfo" id="ErrorInfo"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">ErrorInfo</span> (line <span class="line-number">172</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ErrorInfo
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodprepare" id="prepare"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">prepare</span> (line <span class="line-number">80</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">PrepareTranslated</span> (line <span class="line-number">153</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>
|
||||
(<span class="var-type"></span> <span class="var-name">$statement</span>, [<span class="var-type"></span> <span class="var-name">$driver_options</span> = <span class="var-default">array()</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$statement</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$driver_options</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodquery" id="query"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">query</span> (line <span class="line-number">93</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Rollback</span> (line <span class="line-number">128</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="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TransactionState</span> (line <span class="line-number">144</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">TranslateAll</span> (line <span class="line-number">163</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#methodReplaceNamedParameters">AwlDBDialect::ReplaceNamedParameters()</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 Sat, 17 Apr 2010 12:32:22 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,98 +0,0 @@
|
||||
<?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>
|
||||
| <a href="#sec-constants">Constants</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/AwlQuery 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>
|
||||
| <a href="#sec-constants">Constants</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/AwlDBDialect.html">AwlDBDialect</a>
|
||||
</td>
|
||||
<td>
|
||||
The AwlDBDialect class handles support for different SQL dialects
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-classes">Classes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineE_USER_ERROR"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Constant.png" />
|
||||
<span class="const-title">
|
||||
<span class="const-name">E_USER_ERROR</span> = 256
|
||||
(line <span class="line-number">18</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 17 Apr 2010 12:32:23 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,101 +0,0 @@
|
||||
<?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 AwlDBDialect, 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="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="../../awl/AwlDatabase/_inc---AwlDBDialect.php.html">'AwlDBDialect.php'</a></span>)
|
||||
(line <span class="line-number">37</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 17 Apr 2010 12:32:22 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,193 +0,0 @@
|
||||
<?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 users.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/users.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">Display a list of all users</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net 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="_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">65</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="_DAViCalSession_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/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">12</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_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">'classBrowser.php'</span>)
|
||||
(line <span class="line-number">38</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">11</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Display a list of all users</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">author:</span> Andrew McMillan <<a href="mailto:andrew@catalyst.net.nz">andrew@catalyst.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net Ltd</li>
|
||||
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2</a></li>
|
||||
</ul>
|
||||
|
||||
</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"><a href="../../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">15</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="functiontranslate_relationship_list" id="functiontranslate_relationship_list"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../../media/images/Function.png" />
|
||||
<span class="method-title">translate_relationship_list</span> (line <span class="line-number">22</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Translate relationship names in the relationship_list for each user. See the documentation for classBrowser::BrowserColumn for the definition of the hook function parameters.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
translate_relationship_list
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$value</span>, <span class="var-type"></span> <span class="var-name">$field</span>, <span class="var-type"></span> <span class="var-name">$row</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$value</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$field</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$row</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,478 +0,0 @@
|
||||
<?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 DAViCalUser</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"> DAViCalUser</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">A class for viewing and maintaining DAViCal User records</p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---DAViCalUser.php.html">/inc/DAViCalUser.php</a> (line <span class="field">27</span>)
|
||||
</p>
|
||||
|
||||
|
||||
<pre>User
|
||||
|
|
||||
--DAViCalUser</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="#$delete_collection_confirmation_required" title="details" class="var-name">$delete_collection_confirmation_required</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$delete_user_confirmation_required" title="details" class="var-name">$delete_user_confirmation_required</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">DAViCalUser</span>
|
||||
<a href="#DAViCalUser" title="details" class="method-name">DAViCalUser</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#AllowedTo" title="details" class="method-name">AllowedTo</a>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#HandleAction" title="details" class="method-name">HandleAction</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#Render" title="details" class="method-name">Render</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderCollections" title="details" class="method-name">RenderCollections</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderRelationshipsFrom" title="details" class="method-name">RenderRelationshipsFrom</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">string</span>
|
||||
<a href="#RenderRelationshipsTo" title="details" class="method-name">RenderRelationshipsTo</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">boolean</span>
|
||||
<a href="#Validate" title="details" class="method-name">Validate</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#Write" title="details" class="method-name">Write</a>
|
||||
()
|
||||
</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$delete_collection_confirmation_required" id="$delete_collection_confirmation_required"><!-- --></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">$delete_collection_confirmation_required</span>
|
||||
(line <span class="line-number">30</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$delete_user_confirmation_required" id="$delete_user_confirmation_required"><!-- --></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">$delete_user_confirmation_required</span>
|
||||
(line <span class="line-number">31</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</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="methodDAViCalUser" id="DAViCalUser"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor DAViCalUser</span> (line <span class="line-number">36</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Constructor - nothing fancy as yet.</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">DAViCalUser</span>
|
||||
<span class="method-name">
|
||||
DAViCalUser
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$id</span>, [<span class="var-type"></span> <span class="var-name">$prefix</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$id</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$prefix</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodAllowedTo" id="AllowedTo"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">AllowedTo</span> (line <span class="line-number">321</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Extend parent definition of what the current user is allowed to do</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether they are allowed to.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
AllowedTo
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$whatever</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$whatever</span><span class="var-description">: What the user wants to do</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodHandleAction" id="HandleAction"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">HandleAction</span> (line <span class="line-number">349</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle any unusual actions we might invent</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
HandleAction
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$action</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$action</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRender" id="Render"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Render</span> (line <span class="line-number">52</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the form / viewer as HTML to show the user</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> An HTML fragment to display in the page.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
Render
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">''</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderCollections" id="RenderCollections"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderCollections</span> (line <span class="line-number">242</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's collections</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderCollections
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderRelationshipsFrom" id="RenderRelationshipsFrom"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderRelationshipsFrom</span> (line <span class="line-number">109</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's relationships to other users & resources</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderRelationshipsFrom
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodRenderRelationshipsTo" id="RenderRelationshipsTo"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">RenderRelationshipsTo</span> (line <span class="line-number">158</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Render the user's relationships to other users & resources</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string of html to be output</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
RenderRelationshipsTo
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$ef</span>, [<span class="var-type"></span> <span class="var-name">$title</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$ef</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$title</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodValidate" id="Validate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Validate</span> (line <span class="line-number">311</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Validate the information the user submitted</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> Whether the form data validated OK.</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">boolean</span>
|
||||
<span class="method-name">
|
||||
Validate
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodWrite" id="Write"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../../media/images/Method.png" />
|
||||
<span class="method-title">Write</span> (line <span class="line-number">424</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Write the record to the file</p>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
Write
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 25 Feb 2010 11:39:19 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,148 +0,0 @@
|
||||
<?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 DAViCalUser.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/DAViCalUser.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">User maintain / view with DAViCal specific associated tables</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 .Net 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-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/DAViCalUser/DAViCalUser.html">DAViCalUser</a>
|
||||
</td>
|
||||
<td>
|
||||
A class for viewing and maintaining DAViCal User records
|
||||
</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="_caldav-PUT-functions_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="../../davical/caldav/_inc---caldav-PUT-functions.php.html">'caldav-PUT-functions.php'</a></span>)
|
||||
(line <span class="line-number">17</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_User_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">'User.php'</span>)
|
||||
(line <span class="line-number">14</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">User maintain / view with DAViCal specific associated tables</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 .Net 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>
|
||||
<a name="_check_UTF8_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="../../davical/_inc---check_UTF8.php.html">'check_UTF8.php'</a></span>)
|
||||
(line <span class="line-number">16</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_classBrowser_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">'classBrowser.php'</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 Thu, 25 Feb 2010 11:39:19 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,166 +0,0 @@
|
||||
<?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.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/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>
|
||||
</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-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">44</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">13</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">12</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">48</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="_classBrowser_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">"classBrowser.php"</span>)
|
||||
(line <span class="line-number">17</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">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</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">require_once</span>
|
||||
(<span class="include-name"><a href="../davical/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 25 Feb 2010 11:39:19 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,166 +0,0 @@
|
||||
<?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 relationship_types.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/relationship_types.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-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">98</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">108</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">6</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="_DAViCalSession_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/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DataUpdate_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">"DataUpdate.php"</span>)
|
||||
(line <span class="line-number">9</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">10</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DataEntry_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">"DataEntry.php"</span>)
|
||||
(line <span class="line-number">8</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 25 Feb 2010 11:39:21 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,136 +0,0 @@
|
||||
<?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 roles.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/roles.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-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">36</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">39</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="_DAViCalSession_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/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">3</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">9</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"><a href="../davical/_inc---interactive-page.php.html">interactive-page.php</a></span>)
|
||||
(line <span class="line-number">6</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 23 Feb 2010 23:26:38 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,91 +0,0 @@
|
||||
<?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 testpdo.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/testpdo.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="_AwlQuery_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/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="___/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="_DAViCalSession_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/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,137 +0,0 @@
|
||||
<?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 usr.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/usr.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-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">65</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Handle any actions, such as 'delete_relation'</p>
|
||||
|
||||
</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">67</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="_DAViCalSession_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/DAViCalSession/_inc---DAViCalSession.php.html">DAViCalSession.php</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_DAViCalUser_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/DAViCalUser/_inc---DAViCalUser.php.html">DAViCalUser.php</a></span>)
|
||||
(line <span class="line-number">9</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">7</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Tue, 23 Feb 2010 23:26:39 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,499 +0,0 @@
|
||||
<?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 always.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/always.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-constants">Constants</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@mcmillan.net.nz">andrew@mcmillan.net.nz</a>></li>
|
||||
<li><span class="field">copyright:</span> Catalyst .Net 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>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="___/config/config_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">'../config/config.php'</span>)
|
||||
(line <span class="line-number">104</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_davical_configuration_missing_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---davical_configuration_missing.php.html">'davical_configuration_missing.php'</a></span>)
|
||||
(line <span class="line-number">107</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_/etc/davical/config_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">'/etc/davical/config.php'</span>)
|
||||
(line <span class="line-number">95</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_/usr/local/etc/davical/config_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">'/usr/local/etc/davical/config.php'</span>)
|
||||
(line <span class="line-number">101</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_/etc/davical/_$_SERVER[SERVER_NAME]_-conf_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">'/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php'</span>)
|
||||
(line <span class="line-number">92</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">We use @file_exists because things like open_basedir might noisily deny access which could break DAViCal completely by causing output to start too early.</p>
|
||||
|
||||
</div>
|
||||
<a name="_/usr/local/etc/davical/_$_SERVER[SERVER_NAME]_-conf_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">'/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php'</span>)
|
||||
(line <span class="line-number">98</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_AWLUtilities_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">'AWLUtilities.php'</span>)
|
||||
(line <span class="line-number">63</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_PgQuery_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">'PgQuery.php'</span>)
|
||||
(line <span class="line-number">149</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Force the domain name to what was in the configuration file</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<a name="sec-constants"></a>
|
||||
<div class="info-box">
|
||||
<div class="info-box-title">Constants</div>
|
||||
<div class="nav-bar">
|
||||
<a href="#sec-description">Description</a> |
|
||||
<a href="#sec-includes">Includes</a>
|
||||
| <span class="disabled">Constants</span>
|
||||
| <a href="#sec-functions">Functions</a>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="defineDAVICAL_MAXPRIV"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Constant.png" />
|
||||
<span class="const-title">
|
||||
<span class="const-name">DAVICAL_MAXPRIV</span> = "65535"
|
||||
(line <span class="line-number">357</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a privilege string, or an array of privilege strings, return a bit mask of the privileges.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> A bit mask of the privileges.</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>
|
||||
| <a href="#sec-constants">Constants</a>
|
||||
| <span class="disabled">Functions</span>
|
||||
</div>
|
||||
<div class="info-box-body">
|
||||
<a name="functionbits_to_privilege" id="functionbits_to_privilege"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">bits_to_privilege</span> (line <span class="line-number">408</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Given a bit mask of the privileges, will return an array of the text values of privileges.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The string (or array of strings) of privilege names</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">mixed</span>
|
||||
<span class="method-name">
|
||||
bits_to_privilege
|
||||
</span>
|
||||
(<span class="var-type">integer</span> <span class="var-name">$raw_bits</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">integer</span>
|
||||
<span class="var-name">$raw_bits</span><span class="var-description">: A bit mask of the privileges.</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionConstructURL" id="functionConstructURL"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">ConstructURL</span> (line <span class="line-number">278</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Construct a URL from the supplied dav_name. The URL will be urlencoded, except for any '/' characters in it.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ConstructURL
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$partial_path</span>, [<span class="var-type"></span> <span class="var-name">$force_script</span> = <span class="var-default">false</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$partial_path</span><span class="var-description">: The part of the path after the script name</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$force_script</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionDateToISODate" id="functionDateToISODate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">DateToISODate</span> (line <span class="line-number">346</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Convert a date into ISO format into the sparkly new ISO format.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DateToISODate
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$indate</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$indate</span><span class="var-description">: The date to convert</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionDeconstructURL" id="functionDeconstructURL"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">DeconstructURL</span> (line <span class="line-number">306</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Deconstruct a dav_name from the supplied URL. The dav_name will be urldecoded.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
DeconstructURL
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$url</span>, [<span class="var-type"></span> <span class="var-name">$force_script</span> = <span class="var-default">false</span>], <span class="var-type">string</span> <span class="var-name">$partial_path</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$partial_path</span><span class="var-description">: The part of the path after the script name</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$url</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$force_script</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionearly_exception_handler" id="functionearly_exception_handler"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">early_exception_handler</span> (line <span class="line-number">17</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
early_exception_handler
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$exception</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$exception</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functiongetStatusMessage" id="functiongetStatusMessage"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">getStatusMessage</span> (line <span class="line-number">221</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return the HTTP status code description for a given code. Hopefully this is an efficient way to code this.</p>
|
||||
<ul class="tags">
|
||||
<li><span class="field">return:</span> The text for a give HTTP status code, in english</li>
|
||||
</ul>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">string</span>
|
||||
<span class="method-name">
|
||||
getStatusMessage
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$status</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$status</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functiongetUserByID" id="functiongetUserByID"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">getUserByID</span> (line <span class="line-number">199</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return a user record identified by a user_no, caching it for any subsequent lookup</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
getUserByID
|
||||
</span>
|
||||
(<span class="var-type">int</span> <span class="var-name">$user_no</span>, [<span class="var-type">boolean</span> <span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">int</span>
|
||||
<span class="var-name">$user_no</span><span class="var-description">: The ID of the record to retrieve</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$use_cache</span><span class="var-description">: Whether or not to use the cache (default: yes)</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functiongetUserByName" id="functiongetUserByName"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">getUserByName</span> (line <span class="line-number">174</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Return a user record identified by a username, caching it for any subsequent lookup</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
getUserByName
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$username</span>, [<span class="var-type">boolean</span> <span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$username</span><span class="var-description">: The username of the record to retrieve</span> </li>
|
||||
<li>
|
||||
<span class="var-type">boolean</span>
|
||||
<span class="var-name">$use_cache</span><span class="var-description">: Whether or not to use the cache (default: yes)</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionISODateToHTTPDate" id="functionISODateToHTTPDate"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">ISODateToHTTPDate</span> (line <span class="line-number">337</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<p class="short-description">Convert a date from ISO format into the sad old HTTP format.</p>
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
ISODateToHTTPDate
|
||||
</span>
|
||||
(<span class="var-type">string</span> <span class="var-name">$isodate</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type">string</span>
|
||||
<span class="var-name">$isodate</span><span class="var-description">: The date to convert</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="functionprivilege_to_bits" id="functionprivilege_to_bits"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div>
|
||||
<img src="../media/images/Function.png" />
|
||||
<span class="method-title">privilege_to_bits</span> (line <span class="line-number">358</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
privilege_to_bits
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$raw_privs</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$raw_privs</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Thu, 25 Feb 2010 11:39:17 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,76 +0,0 @@
|
||||
<?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 freebusy-GET.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/freebusy-GET.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="_RRule_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"><a href="../awl/caldav/_inc---RRule.php.html">'RRule.php'</a></span>)
|
||||
(line <span class="line-number">3</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
<a name="_iCalendar_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">'iCalendar.php'</span>)
|
||||
(line <span class="line-number">2</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 17 Apr 2010 12:32:28 +1200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
||||
</p>
|
||||
</div></body>
|
||||
</html>
|
||||
@ -1,746 +0,0 @@
|
||||
<?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 xmpp</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"> xmpp</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">********************************************************************</p>
|
||||
<p class="description"><p>XMPP PubSub for DAViCal Copyright 2009 Rob Ostensen rob@boxacle.net Licenced http://gnu.org/copyleft/gpl.html GNU GPL v2</p><p>*******************************************************************</p></p>
|
||||
<p class="notes">
|
||||
Located in <a class="field" href="_inc---pubsub.php.html">/inc/pubsub.php</a> (line <span class="field">11</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">mixed</span>
|
||||
<a href="#$idle" title="details" class="var-name">$idle</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$jid" title="details" class="var-name">$jid</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$password" title="details" class="var-name">$password</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$port" title="details" class="var-name">$port</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$pubsubLayout" title="details" class="var-name">$pubsubLayout</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$resource" title="details" class="var-name">$resource</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$server" title="details" class="var-name">$server</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$status" title="details" class="var-name">$status</a>
|
||||
</div>
|
||||
<div class="var-title">
|
||||
<img src="../media/images/Variable.png" alt=" " />
|
||||
<span class="var-type">mixed</span>
|
||||
<a href="#$tls" title="details" class="var-name">$tls</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">xmpp</span>
|
||||
<a href="#__construct" title="details" class="method-name">__construct</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#addHandler" title="details" class="method-name">addHandler</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$direction</span>, <span class="var-type"></span> <span class="var-name">$command</span>, <span class="var-type"></span> <span class="var-name">$handler</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#close" title="details" class="method-name">close</a>
|
||||
()
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#open" title="details" class="method-name">open</a>
|
||||
([<span class="var-type"></span> <span class="var-name">$jid</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$password</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="#pubsubConfig" title="details" class="method-name">pubsubConfig</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#pubsubCreate" title="details" class="method-name">pubsubCreate</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>, [<span class="var-type"></span> <span class="var-name">$configure</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="#pubsubDelete" title="details" class="method-name">pubsubDelete</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#pubsubPublish" title="details" class="method-name">pubsubPublish</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>, <span class="var-type"></span> <span class="var-name">$contents</span>, <span class="var-type"></span> <span class="var-name">$nodeId</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#pubsubPurge" title="details" class="method-name">pubsubPurge</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
<div class="method-definition">
|
||||
<img src="../media/images/Method.png" alt=" "/>
|
||||
<span class="method-result">void</span>
|
||||
<a href="#sendMessage" title="details" class="method-name">sendMessage</a>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$message</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$idle" id="$idle"><!-- --></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">$idle</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$jid" id="$jid"><!-- --></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">$jid</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$password" id="$password"><!-- --></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">$password</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$port" id="$port"><!-- --></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">$port</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$pubsubLayout" id="$pubsubLayout"><!-- --></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">$pubsubLayout</span>
|
||||
= <span class="var-default">'hometree'</span> (line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$resource" id="$resource"><!-- --></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">$resource</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$server" id="$server"><!-- --></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">$server</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$status" id="$status"><!-- --></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">$status</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="var$tls" id="$tls"><!-- --></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">$tls</span>
|
||||
(line <span class="line-number">23</span>)
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</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="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Constructor.png" />
|
||||
<span class="method-title">Constructor __construct</span> (line <span class="line-number">26</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">xmpp</span>
|
||||
<span class="method-name">
|
||||
__construct
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodaddHandler" id="addHandler"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">addHandler</span> (line <span class="line-number">673</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
addHandler
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$direction</span>, <span class="var-type"></span> <span class="var-name">$command</span>, <span class="var-type"></span> <span class="var-name">$handler</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$direction</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$command</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$handler</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodclose" id="close"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">close</span> (line <span class="line-number">662</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
close
|
||||
</span>
|
||||
()
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodopen" id="open"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">open</span> (line <span class="line-number">645</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
open
|
||||
</span>
|
||||
([<span class="var-type"></span> <span class="var-name">$jid</span> = <span class="var-default">null</span>], [<span class="var-type"></span> <span class="var-name">$password</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$jid</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$password</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodpubsubConfig" id="pubsubConfig"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">pubsubConfig</span> (line <span class="line-number">295</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
pubsubConfig
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$name</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodpubsubCreate" id="pubsubCreate"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">pubsubCreate</span> (line <span class="line-number">259</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
pubsubCreate
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>, [<span class="var-type"></span> <span class="var-name">$configure</span> = <span class="var-default">null</span>])
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$name</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$configure</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodpubsubDelete" id="pubsubDelete"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">pubsubDelete</span> (line <span class="line-number">312</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
pubsubDelete
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$name</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodpubsubPublish" id="pubsubPublish"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">pubsubPublish</span> (line <span class="line-number">346</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
pubsubPublish
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>, <span class="var-type"></span> <span class="var-name">$contents</span>, <span class="var-type"></span> <span class="var-name">$nodeId</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$name</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$contents</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$nodeId</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodpubsubPurge" id="pubsubPurge"><!-- --></a>
|
||||
<div class="evenrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">pubsubPurge</span> (line <span class="line-number">329</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
pubsubPurge
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$type</span>, <span class="var-type"></span> <span class="var-name">$name</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$type</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$name</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
<a name="methodsendMessage" id="sendMessage"><!-- --></a>
|
||||
<div class="oddrow">
|
||||
|
||||
<div class="method-header">
|
||||
<img src="../media/images/Method.png" />
|
||||
<span class="method-title">sendMessage</span> (line <span class="line-number">249</span>)
|
||||
</div>
|
||||
|
||||
<!-- ========== Info from phpDoc block ========= -->
|
||||
<ul class="tags">
|
||||
<li><span class="field">access:</span> public</li>
|
||||
</ul>
|
||||
|
||||
<div class="method-signature">
|
||||
<span class="method-result">void</span>
|
||||
<span class="method-name">
|
||||
sendMessage
|
||||
</span>
|
||||
(<span class="var-type"></span> <span class="var-name">$to</span>, <span class="var-type"></span> <span class="var-name">$message</span>)
|
||||
</div>
|
||||
|
||||
<ul class="parameters">
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$to</span> </li>
|
||||
<li>
|
||||
<span class="var-type"></span>
|
||||
<span class="var-name">$message</span> </li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<p class="notes" id="credit">
|
||||
Documentation generated on Sat, 17 Apr 2010 12:32:28 +1200 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