docs/api/davical/CheckResult.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 CheckResult</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"> CheckResult</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  23
  24                                         </div>
  25         <div class="info-box-body">
  26                         <!-- ========== Info from phpDoc block ========= -->
  27                 <p class="notes">
  28                         Located in <a class="field" href="_htdocs---setup.php.html">/htdocs/setup.php</a> (line <span class="field">8</span>)
  29                 </p>
  30
  31
  32                 <pre></pre>
  33
  34                         </div>
  35 </div>
  36
  37
  38
  39
  40         <a name="sec-method-summary"></a>
  41         <div class="info-box">
  42                 <div class="info-box-title">Method Summary</span></div>
  43                 <div class="nav-bar">
  44                         <a href="#sec-description">Description</a> |
  45                                                                                                 <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  46                 </div>
  47                 <div class="info-box-body">
  48                         <div class="method-summary">
  49                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 <div class="method-definition">
  50                                         <img src="../media/images/Constructor.png" alt=" "/>
  51                                                                                         <span class="method-result">CheckResult</span>
  52                                                                                 <a href="#__construct" title="details" class="method-name">__construct</a>
  53                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$use_class</span> = <span class="var-default">null</span>])
  54                                                                         </div>
  55                                                                                                                                 <div class="method-definition">
  56                                         <img src="../media/images/Method.png" alt=" "/>
  57                                                                                         <span class="method-result">void</span>
  58                                                                                 <a href="#getClass" title="details" class="method-name">getClass</a>
  59                                                                                 ()
  60                                                                         </div>
  61                                                                                                                                 <div class="method-definition">
  62                                         <img src="../media/images/Method.png" alt=" "/>
  63                                                                                         <span class="method-result">void</span>
  64                                                                                 <a href="#getDescription" title="details" class="method-name">getDescription</a>
  65                                                                                 ()
  66                                                                         </div>
  67                                                                                                                                 <div class="method-definition">
  68                                         <img src="../media/images/Method.png" alt=" "/>
  69                                                                                         <span class="method-result">void</span>
  70                                                                                 <a href="#getOK" title="details" class="method-name">getOK</a>
  71                                                                                 ()
  72                                                                         </div>
  73                                                                                                                                 <div class="method-definition">
  74                                         <img src="../media/images/Method.png" alt=" "/>
  75                                                                                         <span class="method-result">void</span>
  76                                                                                 <a href="#setClass" title="details" class="method-name">setClass</a>
  77                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$new_class</span>)
  78                                                                         </div>
  79                                                                                                                                 <div class="method-definition">
  80                                         <img src="../media/images/Method.png" alt=" "/>
  81                                                                                         <span class="method-result">void</span>
  82                                                                                 <a href="#setDescription" title="details" class="method-name">setDescription</a>
  83                                                                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$new_desc</span>)
  84                                                                         </div>
  85                                                                                         </div>
  86                 </div>
  87         </div>
  88
  89
  90         <a name="sec-methods"></a>
  91         <div class="info-box">
  92                 <div class="info-box-title">Methods</div>
  93                 <div class="nav-bar">
  94                         <a href="#sec-description">Description</a> |
  95                                                                                                         <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  96
  97                 </div>
  98                 <div class="info-box-body">
  99                         <A NAME='method_detail'></A>
 100 <a name="method__construct" id="__construct"><!-- --></a>
 101 <div class="evenrow">
 102
 103         <div class="method-header">
 104                 <img src="../media/images/Constructor.png" />
 105                 <span class="method-title">Constructor __construct</span> (line <span class="line-number">13</span>)
 106         </div>
 107
 108         <!-- ========== Info from phpDoc block ========= -->
 109
 110         <div class="method-signature">
 111                 <span class="method-result">CheckResult</span>
 112                 <span class="method-name">
 113                         __construct
 114                 </span>
 115                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$success</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$description</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$use_class</span> = <span class="var-default">null</span>])
 116                         </div>
 117
 118                         <ul class="parameters">
 119                                         <li>
 120                                 <span class="var-type"></span>
 121                                 <span class="var-name">$success</span>                  </li>
 122                                         <li>
 123                                 <span class="var-type"></span>
 124                                 <span class="var-name">$description</span>                      </li>
 125                                         <li>
 126                                 <span class="var-type"></span>
 127                                 <span class="var-name">$use_class</span>                        </li>
 128                                 </ul>
 129
 130
 131         </div>
 132 <a name="methodgetClass" id="getClass"><!-- --></a>
 133 <div class="oddrow">
 134
 135         <div class="method-header">
 136                 <img src="../media/images/Method.png" />
 137                 <span class="method-title">getClass</span> (line <span class="line-number">19</span>)
 138         </div>
 139
 140         <!-- ========== Info from phpDoc block ========= -->
 141         <ul class="tags">
 142                                 <li><span class="field">access:</span> public</li>
 143                         </ul>
 144
 145         <div class="method-signature">
 146                 <span class="method-result">void</span>
 147                 <span class="method-name">
 148                         getClass
 149                 </span>
 150                                 ()
 151                         </div>
 152
 153
 154
 155         </div>
 156 <a name="methodgetDescription" id="getDescription"><!-- --></a>
 157 <div class="evenrow">
 158
 159         <div class="method-header">
 160                 <img src="../media/images/Method.png" />
 161                 <span class="method-title">getDescription</span> (line <span class="line-number">31</span>)
 162         </div>
 163
 164         <!-- ========== Info from phpDoc block ========= -->
 165         <ul class="tags">
 166                                 <li><span class="field">access:</span> public</li>
 167                         </ul>
 168
 169         <div class="method-signature">
 170                 <span class="method-result">void</span>
 171                 <span class="method-name">
 172                         getDescription
 173                 </span>
 174                                 ()
 175                         </div>
 176
 177
 178
 179         </div>
 180 <a name="methodgetOK" id="getOK"><!-- --></a>
 181 <div class="oddrow">
 182
 183         <div class="method-header">
 184                 <img src="../media/images/Method.png" />
 185                 <span class="method-title">getOK</span> (line <span class="line-number">27</span>)
 186         </div>
 187
 188         <!-- ========== Info from phpDoc block ========= -->
 189         <ul class="tags">
 190                                 <li><span class="field">access:</span> public</li>
 191                         </ul>
 192
 193         <div class="method-signature">
 194                 <span class="method-result">void</span>
 195                 <span class="method-name">
 196                         getOK
 197                 </span>
 198                                 ()
 199                         </div>
 200
 201
 202
 203         </div>
 204 <a name="methodsetClass" id="setClass"><!-- --></a>
 205 <div class="evenrow">
 206
 207         <div class="method-header">
 208                 <img src="../media/images/Method.png" />
 209                 <span class="method-title">setClass</span> (line <span class="line-number">23</span>)
 210         </div>
 211
 212         <!-- ========== Info from phpDoc block ========= -->
 213         <ul class="tags">
 214                                 <li><span class="field">access:</span> public</li>
 215                         </ul>
 216
 217         <div class="method-signature">
 218                 <span class="method-result">void</span>
 219                 <span class="method-name">
 220                         setClass
 221                 </span>
 222                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$new_class</span>)
 223                         </div>
 224
 225                         <ul class="parameters">
 226                                         <li>
 227                                 <span class="var-type"></span>
 228                                 <span class="var-name">$new_class</span>                        </li>
 229                                 </ul>
 230
 231
 232         </div>
 233 <a name="methodsetDescription" id="setDescription"><!-- --></a>
 234 <div class="oddrow">
 235
 236         <div class="method-header">
 237                 <img src="../media/images/Method.png" />
 238                 <span class="method-title">setDescription</span> (line <span class="line-number">35</span>)
 239         </div>
 240
 241         <!-- ========== Info from phpDoc block ========= -->
 242         <ul class="tags">
 243                                 <li><span class="field">access:</span> public</li>
 244                         </ul>
 245
 246         <div class="method-signature">
 247                 <span class="method-result">void</span>
 248                 <span class="method-name">
 249                         setDescription
 250                 </span>
 251                                         (<span class="var-type"></span>&nbsp;<span class="var-name">$new_desc</span>)
 252                         </div>
 253
 254                         <ul class="parameters">
 255                                         <li>
 256                                 <span class="var-type"></span>
 257                                 <span class="var-name">$new_desc</span>                 </li>
 258                                 </ul>
 259
 260
 261         </div>
 262
 263                 </div>
 264         </div>
 265
 266
 267         <p class="notes" id="credit">
 268                 Documentation generated on Tue, 27 Sep 2011 11:30:48 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
 269         </p>
 270         </div></body>
 271 </html>