git.m6w6.name Git - mdref/mdref-pq-gateway/blob - pq-gateway/pq/Query/Writer/param.md

   1 # string pq\Query\Writer::param(mixed $param[, int $type = NULL])
   2
   3 Remember the parameter with any associated type and return $N to be written to the query string.
   4
   5 ## Params:
   6
   7 * mixed $param
   8   Query parameter value.
   9 * Optional int $type = NULL
  10   The type OID of the parameter.
  11
  12 ## Returns:
  13
  14 * string, '$N', to be used with pq\Query\Writer::write(), where N is tne number of this parameter.
  15
  16 ## Example:
  17
  18         <?php
  19
  20         use pq\Query;
  21
  22         $writer = new Query\Writer;
  23         $writer->write("SELECT", $writer->param(1));
  24
  25         var_dump((string) $writer, $writer->getParams());
  26
  27         ?>
  28
  29 Yields:
  30
  31         string(9) "SELECT $1"
  32         array(1) {
  33           [0]=>
  34           int(1)
  35         }