<!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>Binds a PHP array to an Oracle PL/SQL array parameter</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.oci8.html">OCI8 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.oci-bind-by-name.html">oci_bind_by_name</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-bind-array-by-name" class="refentry"> <div class="refnamediv"> <h1 class="refname">oci_bind_array_by_name</h1> <p class="verinfo">(PHP 5 >= 5.1.2, PECL OCI8 >= 1.2.0)</p><p class="refpurpose"><span class="refname">oci_bind_array_by_name</span> — <span class="dc-title">Binds a PHP array to an Oracle PL/SQL array parameter</span></p> </div> <div class="refsect1 description" id="refsect1-function.oci-bind-array-by-name-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>oci_bind_array_by_name</strong></span> ( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$statement</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span> , <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$var_array</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_table_length</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$max_item_length</code><span class="initializer"> = -1</span></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code><span class="initializer"> = SQLT_AFC</span></span> ]] )</div> <p class="para rdfs-comment"> Binds the PHP array <em><code class="parameter">var_array</code></em> to the Oracle placeholder <em><code class="parameter">name</code></em>, which points to an Oracle PL/SQL array. Whether it will be used for input or output will be determined at run-time. </p> </div> <div class="refsect1 parameters" id="refsect1-function.oci-bind-array-by-name-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">statement</code></em></span> <dd> <p class="para"> A valid OCI statement identifier. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">name</code></em></span> <dd> <p class="para"> The Oracle placeholder. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">var_array</code></em></span> <dd> <p class="para"> An array. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">max_table_length</code></em></span> <dd> <p class="para"> Sets the maximum length both for incoming and result arrays. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">max_item_length</code></em></span> <dd> <p class="para"> Sets maximum length for array items. If not specified or equals to -1, <span class="function"><strong>oci_bind_array_by_name()</strong></span> will find the longest element in the incoming array and will use it as the maximum length. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">type</code></em></span> <dd> <p class="para"> Should be used to set the type of PL/SQL array items. See list of available types below: </p> <p class="para"> <ul class="itemizedlist"> <li class="listitem"> <p class="para"> <strong><code>SQLT_NUM</code></strong> - for arrays of NUMBER. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_INT</code></strong> - for arrays of INTEGER (Note: INTEGER it is actually a synonym for NUMBER(38), but <strong><code>SQLT_NUM</code></strong> type won't work in this case even though they are synonyms). </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_FLT</code></strong> - for arrays of FLOAT. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_AFC</code></strong> - for arrays of CHAR. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_CHR</code></strong> - for arrays of VARCHAR2. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_VCS</code></strong> - for arrays of VARCHAR. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_AVC</code></strong> - for arrays of CHARZ. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_STR</code></strong> - for arrays of STRING. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_LVC</code></strong> - for arrays of LONG VARCHAR. </p> </li> <li class="listitem"> <p class="para"> <strong><code>SQLT_ODT</code></strong> - for arrays of DATE. </p> </li> </ul> </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.oci-bind-array-by-name-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.oci-bind-array-by-name-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-1943"> <p><strong>Example #1 <span class="function"><strong>oci_bind_array_by_name()</strong></span> example</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$c </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"scott"</span><span style="color: #007700">, </span><span style="color: #DD0000">"tiger"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$create </span><span style="color: #007700">= </span><span style="color: #DD0000">"CREATE TABLE bind_example(name VARCHAR(20))"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$statement </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #0000BB">$create</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$statement</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$create_pkg </span><span style="color: #007700">= </span><span style="color: #DD0000">"<br />CREATE OR REPLACE PACKAGE ARRAYBINDPKG1 AS<br /> TYPE ARRTYPE IS TABLE OF VARCHAR(20) INDEX BY BINARY_INTEGER;<br /> PROCEDURE iobind(c1 IN OUT ARRTYPE);<br />END ARRAYBINDPKG1;"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$statement </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #0000BB">$create_pkg</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$statement</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$create_pkg_body </span><span style="color: #007700">= </span><span style="color: #DD0000">"<br />CREATE OR REPLACE PACKAGE BODY ARRAYBINDPKG1 AS<br /> CURSOR CUR IS SELECT name FROM bind_example;<br /> PROCEDURE iobind(c1 IN OUT ARRTYPE) IS<br /> BEGIN<br /> FOR i IN 1..5 LOOP<br /> INSERT INTO bind_example VALUES (c1(i));<br /> END LOOP;<br /> IF NOT CUR%ISOPEN THEN<br /> OPEN CUR;<br /> END IF;<br /> FOR i IN REVERSE 1..5 LOOP<br /> FETCH CUR INTO c1(i);<br /> IF CUR%NOTFOUND THEN<br /> CLOSE CUR;<br /> EXIT;<br /> END IF;<br /> END LOOP;<br /> END iobind;<br />END ARRAYBINDPKG1;"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$statement </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #0000BB">$create_pkg_body</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$statement</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$statement </span><span style="color: #007700">= </span><span style="color: #0000BB">oci_parse</span><span style="color: #007700">(</span><span style="color: #0000BB">$c</span><span style="color: #007700">, </span><span style="color: #DD0000">"BEGIN ARRAYBINDPKG1.iobind(:c1); END;"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$array </span><span style="color: #007700">= array(</span><span style="color: #DD0000">"one"</span><span style="color: #007700">, </span><span style="color: #DD0000">"two"</span><span style="color: #007700">, </span><span style="color: #DD0000">"three"</span><span style="color: #007700">, </span><span style="color: #DD0000">"four"</span><span style="color: #007700">, </span><span style="color: #DD0000">"five"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">oci_bind_array_by_name</span><span style="color: #007700">(</span><span style="color: #0000BB">$statement</span><span style="color: #007700">, </span><span style="color: #DD0000">":c1"</span><span style="color: #007700">, </span><span style="color: #0000BB">$array</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">, -</span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">SQLT_CHR</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">oci_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$statement</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$array</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="ref.oci8.html">OCI8 Functions</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.oci-bind-by-name.html">oci_bind_by_name</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>