docs/api/davical/_inc---caldav-REPORT-calquery.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-calquery.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-calquery.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-functions">Functions</a>
  21                         </div>
  22         <div class="info-box-body">
  23                 <!-- ========== Info from phpDoc block ========= -->
  24
  25                         </div>
  26 </div>
  27
  28
  29         <a name="sec-includes"></a>
  30         <div class="info-box">
  31                 <div class="info-box-title">Includes</div>
  32                 <div class="nav-bar">
  33                         <a href="#sec-description">Description</a> |
  34                                                 <span class="disabled">Includes</span>
  35                         |                                                                                                       <a href="#sec-functions">Functions</a>
  36                                         </div>
  37                 <div class="info-box-body">
  38                         <a name="_vCalendar_php"><!-- --></a>
  39 <div class="evenrow">
  40
  41         <div>
  42                 <img src="../media/images/Page.png" alt=" " />
  43                 <span class="include-title">
  44                         <span class="include-type">include_once</span>
  45                         (<span class="include-name">'vCalendar.php'</span>)
  46                         (line <span class="line-number">3</span>)
  47                 </span>
  48         </div>
  49
  50         <!-- ========== Info from phpDoc block ========= -->
  51
  52 </div>
  53                 </div>
  54         </div>
  55
  56
  57
  58         <a name="sec-functions"></a>
  59         <div class="info-box">
  60                 <div class="info-box-title">Functions</div>
  61                 <div class="nav-bar">
  62                         <a href="#sec-description">Description</a> |
  63                                                                                 <a href="#sec-includes">Includes</a>
  64                                 |                                                                                               <span class="disabled">Functions</span>
  65                 </div>
  66                 <div class="info-box-body">
  67                         <a name="functionapply_filter" id="functionapply_filter"><!-- --></a>
  68 <div class="oddrow">
  69
  70         <div>
  71                 <img src="../media/images/Function.png" />
  72                 <span class="method-title">apply_filter</span> (line <span class="line-number">75</span>)
  73         </div>
  74
  75         <!-- ========== Info from phpDoc block ========= -->
  76 <p class="short-description">While we can construct our SQL to apply some filters in the query, other filters  need to be checked against the retrieved record.  This is for handling those ones.</p>
  77         <ul class="tags">
  78                                 <li><span class="field">return:</span> True if the check succeeded, false otherwise.</li>
  79                         </ul>
  80         <div class="method-signature">
  81                 <span class="method-result">boolean</span>
  82                 <span class="method-name">
  83                         apply_filter
  84                 </span>
  85                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$filters</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$item</span>, <span class="var-type">array</span>&nbsp;<span class="var-name">$filter</span>)
  86                         </div>
  87
  88                         <ul class="parameters">
  89                                         <li>
  90                                 <span class="var-type">array</span>
  91                                 <span class="var-name">$filter</span><span class="var-description">: An array of XMLElement which is the filter definition</span>                       </li>
  92                                         <li>
  93                                 <span class="var-type">string</span>
  94                                 <span class="var-name">$item</span><span class="var-description">: The database row retrieved for this calendar item</span>                     </li>
  95                                         <li>
  96                                 <span class="var-type"></span>
  97                                 <span class="var-name">$filters</span>                  </li>
  98                                 </ul>
  99
 100
 101 </div>
 102 <a name="functionBuildSqlFilter" id="functionBuildSqlFilter"><!-- --></a>
 103 <div class="evenrow">
 104
 105         <div>
 106                 <img src="../media/images/Function.png" />
 107                 <span class="method-title">BuildSqlFilter</span> (line <span class="line-number">276</span>)
 108         </div>
 109
 110         <!-- ========== Info from phpDoc block ========= -->
 111 <p class="short-description">Build an SQL 'WHERE' clause which implements (parts of) the filter. The  elements of the filter which are implemented in the SQL will be removed.</p>
 112         <ul class="tags">
 113                                 <li><span class="field">return:</span> A string suitable for use as an SQL 'WHERE' clause selecting the desired records.</li>
 114                         </ul>
 115         <div class="method-signature">
 116                 <span class="method-result">string</span>
 117                 <span class="method-name">
 118                         BuildSqlFilter
 119                 </span>
 120                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$filter</span>, <span class="var-type">arrayref</span>&nbsp;<span class="var-name">&$filter</span>)
 121                         </div>
 122
 123                         <ul class="parameters">
 124                                         <li>
 125                                 <span class="var-type">arrayref</span>
 126                                 <span class="var-name">&$filter</span><span class="var-description">: A reference to an array of XMLElement defining the filter</span>                  </li>
 127                                         <li>
 128                                 <span class="var-type"></span>
 129                                 <span class="var-name">$filter</span>                   </li>
 130                                 </ul>
 131
 132
 133 </div>
 134 <a name="functioncheck_for_expansion" id="functioncheck_for_expansion"><!-- --></a>
 135 <div class="oddrow">
 136
 137         <div>
 138                 <img src="../media/images/Function.png" />
 139                 <span class="method-title">check_for_expansion</span> (line <span class="line-number">6</span>)
 140         </div>
 141
 142         <!-- ========== Info from phpDoc block ========= -->
 143         <div class="method-signature">
 144                 <span class="method-result">void</span>
 145                 <span class="method-name">
 146                         check_for_expansion
 147                 </span>
 148                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$calendar_data_node</span>)
 149                         </div>
 150
 151                         <ul class="parameters">
 152                                         <li>
 153                                 <span class="var-type"></span>
 154                                 <span class="var-name">$calendar_data_node</span>                       </li>
 155                                 </ul>
 156
 157
 158 </div>
 159 <a name="functionSqlFilterFragment" id="functionSqlFilterFragment"><!-- --></a>
 160 <div class="evenrow">
 161
 162         <div>
 163                 <img src="../media/images/Function.png" />
 164                 <span class="method-title">SqlFilterFragment</span> (line <span class="line-number">91</span>)
 165         </div>
 166
 167         <!-- ========== Info from phpDoc block ========= -->
 168 <p class="short-description">Process a filter fragment returning an SQL fragment</p>
 169         <div class="method-signature">
 170                 <span class="method-result">void</span>
 171                 <span class="method-name">
 172                         SqlFilterFragment
 173                 </span>
 174                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$filter</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$components</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$property</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$parameter</span> = <span class="var-default">null</span>])
 175                         </div>
 176
 177                         <ul class="parameters">
 178                                         <li>
 179                                 <span class="var-type"></span>
 180                                 <span class="var-name">$filter</span>                   </li>
 181                                         <li>
 182                                 <span class="var-type"></span>
 183                                 <span class="var-name">$components</span>                       </li>
 184                                         <li>
 185                                 <span class="var-type"></span>
 186                                 <span class="var-name">$property</span>                 </li>
 187                                         <li>
 188                                 <span class="var-type"></span>
 189                                 <span class="var-name">$parameter</span>                        </li>
 190                                 </ul>
 191
 192
 193 </div>
 194                 </div>
 195         </div>
 196
 197         <p class="notes" id="credit">
 198                 Documentation generated on Tue, 27 Sep 2011 11:30:45 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 199         </p>
 200         </div></body>
 201 </html>