pdostatement.debugdumpparams(3) [php man page]

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)

PDOSTATEMENT.EXECUTE(3) 						 1						   PDOSTATEMENT.EXECUTE(3)

PDOStatement::execute - Executes a prepared statement

SYNOPSIS

       public bool PDOStatement::execute ([array  $input_parameters])

DESCRIPTION

	Execute the prepared statement. If the prepared statement included parameter markers, you must either:

	      ocall  PDOStatement.bindParam(3)	to  bind  PHP  variables  to  the parameter markers: bound variables pass their value as input and
	      receive the output value, if any, of their associated parameter markers

	      oor pass an array of input-only parameter values

PARAMETERS

	      o $input_parameters
		- An array of values with as many elements as there are bound parameters in the SQL  statement	being  executed.  All  values  are
		treated  as  PDO::PARAM_STR.   You cannot bind multiple values to a single parameter; for example, you cannot bind two values to a
		single named parameter in an IN() clause.  You cannot bind more values than specified; if more	keys  exist  in  $input_parameters
		than in the SQL specified in the PDO::prepare, then the statement will fail and an error is emitted.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

CHANGELOG

       +--------+---------------------------------------------------+
       |Version |						    |
       |	|						    |
       |	|		     Description		    |
       |	|						    |
       +--------+---------------------------------------------------+
       | 5.2.0	|						    |
       |	|						    |
       |	|  The	keys  from $input_parameters must match the |
       |	| ones declared in the SQL. Before PHP	5.2.0  this |
       |	| was silently ignored. 			    |
       |	|						    |
       +--------+---------------------------------------------------+
EXAMPLES

       Example #1

	      Execute a prepared statement with bound variables

	      <?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->bindParam(':colour', $colour, PDO::PARAM_STR, 12);
	      $sth->execute();
	      ?>

       Example #2

	      Execute a prepared statement with an array of insert values (named parameters)

	      <?php
	      /* Execute a prepared statement by passing an array of insert values */
	      $calories = 150;
	      $colour = 'red';
	      $sth = $dbh->prepare('SELECT name, colour, calories
		  FROM fruit
		  WHERE calories < :calories AND colour = :colour');
	      $sth->execute(array(':calories' => $calories, ':colour' => $colour));
	      ?>

       Example #3

	      Execute a prepared statement with an array of insert values (placeholders)

	      <?php
	      /* Execute a prepared statement by passing an array of insert values */
	      $calories = 150;
	      $colour = 'red';
	      $sth = $dbh->prepare('SELECT name, colour, calories
		  FROM fruit
		  WHERE calories < ? AND colour = ?');
	      $sth->execute(array($calories, $colour));
	      ?>

       Example #4

	      Execute a prepared statement with question mark placeholders

	      <?php
	      /* Execute a prepared statement by binding PHP variables */
	      $calories = 150;
	      $colour = 'red';
	      $sth = $dbh->prepare('SELECT name, colour, calories
		  FROM fruit
		  WHERE calories < ? AND colour = ?');
	      $sth->bindParam(1, $calories, PDO::PARAM_INT);
	      $sth->bindParam(2, $colour, PDO::PARAM_STR, 12);
	      $sth->execute();
	      ?>

       Example #5

	      Execute a prepared statement using array for IN clause

	      <?php
	      /* Execute a prepared statement using an array of values for an IN clause */
	      $params = array(1, 21, 63, 171);
	      /* Create a string for the parameter placeholders filled to the number of params */
	      $place_holders = implode(',', array_fill(0, count($params), '?'));

	      /*
		  This prepares the statement with enough unnamed placeholders for every value
		  in our $params array. The values of the $params array are then bound to the
		  placeholders in the prepared statement when the statement is executed.
		  This is not the same thing as using PDOStatement::bindParam() since this
		  requires a reference to the variable. PDOStatement::execute() only binds
		  by value instead.
	      */
	      $sth = $dbh->prepare("SELECT id, name FROM contacts WHERE id IN ($place_holders)");
	      $sth->execute($params);
	      ?>

NOTES

       Note

	       Some drivers require to close cursor before executing next statement.

SEE ALSO

       PDO.prepare(3), PDOStatement.bindParam(3), PDOStatement.fetch(3), PDOStatement.fetchAll(3), PDOStatement.fetchColumn(3).

PHP Documentation Group 												   PDOSTATEMENT.EXECUTE(3)