Merge pull request #234 from VoycerAG/comment-operator

Add support for the $comment operator

lib/Doctrine/MongoDB/Query/Builder.php

@@ -216,6 +216,20 @@ public function bitXor($value)
         return $this;
     }
 
+    /**
+     * Associates a comment to any expression taking a query predicate.
+     *
+     * @see Expr::comment()
+     * @see http://docs.mongodb.org/manual/reference/operator/query/comment/
+     * @param string $comment
+     * @return self
+     */
+    public function comment($comment)
+    {
+        $this->expr->comment($comment);
+        return $this;
+    }
+
     /**
      * Change the query type to count.
      *

lib/Doctrine/MongoDB/Query/Expr.php

@@ -215,6 +215,20 @@ public function bitXor($value)
         return $this->bit('xor', $value);
     }
 
+    /**
+     * Associates a comment to any expression taking a query predicate.
+     *
+     * @see Builder::comment()
+     * @see http://docs.mongodb.org/manual/reference/operator/query/comment/
+     * @param string $comment
+     * @return self
+     */
+    public function comment($comment)
+    {
+        $this->query['$comment'] = $comment;
+        return $this;
+    }
+
     /**
      * Sets the value of the current field to the current date, either as a date or a timestamp.
      *

tests/Doctrine/MongoDB/Tests/Query/BuilderTest.php

@@ -373,6 +373,7 @@ public function provideProxiedExprMethods()
             'text()' => array('text', array('foo')),
             'max()' => array('max', array(1)),
             'min()' => array('min', array(1)),
+            'comment()' => array('comment', array('A comment explaining what the query does'))
         );
     }