docs/api/davical/Principal/DAVPrincipal.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3   <html xmlns="http://www.w3.org/1999/xhtml">
   4                 <head>
   5                         <!-- template designed by Marco Von Ballmoos -->
   6                         <title>Docs For Class DAVPrincipal</title>
   7                         <link rel="stylesheet" href="../../media/stylesheet.css" />
   8                         <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9                 </head>
  10                 <body>
  11                         <div class="page-body">
  12 <h2 class="class-name"><img src="../../media/images/Class_logo.png"
  13                                                                                                                 alt=" Class"
  14                                                                                                                 title=" Class"
  15                                                                                                                 style="vertical-align: middle"> DAVPrincipal</h2>
  16
  17 <a name="sec-description"></a>
  18 <div class="info-box">
  19         <div class="info-box-title">Description</div>
  20         <div class="nav-bar">
  21                                         <span class="disabled">Description</span> |
  22                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  23                                                 |                                                                                       <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  24
  25                                         </div>
  26         <div class="info-box-body">
  27                         <!-- ========== Info from phpDoc block ========= -->
  28 <p class="short-description">A class for things to do with a DAV Principal</p>
  29                 <p class="notes">
  30                         Located in <a class="field" href="_inc---DAVPrincipal.php.html">/inc/DAVPrincipal.php</a> (line <span class="field">19</span>)
  31                 </p>
  32
  33
  34                 <pre><a href="../../davical/Principal/Principal.html">Principal</a>
  35    |
  36    --DAVPrincipal</pre>
  37
  38                         </div>
  39 </div>
  40
  41
  42
  43         <a name="sec-var-summary"></a>
  44         <div class="info-box">
  45                 <div class="info-box-title">Variable Summary</span></div>
  46                 <div class="nav-bar">
  47                         <a href="#sec-description">Description</a> |
  48                                                 <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
  49                                                         |
  50                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  51
  52                                                                 </div>
  53                 <div class="info-box-body">
  54                         <div class="var-summary">
  55                                                                                                                                                                                                 <div class="var-title">
  56                                         <img src="../../media/images/Variable.png" alt=" " />
  57                                         <span class="var-type">RFC3744:</span>
  58                                         <a href="#$_is_group" title="details" class="var-name">$_is_group</a>
  59                                 </div>
  60                                                                                         </div>
  61                 </div>
  62         </div>
  63
  64         <a name="sec-method-summary"></a>
  65         <div class="info-box">
  66                 <div class="info-box-title">Method Summary</span></div>
  67                 <div class="nav-bar">
  68                         <a href="#sec-description">Description</a> |
  69                                                                                                                                                 <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
  70
  71                                 |
  72                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  73                 </div>
  74                 <div class="info-box-body">
  75                         <div class="method-summary">
  76                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  77                                         <img src="../../media/images/Constructor.png" alt=" "/>
  78                                                                                         <span class="method-result">boolean</span>
  79                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  80                                                                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
  81                                                                         </div>
  82                                                                                                                                 <div class="method-definition">
  83                                         <img src="../../media/images/Method.png" alt=" "/>
  84                                                                                         <span class="method-result">void</span>
  85                                                                                 <a href="#addressbook_home_set" title="details" class="method-name">addressbook_home_set</a>
  86                                                                                 ()
  87                                                                         </div>
  88                                                                                                                                 <div class="method-definition">
  89                                         <img src="../../media/images/Method.png" alt=" "/>
  90                                                                                         <span class="method-result">void</span>
  91                                                                                 <a href="#AsCollection" title="details" class="method-name">AsCollection</a>
  92                                                                                 ()
  93                                                                         </div>
  94                                                                                                                                 <div class="method-definition">
  95                                         <img src="../../media/images/Method.png" alt=" "/>
  96                                                                                         <span class="method-result">void</span>
  97                                                                                 <a href="#calendar_free_busy_set" title="details" class="method-name">calendar_free_busy_set</a>
  98                                                                                 ()
  99                                                                         </div>
 100                                                                                                                                 <div class="method-definition">
 101                                         <img src="../../media/images/Method.png" alt=" "/>
 102                                                                                         <span class="method-result">void</span>
 103                                                                                 <a href="#calendar_home_set" title="details" class="method-name">calendar_home_set</a>
 104                                                                                 ()
 105                                                                         </div>
 106                                                                                                                                 <div class="method-definition">
 107                                         <img src="../../media/images/Method.png" alt=" "/>
 108                                                                                         <span class="method-result">void</span>
 109                                                                                 <a href="#FetchProxyGroups" title="details" class="method-name">FetchProxyGroups</a>
 110                                                                                 ()
 111                                                                         </div>
 112                                                                                                                                 <div class="method-definition">
 113                                         <img src="../../media/images/Method.png" alt=" "/>
 114                                                                                         <span class="method-result">string</span>
 115                                                                                 <a href="#GetProperty" title="details" class="method-name">GetProperty</a>
 116                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$property_id</span>)
 117                                                                         </div>
 118                                                                                                                                 <div class="method-definition">
 119                                         <img src="../../media/images/Method.png" alt=" "/>
 120                                                                                         <span class="method-result">void</span>
 121                                                                                 <a href="#GroupMemberSet" title="details" class="method-name">GroupMemberSet</a>
 122                                                                                 ()
 123                                                                         </div>
 124                                                                                                                                 <div class="method-definition">
 125                                         <img src="../../media/images/Method.png" alt=" "/>
 126                                                                                         <span class="method-result">void</span>
 127                                                                                 <a href="#GroupMembership" title="details" class="method-name">GroupMembership</a>
 128                                                                                 ()
 129                                                                         </div>
 130                                                                                                                                 <div class="method-definition">
 131                                         <img src="../../media/images/Method.png" alt=" "/>
 132                                                                                         <span class="method-result">void</span>
 133                                                                                 <a href="#InitialiseRecord" title="details" class="method-name">InitialiseRecord</a>
 134                                                                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">$usr</span>)
 135                                                                         </div>
 136                                                                                                                                 <div class="method-definition">
 137                                         <img src="../../media/images/Method.png" alt=" "/>
 138                                                                                         <span class="method-result">boolean</span>
 139                                                                                 <a href="#IsGroup" title="details" class="method-name">IsGroup</a>
 140                                                                                 ()
 141                                                                         </div>
 142                                                                                                                                 <div class="method-definition">
 143                                         <img src="../../media/images/Method.png" alt=" "/>
 144                                                                                         <span class="method-result">void</span>
 145                                                                                 <a href="#PrincipalProperty" title="details" class="method-name">PrincipalProperty</a>
 146                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
 147                                                                         </div>
 148                                                                                                                                 <div class="method-definition">
 149                                         <img src="../../media/images/Method.png" alt=" "/>
 150                                                                                         <span class="method-result">void</span>
 151                                                                                 <a href="#Privileges" title="details" class="method-name">Privileges</a>
 152                                                                                 ()
 153                                                                         </div>
 154                                                                                                                                 <div class="method-definition">
 155                                         <img src="../../media/images/Method.png" alt=" "/>
 156                                                                                         <span class="method-result">void</span>
 157                                                                                 <a href="#PropertySearch" title="details" class="method-name">PropertySearch</a>
 158                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span>)
 159                                                                         </div>
 160                                                                                                                                 <div class="method-definition">
 161                                         <img src="../../media/images/Method.png" alt=" "/>
 162                                                                                         <span class="method-result">void</span>
 163                                                                                 <a href="#ProxyFor" title="details" class="method-name">ProxyFor</a>
 164                                                                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
 165                                                                         </div>
 166                                                                                                                                 <div class="method-definition">
 167                                         <img src="../../media/images/Method.png" alt=" "/>
 168                                                                                         <span class="method-result">void</span>
 169                                                                                 <a href="#ReadProxyGroup" title="details" class="method-name">ReadProxyGroup</a>
 170                                                                                 ()
 171                                                                         </div>
 172                                                                                                                                 <div class="method-definition">
 173                                         <img src="../../media/images/Method.png" alt=" "/>
 174                                                                                         <span class="method-result">string</span>
 175                                                                                 <a href="#RenderAsXML" title="details" class="method-name">RenderAsXML</a>
 176                                                                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
 177                                                                         </div>
 178                                                                                                                                 <div class="method-definition">
 179                                         <img src="../../media/images/Method.png" alt=" "/>
 180                                                                                         <span class="method-result">void</span>
 181                                                                                 <a href="#unique_tag" title="details" class="method-name">unique_tag</a>
 182                                                                                 ()
 183                                                                         </div>
 184                                                                                                                                 <div class="method-definition">
 185                                         <img src="../../media/images/Method.png" alt=" "/>
 186                                                                                         <span class="method-result">void</span>
 187                                                                                 <a href="#WriteProxyGroup" title="details" class="method-name">WriteProxyGroup</a>
 188                                                                                 ()
 189                                                                         </div>
 190                                                                                         </div>
 191                 </div>
 192         </div>
 193
 194         <a name="sec-vars"></a>
 195         <div class="info-box">
 196                 <div class="info-box-title">Variables</div>
 197                 <div class="nav-bar">
 198                         <a href="#sec-description">Description</a> |
 199                                                                                 <a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
 200
 201
 202                                                                                 |
 203                                                                         <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
 204
 205                                         </div>
 206                 <div class="info-box-body">
 207
 208 <a name="var$_is_group" id="$_is_group"><!-- --></A>
 209 <div class="oddrow">
 210
 211         <div class="var-header">
 212                 <img src="../../media/images/Variable.png" />
 213                 <span class="var-title">
 214                         <span class="var-type">RFC3744:</span>
 215                         <span class="var-name">$_is_group</span>
 216                                                 (line <span class="line-number">42</span>)
 217                 </span>
 218         </div>
 219
 220         <!-- ========== Info from phpDoc block ========= -->
 221         <ul class="tags">
 222                                 <li><span class="field">var:</span> The principals that are direct members of this group.</li>
 223                                 <li><span class="field">access:</span> protected</li>
 224                         </ul>
 225
 226
 227
 228
 229
 230 </div>
 231                                                         <h4>Inherited Variables</h4>
 232                                 <A NAME='inherited_vars'><!-- --></A>
 233                                                                         <p>Inherited from <span class="classname"><a href="../../davical/Principal/Principal.html">Principal</a></span></p>
 234                                         <blockquote>
 235                                                                                                         <img src="../../media/images/Variable.png" />
 236                                                         <span class="var-title">
 237                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$by_email">Principal::$by_email</a></span><br>
 238                                                         </span>
 239                                                                                                         <img src="../../media/images/Variable.png" />
 240                                                         <span class="var-title">
 241                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$collections">Principal::$collections</a></span><br>
 242                                                         </span>
 243                                                                                                         <img src="../../media/images/Variable.png" />
 244                                                         <span class="var-title">
 245                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$collection_id">Principal::$collection_id</a></span><br>
 246                                                         </span>
 247                                                                                                         <img src="../../media/images/Variable.png" />
 248                                                         <span class="var-title">
 249                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$created">Principal::$created</a></span><br>
 250                                                         </span>
 251                                                                                                         <img src="../../media/images/Variable.png" />
 252                                                         <span class="var-title">
 253                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$date_format_type">Principal::$date_format_type</a></span><br>
 254                                                         </span>
 255                                                                                                         <img src="../../media/images/Variable.png" />
 256                                                         <span class="var-title">
 257                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$dav_name">Principal::$dav_name</a></span><br>
 258                                                         </span>
 259                                                                                                         <img src="../../media/images/Variable.png" />
 260                                                         <span class="var-title">
 261                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$dead_properties">Principal::$dead_properties</a></span><br>
 262                                                         </span>
 263                                                                                                         <img src="../../media/images/Variable.png" />
 264                                                         <span class="var-title">
 265                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$default_calendar">Principal::$default_calendar</a></span><br>
 266                                                         </span>
 267                                                                                                         <img src="../../media/images/Variable.png" />
 268                                                         <span class="var-title">
 269                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$default_privileges">Principal::$default_privileges</a></span><br>
 270                                                         </span>
 271                                                                                                         <img src="../../media/images/Variable.png" />
 272                                                         <span class="var-title">
 273                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$displayname">Principal::$displayname</a></span><br>
 274                                                         </span>
 275                                                                                                         <img src="../../media/images/Variable.png" />
 276                                                         <span class="var-title">
 277                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$email">Principal::$email</a></span><br>
 278                                                         </span>
 279                                                                                                         <img src="../../media/images/Variable.png" />
 280                                                         <span class="var-title">
 281                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$email_ok">Principal::$email_ok</a></span><br>
 282                                                         </span>
 283                                                                                                         <img src="../../media/images/Variable.png" />
 284                                                         <span class="var-title">
 285                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$exists">Principal::$exists</a></span><br>
 286                                                         </span>
 287                                                                                                         <img src="../../media/images/Variable.png" />
 288                                                         <span class="var-title">
 289                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$fullname">Principal::$fullname</a></span><br>
 290                                                         </span>
 291                                                                                                         <img src="../../media/images/Variable.png" />
 292                                                         <span class="var-title">
 293                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$is_addressbook">Principal::$is_addressbook</a></span><br>
 294                                                         </span>
 295                                                                                                         <img src="../../media/images/Variable.png" />
 296                                                         <span class="var-title">
 297                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$is_calendar">Principal::$is_calendar</a></span><br>
 298                                                         </span>
 299                                                                                                         <img src="../../media/images/Variable.png" />
 300                                                         <span class="var-title">
 301                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$is_principal">Principal::$is_principal</a></span><br>
 302                                                         </span>
 303                                                                                                         <img src="../../media/images/Variable.png" />
 304                                                         <span class="var-title">
 305                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$locale">Principal::$locale</a></span><br>
 306                                                         </span>
 307                                                                                                         <img src="../../media/images/Variable.png" />
 308                                                         <span class="var-title">
 309                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$modified">Principal::$modified</a></span><br>
 310                                                         </span>
 311                                                                                                         <img src="../../media/images/Variable.png" />
 312                                                         <span class="var-title">
 313                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$original_request_url">Principal::$original_request_url</a></span><br>
 314                                                         </span>
 315                                                                                                         <img src="../../media/images/Variable.png" />
 316                                                         <span class="var-title">
 317                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$password">Principal::$password</a></span><br>
 318                                                         </span>
 319                                                                                                         <img src="../../media/images/Variable.png" />
 320                                                         <span class="var-title">
 321                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$principal_id">Principal::$principal_id</a></span><br>
 322                                                         </span>
 323                                                                                                         <img src="../../media/images/Variable.png" />
 324                                                         <span class="var-title">
 325                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$privileges">Principal::$privileges</a></span><br>
 326                                                         </span>
 327                                                                                                         <img src="../../media/images/Variable.png" />
 328                                                         <span class="var-title">
 329                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$resourcetypes">Principal::$resourcetypes</a></span><br>
 330                                                         </span>
 331                                                                                                         <img src="../../media/images/Variable.png" />
 332                                                         <span class="var-title">
 333                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$type_id">Principal::$type_id</a></span><br>
 334                                                         </span>
 335                                                                                                         <img src="../../media/images/Variable.png" />
 336                                                         <span class="var-title">
 337                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$url">Principal::$url</a></span><br>
 338                                                         </span>
 339                                                                                                         <img src="../../media/images/Variable.png" />
 340                                                         <span class="var-title">
 341                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$username">Principal::$username</a></span><br>
 342                                                         </span>
 343                                                                                                         <img src="../../media/images/Variable.png" />
 344                                                         <span class="var-title">
 345                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$user_active">Principal::$user_active</a></span><br>
 346                                                         </span>
 347                                                                                                         <img src="../../media/images/Variable.png" />
 348                                                         <span class="var-title">
 349                                                                 <span class="var-name"><a href="../../davical/Principal/Principal.html#var$user_no">Principal::$user_no</a></span><br>
 350                                                         </span>
 351                                                                                         </blockquote>
 352
 353                 </div>
 354         </div>
 355
 356         <a name="sec-methods"></a>
 357         <div class="info-box">
 358                 <div class="info-box-title">Methods</div>
 359                 <div class="nav-bar">
 360                         <a href="#sec-description">Description</a> |
 361                                                                                                                         <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
 362                                                                                                                 <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 363
 364                 </div>
 365                 <div class="info-box-body">
 366                         <A NAME='method_detail'></A>
 367 <a name="method__construct" id="__construct"><!-- --></a>
 368 <div class="evenrow">
 369
 370         <div class="method-header">
 371                 <img src="../../media/images/Constructor.png" />
 372                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">95</span>)
 373         </div>
 374
 375         <!-- ========== Info from phpDoc block ========= -->
 376 <p class="short-description">Constructor</p>
 377         <ul class="tags">
 378                                 <li><span class="field">return:</span> Whether we actually read data from the DB to initialise the record.</li>
 379                         </ul>
 380
 381         <div class="method-signature">
 382                 <span class="method-result">boolean</span>
 383                 <span class="method-name">
 384                         __construct
 385                 </span>
 386                                         ([<span class="var-type">mixed</span>&nbsp;<span class="var-name">$parameters</span> = <span class="var-default">null</span>])
 387                         </div>
 388
 389                         <ul class="parameters">
 390                                         <li>
 391                                 <span class="var-type">mixed</span>
 392                                 <span class="var-name">$parameters</span><span class="var-description">: If null, an empty Principal is created.  If it               is an integer then that ID is read (if possible).  If it is               an array then the Principal matching the supplied elements               is read.  If it is an object then it is expected to be a 'usr'               record that was read elsewhere.</span>                    </li>
 393                                 </ul>
 394
 395                         <hr class="separator" />
 396                 <div class="notes">Redefinition of:</div>
 397                 <dl>
 398                         <dt><a href="../../davical/Principal/Principal.html#method__construct">Principal::__construct()</a></dt>
 399                                                 <dd>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.</dd>
 400                                         </dl>
 401
 402         </div>
 403 <a name="methodaddressbook_home_set" id="addressbook_home_set"><!-- --></a>
 404 <div class="oddrow">
 405
 406         <div class="method-header">
 407                 <img src="../../media/images/Method.png" />
 408                 <span class="method-title">addressbook_home_set</span> (line <span class="line-number">359</span>)
 409         </div>
 410
 411         <!-- ========== Info from phpDoc block ========= -->
 412 <p class="short-description">Get the addressbook_home_set, as lazily as possible</p>
 413
 414         <div class="method-signature">
 415                 <span class="method-result">void</span>
 416                 <span class="method-name">
 417                         addressbook_home_set
 418                 </span>
 419                                 ()
 420                         </div>
 421
 422
 423
 424         </div>
 425 <a name="methodAsCollection" id="AsCollection"><!-- --></a>
 426 <div class="evenrow">
 427
 428         <div class="method-header">
 429                 <img src="../../media/images/Method.png" />
 430                 <span class="method-title">AsCollection</span> (line <span class="line-number">420</span>)
 431         </div>
 432
 433         <!-- ========== Info from phpDoc block ========= -->
 434 <p class="short-description">Returns a representation of the principal as a collection</p>
 435
 436         <div class="method-signature">
 437                 <span class="method-result">void</span>
 438                 <span class="method-name">
 439                         AsCollection
 440                 </span>
 441                                 ()
 442                         </div>
 443
 444
 445
 446         </div>
 447 <a name="methodcalendar_free_busy_set" id="calendar_free_busy_set"><!-- --></a>
 448 <div class="oddrow">
 449
 450         <div class="method-header">
 451                 <img src="../../media/images/Method.png" />
 452                 <span class="method-title">calendar_free_busy_set</span> (line <span class="line-number">382</span>)
 453         </div>
 454
 455         <!-- ========== Info from phpDoc block ========= -->
 456 <p class="short-description">Get the calendar_free_busy_set, as lazily as possible</p>
 457
 458         <div class="method-signature">
 459                 <span class="method-result">void</span>
 460                 <span class="method-name">
 461                         calendar_free_busy_set
 462                 </span>
 463                                 ()
 464                         </div>
 465
 466
 467
 468         </div>
 469 <a name="methodcalendar_home_set" id="calendar_home_set"><!-- --></a>
 470 <div class="evenrow">
 471
 472         <div class="method-header">
 473                 <img src="../../media/images/Method.png" />
 474                 <span class="method-title">calendar_home_set</span> (line <span class="line-number">336</span>)
 475         </div>
 476
 477         <!-- ========== Info from phpDoc block ========= -->
 478 <p class="short-description">Get the calendar_home_set, as lazily as possible</p>
 479
 480         <div class="method-signature">
 481                 <span class="method-result">void</span>
 482                 <span class="method-name">
 483                         calendar_home_set
 484                 </span>
 485                                 ()
 486                         </div>
 487
 488
 489
 490         </div>
 491 <a name="methodFetchProxyGroups" id="FetchProxyGroups"><!-- --></a>
 492 <div class="oddrow">
 493
 494         <div class="method-header">
 495                 <img src="../../media/images/Method.png" />
 496                 <span class="method-title">FetchProxyGroups</span> (line <span class="line-number">194</span>)
 497         </div>
 498
 499         <!-- ========== Info from phpDoc block ========= -->
 500 <p class="short-description">Split this out so we do it as infrequently as possible, given the cost.</p>
 501
 502         <div class="method-signature">
 503                 <span class="method-result">void</span>
 504                 <span class="method-name">
 505                         FetchProxyGroups
 506                 </span>
 507                                 ()
 508                         </div>
 509
 510
 511
 512         </div>
 513 <a name="methodGetProperty" id="GetProperty"><!-- --></a>
 514 <div class="evenrow">
 515
 516         <div class="method-header">
 517                 <img src="../../media/images/Method.png" />
 518                 <span class="method-title">GetProperty</span> (line <span class="line-number">303</span>)
 519         </div>
 520
 521         <!-- ========== Info from phpDoc block ========= -->
 522 <p class="short-description">Return an arbitrary property</p>
 523         <ul class="tags">
 524                                 <li><span class="field">return:</span> The name of the arbitrary property</li>
 525                         </ul>
 526
 527         <div class="method-signature">
 528                 <span class="method-result">string</span>
 529                 <span class="method-name">
 530                         GetProperty
 531                 </span>
 532                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$property_id</span>)
 533                         </div>
 534
 535                         <ul class="parameters">
 536                                         <li>
 537                                 <span class="var-type"></span>
 538                                 <span class="var-name">$property_id</span>                      </li>
 539                                 </ul>
 540
 541
 542         </div>
 543 <a name="methodGroupMemberSet" id="GroupMemberSet"><!-- --></a>
 544 <div class="oddrow">
 545
 546         <div class="method-header">
 547                 <img src="../../media/images/Method.png" />
 548                 <span class="method-title">GroupMemberSet</span> (line <span class="line-number">284</span>)
 549         </div>
 550
 551         <!-- ========== Info from phpDoc block ========= -->
 552 <p class="short-description">Accessor for the group member set - the members of this group</p>
 553
 554         <div class="method-signature">
 555                 <span class="method-result">void</span>
 556                 <span class="method-name">
 557                         GroupMemberSet
 558                 </span>
 559                                 ()
 560                         </div>
 561
 562
 563
 564         </div>
 565 <a name="methodGroupMembership" id="GroupMembership"><!-- --></a>
 566 <div class="evenrow">
 567
 568         <div class="method-header">
 569                 <img src="../../media/images/Method.png" />
 570                 <span class="method-title">GroupMembership</span> (line <span class="line-number">275</span>)
 571         </div>
 572
 573         <!-- ========== Info from phpDoc block ========= -->
 574 <p class="short-description">Accessor for the group membership - the groups this principal is a member of</p>
 575
 576         <div class="method-signature">
 577                 <span class="method-result">void</span>
 578                 <span class="method-name">
 579                         GroupMembership
 580                 </span>
 581                                 ()
 582                         </div>
 583
 584
 585
 586         </div>
 587 <a name="methodInitialiseRecord" id="InitialiseRecord"><!-- --></a>
 588 <div class="oddrow">
 589
 590         <div class="method-header">
 591                 <img src="../../media/images/Method.png" />
 592                 <span class="method-title">InitialiseRecord</span> (line <span class="line-number">144</span>)
 593         </div>
 594
 595         <!-- ========== Info from phpDoc block ========= -->
 596 <p class="short-description">Initialise the Principal object from a $usr record from the DB.</p>
 597
 598         <div class="method-signature">
 599                 <span class="method-result">void</span>
 600                 <span class="method-name">
 601                         InitialiseRecord
 602                 </span>
 603                                         (<span class="var-type">object</span>&nbsp;<span class="var-name">$usr</span>)
 604                         </div>
 605
 606                         <ul class="parameters">
 607                                         <li>
 608                                 <span class="var-type">object</span>
 609                                 <span class="var-name">$usr</span><span class="var-description">: The usr record from the DB.</span>                    </li>
 610                                 </ul>
 611
 612
 613         </div>
 614 <a name="methodIsGroup" id="IsGroup"><!-- --></a>
 615 <div class="evenrow">
 616
 617         <div class="method-header">
 618                 <img src="../../media/images/Method.png" />
 619                 <span class="method-title">IsGroup</span> (line <span class="line-number">294</span>)
 620         </div>
 621
 622         <!-- ========== Info from phpDoc block ========= -->
 623 <p class="short-description">Is this a group principal?</p>
 624         <ul class="tags">
 625                                 <li><span class="field">return:</span> Whether this is a group principal</li>
 626                         </ul>
 627
 628         <div class="method-signature">
 629                 <span class="method-result">boolean</span>
 630                 <span class="method-name">
 631                         IsGroup
 632                 </span>
 633                                 ()
 634                         </div>
 635
 636
 637
 638         </div>
 639 <a name="methodPrincipalProperty" id="PrincipalProperty"><!-- --></a>
 640 <div class="oddrow">
 641
 642         <div class="method-header">
 643                 <img src="../../media/images/Method.png" />
 644                 <span class="method-title">PrincipalProperty</span> (line <span class="line-number">451</span>)
 645         </div>
 646
 647         <!-- ========== Info from phpDoc block ========= -->
 648 <p class="short-description">Returns properties which are specific to this principal</p>
 649
 650         <div class="method-signature">
 651                 <span class="method-result">void</span>
 652                 <span class="method-name">
 653                         PrincipalProperty
 654                 </span>
 655                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$prop</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$denied</span>)
 656                         </div>
 657
 658                         <ul class="parameters">
 659                                         <li>
 660                                 <span class="var-type"></span>
 661                                 <span class="var-name">$tag</span>                      </li>
 662                                         <li>
 663                                 <span class="var-type"></span>
 664                                 <span class="var-name">$prop</span>                     </li>
 665                                         <li>
 666                                 <span class="var-type"></span>
 667                                 <span class="var-name">&$reply</span>                   </li>
 668                                         <li>
 669                                 <span class="var-type"></span>
 670                                 <span class="var-name">&$denied</span>                  </li>
 671                                 </ul>
 672
 673
 674         </div>
 675 <a name="methodPrivileges" id="Privileges"><!-- --></a>
 676 <div class="evenrow">
 677
 678         <div class="method-header">
 679                 <img src="../../media/images/Method.png" />
 680                 <span class="method-title">Privileges</span> (line <span class="line-number">404</span>)
 681         </div>
 682
 683         <!-- ========== Info from phpDoc block ========= -->
 684 <p class="short-description">Return the privileges bits for the current session user to this resource</p>
 685
 686         <div class="method-signature">
 687                 <span class="method-result">void</span>
 688                 <span class="method-name">
 689                         Privileges
 690                 </span>
 691                                 ()
 692                         </div>
 693
 694
 695
 696         </div>
 697 <a name="methodPropertySearch" id="PropertySearch"><!-- --></a>
 698 <div class="oddrow">
 699
 700         <div class="method-header">
 701                 <img src="../../media/images/Method.png" />
 702                 <span class="method-title">PropertySearch</span> (line <span class="line-number">444</span>)
 703         </div>
 704
 705         <!-- ========== Info from phpDoc block ========= -->
 706
 707         <div class="method-signature">
 708                 <span class="method-result">void</span>
 709                 <span class="method-name">
 710                         PropertySearch
 711                 </span>
 712                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$parameters</span>)
 713                         </div>
 714
 715                         <ul class="parameters">
 716                                         <li>
 717                                 <span class="var-type"></span>
 718                                 <span class="var-name">$parameters</span>                       </li>
 719                                 </ul>
 720
 721
 722         </div>
 723 <a name="methodProxyFor" id="ProxyFor"><!-- --></a>
 724 <div class="evenrow">
 725
 726         <div class="method-header">
 727                 <img src="../../media/images/Method.png" />
 728                 <span class="method-title">ProxyFor</span> (line <span class="line-number">265</span>)
 729         </div>
 730
 731         <!-- ========== Info from phpDoc block ========= -->
 732 <p class="short-description">Accessor for read or write proxy</p>
 733
 734         <div class="method-signature">
 735                 <span class="method-result">void</span>
 736                 <span class="method-name">
 737                         ProxyFor
 738                 </span>
 739                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
 740                         </div>
 741
 742                         <ul class="parameters">
 743                                         <li>
 744                                 <span class="var-type">string</span>
 745                                 <span class="var-name">$type</span><span class="var-description">: read/write - which sort of proxy list is requested.</span>                   </li>
 746                                 </ul>
 747
 748
 749         </div>
 750 <a name="methodReadProxyGroup" id="ReadProxyGroup"><!-- --></a>
 751 <div class="oddrow">
 752
 753         <div class="method-header">
 754                 <img src="../../media/images/Method.png" />
 755                 <span class="method-title">ReadProxyGroup</span> (line <span class="line-number">246</span>)
 756         </div>
 757
 758         <!-- ========== Info from phpDoc block ========= -->
 759 <p class="short-description">Accessor for the read proxy group</p>
 760
 761         <div class="method-signature">
 762                 <span class="method-result">void</span>
 763                 <span class="method-name">
 764                         ReadProxyGroup
 765                 </span>
 766                                 ()
 767                         </div>
 768
 769
 770
 771         </div>
 772 <a name="methodRenderAsXML" id="RenderAsXML"><!-- --></a>
 773 <div class="evenrow">
 774
 775         <div class="method-header">
 776                 <img src="../../media/images/Method.png" />
 777                 <span class="method-title">RenderAsXML</span> (line <span class="line-number">569</span>)
 778         </div>
 779
 780         <!-- ========== Info from phpDoc block ========= -->
 781 <p class="short-description">Render XML for a single Principal (user) from the DB</p>
 782         <ul class="tags">
 783                                 <li><span class="field">return:</span> An XML fragment with the requested properties for this principal</li>
 784                         </ul>
 785
 786         <div class="method-signature">
 787                 <span class="method-result">string</span>
 788                 <span class="method-name">
 789                         RenderAsXML
 790                 </span>
 791                                         (<span class="var-type">array</span>&nbsp;<span class="var-name">$properties</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$props_only</span> = <span class="var-default">false</span>], <span class="var-type">reference</span>&nbsp;<span class="var-name">$reply</span>)
 792                         </div>
 793
 794                         <ul class="parameters">
 795                                         <li>
 796                                 <span class="var-type">array</span>
 797                                 <span class="var-name">$properties</span><span class="var-description">: The requested properties for this principal</span>                     </li>
 798                                         <li>
 799                                 <span class="var-type">reference</span>
 800                                 <span class="var-name">$reply</span><span class="var-description">: A reference to the XMLDocument being used for the reply</span>                      </li>
 801                                         <li>
 802                                 <span class="var-type">boolean</span>
 803                                 <span class="var-name">$props_only</span><span class="var-description">: Default false.  If true will only return the fragment with the properties, not a full response fragment.</span>                        </li>
 804                                         <li>
 805                                 <span class="var-type"></span>
 806                                 <span class="var-name">&$reply</span>                   </li>
 807                                 </ul>
 808
 809
 810         </div>
 811 <a name="methodunique_tag" id="unique_tag"><!-- --></a>
 812 <div class="oddrow">
 813
 814         <div class="method-header">
 815                 <img src="../../media/images/Method.png" />
 816                 <span class="method-title">unique_tag</span> (line <span class="line-number">324</span>)
 817         </div>
 818
 819         <!-- ========== Info from phpDoc block ========= -->
 820 <p class="short-description">Returns the unique_tag (ETag or getctag) for this resource</p>
 821         <ul class="tags">
 822                                 <li><span class="field">access:</span> public</li>
 823                         </ul>
 824
 825         <div class="method-signature">
 826                 <span class="method-result">void</span>
 827                 <span class="method-name">
 828                         unique_tag
 829                 </span>
 830                                 ()
 831                         </div>
 832
 833
 834
 835         </div>
 836 <a name="methodWriteProxyGroup" id="WriteProxyGroup"><!-- --></a>
 837 <div class="evenrow">
 838
 839         <div class="method-header">
 840                 <img src="../../media/images/Method.png" />
 841                 <span class="method-title">WriteProxyGroup</span> (line <span class="line-number">255</span>)
 842         </div>
 843
 844         <!-- ========== Info from phpDoc block ========= -->
 845 <p class="short-description">Accessor for the write proxy group</p>
 846
 847         <div class="method-signature">
 848                 <span class="method-result">void</span>
 849                 <span class="method-name">
 850                         WriteProxyGroup
 851                 </span>
 852                                 ()
 853                         </div>
 854
 855
 856
 857         </div>
 858                                                         <h4>Inherited Methods</h4>
 859                                 <a name='inherited_methods'><!-- --></a>
 860                                                                         <!-- =========== Summary =========== -->
 861                                         <p>Inherited From <span class="classname"><a href="../../davical/Principal/Principal.html">Principal</a></span></p>
 862                                         <blockquote>
 863                                                                                                         <img src="../../media/images/Constructor.png" alt=" "/>
 864                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#method__construct">Principal::__construct()</a></span><br>
 865                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 866                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodbyEmail">Principal::byEmail()</a></span><br>
 867                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 868                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodcacheDelete">Principal::cacheDelete()</a></span><br>
 869                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 870                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodcacheFlush">Principal::cacheFlush()</a></span><br>
 871                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 872                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodCreate">Principal::Create()</a></span><br>
 873                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 874                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methoddav_name">Principal::dav_name()</a></span><br>
 875                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 876                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methoddefault_calendar">Principal::default_calendar()</a></span><br>
 877                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 878                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodemail">Principal::email()</a></span><br>
 879                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 880                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodExists">Principal::Exists()</a></span><br>
 881                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 882                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodFetchCollections">Principal::FetchCollections()</a></span><br>
 883                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 884                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodFetchDeadProperties">Principal::FetchDeadProperties()</a></span><br>
 885                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 886                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodinternal_url">Principal::internal_url()</a></span><br>
 887                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 888                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodprincipal_id">Principal::principal_id()</a></span><br>
 889                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 890                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodsetUsername">Principal::setUsername()</a></span><br>
 891                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 892                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodunCache">Principal::unCache()</a></span><br>
 893                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 894                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodUpdate">Principal::Update()</a></span><br>
 895                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 896                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodupdateableFields">Principal::updateableFields()</a></span><br>
 897                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 898                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodurl">Principal::url()</a></span><br>
 899                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 900                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methodusername">Principal::username()</a></span><br>
 901                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 902                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#methoduser_no">Principal::user_no()</a></span><br>
 903                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 904                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#method__get">Principal::__get()</a></span><br>
 905                                                                                                         <img src="../../media/images/Method.png" alt=" "/>
 906                                                         <span class="method-name"><a href="../../davical/Principal/Principal.html#method__isset">Principal::__isset()</a></span><br>
 907                                                                                         </blockquote>
 908
 909                 </div>
 910         </div>
 911
 912
 913         <p class="notes" id="credit">
 914                 Documentation generated on Fri, 13 Jan 2012 23:44:54 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 915         </p>
 916         </div></body>
 917 </html>