[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 IModule</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 IModule</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">IModule interface.</p>
  25  <p class="description"><p>This interface must be implemented by application modules.</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">23</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">string</span>
  56                                          <a href="#getID" title="details" class="method-name">getID</a>
  57                                          ()
  58                                      </div>
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">void</span>
  62                                          <a href="#init" title="details" class="method-name">init</a>
  63                                              (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
  64                                      </div>
  65                                  
  66                  <div class="method-definition">
  67                                              <span class="method-result">void</span>
  68                                          <a href="#setID" title="details" class="method-name">setID</a>
  69                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
  70                                      </div>
  71                              </div>
  72          </div>
  73      </div>        
  74  
  75      
  76      <a name="sec-methods"></a>
  77      <div class="info-box">
  78          <div class="info-box-title">Methods</div>
  79          <div class="nav-bar">
  80              <a href="#sec-description">Description</a> |
  81                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  82                          
  83          </div>
  84          <div class="info-box-body">
  85              <A NAME='method_detail'></A>
  86  <a name="methodgetID" id="getID"><!-- --></a>
  87  <div class="oddrow">
  88      
  89      <div class="method-header">
  90          <span class="method-title">getID</span> (line <span class="line-number">33</span>)
  91      </div> 
  92      
  93      <!-- ========== Info from phpDoc block ========= -->
  94      <ul class="tags">
  95                  <li><span class="field">return:</span> ID of the module</li>
  96                  <li><span class="field">access:</span> public</li>
  97              </ul>
  98      
  99      <div class="method-signature">
 100          <span class="method-result">string</span>
 101          <span class="method-name">
 102              getID
 103          </span>
 104                  ()
 105              </div>
 106      
 107          
 108          
 109      </div>
 110  <a name="methodinit" id="init"><!-- --></a>
 111  <div class="evenrow">
 112      
 113      <div class="method-header">
 114          <span class="method-title">init</span> (line <span class="line-number">29</span>)
 115      </div> 
 116      
 117      <!-- ========== Info from phpDoc block ========= -->
 118  <p class="short-description">Initializes the module.</p>
 119      <ul class="tags">
 120                  <li><span class="field">access:</span> public</li>
 121              </ul>
 122      
 123      <div class="method-signature">
 124          <span class="method-result">void</span>
 125          <span class="method-name">
 126              init
 127          </span>
 128                      (<span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>&nbsp;<span class="var-name">$config</span>)
 129              </div>
 130      
 131              <ul class="parameters">
 132                      <li>
 133                  <span class="var-type"><a href="../System.Xml/TXmlElement.html">TXmlElement</a></span>
 134                  <span class="var-name">$config</span><span class="var-description">: the configuration for the module</span>            </li>
 135                  </ul>
 136          
 137          
 138      </div>
 139  <a name="methodsetID" id="setID"><!-- --></a>
 140  <div class="oddrow">
 141      
 142      <div class="method-header">
 143          <span class="method-title">setID</span> (line <span class="line-number">37</span>)
 144      </div> 
 145      
 146      <!-- ========== Info from phpDoc block ========= -->
 147      <ul class="tags">
 148                  <li><span class="field">access:</span> public</li>
 149              </ul>
 150      
 151      <div class="method-signature">
 152          <span class="method-result">void</span>
 153          <span class="method-name">
 154              setID
 155          </span>
 156                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
 157              </div>
 158      
 159              <ul class="parameters">
 160                      <li>
 161                  <span class="var-type">string</span>
 162                  <span class="var-name">$id</span><span class="var-description">: ID of the module</span>            </li>
 163                  </ul>
 164          
 165          
 166      </div>
 167                          
 168          </div>
 169      </div>
 170  
 171  
 172      <p class="notes" id="credit">
 173          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>
 174      </p>
 175      </div></body>
 176  </html>