[Sommaire] [Imprimer]

   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 ICache</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">Interface ICache</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">ICache interface.</p>
  25  <p class="description"><p>This interface must be implemented by cache managers.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: interfaces.php 1397 2006-09-07 07:55:53Z wei $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_interfaces_php.html">/interfaces.php</a> (line <span class="field">183</span>)
  33          </p>
  34          
  35                  
  36          <pre></pre>
  37      
  38              </div>
  39  </div>
  40  
  41  
  42  
  43  
  44      <a name="sec-method-summary"></a>
  45      <div class="info-box">
  46          <div class="info-box-title">Method Summary</span></div>
  47          <div class="nav-bar">
  48              <a href="#sec-description">Description</a> |
  49                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  50          </div>
  51          <div class="info-box-body">            
  52              <div class="method-summary">
  53                                  
  54                  <div class="method-definition">
  55                                              <span class="method-result">boolean</span>
  56                                          <a href="#add" title="details" class="method-name">add</a>
  57                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expire</span>, [<span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>&nbsp;<span class="var-name">$dependency</span> = <span class="var-default">null</span>])
  58                                      </div>
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">boolean</span>
  62                                          <a href="#delete" title="details" class="method-name">delete</a>
  63                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
  64                                      </div>
  65                                  
  66                  <div class="method-definition">
  67                                              <span class="method-result">void</span>
  68                                          <a href="#flush" title="details" class="method-name">flush</a>
  69                                          ()
  70                                      </div>
  71                                  
  72                  <div class="method-definition">
  73                                              <span class="method-result">mixed</span>
  74                                          <a href="#get" title="details" class="method-name">get</a>
  75                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
  76                                      </div>
  77                                  
  78                  <div class="method-definition">
  79                                              <span class="method-result">boolean</span>
  80                                          <a href="#set" title="details" class="method-name">set</a>
  81                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expire</span>, [<span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>&nbsp;<span class="var-name">$dependency</span> = <span class="var-default">null</span>])
  82                                      </div>
  83                              </div>
  84          </div>
  85      </div>        
  86  
  87      
  88      <a name="sec-methods"></a>
  89      <div class="info-box">
  90          <div class="info-box-title">Methods</div>
  91          <div class="nav-bar">
  92              <a href="#sec-description">Description</a> |
  93                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  94                          
  95          </div>
  96          <div class="info-box-body">
  97              <A NAME='method_detail'></A>
  98  <a name="methodadd" id="add"><!-- --></a>
  99  <div class="oddrow">
 100      
 101      <div class="method-header">
 102          <span class="method-title">add</span> (line <span class="line-number">212</span>)
 103      </div> 
 104      
 105      <!-- ========== Info from phpDoc block ========= -->
 106  <p class="short-description">Stores a value identified by a key into cache if the cache does not contain this key.</p>
 107  <p class="description"><p>Nothing will be done if the cache already contains the key.</p></p>
 108      <ul class="tags">
 109                  <li><span class="field">return:</span> true if the value is successfully stored into cache, false otherwise</li>
 110                  <li><span class="field">access:</span> public</li>
 111              </ul>
 112      
 113      <div class="method-signature">
 114          <span class="method-result">boolean</span>
 115          <span class="method-name">
 116              add
 117          </span>
 118                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expire</span>, [<span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>&nbsp;<span class="var-name">$dependency</span> = <span class="var-default">null</span>])
 119              </div>
 120      
 121              <ul class="parameters">
 122                      <li>
 123                  <span class="var-type">string</span>
 124                  <span class="var-name">$id</span><span class="var-description">: the key identifying the value to be cached</span>            </li>
 125                      <li>
 126                  <span class="var-type">mixed</span>
 127                  <span class="var-name">$value</span><span class="var-description">: the value to be cached</span>            </li>
 128                      <li>
 129                  <span class="var-type">integer</span>
 130                  <span class="var-name">$expire</span><span class="var-description">: the number of seconds in which the cached value will expire. 0 means never expire.</span>            </li>
 131                      <li>
 132                  <span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>
 133                  <span class="var-name">$dependency</span><span class="var-description">: dependency of the cached item. If the dependency changes, the item is labelled invalid.</span>            </li>
 134                  </ul>
 135          
 136          
 137      </div>
 138  <a name="methoddelete" id="delete"><!-- --></a>
 139  <div class="evenrow">
 140      
 141      <div class="method-header">
 142          <span class="method-title">delete</span> (line <span class="line-number">218</span>)
 143      </div> 
 144      
 145      <!-- ========== Info from phpDoc block ========= -->
 146  <p class="short-description">Deletes a value with the specified key from cache</p>
 147      <ul class="tags">
 148                  <li><span class="field">return:</span> if no error happens during deletion</li>
 149                  <li><span class="field">access:</span> public</li>
 150              </ul>
 151      
 152      <div class="method-signature">
 153          <span class="method-result">boolean</span>
 154          <span class="method-name">
 155              delete
 156          </span>
 157                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
 158              </div>
 159      
 160              <ul class="parameters">
 161                      <li>
 162                  <span class="var-type">string</span>
 163                  <span class="var-name">$id</span><span class="var-description">: the key of the value to be deleted</span>            </li>
 164                  </ul>
 165          
 166          
 167      </div>
 168  <a name="methodflush" id="flush"><!-- --></a>
 169  <div class="oddrow">
 170      
 171      <div class="method-header">
 172          <span class="method-title">flush</span> (line <span class="line-number">223</span>)
 173      </div> 
 174      
 175      <!-- ========== Info from phpDoc block ========= -->
 176  <p class="short-description">Deletes all values from cache.</p>
 177  <p class="description"><p>Be careful of performing this operation if the cache is shared by multiple applications.</p></p>
 178      <ul class="tags">
 179                  <li><span class="field">access:</span> public</li>
 180              </ul>
 181      
 182      <div class="method-signature">
 183          <span class="method-result">void</span>
 184          <span class="method-name">
 185              flush
 186          </span>
 187                  ()
 188              </div>
 189      
 190          
 191          
 192      </div>
 193  <a name="methodget" id="get"><!-- --></a>
 194  <div class="evenrow">
 195      
 196      <div class="method-header">
 197          <span class="method-title">get</span> (line <span class="line-number">190</span>)
 198      </div> 
 199      
 200      <!-- ========== Info from phpDoc block ========= -->
 201  <p class="short-description">Retrieves a value from cache with a specified key.</p>
 202      <ul class="tags">
 203                  <li><span class="field">return:</span> the value stored in cache, false if the value is not in the cache or expired.</li>
 204                  <li><span class="field">access:</span> public</li>
 205              </ul>
 206      
 207      <div class="method-signature">
 208          <span class="method-result">mixed</span>
 209          <span class="method-name">
 210              get
 211          </span>
 212                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
 213              </div>
 214      
 215              <ul class="parameters">
 216                      <li>
 217                  <span class="var-type">string</span>
 218                  <span class="var-name">$id</span><span class="var-description">: a key identifying the cached value</span>            </li>
 219                  </ul>
 220          
 221          
 222      </div>
 223  <a name="methodset" id="set"><!-- --></a>
 224  <div class="oddrow">
 225      
 226      <div class="method-header">
 227          <span class="method-title">set</span> (line <span class="line-number">202</span>)
 228      </div> 
 229      
 230      <!-- ========== Info from phpDoc block ========= -->
 231  <p class="short-description">Stores a value identified by a key into cache.</p>
 232  <p class="description"><p>If the cache already contains such a key, the existing value and  expiration time will be replaced with the new ones.</p></p>
 233      <ul class="tags">
 234                  <li><span class="field">return:</span> true if the value is successfully stored into cache, false otherwise</li>
 235                  <li><span class="field">access:</span> public</li>
 236              </ul>
 237      
 238      <div class="method-signature">
 239          <span class="method-result">boolean</span>
 240          <span class="method-name">
 241              set
 242          </span>
 243                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$expire</span>, [<span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>&nbsp;<span class="var-name">$dependency</span> = <span class="var-default">null</span>])
 244              </div>
 245      
 246              <ul class="parameters">
 247                      <li>
 248                  <span class="var-type">string</span>
 249                  <span class="var-name">$id</span><span class="var-description">: the key identifying the value to be cached</span>            </li>
 250                      <li>
 251                  <span class="var-type">mixed</span>
 252                  <span class="var-name">$value</span><span class="var-description">: the value to be cached</span>            </li>
 253                      <li>
 254                  <span class="var-type">integer</span>
 255                  <span class="var-name">$expire</span><span class="var-description">: the number of seconds in which the cached value will expire. 0 means never expire.</span>            </li>
 256                      <li>
 257                  <span class="var-type"><a href="../System/ICacheDependency.html">ICacheDependency</a></span>
 258                  <span class="var-name">$dependency</span><span class="var-description">: dependency of the cached item. If the dependency changes, the item is labelled invalid.</span>            </li>
 259                  </ul>
 260          
 261          
 262      </div>
 263                          
 264          </div>
 265      </div>
 266  
 267  
 268      <p class="notes" id="credit">
 269          Documentation generated on Mon, 04 Dec 2006 11:25:49 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 270      </p>
 271      </div></body>
 272  </html>