Add slaveOkay flag for all queries for a document.

Author: jwage

lib/Doctrine/ODM/MongoDB/DocumentManager.php

@@ -337,6 +337,10 @@ public function getDocumentCollection($className)
                 $this->documentCollections[$className] = $db->selectCollection($collection);
             }
         }
+        $collection = $this->documentCollections[$className];
+        if (isset($metadata->slaveOkay)) {
+            $collection->setSlaveOkay($metadata->slaveOkay);
+        }
         return $this->documentCollections[$className];
     }
 

lib/Doctrine/ODM/MongoDB/Mapping/Annotations/DoctrineAnnotations.php

@@ -32,6 +32,7 @@ final class Document extends AbstractDocument
     public $repositoryClass;
     public $indexes = array();
     public $requireIndexes = false;
+    public $slaveOkay;
 }
 /** @Annotation */
 final class EmbeddedDocument extends AbstractDocument

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadataInfo.php

@@ -166,6 +166,11 @@ class ClassMetadataInfo implements \Doctrine\Common\Persistence\Mapping\ClassMet
      */
     public $distance;
 
+    /**
+     * READ-ONLY: Whether or not reads for this class are okay to read from a slave.
+     */
+    public $slaveOkay = false;
+
     /**
      * READ-ONLY: The array of indexes for the document collection.
      */
@@ -606,6 +611,16 @@ public function setDiscriminatorValue($value)
         $this->discriminatorValue = $value;
     }
 
+    /**
+     * Sets whether or not reads for this class are okay to read from a slave.
+     *
+     * @param bool $slaveOkay
+     */
+    public function setSlaveOkay($slaveOkay)
+    {
+        $this->slaveOkay = $slaveOkay;
+    }
+
     /**
      * Add a index for this Document.
      *

lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php

@@ -186,6 +186,9 @@ public function loadMetadataForClass($className, ClassMetadataInfo $class)
         if (isset($documentAnnot->requireIndexes)) {
             $class->setRequireIndexes($documentAnnot->requireIndexes);
         }
+        if (isset($documentAnnot->slaveOkay)) {
+            $class->setSlaveOkay($documentAnnot->slaveOkay);
+        }
 
         foreach ($reflClass->getProperties() as $property) {
             if ($class->isMappedSuperclass && !$property->isPrivate() || $class->isInheritedField($property->name)) {

lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php

@@ -92,8 +92,11 @@ public function loadMetadataForClass($className, ClassMetadataInfo $class)
                 $this->addIndex($class, $index);
             }
         }
-        if (isset($xmlRoot->{'requireIndexes'})) {
-            $class->setRequireIndexes((bool) $xmlRoot->{'requireIndexes'});
+        if (isset($xmlRoot->{'require-indexes'})) {
+            $class->setRequireIndexes((bool) $xmlRoot->{'require-indexes'});
+        }
+        if (isset($xmlRoot->{'slave-okay'})) {
+            $class->setSlaveOkay((bool) $xmlRoot->{'slave-okay'});
         }
         if (isset($xmlRoot->field)) {
             foreach ($xmlRoot->field as $field) {

lib/Doctrine/ODM/MongoDB/Mapping/Driver/YamlDriver.php

@@ -89,6 +89,9 @@ public function loadMetadataForClass($className, ClassMetadataInfo $class)
         if (isset($element['requireIndexes'])) {
             $class->setRequireIndexes($element['requireIndexes']);
         }
+        if (isset($element['slaveOkay'])) {
+            $class->setSlaveOkay($element['slaveOkay']);
+        }
         if (isset($element['fields'])) {
             foreach ($element['fields'] as $fieldName => $mapping) {
                 if (is_string($mapping)) {

lib/Doctrine/ODM/MongoDB/Query/Builder.php

@@ -236,6 +236,10 @@ public function getQuery(array $options = array())
             ->getDocumentPersister($this->class->name)
             ->prepareSort($query['sort']);
 
+        if ($this->class->slaveOkay) {
+            $query['slaveOkay'] = $this->class->slaveOkay;
+        }
+
         return new Query(
             $this->dm,
             $this->class,

lib/vendor/doctrine-mongodb

@@ -2,6 +2,7 @@
 
 namespace Doctrine\ODM\MongoDB\Tests\Functional;
 
+use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
 use Doctrine\ODM\MongoDB\Query\Query;
 use Documents\User;
 use Documents\Group;
@@ -72,4 +73,21 @@ public function testSlaveOkayOnPersistentCollection()
         $groups->setHints(array(Query::HINT_SLAVE_OKAY => true));
         $this->assertEquals(array(Query::HINT_SLAVE_OKAY => true), $groups->getHints());
     }
+
+    public function testSlaveOkayDocument()
+    {
+        $users = $this->dm->getRepository(__NAMESPACE__.'\SlaveOkayDocument')
+            ->createQueryBuilder()
+            ->getQuery()
+            ->execute();
+
+        $this->assertEquals(array(Query::HINT_SLAVE_OKAY => true), $users->getHints());
+    }
+}
+
+/** @ODM\Document(slaveOkay=true) */
+class SlaveOkayDocument
+{
+    /** @ODM\Id */
+    public $id;
 }