|
|
PDOSTATEMENT.DEBUGDUMPPARAMS(3) 1 PDOSTATEMENT.DEBUGDUMPPARAMS(3) PDOStatement::debugDumpParams - Dump an SQL prepared command SYNOPSIS
public void PDOStatement::debugDumpParams (void ) DESCRIPTION
Dumps the information contained by a prepared statement directly on the output. It will provide the SQL query in use, the number of param- eters used ( Params), the list of parameters with their key name or position, their name, their position in the query (if this is supported by the PDO driver, otherwise, it will be -1), type ( param_type) as an integer, and a boolean value is_param. This is a debug function, which dumps the data directly to the normal output. Tip As with anything that outputs its result directly to the browser, the output-control functions can be used to capture the output of this function, and save it in a string (for example). This will only dump the parameters in the statement at the moment of the dump. Extra parameters are not stored in the statement, and not displayed. RETURN VALUES
No value is returned. EXAMPLES
Example #1 PDOStatement.debugDumpParams(3) example with named parameters <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; $colour = 'red'; $sth = $dbh->prepare('SELECT name, colour, calories FROM fruit WHERE calories < :calories AND colour = :colour'); $sth->bindParam(':calories', $calories, PDO::PARAM_INT); $sth->bindValue(':colour', $colour, PDO::PARAM_STR, 12); $sth->execute(); $sth->debugDumpParams(); ?> The above example will output: SQL: [96] SELECT name, colour, calories FROM fruit WHERE calories < :calories AND colour = :colour Params: 2 Key: Name: [9] :calories paramno=-1 name=[9] ":calories" is_param=1 param_type=1 Key: Name: [7] :colour paramno=-1 name=[7] ":colour" is_param=1 param_type=2 Example #2 PDOStatement.debugDumpParams(3) example with unnamed parameters <?php /* Execute a prepared statement by binding PHP variables */ $calories = 150; $colour = 'red'; $name = 'apple'; $sth = $dbh->prepare('SELECT name, colour, calories FROM fruit WHERE calories < ? AND colour = ?'); $sth->bindParam(1, $calories, PDO::PARAM_INT); $sth->bindValue(2, $colour, PDO::PARAM_STR); $sth->execute(); $sth->debugDumpParams(); ?> The above example will output: SQL: [82] SELECT name, colour, calories FROM fruit WHERE calories < ? AND colour = ? Params: 2 Key: Position #0: paramno=0 name=[0] "" is_param=1 param_type=1 Key: Position #1: paramno=1 name=[0] "" is_param=1 param_type=2 SEE ALSO
PDO.prepare(3), PDOStatement.bindParam(3), PDOStatement.bindValue(3). PHP Documentation Group PDOSTATEMENT.DEBUGDUMPPARAMS(3)