docs/api/davical/_htdocs---always.php.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 page always.php</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="file-name"><img src="../media/images/Page_logo.png" alt="File" style="vertical-align: middle">/htdocs/always.php</h2>
  13
  14 <a name="sec-description"></a>
  15 <div class="info-box">
  16         <div class="info-box-title">Description</div>
  17         <div class="nav-bar">
  18                                         <span class="disabled">Description</span> |
  19                                                                         <a href="#sec-includes">Includes</a>
  20                         |                                                       <a href="#sec-constants">Constants</a>
  21                         |                                                                       <a href="#sec-functions">Functions</a>
  22                         </div>
  23         <div class="info-box-body">
  24                 <!-- ========== Info from phpDoc block ========= -->
  25         <ul class="tags">
  26                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
  27                                 <li><span class="field">copyright:</span> Catalyst .Net Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
  28                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
  29                         </ul>
  30
  31                         </div>
  32 </div>
  33
  34
  35         <a name="sec-includes"></a>
  36         <div class="info-box">
  37                 <div class="info-box-title">Includes</div>
  38                 <div class="nav-bar">
  39                         <a href="#sec-description">Description</a> |
  40                                                 <span class="disabled">Includes</span>
  41                         |                                                       <a href="#sec-constants">Constants</a>
  42                                 |                                                                                                       <a href="#sec-functions">Functions</a>
  43                                         </div>
  44                 <div class="info-box-body">
  45                         <a name="___/config/config_php"><!-- --></a>
  46 <div class="oddrow">
  47
  48         <div>
  49                 <img src="../media/images/Page.png" alt=" " />
  50                 <span class="include-title">
  51                         <span class="include-type">include</span>
  52                         (<span class="include-name">'../config/config.php'</span>)
  53                         (line <span class="line-number">141</span>)
  54                 </span>
  55         </div>
  56
  57         <!-- ========== Info from phpDoc block ========= -->
  58
  59 </div>
  60 <a name="_/usr/local/etc/davical/_$_SERVER[SERVER_NAME]_-conf_php"><!-- --></a>
  61 <div class="evenrow">
  62
  63         <div>
  64                 <img src="../media/images/Page.png" alt=" " />
  65                 <span class="include-title">
  66                         <span class="include-type">include</span>
  67                         (<span class="include-name">'/usr/local/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php'</span>)
  68                         (line <span class="line-number">135</span>)
  69                 </span>
  70         </div>
  71
  72         <!-- ========== Info from phpDoc block ========= -->
  73
  74 </div>
  75 <a name="_/usr/local/etc/davical/config_php"><!-- --></a>
  76 <div class="oddrow">
  77
  78         <div>
  79                 <img src="../media/images/Page.png" alt=" " />
  80                 <span class="include-title">
  81                         <span class="include-type">include</span>
  82                         (<span class="include-name">'/usr/local/etc/davical/config.php'</span>)
  83                         (line <span class="line-number">138</span>)
  84                 </span>
  85         </div>
  86
  87         <!-- ========== Info from phpDoc block ========= -->
  88
  89 </div>
  90 <a name="_/etc/davical/_$_SERVER[SERVER_NAME]_-conf_php"><!-- --></a>
  91 <div class="evenrow">
  92
  93         <div>
  94                 <img src="../media/images/Page.png" alt=" " />
  95                 <span class="include-title">
  96                         <span class="include-type">include</span>
  97                         (<span class="include-name">'/etc/davical/'.$_SERVER['SERVER_NAME'].'-conf.php'</span>)
  98                         (line <span class="line-number">129</span>)
  99                 </span>
 100         </div>
 101
 102         <!-- ========== Info from phpDoc block ========= -->
 103 <p class="short-description">We use @file_exists because things like open_basedir might noisily deny  access which could break DAViCal completely by causing output to start  too early.</p>
 104
 105 </div>
 106 <a name="_config/config_php"><!-- --></a>
 107 <div class="oddrow">
 108
 109         <div>
 110                 <img src="../media/images/Page.png" alt=" " />
 111                 <span class="include-title">
 112                         <span class="include-type">include</span>
 113                         (<span class="include-name">'config/config.php'</span>)
 114                         (line <span class="line-number">144</span>)
 115                 </span>
 116         </div>
 117
 118         <!-- ========== Info from phpDoc block ========= -->
 119
 120 </div>
 121 <a name="_davical_configuration_missing_php"><!-- --></a>
 122 <div class="evenrow">
 123
 124         <div>
 125                 <img src="../media/images/Page.png" alt=" " />
 126                 <span class="include-title">
 127                         <span class="include-type">include</span>
 128                         (<span class="include-name"><a href="../davical/_inc---davical_configuration_missing.php.html">davical_configuration_missing.php</a></span>)
 129                         (line <span class="line-number">147</span>)
 130                 </span>
 131         </div>
 132
 133         <!-- ========== Info from phpDoc block ========= -->
 134
 135 </div>
 136 <a name="_/etc/davical/config_php"><!-- --></a>
 137 <div class="oddrow">
 138
 139         <div>
 140                 <img src="../media/images/Page.png" alt=" " />
 141                 <span class="include-title">
 142                         <span class="include-type">include</span>
 143                         (<span class="include-name">'/etc/davical/config.php'</span>)
 144                         (line <span class="line-number">132</span>)
 145                 </span>
 146         </div>
 147
 148         <!-- ========== Info from phpDoc block ========= -->
 149
 150 </div>
 151 <a name="_AWLUtilities_php"><!-- --></a>
 152 <div class="evenrow">
 153
 154         <div>
 155                 <img src="../media/images/Page.png" alt=" " />
 156                 <span class="include-title">
 157                         <span class="include-type">include_once</span>
 158                         (<span class="include-name">'AWLUtilities.php'</span>)
 159                         (line <span class="line-number">90</span>)
 160                 </span>
 161         </div>
 162
 163         <!-- ========== Info from phpDoc block ========= -->
 164
 165 </div>
 166 <a name="_AWLUtilities_php"><!-- --></a>
 167 <div class="oddrow">
 168
 169         <div>
 170                 <img src="../media/images/Page.png" alt=" " />
 171                 <span class="include-title">
 172                         <span class="include-type">include_once</span>
 173                         (<span class="include-name">'AWLUtilities.php'</span>)
 174                         (line <span class="line-number">77</span>)
 175                 </span>
 176         </div>
 177
 178         <!-- ========== Info from phpDoc block ========= -->
 179
 180 </div>
 181 <a name="_AwlQuery_php"><!-- --></a>
 182 <div class="evenrow">
 183
 184         <div>
 185                 <img src="../media/images/Page.png" alt=" " />
 186                 <span class="include-title">
 187                         <span class="include-type">require_once</span>
 188                         (<span class="include-name">'AwlQuery.php'</span>)
 189                         (line <span class="line-number">193</span>)
 190                 </span>
 191         </div>
 192
 193         <!-- ========== Info from phpDoc block ========= -->
 194 <p class="short-description">Force the domain name to what was in the configuration file</p>
 195
 196 </div>
 197 <a name="_Principal_php"><!-- --></a>
 198 <div class="oddrow">
 199
 200         <div>
 201                 <img src="../media/images/Page.png" alt=" " />
 202                 <span class="include-title">
 203                         <span class="include-type">require_once</span>
 204                         (<span class="include-name"><a href="../davical/Principal/_inc---Principal.php.html">Principal.php</a></span>)
 205                         (line <span class="line-number">211</span>)
 206                 </span>
 207         </div>
 208
 209         <!-- ========== Info from phpDoc block ========= -->
 210
 211 </div>
 212                 </div>
 213         </div>
 214
 215         <a name="sec-constants"></a>
 216         <div class="info-box">
 217                 <div class="info-box-title">Constants</div>
 218                 <div class="nav-bar">
 219                         <a href="#sec-description">Description</a> |
 220                                                                                 <a href="#sec-includes">Includes</a>
 221                                 |                                               <span class="disabled">Constants</span>
 222                         |                                                                               <a href="#sec-functions">Functions</a>
 223                                         </div>
 224                 <div class="info-box-body">
 225                         <a name="defineDAVICAL_ADDRESSBOOK_MAXPRIV"><!-- --></a>
 226 <div class="evenrow">
 227
 228         <div>
 229                 <img src="../media/images/Constant.png" />
 230                 <span class="const-title">
 231                         <span class="const-name">DAVICAL_ADDRESSBOOK_MAXPRIV</span> = &quot;1023&quot;
 232                         (line <span class="line-number">357</span>)
 233                 </span>
 234         </div>
 235
 236         <!-- ========== Info from phpDoc block ========= -->
 237
 238
 239 </div>
 240 <a name="defineDAVICAL_MAXPRIV"><!-- --></a>
 241 <div class="oddrow">
 242
 243         <div>
 244                 <img src="../media/images/Constant.png" />
 245                 <span class="const-title">
 246                         <span class="const-name">DAVICAL_MAXPRIV</span> = &quot;65535&quot;
 247                         (line <span class="line-number">356</span>)
 248                 </span>
 249         </div>
 250
 251         <!-- ========== Info from phpDoc block ========= -->
 252 <p class="short-description">Given a privilege string, or an array of privilege strings, return a bit mask  of the privileges.</p>
 253         <ul class="tags">
 254                                 <li><span class="field">return:</span> A bit mask of the privileges.</li>
 255                         </ul>
 256
 257
 258 </div>
 259                 </div>
 260         </div>
 261
 262
 263         <a name="sec-functions"></a>
 264         <div class="info-box">
 265                 <div class="info-box-title">Functions</div>
 266                 <div class="nav-bar">
 267                         <a href="#sec-description">Description</a> |
 268                                                                                 <a href="#sec-includes">Includes</a>
 269                                 |                                                                               <a href="#sec-constants">Constants</a>
 270                                 |                                                                       <span class="disabled">Functions</span>
 271                 </div>
 272                 <div class="info-box-body">
 273                         <a name="functionbits_to_privilege" id="functionbits_to_privilege"><!-- --></a>
 274 <div class="evenrow">
 275
 276         <div>
 277                 <img src="../media/images/Function.png" />
 278                 <span class="method-title">bits_to_privilege</span> (line <span class="line-number">409</span>)
 279         </div>
 280
 281         <!-- ========== Info from phpDoc block ========= -->
 282 <p class="short-description">Given a bit mask of the privileges, will return an array of the  text values of privileges.</p>
 283         <ul class="tags">
 284                                 <li><span class="field">return:</span> The string (or array of strings) of privilege names</li>
 285                         </ul>
 286         <div class="method-signature">
 287                 <span class="method-result">mixed</span>
 288                 <span class="method-name">
 289                         bits_to_privilege
 290                 </span>
 291                                         (<span class="var-type">integer</span>&nbsp;<span class="var-name">$raw_bits</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$resourcetype</span> = <span class="var-default">&#039;resource&#039;</span>])
 292                         </div>
 293
 294                         <ul class="parameters">
 295                                         <li>
 296                                 <span class="var-type">integer</span>
 297                                 <span class="var-name">$raw_bits</span><span class="var-description">: A bit mask of the privileges.</span>                     </li>
 298                                         <li>
 299                                 <span class="var-type"></span>
 300                                 <span class="var-name">$resourcetype</span>                     </li>
 301                                 </ul>
 302
 303
 304 </div>
 305 <a name="functionConstructURL" id="functionConstructURL"><!-- --></a>
 306 <div class="oddrow">
 307
 308         <div>
 309                 <img src="../media/images/Function.png" />
 310                 <span class="method-title">ConstructURL</span> (line <span class="line-number">275</span>)
 311         </div>
 312
 313         <!-- ========== Info from phpDoc block ========= -->
 314 <p class="short-description">Construct a URL from the supplied dav_name.  The URL will be urlencoded,  except for any '/' characters in it.</p>
 315         <div class="method-signature">
 316                 <span class="method-result">void</span>
 317                 <span class="method-name">
 318                         ConstructURL
 319                 </span>
 320                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$partial_path</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$force_script</span> = <span class="var-default">false</span>])
 321                         </div>
 322
 323                         <ul class="parameters">
 324                                         <li>
 325                                 <span class="var-type">string</span>
 326                                 <span class="var-name">$partial_path</span><span class="var-description">: The part of the path after the script name</span>                    </li>
 327                                         <li>
 328                                 <span class="var-type"></span>
 329                                 <span class="var-name">$force_script</span>                     </li>
 330                                 </ul>
 331
 332
 333 </div>
 334 <a name="functionDateToISODate" id="functionDateToISODate"><!-- --></a>
 335 <div class="evenrow">
 336
 337         <div>
 338                 <img src="../media/images/Function.png" />
 339                 <span class="method-title">DateToISODate</span> (line <span class="line-number">344</span>)
 340         </div>
 341
 342         <!-- ========== Info from phpDoc block ========= -->
 343 <p class="short-description">Convert a date into ISO format into the sparkly new ISO format.</p>
 344         <div class="method-signature">
 345                 <span class="method-result">void</span>
 346                 <span class="method-name">
 347                         DateToISODate
 348                 </span>
 349                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$indate</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$in_utc</span> = <span class="var-default">false</span>])
 350                         </div>
 351
 352                         <ul class="parameters">
 353                                         <li>
 354                                 <span class="var-type">string</span>
 355                                 <span class="var-name">$indate</span><span class="var-description">: The date to convert</span>                 </li>
 356                                         <li>
 357                                 <span class="var-type"></span>
 358                                 <span class="var-name">$in_utc</span>                   </li>
 359                                 </ul>
 360
 361
 362 </div>
 363 <a name="functionDeconstructURL" id="functionDeconstructURL"><!-- --></a>
 364 <div class="oddrow">
 365
 366         <div>
 367                 <img src="../media/images/Function.png" />
 368                 <span class="method-title">DeconstructURL</span> (line <span class="line-number">304</span>)
 369         </div>
 370
 371         <!-- ========== Info from phpDoc block ========= -->
 372 <p class="short-description">Deconstruct a dav_name from the supplied URL.  The dav_name will be urldecoded.</p>
 373         <div class="method-signature">
 374                 <span class="method-result">void</span>
 375                 <span class="method-name">
 376                         DeconstructURL
 377                 </span>
 378                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$url</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$force_script</span> = <span class="var-default">false</span>], <span class="var-type">string</span>&nbsp;<span class="var-name">$partial_path</span>)
 379                         </div>
 380
 381                         <ul class="parameters">
 382                                         <li>
 383                                 <span class="var-type">string</span>
 384                                 <span class="var-name">$partial_path</span><span class="var-description">: The part of the path after the script name</span>                    </li>
 385                                         <li>
 386                                 <span class="var-type"></span>
 387                                 <span class="var-name">$url</span>                      </li>
 388                                         <li>
 389                                 <span class="var-type"></span>
 390                                 <span class="var-name">$force_script</span>                     </li>
 391                                 </ul>
 392
 393
 394 </div>
 395 <a name="functionearly_exception_handler" id="functionearly_exception_handler"><!-- --></a>
 396 <div class="evenrow">
 397
 398         <div>
 399                 <img src="../media/images/Function.png" />
 400                 <span class="method-title">early_exception_handler</span> (line <span class="line-number">20</span>)
 401         </div>
 402
 403         <!-- ========== Info from phpDoc block ========= -->
 404         <ul class="tags">
 405                                 <li><span class="field">author:</span> Andrew McMillan &lt;<a href="mailto:andrew@mcmillan.net.nz">andrew@mcmillan.net.nz</a>&gt;</li>
 406                                 <li><span class="field">copyright:</span> Catalyst .Net Ltd, Morphoss Ltd &lt;http://www.morphoss.com/&gt;</li>
 407                                 <li><span class="field">license:</span> <a href="http://gnu.org/copyleft/gpl.html">GNU GPL v2 or later</a></li>
 408                         </ul>
 409         <div class="method-signature">
 410                 <span class="method-result">void</span>
 411                 <span class="method-name">
 412                         early_exception_handler
 413                 </span>
 414                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$e</span>)
 415                         </div>
 416
 417                         <ul class="parameters">
 418                                         <li>
 419                                 <span class="var-type"></span>
 420                                 <span class="var-name">$e</span>                        </li>
 421                                 </ul>
 422
 423
 424 </div>
 425 <a name="functiongetStatusMessage" id="functiongetStatusMessage"><!-- --></a>
 426 <div class="oddrow">
 427
 428         <div>
 429                 <img src="../media/images/Function.png" />
 430                 <span class="method-title">getStatusMessage</span> (line <span class="line-number">218</span>)
 431         </div>
 432
 433         <!-- ========== Info from phpDoc block ========= -->
 434 <p class="short-description">Return the HTTP status code description for a given code. Hopefully  this is an efficient way to code this.</p>
 435         <ul class="tags">
 436                                 <li><span class="field">return:</span> The text for a give HTTP status code, in english</li>
 437                         </ul>
 438         <div class="method-signature">
 439                 <span class="method-result">string</span>
 440                 <span class="method-name">
 441                         getStatusMessage
 442                 </span>
 443                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$status</span>)
 444                         </div>
 445
 446                         <ul class="parameters">
 447                                         <li>
 448                                 <span class="var-type"></span>
 449                                 <span class="var-name">$status</span>                   </li>
 450                                 </ul>
 451
 452
 453 </div>
 454 <a name="functionISODateToHTTPDate" id="functionISODateToHTTPDate"><!-- --></a>
 455 <div class="evenrow">
 456
 457         <div>
 458                 <img src="../media/images/Function.png" />
 459                 <span class="method-title">ISODateToHTTPDate</span> (line <span class="line-number">335</span>)
 460         </div>
 461
 462         <!-- ========== Info from phpDoc block ========= -->
 463 <p class="short-description">Convert a date from ISO format into the sad old HTTP format.</p>
 464         <div class="method-signature">
 465                 <span class="method-result">void</span>
 466                 <span class="method-name">
 467                         ISODateToHTTPDate
 468                 </span>
 469                                         (<span class="var-type">string</span>&nbsp;<span class="var-name">$isodate</span>)
 470                         </div>
 471
 472                         <ul class="parameters">
 473                                         <li>
 474                                 <span class="var-type">string</span>
 475                                 <span class="var-name">$isodate</span><span class="var-description">: The date to convert</span>                        </li>
 476                                 </ul>
 477
 478
 479 </div>
 480 <a name="functionprivileges_to_XML" id="functionprivileges_to_XML"><!-- --></a>
 481 <div class="oddrow">
 482
 483         <div>
 484                 <img src="../media/images/Function.png" />
 485                 <span class="method-title">privileges_to_XML</span> (line <span class="line-number">456</span>)
 486         </div>
 487
 488         <!-- ========== Info from phpDoc block ========= -->
 489 <p class="short-description">Returns the array of privilege names converted into XMLElements</p>
 490         <div class="method-signature">
 491                 <span class="method-result">void</span>
 492                 <span class="method-name">
 493                         privileges_to_XML
 494                 </span>
 495                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$privilege_names</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$xmldoc</span> = <span class="var-default">null</span>])
 496                         </div>
 497
 498                         <ul class="parameters">
 499                                         <li>
 500                                 <span class="var-type"></span>
 501                                 <span class="var-name">$privilege_names</span>                  </li>
 502                                         <li>
 503                                 <span class="var-type"></span>
 504                                 <span class="var-name">&$xmldoc</span>                  </li>
 505                                 </ul>
 506
 507
 508 </div>
 509 <a name="functionprivilege_to_bits" id="functionprivilege_to_bits"><!-- --></a>
 510 <div class="evenrow">
 511
 512         <div>
 513                 <img src="../media/images/Function.png" />
 514                 <span class="method-title">privilege_to_bits</span> (line <span class="line-number">358</span>)
 515         </div>
 516
 517         <!-- ========== Info from phpDoc block ========= -->
 518         <div class="method-signature">
 519                 <span class="method-result">void</span>
 520                 <span class="method-name">
 521                         privilege_to_bits
 522                 </span>
 523                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$raw_privs</span>)
 524                         </div>
 525
 526                         <ul class="parameters">
 527                                         <li>
 528                                 <span class="var-type"></span>
 529                                 <span class="var-name">$raw_privs</span>                        </li>
 530                                 </ul>
 531
 532
 533 </div>
 534                 </div>
 535         </div>
 536
 537         <p class="notes" id="credit">
 538                 Documentation generated on Tue, 27 Sep 2011 11:30:43 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 539         </p>
 540         </div></body>
 541 </html>