<!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>Initializes a new empty LOB or FILE descriptor</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.oci-new-cursor.html">oci_new_cursor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.oci-num-fields.html">oci_num_fields</a></div>
<div class="up"><a href="ref.oci8.html">OCI8 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.oci-new-descriptor" class="refentry">
<div class="refnamediv">
<h1 class="refname">oci_new_descriptor</h1>
<p class="verinfo">(PHP 5, PECL OCI8 >= 1.1.0)</p><p class="refpurpose"><span class="refname">oci_new_descriptor</span> — <span class="dc-title">Initializes a new empty LOB or FILE descriptor</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.oci-new-descriptor-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type OCI-Lob">OCI-Lob</span></span> <span class="methodname"><strong>oci_new_descriptor</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$connection</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = OCI_DTYPE_LOB</span></span>
] )</div>
<p class="para rdfs-comment">
Allocates resources to hold descriptor or LOB locator.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.oci-new-descriptor-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">connection</code></em></span>
<dd>
<p class="para">
An Oracle connection identifier, returned by
<span class="function"><a href="function.oci-connect.html" class="function">oci_connect()</a></span> or <span class="function"><a href="function.oci-pconnect.html" class="function">oci_pconnect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">type</code></em></span>
<dd>
<p class="para">
Valid values for <em><code class="parameter">type</code></em> are:
<strong><code>OCI_DTYPE_FILE</code></strong>, <strong><code>OCI_DTYPE_LOB</code></strong> and
<strong><code>OCI_DTYPE_ROWID</code></strong>.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.oci-new-descriptor-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a new LOB or FILE descriptor on success, <strong><code>FALSE</code></strong> on error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.oci-new-descriptor-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2009">
<p><strong>Example #1 <span class="function"><strong>oci_new_descriptor()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* This script is designed to be called from a HTML form.<br /> * It expects $user, $password, $table, $where, and $commitsize<br /> * to be passed in from the form. The script then deletes<br /> * the selected rows using the ROWID and commits after each<br /> * set of $commitsize rows. (Use with care, there is no rollback)<br /> */<br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"select rowid from </span><span style="color: #0000BB">$table</span><span style="color: #DD0000"> </span><span style="color: #0000BB">$where</span><span style="color: #DD0000">"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$rowid </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_new_descriptor</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_D_ROWID</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_define_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">"ROWID"</span><span style="color: #007700">, </span><span style="color: #0000BB">$rowid</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br />while (</span><span style="color: #0000BB">oci_fetch</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$nrows </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_num_rows</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$delete </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"delete from </span><span style="color: #0000BB">$table</span><span style="color: #DD0000"> where ROWID = :rid"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">oci_bind_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$delete</span><span style="color: #007700">, </span><span style="color: #DD0000">":rid"</span><span style="color: #007700">, </span><span style="color: #0000BB">$rowid</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_B_ROWID</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$delete</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$nrows</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br /> if ((</span><span style="color: #0000BB">$nrows </span><span style="color: #007700">% </span><span style="color: #0000BB">$commitsize</span><span style="color: #007700">) == </span><span style="color: #0000BB">0</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">oci_commit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /> }<br />}<br /></span><span style="color: #0000BB">$nrows </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_num_rows</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$nrows</span><span style="color: #DD0000"> deleted...\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_close</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">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> </span><span style="color: #FF8000">/* This script demonstrates file upload to LOB columns<br /> * The formfield used for this example looks like this<br /> * <form action="upload.php" method="post" enctype="multipart/form-data"><br /> * <input type="file" name="lob_upload" /><br /> * ...<br /> */<br /> </span><span style="color: #007700">if (!isset(</span><span style="color: #0000BB">$lob_upload</span><span style="color: #007700">) || </span><span style="color: #0000BB">$lob_upload </span><span style="color: #007700">== </span><span style="color: #DD0000">'none'</span><span style="color: #007700">){<br /></span><span style="color: #0000BB">?><br /></span><form action="upload.php" method="post" enctype="multipart/form-data"><br />Upload file: <input type="file" name="lob_upload" /><br /><br /><input type="submit" value="Upload" /> - <input type="reset" value="Reset" /><br /></form><br /><span style="color: #0000BB"><?php<br /> </span><span style="color: #007700">} else {<br /><br /> </span><span style="color: #FF8000">// $lob_upload contains the temporary filename of the uploaded file<br /><br /> // see also the features section on file upload,<br /> // if you would like to use secure uploads<br /><br /> </span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$lob </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_new_descriptor</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_D_LOB</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"insert into </span><span style="color: #0000BB">$table</span><span style="color: #DD0000"> (id, the_blob)<br /> values(my_seq.NEXTVAL, EMPTY_BLOB()) returning the_blob into :the_blob"</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">oci_bind_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">':the_blob'</span><span style="color: #007700">, </span><span style="color: #0000BB">$lob</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_B_BLOB</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_DEFAULT</span><span style="color: #007700">);<br /> if (</span><span style="color: #0000BB">$lob</span><span style="color: #007700">-></span><span style="color: #0000BB">savefile</span><span style="color: #007700">(</span><span style="color: #0000BB">$lob_upload</span><span style="color: #007700">)){<br /> </span><span style="color: #0000BB">oci_commit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /> echo </span><span style="color: #DD0000">"Blob successfully uploaded\n"</span><span style="color: #007700">;<br /> }else{<br /> echo </span><span style="color: #DD0000">"Couldn't upload Blob\n"</span><span style="color: #007700">;<br /> }<br /> </span><span style="color: #0000BB">$lob</span><span style="color: #007700">-></span><span style="color: #0000BB">free</span><span style="color: #007700">();<br /> </span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">oci_close</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /> }<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
<div class="example" id="example-2010">
<p><strong>Example #2 <span class="function"><strong>oci_new_descriptor()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">/* Calling PL/SQL stored procedures which contain clobs as input<br /> * parameters (PHP 4 >= 4.0.6).<br /> * Example PL/SQL stored procedure signature is:<br /> *<br /> * PROCEDURE save_data<br /> * Argument Name Type In/Out Default?<br /> * ------------------------------ ----------------------- ------ --------<br /> * KEY NUMBER(38) IN<br /> * DATA CLOB IN<br /> *<br /> */<br /><br /></span><span style="color: #0000BB">$conn </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #0000BB">$user</span><span style="color: #007700">, </span><span style="color: #0000BB">$password</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$stmt </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #DD0000">"begin save_data(:key, :data); end;"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$clob </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_new_descriptor</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_D_LOB</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_bind_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">':key'</span><span style="color: #007700">, </span><span style="color: #0000BB">$key</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_bind_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #DD0000">':data'</span><span style="color: #007700">, </span><span style="color: #0000BB">$clob</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_B_CLOB</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$clob</span><span style="color: #007700">-></span><span style="color: #0000BB">write</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">, </span><span style="color: #0000BB">OCI_DEFAULT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_commit</span><span style="color: #007700">(</span><span style="color: #0000BB">$conn</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$clob</span><span style="color: #007700">-></span><span style="color: #0000BB">free</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">oci_free_statement</span><span style="color: #007700">(</span><span style="color: #0000BB">$stmt</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.oci-new-descriptor-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
In PHP versions before 5.0.0 you must use <span class="function"><a href="function.ocinewdescriptor.html" class="function">ocinewdescriptor()</a></span> instead.
This name still can be used, it was left as alias of
<span class="function"><strong>oci_new_descriptor()</strong></span> for downwards compatability.
This, however, is deprecated and not recommended.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.oci-new-descriptor-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.oci-bind-by-name.html" class="function" rel="rdfs-seeAlso">oci_bind_by_name()</a> - Binds a PHP variable to an Oracle placeholder</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.oci-new-cursor.html">oci_new_cursor</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.oci-num-fields.html">oci_num_fields</a></div>
<div class="up"><a href="ref.oci8.html">OCI8 Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
