<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.pdostatement.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'pt_BR',
  ),
  'this' => 
  array (
    0 => 'pdostatement.getcolumnmeta.php',
    1 => 'PDOStatement::getColumnMeta',
    2 => 'Retorna metadados para uma coluna no resultado',
  ),
  'up' => 
  array (
    0 => 'class.pdostatement.php',
    1 => 'PDOStatement',
  ),
  'prev' => 
  array (
    0 => 'pdostatement.getattribute.php',
    1 => 'PDOStatement::getAttribute',
  ),
  'next' => 
  array (
    0 => 'pdostatement.getiterator.php',
    1 => 'PDOStatement::getIterator',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'pt_BR',
    'path' => 'reference/pdo/pdostatement/getcolumnmeta.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="pdostatement.getcolumnmeta" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">PDOStatement::getColumnMeta</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8, PECL pdo &gt;= 0.2.0)</p><p class="refpurpose"><span class="refname">PDOStatement::getColumnMeta</span> &mdash; <span class="dc-title">
   Retorna metadados para uma coluna no resultado
  </span></p>

 </div>
 <div class="refsect1 description" id="refsect1-pdostatement.getcolumnmeta-description">
  <h3 class="title">Descrição</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>PDOStatement::getColumnMeta</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$column</code></span>): <span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>


  <p class="para rdfs-comment">
   Retorna metadados para uma coluna no resultado, indexada a partir de 0, como um
   array associativo.
  </p>
  <div class="warning"><strong class="warning">Aviso</strong>
   <p class="simpara">
    Alguns drivers podem não implementar o método
    <span class="methodname"><strong>PDOStatement::getColumnMeta()</strong></span>,
    já que ele é opcional. Entretanto, todos os
    <a href="pdo.drivers.php" class="link">drivers PDO</a>
    documentados neste manual implementam este método.
   </p>
  </div>

 </div>

 <div class="refsect1 parameters" id="refsect1-pdostatement.getcolumnmeta-parameters">
  <h3 class="title">Parâmetros</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">column</code></dt>
      <dd>
       <p class="para">
        A coluna no resultado, indexada a partir de 0.
       </p>
      </dd>
     
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-pdostatement.getcolumnmeta-returnvalues">
  <h3 class="title">Valor Retornado</h3>
  <p class="para">
   Retorna um array associativo contendo os seguintes valores que representam
   os metadados para uma única coluna:
  </p>
   <table class="doctable table">
    <caption><strong>Metadados de coluna</strong></caption>
    
     <col />
     <col />
     <thead>
      <tr>
       <th>Nome</th>
       <th>Valor</th>
      </tr>

     </thead>

     <tbody class="tbody">
      <tr>
       <td><code class="literal">native_type</code></td>
       <td>O tipo de dados nativo do PHP usado para representar o valor da coluna.</td>
      </tr>

      <tr>
       <td><code class="literal">driver:decl_type</code></td>
       <td>O tipo de dados SQL usado para representar o valor da coluna no banco de dados.
       Se a coluna for resultado de uma função, este valor
       não será retornado por <span class="methodname"><strong>PDOStatement::getColumnMeta()</strong></span>.
       </td>
      </tr>

      <tr>
       <td><code class="literal">flags</code></td>
       <td>Quaisquer opções configuradas para esta coluna.</td>
      </tr>

      <tr>
       <td><code class="literal">name</code></td>
       <td>O nome desta coluna como retornado pelo banco de dados.</td>
      </tr>

      <tr>
       <td><code class="literal">table</code></td>
       <td>O nome da tabela desta coluna como retornado pelo banco de dados.</td>
      </tr>

      <tr>
       <td><code class="literal">len</code></td>
       <td>O comprimento desta coluna. Normalmente <code class="literal">-1</code> para
       tipos que não sejam números com decimais.</td>
      </tr>

      <tr>
       <td><code class="literal">precision</code></td>
       <td>A precisão numérica desta coluna. Normalmente
       <code class="literal">0</code> para tipos que não sejam números
       decimais.</td>
      </tr>

      <tr>
       <td><code class="literal">pdo_type</code></td>
       <td>O tipo desta coluna como representado pelas
       <a href="pdo.constants.php" class="link">constantes
       <code class="literal">PDO::PARAM_*</code></a>.</td>
      </tr>

     </tbody>
    
   </table>

  <p class="para">
   Retorna <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> se a coluna requisitada não existir no resultado
   ou se não existir resultado.
  </p>
 </div>


 

 <div class="refsect1 examples" id="refsect1-pdostatement.getcolumnmeta-examples">
  <h3 class="title">Exemplos</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Exemplo #1 Recuperando metadados de coluna</strong></p>
    <div class="example-contents"><p>
     O exemplo a seguir mostra o resultado da recuperação de metadados para uma
     única coluna gerada por uma função (COUNT) em um driver PDO_SQLITE.
    </p></div>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$select </span><span style="color: #007700">= </span><span style="color: #0000BB">$DB</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">query</span><span style="color: #007700">(</span><span style="color: #DD0000">'SELECT COUNT(*) FROM fruit'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$meta </span><span style="color: #007700">= </span><span style="color: #0000BB">$select</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getColumnMeta</span><span style="color: #007700">(</span><span style="color: #0000BB">0</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$meta</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

    <div class="example-contents"><p>O exemplo acima produzirá:</p></div>
    <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">array(6) {
  [&quot;native_type&quot;]=&gt;
  string(7) &quot;integer&quot;
  [&quot;flags&quot;]=&gt;
  array(0) {
  }
  [&quot;name&quot;]=&gt;
  string(8) &quot;COUNT(*)&quot;
  [&quot;len&quot;]=&gt;
  int(-1)
  [&quot;precision&quot;]=&gt;
  int(0)
  [&quot;pdo_type&quot;]=&gt;
  int(2)
}</pre>
</div>
    </div>
   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-pdostatement.getcolumnmeta-seealso">
  <h3 class="title">Veja Também</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="pdostatement.columncount.php" class="methodname" rel="rdfs-seeAlso">PDOStatement::columnCount()</a> - Retorna o n&uacute;mero de colunas no conjunto de resultados</span></li>
    <li><span class="methodname"><a href="pdostatement.rowcount.php" class="methodname" rel="rdfs-seeAlso">PDOStatement::rowCount()</a> - Retorna o n&uacute;mero de registros afetados pela &uacute;ltima instru&ccedil;&atilde;o SQL</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>