nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-03-13 08:00:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/davical/Principal/Principal.html
Andrew McMillan 4ee76f91ff Release 1.1.0
2012-06-17 23:16:25 +12:00

1684 lines
51 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 Class Principal</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"> Principal</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">A class for things to do with a Principal</p>
<p class="notes">
Located in <a class="field" href="_inc---Principal.php.html">/inc/Principal.php</a> (line <span class="field">19</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="../../davical/Principal/DAVPrincipal.html">DAVPrincipal</a>
</td>
<td>
A class for things to do with a DAV Principal
</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">boolean</span>
<a href="#$by_email" title="details" class="var-name">$by_email</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$collections" title="details" class="var-name">$collections</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$collection_id" title="details" class="var-name">$collection_id</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$created" title="details" class="var-name">$created</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$date_format_type" title="details" class="var-name">$date_format_type</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$dav_name" title="details" class="var-name">$dav_name</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$dead_properties" title="details" class="var-name">$dead_properties</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$default_calendar" title="details" class="var-name">$default_calendar</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$default_privileges" title="details" class="var-name">$default_privileges</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$displayname" title="details" class="var-name">$displayname</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$email" title="details" class="var-name">$email</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$email_ok" title="details" class="var-name">$email_ok</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">boolean</span>
<a href="#$exists" title="details" class="var-name">$exists</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$fullname" title="details" class="var-name">$fullname</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$is_addressbook" title="details" class="var-name">$is_addressbook</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$is_calendar" title="details" class="var-name">$is_calendar</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$is_principal" title="details" class="var-name">$is_principal</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$locale" title="details" class="var-name">$locale</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$modified" title="details" class="var-name">$modified</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$original_request_url" title="details" class="var-name">$original_request_url</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="#$principal_id" title="details" class="var-name">$principal_id</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$privileges" title="details" class="var-name">$privileges</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$resourcetypes" title="details" class="var-name">$resourcetypes</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$type_id" title="details" class="var-name">$type_id</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">The</span>
<a href="#$url" title="details" class="var-name">$url</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$username" title="details" class="var-name">$username</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$user_active" title="details" class="var-name">$user_active</a>
</div>
<div class="var-title">
<img src="../../media/images/Variable.png" alt=" " />
<span class="var-type">mixed</span>
<a href="#$user_no" title="details" class="var-name">$user_no</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/StaticMethod.png" alt=" "/>
static <span class="method-result">void</span>
<a href="#cacheDelete" title="details" class="method-name">cacheDelete</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result">void</span>
<a href="#cacheFlush" title="details" class="method-name">cacheFlush</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$where</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$whereparams</span> = <span class="var-default">array()</span>])
</div>
<div class="method-definition">
<img src="../../media/images/StaticMethod.png" alt=" "/>
static <span class="method-result">void</span>
<a href="#updateableFields" title="details" class="method-name">updateableFields</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Constructor.png" alt=" "/>
<span class="method-result"><a href="../../davical/Principal/Principal.html">Principal</a></span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$use_cache</span> = <span class="var-default">true</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#byEmail" title="details" class="method-name">byEmail</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Create" title="details" class="method-name">Create</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field_values</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#dav_name" title="details" class="method-name">dav_name</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#default_calendar" title="details" class="method-name">default_calendar</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#email" title="details" class="method-name">email</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Exists" title="details" class="method-name">Exists</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#FetchCollections" title="details" class="method-name">FetchCollections</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#FetchDeadProperties" title="details" class="method-name">FetchDeadProperties</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#internal_url" title="details" class="method-name">internal_url</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'principal'</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#principal_id" title="details" class="method-name">principal_id</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#setUsername" title="details" class="method-name">setUsername</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_username</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#unCache" title="details" class="method-name">unCache</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#Update" title="details" class="method-name">Update</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field_values</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#url" title="details" class="method-name">url</a>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'principal'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$internal</span> = <span class="var-default">false</span>])
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">string</span>
<a href="#username" title="details" class="method-name">username</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">int</span>
<a href="#user_no" title="details" class="method-name">user_no</a>
()
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#__get" title="details" class="method-name">__get</a>
(<span class="var-type">$property</span>&nbsp;<span class="var-name">$property</span>)
</div>
<div class="method-definition">
<img src="../../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#__isset" title="details" class="method-name">__isset</a>
(<span class="var-type">$property</span>&nbsp;<span class="var-name">$property</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$by_email" id="$by_email"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$by_email</span>
(line <span class="line-number">92</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Whether this was retrieved using an e-mail address</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$collections" id="$collections"><!-- --></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">$collections</span>
(line <span class="line-number">101</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$collection_id" id="$collection_id"><!-- --></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">$collection_id</span>
(line <span class="line-number">67</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$created" id="$created"><!-- --></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">$created</span>
(line <span class="line-number">55</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$date_format_type" id="$date_format_type"><!-- --></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">$date_format_type</span>
(line <span class="line-number">60</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$dav_name" id="$dav_name"><!-- --></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">$dav_name</span>
(line <span class="line-number">53</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$dead_properties" id="$dead_properties"><!-- --></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">$dead_properties</span>
(line <span class="line-number">102</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$default_calendar" id="$default_calendar"><!-- --></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">$default_calendar</span>
(line <span class="line-number">103</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$default_privileges" id="$default_privileges"><!-- --></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">$default_privileges</span>
(line <span class="line-number">64</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$displayname" id="$displayname"><!-- --></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">$displayname</span>
(line <span class="line-number">63</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$email" id="$email"><!-- --></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">$email</span>
(line <span class="line-number">52</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$email_ok" id="$email_ok"><!-- --></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">$email_ok</span>
(line <span class="line-number">59</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$exists" id="$exists"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">boolean</span>
<span class="var-name">$exists</span>
(line <span class="line-number">76</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Whether this Principal actually exists in the database yet.</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$fullname" id="$fullname"><!-- --></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">$fullname</span>
(line <span class="line-number">58</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$is_addressbook" id="$is_addressbook"><!-- --></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">$is_addressbook</span>
(line <span class="line-number">68</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$is_calendar" id="$is_calendar"><!-- --></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">$is_calendar</span>
(line <span class="line-number">66</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$is_principal" id="$is_principal"><!-- --></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">$is_principal</span>
(line <span class="line-number">65</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$locale" id="$locale"><!-- --></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">$locale</span>
(line <span class="line-number">61</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$modified" id="$modified"><!-- --></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">$modified</span>
(line <span class="line-number">56</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$original_request_url" id="$original_request_url"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$original_request_url</span>
(line <span class="line-number">86</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> actual requested URL for this principal, when the request was for /principals/... or such</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$password" id="$password"><!-- --></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">$password</span>
(line <span class="line-number">57</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$principal_id" id="$principal_id"><!-- --></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">$principal_id</span>
(line <span class="line-number">51</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$privileges" id="$privileges"><!-- --></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">$privileges</span>
(line <span class="line-number">70</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$resourcetypes" id="$resourcetypes"><!-- --></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">$resourcetypes</span>
(line <span class="line-number">69</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$type_id" id="$type_id"><!-- --></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">$type_id</span>
(line <span class="line-number">62</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$url" id="$url"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<img src="../../media/images/Variable.png" />
<span class="var-title">
<span class="var-type">The</span>
<span class="var-name">$url</span>
(line <span class="line-number">81</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> home URL of the principal</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$username" id="$username"><!-- --></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">$username</span>
(line <span class="line-number">49</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Columns from the database</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$user_active" id="$user_active"><!-- --></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">$user_active</span>
(line <span class="line-number">54</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$user_no" id="$user_no"><!-- --></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">$user_no</span>
(line <span class="line-number">50</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<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="methodcacheDelete" id="cacheDelete"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static cacheDelete</span> (line <span class="line-number">614</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">
cacheDelete
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$type</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$value</span> </li>
</ul>
</div>
<a name="methodcacheFlush" id="cacheFlush"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static cacheFlush</span> (line <span class="line-number">603</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">
cacheFlush
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$where</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$whereparams</span> = <span class="var-default">array()</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$where</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$whereparams</span> </li>
</ul>
</div>
<a name="methodupdateableFields" id="updateableFields"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/StaticMethod.png" />
<span class="method-title">static updateableFields</span> (line <span class="line-number">30</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">
updateableFields
</span>
()
</div>
</div>
<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">122</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Construct a new Principal object. The principal record will be retrieved from the database, or (if not found) initialised to a new record. You can test for whether the Principal exists by calling the Exists() method on the returned object.</p>
<p class="description"><p>Depending on the supplied $type, the following behaviour will occur: path: Will attempt to extract a username or email from the supplied path, and then do what those do. dav_name: Expects the dav_name of a &lt;em&gt;principal&lt;/em&gt;, exactly, like: /principal/ and will use that as for username. user_no: Expects an integer which is the usr.user_no (deprecated) principal_id: Expects an integer which is the principal.principal_id email: Will try and retrieve a unique principal by using the email address. Will fail (subsequent call to Exists() will be false) if there is not a unique match. username: Will retrieve based on strtolower($value) = lower(usr.username)</p></p>
<ul class="tags">
<li><span class="field">throws:</span> Exception When provided with an invalid $type parameter.</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../../davical/Principal/Principal.html">Principal</a></span>
<span class="method-name">
__construct
</span>
(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, [<span class="var-type">boolean</span>&nbsp;<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">$type</span><span class="var-description">: One of 'path', 'dav_name', 'user_no', 'principal_id', 'email' or 'username'</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$value</span><span class="var-description">: A value appropriate to the $type requested.</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$use_cache</span><span class="var-description">: Whether to use an available cache source (default true)</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../../davical/Principal/DAVPrincipal.html#method__construct">DAVPrincipal::__construct()</a>
: Constructor
</li>
</ul>
</div>
<a name="methodbyEmail" id="byEmail"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">byEmail</span> (line <span class="line-number">288</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">
byEmail
</span>
()
</div>
</div>
<a name="methodCreate" id="Create"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Create</span> (line <span class="line-number">592</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">
Create
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field_values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field_values</span> </li>
</ul>
</div>
<a name="methoddav_name" id="dav_name"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">dav_name</span> (line <span class="line-number">380</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the partial path representing this principal</p>
<ul class="tags">
<li><span class="field">return:</span> The dav_name</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
dav_name
</span>
()
</div>
</div>
<a name="methoddefault_calendar" id="default_calendar"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">default_calendar</span> (line <span class="line-number">428</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the default calendar for this principal</p>
<ul class="tags">
<li><span class="field">return:</span> The internal dav_name for the home_calendar, or false if there is none</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
default_calendar
</span>
()
</div>
</div>
<a name="methodemail" id="email"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">email</span> (line <span class="line-number">371</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the email</p>
<ul class="tags">
<li><span class="field">return:</span> The email</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
email
</span>
()
</div>
</div>
<a name="methodExists" id="Exists"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Exists</span> (line <span class="line-number">283</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">
Exists
</span>
()
</div>
</div>
<a name="methodFetchCollections" id="FetchCollections"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchCollections</span> (line <span class="line-number">411</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Fetch the list of collections for this principal</p>
<ul class="tags">
<li><span class="field">return:</span> The internal dav_name for the home_calendar, or null if there is none</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
FetchCollections
</span>
()
</div>
</div>
<a name="methodFetchDeadProperties" id="FetchDeadProperties"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">FetchDeadProperties</span> (line <span class="line-number">394</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Ensure the principal's dead properties are loaded</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FetchDeadProperties
</span>
()
</div>
</div>
<a name="methodinternal_url" id="internal_url"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">internal_url</span> (line <span class="line-number">494</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">
internal_url
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'principal'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
</ul>
</div>
<a name="methodprincipal_id" id="principal_id"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">principal_id</span> (line <span class="line-number">362</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the principal_id</p>
<ul class="tags">
<li><span class="field">return:</span> The principal_id</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
principal_id
</span>
()
</div>
</div>
<a name="methodsetUsername" id="setUsername"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">setUsername</span> (line <span class="line-number">342</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the username - but only if the record does not yet exist!</p>
<ul class="tags">
<li><span class="field">return:</span> The username</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
setUsername
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_username</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_username</span> </li>
</ul>
</div>
<a name="methodunCache" id="unCache"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">unCache</span> (line <span class="line-number">499</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">
unCache
</span>
()
</div>
</div>
<a name="methodUpdate" id="Update"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">Update</span> (line <span class="line-number">596</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">
Update
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$field_values</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$field_values</span> </li>
</ul>
</div>
<a name="methodurl" id="url"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">url</span> (line <span class="line-number">468</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the URL for this principal</p>
<ul class="tags">
<li><span class="field">return:</span> The principal-URL</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
url
</span>
([<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'principal'</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$internal</span> = <span class="var-default">false</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$type</span><span class="var-description">: The type of URL we want (the principal, by default)</span> </li>
<li>
<span class="var-type">boolean</span>
<span class="var-name">$internal</span><span class="var-description">: Whether an internal reference is requested</span> </li>
</ul>
</div>
<a name="methodusername" id="username"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">username</span> (line <span class="line-number">333</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the username</p>
<ul class="tags">
<li><span class="field">return:</span> The username</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
username
</span>
()
</div>
</div>
<a name="methoduser_no" id="user_no"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">user_no</span> (line <span class="line-number">353</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the user_no</p>
<ul class="tags">
<li><span class="field">return:</span> The user_no</li>
</ul>
<div class="method-signature">
<span class="method-result">int</span>
<span class="method-name">
user_no
</span>
()
</div>
</div>
<a name="method__get" id="__get"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">__get</span> (line <span class="line-number">251</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This will allow protected properties to be referenced for retrieval, but not referenced for update.</p>
<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">
__get
</span>
(<span class="var-type">$property</span>&nbsp;<span class="var-name">$property</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$property</span>
<span class="var-name">$property</span> </li>
</ul>
</div>
<a name="method__isset" id="__isset"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../../media/images/Method.png" />
<span class="method-title">__isset</span> (line <span class="line-number">261</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This will allow protected properties to be examined for whether they are set without making them writable. PHP 5.1 or later only.</p>
<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">
__isset
</span>
(<span class="var-type">$property</span>&nbsp;<span class="var-name">$property</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">$property</span>
<span class="var-name">$property</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Sun, 17 Jun 2012 10:28:00 +0000 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