nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-02-22 04:53:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/davical/_htdocs---always.php.html
Andrew McMillan 11892c4e97 Release 0.9.9.6
2011-09-27 13:27:56 +13:00

541 lines
18 KiB
HTML
Raw Blame History

<?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">/htdocs/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 &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
<li><span class="field">copyright:</span> Catalyst .Net Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
</ul>
</div>
</div>
<a name="sec-includes"></a>
<div class="info-box">
<div class="info-box-title">Includes</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Includes</span>
| <a href="#sec-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">141</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</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">135</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_/usr/local/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">'/usr/local/etc/davical/config.php'</span>)
(line <span class="line-number">138</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_/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">'/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php'</span>)
(line <span class="line-number">129</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="_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">144</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">147</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">132</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_AWLUtilities_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">'AWLUtilities.php'</span>)
(line <span class="line-number">90</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">include_once</span>
(<span class="include-name">'AWLUtilities.php'</span>)
(line <span class="line-number">77</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<a name="_AwlQuery_php"><!-- --></a>
<div class="evenrow">
<div>
<img src="../media/images/Page.png" alt=" " />
<span class="include-title">
<span class="include-type">require_once</span>
(<span class="include-name">'AwlQuery.php'</span>)
(line <span class="line-number">193</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Force the domain name to what was in the configuration file</p>
</div>
<a name="_Principal_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/Principal/_inc---Principal.php.html">Principal.php</a></span>)
(line <span class="line-number">211</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</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_ADDRESSBOOK_MAXPRIV"><!-- --></a>
<div class="evenrow">
<div>
<img src="../media/images/Constant.png" />
<span class="const-title">
<span class="const-name">DAVICAL_ADDRESSBOOK_MAXPRIV</span> = &quot;1023&quot;
(line <span class="line-number">357</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
</div>
<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> = &quot;65535&quot;
(line <span class="line-number">356</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">409</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>&nbsp;<span class="var-name">$raw_bits</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$resourcetype</span> = <span class="var-default">&#039;resource&#039;</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>
<li>
<span class="var-type"></span>
<span class="var-name">$resourcetype</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">275</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>&nbsp;<span class="var-name">$partial_path</span>, [<span class="var-type"></span>&nbsp;<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">344</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>&nbsp;<span class="var-name">$indate</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$in_utc</span> = <span class="var-default">false</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>
<li>
<span class="var-type"></span>
<span class="var-name">$in_utc</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">304</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>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$force_script</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<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">20</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
<li><span class="field">copyright:</span> Catalyst .Net Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
<li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
early_exception_handler
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$e</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">218</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>&nbsp;<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="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">335</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>&nbsp;<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="functionprivileges_to_XML" id="functionprivileges_to_XML"><!-- --></a>
<div class="oddrow">
<div>
<img src="../media/images/Function.png" />
<span class="method-title">privileges_to_XML</span> (line <span class="line-number">456</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the array of privilege names converted into XMLElements</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
privileges_to_XML
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$privilege_names</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">&$xmldoc</span> </li>
</ul>
</div>
<a name="functionprivilege_to_bits" id="functionprivilege_to_bits"><!-- --></a>
<div class="evenrow">
<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>&nbsp;<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 Tue, 27 Sep 2011 11:30:43 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink