Last updated: Fri, 15 Aug 2008

oci_bind_by_name

(PHP 5, PECL oci8:1.1-1.2.4)

oci_bind_by_name — Binds the PHP variable to the Oracle placeholder

Description

bool oci_bind_by_name ( resource $statement , string $ph_name , mixed &$variable [, int $maxlength [, int $type ]] )

Binds the PHP variable variable to the Oracle placeholder ph_name . Whether it will be used for input or output will be determined at run-time and the necessary storage space will be allocated.

Parameters

statement

An OCI statement.

ph_name

The placeholder.

variable

The PHP variable.

maxlength

Sets the maximum length for the bind. If you set it to -1, this function will use the current length of variable to set the maximum length.

type

If you need to bind an abstract datatype (LOB/ROWID/BFILE) you need to allocate it first using the oci_new_descriptor() function. The length is not used for abstract datatypes and should be set to -1. The type parameter tells Oracle which descriptor is used. Default to SQLT_CHR. Possible values are:

SQLT_FILE - for BFILEs;
SQLT_CFILE - for CFILEs;
SQLT_CLOB - for CLOBs;
SQLT_BLOB - for BLOBs;
SQLT_RDD - for ROWIDs;
SQLT_NTY - for named datatypes;
SQLT_INT - for integers;
SQLT_CHR - for VARCHARs;
SQLT_BIN - for RAW columns;
SQLT_LNG - for LONG columns;
SQLT_LBI - for LONG RAW columns;
SQLT_RSET - for cursors, that were created before with oci_new_cursor().

Return Values

Returns TRUE on success or FALSE on failure.

Examples

Example #1 oci_bind_by_name() example


<?php
/* oci_bind_by_name example thies at thieso dot net (980221)
  inserts 3 records into emp, and uses the ROWID for updating the
  records just after the insert.
*/

$conn = oci_connect("scott", "tiger");

$stmt = oci_parse($conn, "
                          INSERT INTO
                                     emp (empno, ename)
                               VALUES
                                     (:empno,:ename)
                            RETURNING
                                     ROWID
                                 INTO
                                     :rid
                         ");

$data = array(
              1111 => "Larry",
              2222 => "Bill",
              3333 => "Jim"
             );

$rowid = oci_new_descriptor($conn, OCI_D_ROWID);

oci_bind_by_name($stmt, ":empno", $empno, 32);
oci_bind_by_name($stmt, ":ename", $ename, 32);
oci_bind_by_name($stmt, ":rid",   $rowid, -1, OCI_B_ROWID);

$update = oci_parse($conn, "
                            UPDATE
                                  emp
                               SET
                                  sal = :sal
                             WHERE
                                  ROWID = :rid
                           ");
oci_bind_by_name($update, ":rid", $rowid, -1, OCI_B_ROWID);
oci_bind_by_name($update, ":sal", $sal,   32);

$sal = 10000;

foreach ($data as $empno => $ename) {
    oci_execute($stmt);
    oci_execute($update);
}

$rowid->free();

oci_free_statement($update);
oci_free_statement($stmt);

$stmt = oci_parse($conn, "
                          SELECT
                                *
                            FROM
                                emp
                           WHERE
                                empno
                              IN
                                (1111,2222,3333)
                         ");
oci_execute($stmt);

while ($row = oci_fetch_assoc($stmt)) {
    var_dump($row);
}

oci_free_statement($stmt);

/* delete our "junk" from the emp table.... */
$stmt = oci_parse($conn, "
                          DELETE FROM
                                     emp
                                WHERE
                                     empno
                                   IN
                                     (1111,2222,3333)
                         ");
oci_execute($stmt);
oci_free_statement($stmt);

oci_close($conn);
?>

Remember, this function strips trailing whitespaces. See the following example:

Example #2 oci_bind_by_name() example


<?php
    $connection = oci_connect('apelsin','kanistra');
    $query = "INSERT INTO test_table VALUES(:id, :text)";

    $statement = oci_parse($query);
    oci_bind_by_name($statement, ":id", 1);
    oci_bind_by_name($statement, ":text", "trailing spaces follow     ");
    oci_execute($statement);
    /*
     This code will insert into DB string 'trailing spaces follow', without
     trailing spaces
    */
?>

Example #3 oci_bind_by_name() example


<?php
    $connection = oci_connect('apelsin','kanistra');
    $query = "INSERT INTO test_table VALUES(:id, 'trailing spaces follow      ')";

    $statement = oci_parse($query);
    oci_bind_by_name($statement, ":id", 1);
    oci_execute($statement);
    /*
     And this code will add 'trailing spaces follow      ', preserving
     trailing whitespaces
    */
?>

Return Values

Returns TRUE on success or FALSE on failure.

Notes

Warning

Do not use magic_quotes_gpc or addslashes() and oci_bind_by_name() simultaneously as no quoting is needed and any magically applied quotes will be written into your database as oci_bind_by_name() is not able to distinguish magically added quotings from those added intentionally.

Note: In PHP versions before 5.0.0 you must use ocibindbyname() instead. This name still can be used, it was left as alias of oci_bind_by_name() for downwards compatability. This, however, is deprecated and not recommended.

oci_cancel

oci_bind_array_by_name

Last updated: Fri, 15 Aug 2008

add a note User Contributed Notes
oci_bind_by_name

sixd at php dot net
10-May-2008 01:11


For IN string binds (i.e. INSERT or passing a value into a PL/SQL

procedure) where the length is not known when binding, use a length

that is longer than the longest possible string.  If you don't know

what this is in advance, then re-call oci_bind_by_name() with the

actual size prior to each oci_execute() call.



For OUT binds, always specify a length so that PHP allocates enough

memory to hold the returned value.



The cardinal rule for binding is that the memory address used in the

bind call must continue to exist and be usable when the oci_execute

occurs.  This is the common problem with 'foreach' loops.

ajitsingh4u at gmail dot com
09-May-2008 06:39


//Calling Oracle Stored Procedure

//I assume that you have a users table and three columns in users table i.e. id, user, email in oracle

// For example I made connection in constructor, you can modify as per your requirement.

//http://www.devshed.com/c/a/PHP/Understanding-Destructors-in-PHP-5/1/

<?php

class Users{

    private $connection;

    

    public function __construct()

    {

        $this->connection = oci_connect("scott", "tiger", $db); // Establishes a connection to the Oracle server; 

    }



    public function selectUsers($start_index=1, $numbers_of_rows=20)

    {

        $sql ="BEGIN sp_users_select(:p_start_index, :p_numbers_of_rows, :p_cursor, :p_result); END;";

        $stmt = oci_parse($this->connection, $sql);



        //Bind in parameter

        oci_bind_by_name($stmt, ':p_start_index', $start_index, 20);

        oci_bind_by_name($stmt, ':p_numbers_of_rows', $numbers_of_rows, 20);



        //Bind out parameter

        oci_bind_by_name($stmt, ':p_result', $result, 20); // returns 0 if stored procedure succeessfully executed.



        //Bind Cursor

        $p_cursor = oci_new_cursor($this->connection);

        oci_bind_by_name($stmt, ':p_cursor', $p_cursor, -1, OCI_B_CURSOR);



        // Execute Statement

        oci_execute($stmt);

        oci_execute($p_cursor, OCI_DEFAULT);



        oci_fetch_all($p_cursor, $cursor, null, null, OCI_FETCHSTATEMENT_BY_ROW);



        echo $result;

        echo '<br>';

        var_dump($cursor); // $cursor is an associative array so we can use print_r() to print this data.

        // you can return data from this function to use it at your user interface.

    }



    public function deleteUser($id)

    {

        $sql ="BEGIN sp_user_delete(:p_id, :p_result); END;";

        $stmt = oci_parse($this->connection, $sql);



        // bind in and out variables

        oci_bind_by_name($stmt, ':p_id', $id, 20);

        oci_bind_by_name($stmt, ':p_result', $result, 20);



        //Execute the statement

        $check = oci_execute($stmt);



        if($check == true)

        $commit = oci_commit($this->connection);

        else

        $commit = oci_rollback($this->connection);



        return $result;

    }

    

    // You can make function for insert ,update using above two functions



}

?>

08-May-2007 10:59


This is what the old OCI_B_* constants are now called:

(PHP 5.1.6 win32)



OCI_B_NTY - SQLT_NTY

OCI_B_BFILE - SQLT_BFILEE

OCI_B_CFILEE - SQLT_CFILEE

OCI_B_CLOB - SQLT_CLOB

OCI_B_BLOB - SQLT_BLOB

OCI_B_ROWID - SQLT_RDD

OCI_B_CURSOR - SQLT_RSET

OCI_B_BIN - SQLT_BIN

OCI_B_INT - SQLT_INT

OCI_B_NUM - SQLT_NUM

tom at bitworks dot de
27-Jan-2007 01:27


Referes to:



Be careful that the variable argument is a reference. So, the following code does not work:

  foreach($some_array as $key => $value)

  {

   OCIBindByName($stmt, $key, $value);

  }



I assume this is because the contents of $value changes, even though the reference remains the same, so all bound variables end up pointing to the last loop iteration's value.



Instead use the following:

  foreach($some_array as $key => $value)

  {

   OCIBindByName($stmt, $key, $some_array[$key]);

  } 



This dues to the foreach statement. $some_array in foreach() is a copy of the origine array. $key would be the "reference" in the copy, but $some_array[$key] points to the original one.

Chris Delcamp
11-Jan-2007 05:48


This is an example of returning the primary key from an insert so that you can do inserts on other tables with foreign keys based on that value.  The date is just used to provied semi-unique data to be inserted.



$conn = oci_connect("username", "password")

$stmt = oci_parse($conn, "INSERT INTO test (test_msg) values (:data) RETURN test_id INTO :RV");

$data = date("d-M-Y H:i:s");

oci_bind_by_name($stmt, ":RV", $rv, -1, SQLT_INT);

oci_bind_by_name($stmt, ":data", $data, 24);

oci_execute($stmt);

print $rv;

js at mcs dot be
20-Feb-2006 01:48


Be careful that the variable argument is a reference. So, the following code does not work:

  foreach($some_array as $key => $value)

  {

    OCIBindByName($stmt, $key, $value);

  }



I assume this is because the contents of $value changes, even though the reference remains the same, so all bound variables end up pointing to the last loop iteration's value.



Instead use the following:

  foreach($some_array as $key => $value)

  {

    OCIBindByName($stmt, $key, $some_array[$key]);

  }

ehsmeng
16-Feb-2006 09:43


If you do a wrapper for these functions there is a bug I found on php5.1.1 / oracle 9 / windows xp. see the section with oci_bind_by_name.



function db_layer_insert_1_row ($dbquery, $bindvar = array())

{

    global $_db_layer_database;

    global $_db_layer_lasterror;

    

    if (false === ($stid = oci_parse($_db_layer_database, $dbquery))) {

        db_layer_lasterror ();

        return -1;

    }

    

    // Bind variables. NOTE substituting $bindvar[$bcol] with $bval causes

    // all variables to be set to the last value of $bval?!?!

    foreach ($bindvar as $bcol => $bval) {

        oci_bind_by_name($stid, $bcol, $bindvar[$bcol]); //$bval); <- bug?!

    }

    

    ...

hfuecks at nospam dot org
16-Aug-2005 10:12


Note that there have been some changes on the constant identifiers and the documentation is currently not entirely accurate.



Running the following script;



<?php

foreach (array_keys(get_defined_constants()) as $const) {

    if ( preg_match('/^OCI_B_/', $const) ) {

        print "$const\n";

    }

}

?>



Under PHP 4.4.0 I get;



OCI_B_SQLT_NTY < renamed to OCI_B_NTY with PHP5

OCI_B_BFILE

OCI_B_CFILEE

OCI_B_CLOB

OCI_B_BLOB

OCI_B_ROWID

OCI_B_CURSOR

OCI_B_BIN



Under PHP 5.0.4 I get;



OCI_B_NTY

OCI_B_BFILE < docs are wrong right now

OCI_B_CFILEE < docs are wrong right now

OCI_B_CLOB

OCI_B_BLOB

OCI_B_ROWID

OCI_B_CURSOR

OCI_B_BIN < it's a mystery

add a note

oci_cancel

oci_bind_array_by_name

Last updated: Fri, 15 Aug 2008