manage properties where they belong
[m6w6/pq-gateway] / lib / pq / Query / WriterInterface.php
index 885d4ca8db00a0003ec4f03597cee20e40a8658e..72c5f15033aa5095300eb1f5ab0ddc8b32d32eea 100644 (file)
@@ -4,6 +4,7 @@ namespace pq\Query;
 
 /**
  * A query writer which supports easily constructing queries for \pq\Connection::execParams()
+ * @codeCoverageIgnore
  */
 interface WriterInterface
 {
@@ -21,17 +22,20 @@ interface WriterInterface
        
        /**
         * Returns a list any types associated with the params
+        * @return array
         */
        function getTypes();
        
        /**
         * Reset the state of the query writer
+        * @return \pq\Query\WriterInterface
         */
        function reset();
        
        /**
         * Write plain SQL to the query
-        * @param mixed $arg variable list of arguments, arrays will be imploded to a comm separated list
+        * @param mixed $arg variable list of arguments, arrays will be imploded to a comma separated list
+        * @return \pq\Query\WriterInterface
         */
        function write(/*...*/);
        
@@ -39,6 +43,7 @@ interface WriterInterface
         * Remember the parameter with any associated type and return $N to be written to the query string
         * @param mixed $param a literal parameter, a \pq\Gateway\Table\Cell or a \pq\Query\Expr
         * @param int $type the oid of the type of the param
+        * @return \pq\Query\WriterInterface
         */
        function param($param, $type = null);