<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get column information from a result and return as an object</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cubrid-fetch-assoc.html">cubrid_fetch_assoc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-fetch-lengths.html">cubrid_fetch_lengths</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.cubrid-fetch-field" class="refentry">
<div class="refnamediv">
<h1 class="refname">cubrid_fetch_field</h1>
<p class="verinfo">(PECL CUBRID >= 8.3.1)</p><p class="refpurpose"><span class="refname">cubrid_fetch_field</span> — <span class="dc-title">Get column information from a result and return as an object</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.cubrid-fetch-field-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">object</span> <span class="methodname"><strong>cubrid_fetch_field</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$result</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$field_offset</code><span class="initializer"> = 0</span></span>
] )</div>
<p class="para rdfs-comment">
This function returns an object with certain properties of the specific
column. The properties of the object are:
</p>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">column name</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">table</code></em></span>
<dd>
<p class="para">name of the table that the column belongs to</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">def</code></em></span>
<dd>
<p class="para">default value of the column</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">max_length</code></em></span>
<dd>
<p class="para">maximum length of the column</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">not_null</code></em></span>
<dd>
<p class="para">1 if the column cannot be NULL</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">primary_key</code></em></span>
<dd>
<p class="para">1 if the column is a primary key</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">unique_key</code></em></span>
<dd>
<p class="para">1 if the column is an unique key</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">multiple_key</code></em></span>
<dd>
<p class="para">1 if the column is a non-unique key</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">numeric</code></em></span>
<dd>
<p class="para">1 if the column is numeric</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">blob</code></em></span>
<dd>
<p class="para">1 if the column is a BLOB</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">the type of the column</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">unsigned</code></em></span>
<dd>
<p class="para">1 if the column is unsigned</p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">zerofill</code></em></span>
<dd>
<p class="para">1 if the column is zero-filled</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.cubrid-fetch-field-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">result</code></em></span>
<dd>
<p class="para"><em><code class="parameter">result</code></em> comes from a call to <span class="function"><a href="function.cubrid-execute.html" class="function">cubrid_execute()</a></span></p></dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">field_offset</code></em></span>
<dd>
<p class="para">
The numerical field offset. If the field offset is not specified, the
next field (that was not yet retrieved by this function) is retrieved.
The <em><code class="parameter">field_offset</code></em> starts at 0.
</p></dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.cubrid-fetch-field-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Object with certain properties of the specific column, when process is successful.
</p>
<p class="para">
<strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.cubrid-fetch-field-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-1072">
<p><strong>Example #1 <span class="function"><strong>cubrid_fetch_field()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">33000</span><span style="color: #007700">, </span><span style="color: #DD0000">"demodb"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$req </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"SELECT event_code,athlete_code,nation_code,game_date FROM game WHERE host_year=1988 and event_code=20001;"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">cubrid_fetch_row</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">cubrid_field_seek</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">, </span><span style="color: #0000BB">1</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$field </span><span style="color: #007700">= </span><span style="color: #0000BB">cubrid_fetch_field</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"\n--- Field Properties ---\n"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %s\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"name:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">name</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %s\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"table:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">table</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s \"%s\"\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"default value:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">def</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"max length:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">max_length</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"not null:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">not_null</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"primary key:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">primary_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"unique key:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">unique_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"multiple key:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">multiple_key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"numeric:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">numeric</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"blob:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">blob</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %s\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"type:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">type</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"unsigned:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">unsigned</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">printf</span><span style="color: #007700">(</span><span style="color: #DD0000">"%-30s %d\n"</span><span style="color: #007700">, </span><span style="color: #DD0000">"zerofill:"</span><span style="color: #007700">, </span><span style="color: #0000BB">$field</span><span style="color: #007700">-></span><span style="color: #0000BB">zerofill</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">cubrid_close_request</span><span style="color: #007700">(</span><span style="color: #0000BB">$req</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">cubrid_disconnect</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(4) {
[0]=>
string(5) "20001"
[1]=>
string(5) "16681"
[2]=>
string(3) "KOR"
[3]=>
string(9) "1988-9-30"
}
--- Field Properties ---
name: athlete_code
table: game
default value: ""
max length: 0
not null: 1
primary key: 1
unique key: 1
multiple key: 0
numeric: 1
blob: 0
type: integer
unsigned: 0
zerofill: 0
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.cubrid-fetch-assoc.html">cubrid_fetch_assoc</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.cubrid-fetch-lengths.html">cubrid_fetch_lengths</a></div>
<div class="up"><a href="cubridmysql.cubrid.html">CUBRID MySQL Compatibility Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
