[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 TDataFieldAccessor</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">Class TDataFieldAccessor</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">TDataFieldAccessor class</p>
  25  <p class="description"><p>TDataFieldAccessor is a utility class that provides access to a field of some data.  The accessor attempts to obtain the field value in the following order: <ul><li>If the data is an array, then the field is treated as an array index
  26     and the corresponding element value is returned;</li><li>If the data is a TMap or TList object, then the field is treated as a key
  27     into the map or list, and the corresponding value is returned.</li><li>If the data is an object, the field is treated as a property or subproperty
  28     defined with getter methods. For example, if the object has a method called
  29     getMyValue(), then field 'MyValue' will retrive the result of this method call.
  30     If getMyValue() returns an object which contains a method getMySubValue(),
  31     then field 'MyValue.MySubValue' will return that method call result.</li></ul></p></p>
  32      <ul class="tags">
  33                  <li><span class="field">since:</span> 3.0</li>
  34                  <li><span class="field">version:</span> $Id: TDataFieldAccessor.php 1397 2006-09-07 07:55:53Z wei $</li>
  35                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  36              </ul>
  37          <p class="notes">
  38              Located in <a class="field" href="_Util_TDataFieldAccessor_php.html">/Util/TDataFieldAccessor.php</a> (line <span class="field">33</span>)
  39          </p>
  40          
  41                  
  42          <pre></pre>
  43      
  44              </div>
  45  </div>
  46  
  47  
  48  
  49  
  50      <a name="sec-method-summary"></a>
  51      <div class="info-box">
  52          <div class="info-box-title">Method Summary</span></div>
  53          <div class="nav-bar">
  54              <a href="#sec-description">Description</a> |
  55                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  56          </div>
  57          <div class="info-box-body">            
  58              <div class="method-summary">
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">mixed</span>
  62                                          <a href="#getDataFieldValue" title="details" class="method-name">getDataFieldValue</a>
  63                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$field</span>)
  64                                      </div>
  65                              </div>
  66          </div>
  67      </div>        
  68  
  69      
  70      <a name="sec-methods"></a>
  71      <div class="info-box">
  72          <div class="info-box-title">Methods</div>
  73          <div class="nav-bar">
  74              <a href="#sec-description">Description</a> |
  75                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
  76                          
  77          </div>
  78          <div class="info-box-body">
  79              <A NAME='method_detail'></A>
  80  <a name="methodgetDataFieldValue" id="getDataFieldValue"><!-- --></a>
  81  <div class="oddrow">
  82      
  83      <div class="method-header">
  84          <span class="method-title">getDataFieldValue</span> (line <span class="line-number">51</span>)
  85      </div> 
  86      
  87      <!-- ========== Info from phpDoc block ========= -->
  88  <p class="short-description">Evaluates the data value at the specified field.</p>
  89  <p class="description"><p><ul><li>If the data is an array, then the field is treated as an array index
  90     and the corresponding element value is returned;</li><li>If the data is a TMap or TList object, then the field is treated as a key
  91     into the map or list, and the corresponding value is returned.</li><li>If the data is an object, the field is treated as a property or subproperty
  92     defined with getter methods. For example, if the object has a method called
  93     getMyValue(), then field 'MyValue' will retrive the result of this method call.
  94     If getMyValue() returns an object which contains a method getMySubValue(),
  95     then field 'MyValue.MySubValue' will return that method call result.</li></ul></p></p>
  96      <ul class="tags">
  97                  <li><span class="field">return:</span> value at the specified field</li>
  98                  <li><span class="field">static:</span> </li>
  99                  <li><span class="field">access:</span> public</li>
 100                  <li><span class="field">throws:</span> TInvalidDataValueException if field or data is invalid</li>
 101              </ul>
 102      
 103      <div class="method-signature">
 104          <span class="method-result">mixed</span>
 105          <span class="method-name">
 106              getDataFieldValue
 107          </span>
 108                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$field</span>)
 109              </div>
 110      
 111              <ul class="parameters">
 112                      <li>
 113                  <span class="var-type">mixed</span>
 114                  <span class="var-name">$data</span><span class="var-description">: data containing the field value, can be an array, TMap, TList or object.</span>            </li>
 115                      <li>
 116                  <span class="var-type">mixed</span>
 117                  <span class="var-name">$field</span><span class="var-description">: field value</span>            </li>
 118                  </ul>
 119          
 120          
 121      </div>
 122                          
 123          </div>
 124      </div>
 125  
 126  
 127      <p class="notes" id="credit">
 128          Documentation generated on Mon, 04 Dec 2006 11:26:19 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 129      </p>
 130      </div></body>
 131  </html>