docs/api/davical/_inc---caldav-REPORT-expand-property.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 caldav-REPORT-expand-property.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">/inc/caldav-REPORT-expand-property.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-functions">Functions</a>
  20                         </div>
  21         <div class="info-box-body">
  22                 <!-- ========== Info from phpDoc block ========= -->
  23
  24                         </div>
  25 </div>
  26
  27
  28
  29
  30
  31         <a name="sec-functions"></a>
  32         <div class="info-box">
  33                 <div class="info-box-title">Functions</div>
  34                 <div class="nav-bar">
  35                         <a href="#sec-description">Description</a> |
  36                                                                                                                         <span class="disabled">Functions</span>
  37                 </div>
  38                 <div class="info-box-body">
  39                         <a name="functionexpand_properties" id="functionexpand_properties"><!-- --></a>
  40 <div class="oddrow">
  41
  42         <div>
  43                 <img src="../media/images/Function.png" />
  44                 <span class="method-title">expand_properties</span> (line <span class="line-number">44</span>)
  45         </div>
  46
  47         <!-- ========== Info from phpDoc block ========= -->
  48 <p class="short-description">Expand the properties, recursing only once</p>
  49         <div class="method-signature">
  50                 <span class="method-result">void</span>
  51                 <span class="method-name">
  52                         expand_properties
  53                 </span>
  54                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$urls</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$ptree</span>, <span class="var-type"></span>&nbsp;<span class="var-name">&$reply</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$recurse_again</span> = <span class="var-default">true</span>])
  55                         </div>
  56
  57                         <ul class="parameters">
  58                                         <li>
  59                                 <span class="var-type"></span>
  60                                 <span class="var-name">$urls</span>                     </li>
  61                                         <li>
  62                                 <span class="var-type"></span>
  63                                 <span class="var-name">$ptree</span>                    </li>
  64                                         <li>
  65                                 <span class="var-type"></span>
  66                                 <span class="var-name">&$reply</span>                   </li>
  67                                         <li>
  68                                 <span class="var-type"></span>
  69                                 <span class="var-name">$recurse_again</span>                    </li>
  70                                 </ul>
  71
  72
  73 </div>
  74 <a name="functionget_href_containers" id="functionget_href_containers"><!-- --></a>
  75 <div class="evenrow">
  76
  77         <div>
  78                 <img src="../media/images/Function.png" />
  79                 <span class="method-title">get_href_containers</span> (line <span class="line-number">8</span>)
  80         </div>
  81
  82         <!-- ========== Info from phpDoc block ========= -->
  83 <p class="short-description">Given a &lt;response&gt;&lt;href&gt;...&lt;/href&gt;&lt;propstat&gt;&lt;prop&gt;&lt;someprop/&gt;&lt;/prop&gt;&lt;status&gt;HTTP/1.1 200 OK&lt;/status&gt;&lt;/propstat&gt;...&lt;/response&gt;  pull out the content of &lt;someprop&gt;content&lt;/someprop&gt; and check to see if it has any href elements.  If it *does* then  recurse into them, looking for the next deeper nesting of properties.</p>
  84         <div class="method-signature">
  85                 <span class="method-result">void</span>
  86                 <span class="method-name">
  87                         get_href_containers
  88                 </span>
  89                                         (<span class="var-type"></span>&nbsp;<span class="var-name">&$multistatus_response</span>)
  90                         </div>
  91
  92                         <ul class="parameters">
  93                                         <li>
  94                                 <span class="var-type"></span>
  95                                 <span class="var-name">&$multistatus_response</span>                    </li>
  96                                 </ul>
  97
  98
  99 </div>
 100                 </div>
 101         </div>
 102
 103         <p class="notes" id="credit">
 104                 Documentation generated on Fri, 13 Jan 2012 23:44:53 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 105         </p>
 106         </div></body>
 107 </html>