PDOStatement::bindColumn

(no version information, might be only in CVS)

PDOStatement::bindColumn --  Bind a column to a PHP variable

Description

bool PDOStatement::bindColumn ( mixed column, mixed &param [, int type [, int maxlen [, mixed driver_options]]] )

Warning

This function is EXPERIMENTAL. The behaviour of this function, the name of this function, and anything else documented about this function may change without notice in a future release of PHP. Use this function at your own risk.

On each row fetch param will contain the value of the corresponding column. column is the 1-based offset of the column, or the column name. For maximum portability, do not call this function before calling PDOStatement::execute().

Parameters

column

Number of the column (1-indexed) in the result set.

param

Name of the PHP variable to which the column will be bound.

type

Data type of the parameter, specified by the PDO_PARAM_* constants.

maxlen

Maximum length of the parameter.

driver_options

Examples

Example 1. Binding result set output to PHP variables

Binding columns in the result set to PHP variables is an effective way to make the data contained in each row immediately available to your application. The following example demonstrates how PDO allows you to bind and retrieve columns with a variety of options and with intelligent defaults.

<?php
function readData($dbh) {
  
$sql = 'SELECT name, colour, calories FROM fruit';
  
try {
    
$stmt = $dbh->prepare($sql);
    
$stmt->execute();

    
/* Bind by column number with an explicit data type & length */
    
$stmt->bindColumn(1, $name, PDO_PARAM_STR, 64);

    
/* Bind by column number with default data type & length */
    
$stmt->bindColumn(2, $colour);

    
/* Bind by column name with default data type & length */
    
$stmt->bindColumn('CALORIES', $cals);

    while (
$row = $stmt->fetch(PDO_FETCH_BOUND)) {
      
$data = $name . "\t" . $colour . "\t" . $cals . "\n";
      print
$data;
    }
  }
  
catch (PDOException $e) {
    print
$e->getMessage();
  }
}
readData($dbh);
?>

The above example will output:

apple   red     150
banana  yellow  175
kiwi    green   75
orange  orange  150
mango   red     200
strawberry      red     25

See Also

PDOStatement::execute()
PDOStatement::fetch()
PDOStatement::fetchAll()
PDOStatement::fetchSingle()