partial QueryWriter

[mdref/mdref-pq-gateway] / pq-gateway / pq / Query / Writer / param.md

diff --git a/pq-gateway/pq/Query/Writer/param.md b/pq-gateway/pq/Query/Writer/param.md
new file mode 100644 (file)
index 0000000..9a7e9a7
--- /dev/null
+++ b/pq-gateway/pq/Query/Writer/param.md
@@ -0,0 +1,35 @@
+# string pq\Query\Writer::param(mixed $param[, int $type = NULL])
+
+Remember the parameter with any associated type and return $N to be written to the query string.
+
+## Params:
+
+* mixed $param  
+  Query parameter value.
+* Optional int $type = NULL  
+  The type OID of the parameter.
+
+## Returns:
+
+* string, '$N', to be used with pq\Query\Writer::write(), where N is tne number of this parameter.
+
+## Example:
+
+       <?php
+       
+       use pq\Query;
+       
+       $writer = new Query\Writer;
+       $writer->write("SELECT", $writer->param(1));
+       
+       var_dump((string) $writer, $writer->getParams());
+       
+       ?>
+
+Yields:
+
+       string(9) "SELECT $1"
+       array(1) {
+         [0]=>
+         int(1)
+       }