## /htdocs/always.php

Description

- author: Andrew McMillan <andrew@mcmillan.net.nz>
- copyright: Catalyst .Net Ltd, Morphoss Ltd <http://www.morphoss.com/>
- license: GNU GPL v2 or later

Includes
include (davical_configuration_missing.php) (line 139)
include ('/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php') (line 127)
include ('/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php') (line 121)

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

include ('/etc/davical/config.php') (line 124)
include ('../config/config.php') (line 133)
include ('/usr/local/etc/davical/config.php') (line 130)
include ('config/config.php') (line 136)
include_once ('AWLUtilities.php') (line 72)
include_once ('AWLUtilities.php') (line 84)
require_once ('AwlQuery.php') (line 184)

Force the domain name to what was in the configuration file

Constants
DAVICAL_ADDRESSBOOK_MAXPRIV = "1023" (line 434)
DAVICAL_MAXPRIV = "65535" (line 433)

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

- return: A bit mask of the privileges.

Functions
bits_to_privilege (line 485)

Given a bit mask of the privileges, will return an array of the text values of privileges.

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

mixed bits_to_privilege (integer $raw_bits, [ $resourcetype = 'resource'])

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

ConstructURL (line 354)

Construct a URL from the supplied dav_name. The URL will be urlencoded, except for any '/' characters in it.

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

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

DateToISODate (line 422)

Convert a date into ISO format into the sparkly new ISO format.

void DateToISODate (string $indate)

- string $indate: The date to convert

DeconstructURL (line 382)

Deconstruct a dav_name from the supplied URL. The dav_name will be urldecoded.

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

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

early_exception_handler (line 20)

- author: Andrew McMillan <andrew@mcmillan.net.nz>
- copyright: Catalyst .Net Ltd, Morphoss Ltd <http://www.morphoss.com/>
- license: GNU GPL v2 or later

void early_exception_handler ( $e)

- $e

getPrincipalByID (line 284)

Return a user record identified by a user_no, caching it for any subsequent lookup

void getPrincipalByID ( $principal_id, [boolean $use_cache = true], int $user_no)

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

getStatusMessage (line 297)

Return the HTTP status code description for a given code. Hopefully this is an efficient way to code this.

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

string getStatusMessage ( $status)

- $status

getUserByEMail (line 253)

Return a user record identified by e-mail address, caching it for any subsequent lookup

void getUserByEMail (string $email, [boolean $use_cache = true])

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

getUserByID (line 271)

Return a user record identified by a user_no, caching it for any subsequent lookup

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

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

getUserByName (line 240)

Return a user record identified by a username, caching it for any subsequent lookup

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

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

ISODateToHTTPDate (line 413)

Convert a date from ISO format into the sad old HTTP format.

void ISODateToHTTPDate (string $isodate)

- string $isodate: The date to convert

privileges_to_XML (line 532)

Returns the array of privilege names converted into XMLElements

void privileges_to_XML ( $privilege_names, [ &$xmldoc = null])

- $privilege_names
- &$xmldoc

privilege_to_bits (line 435)
void privilege_to_bits ( $raw_privs)

- $raw_privs

_davical_get_principal_query_cached (line 207)
void _davical_get_principal_query_cached ( $where, $parameter)

- $where
- $parameter

Documentation generated on Sun, 26 Sep 2010 00:46:06 +1200 by phpDocumentor 1.4.3