mirror of
https://gitlab.com/davical-project/davical.git
synced 2026-02-11 03:03:34 +00:00
499 lines
17 KiB
HTML
499 lines
17 KiB
HTML
<?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 Tue, 23 Feb 2010 23:26:29 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
|
|
</p>
|
|
</div></body>
|
|
</html>
|