From 5f093a83c0362b8e369328a931c109971e905d2d Mon Sep 17 00:00:00 2001
From: Neil Hastings <nhastings@phase2technology.com>
Date: Fri, 19 Oct 2012 11:47:09 -0400
Subject: [PATCH] Revisionable layouts

---
 core/includes/entity.inc                           | 22 +++++++++++++++++-
 .../Core/Config/Entity/ConfigStorageController.php |  4 ++--
 .../Core/Entity/DatabaseStorageController.php      | 26 ++++++++++++----------
 .../Core/Entity/DatabaseStorageControllerNG.php    | 14 +++++++-----
 .../Entity/EntityStorageControllerInterface.php    |  4 ++--
 .../Drupal/comment/CommentStorageController.php    |  8 +++----
 .../node/lib/Drupal/node/NodeStorageController.php |  8 +++----
 .../lib/Drupal/taxonomy/TermStorageController.php  |  4 ++--
 .../taxonomy/VocabularyStorageController.php       |  4 ++--
 .../user/lib/Drupal/user/UserStorageController.php |  4 ++--
 10 files changed, 61 insertions(+), 37 deletions(-)

diff --git a/core/includes/entity.inc b/core/includes/entity.inc
index 75c3386..9111e8d 100644
--- a/core/includes/entity.inc
+++ b/core/includes/entity.inc
@@ -146,7 +146,27 @@ function entity_load($entity_type, $id, $reset = FALSE) {
  * @see Drupal\Core\Entity\DatabaseStorageController
  */
 function entity_revision_load($entity_type, $revision_id) {
-  return entity_get_controller($entity_type)->loadRevision($revision_id);
+  $entities = entity_revision_load_multiple($entity_type, array($revision_id));
+  return isset($entities[$revision_id]) ? $entities[$revision_id] : FALSE;
+}
+
+/**
+ * Loads an entity from the database.
+ *
+ * @param string $entity_type
+ *   The entity type to load, e.g. node or user.
+ * @param array $revision_ids
+ *   An array of revision ID's to load.
+ *
+ * @return array
+ *   An array of entity objects indexed by their ids.
+ *
+ * @see hook_entity_info()
+ * @see Drupal\Core\Entity\EntityStorageControllerInterface
+ * @see Drupal\Core\Entity\DatabaseStorageController
+ */
+function entity_revision_load_multiple($entity_type, array $revision_ids) {
+  return entity_get_controller($entity_type)->loadRevisions($revision_ids);
 }
 
 /**
diff --git a/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php b/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php
index e82eb7f..06a83a2 100644
--- a/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php
+++ b/core/lib/Drupal/Core/Config/Entity/ConfigStorageController.php
@@ -115,9 +115,9 @@ public function load(array $ids = NULL) {
   }
 
   /**
-   * Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadRevision().
+   * Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadRevisions().
    */
-  public function loadRevision($revision_id) {
+  public function loadRevisions(array $revision_ids) {
     return FALSE;
   }
 
diff --git a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php
index 1fa59ec..647aeae 100644
--- a/core/lib/Drupal/Core/Entity/DatabaseStorageController.php
+++ b/core/lib/Drupal/Core/Entity/DatabaseStorageController.php
@@ -219,11 +219,11 @@ public function load(array $ids = NULL) {
   }
 
   /**
-   * Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadRevision().
+   * Implements Drupal\Core\Entity\EntityStorageControllerInterface::loadRevisions().
    */
-  public function loadRevision($revision_id) {
+  public function loadRevisions(array $revision_ids) {
     // Build and execute the query.
-    $query_result = $this->buildQuery(array(), $revision_id)->execute();
+    $query_result = $this->buildQuery(array(), $revision_ids)->execute();
 
     if (!empty($this->entityInfo['entity class'])) {
       // We provide the necessary arguments for PDO to create objects of the
@@ -295,13 +295,13 @@ protected function buildPropertyQuery(EntityFieldQuery $entity_query, array $val
    * @return SelectQuery
    *   A SelectQuery object for loading the entity.
    */
-  protected function buildQuery($ids, $revision_id = FALSE) {
+  protected function buildQuery($ids, array $revision_ids = array()) {
     $query = db_select($this->entityInfo['base table'], 'base');
 
     $query->addTag($this->entityType . '_load_multiple');
 
-    if ($revision_id) {
-      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} = :revisionId", array(':revisionId' => $revision_id));
+    if ($revision_ids) {
+      $query->join($this->revisionTable, 'revision', "revision.{$this->idKey} = base.{$this->idKey} AND revision.{$this->revisionKey} IN :revisionIds", array(':revisionIds' => $revision_ids));
     }
     elseif ($this->revisionKey) {
       $query->join($this->revisionTable, 'revision', "revision.{$this->revisionKey} = base.{$this->revisionKey}");
@@ -355,14 +355,16 @@ protected function buildQuery($ids, $revision_id = FALSE) {
    * @param $load_revision
    *   (optional) TRUE if the revision should be loaded, defaults to FALSE.
    */
-  protected function attachLoad(&$queried_entities, $load_revision = FALSE) {
+  protected function attachLoad(array &$queried_entities) {
     // Attach fields.
     if ($this->entityInfo['fieldable']) {
-      if ($load_revision) {
-        field_attach_load_revision($this->entityType, $queried_entities);
-      }
-      else {
-        field_attach_load($this->entityType, $queried_entities);
+      foreach ($queried_entities as $entity) {
+        if ($entity->isDefaultRevision()) {
+          field_attach_load($this->entityType, $queried_entities);
+        }
+        else {
+          field_attach_load_revision($this->entityType, $queried_entities);
+        }
       }
     }
 
diff --git a/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php b/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php
index 007d6d3..ef8a876 100644
--- a/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php
+++ b/core/lib/Drupal/Core/Entity/DatabaseStorageControllerNG.php
@@ -102,18 +102,20 @@ public function create(array $values) {
    *
    * Added mapping from storage records to entities.
    */
-  protected function attachLoad(&$queried_entities, $load_revision = FALSE) {
+  protected function attachLoad(array &$queried_entities) {
     // Now map the record values to the according entity properties and
     // activate compatibility mode.
     $queried_entities = $this->mapFromStorageRecords($queried_entities);
 
     // Attach fields.
     if ($this->entityInfo['fieldable']) {
-      if ($load_revision) {
-        field_attach_load_revision($this->entityType, $queried_entities);
-      }
-      else {
-        field_attach_load($this->entityType, $queried_entities);
+      foreach ($queried_entities as $entity) {
+        if ($entity->isDefaultRevision()) {
+          field_attach_load($this->entityType, $queried_entities);
+        }
+        else {
+          field_attach_load_revision($this->entityType, $queried_entities);
+        }
       }
     }
 
diff --git a/core/lib/Drupal/Core/Entity/EntityStorageControllerInterface.php b/core/lib/Drupal/Core/Entity/EntityStorageControllerInterface.php
index b0267e5..0ad9135 100644
--- a/core/lib/Drupal/Core/Entity/EntityStorageControllerInterface.php
+++ b/core/lib/Drupal/Core/Entity/EntityStorageControllerInterface.php
@@ -51,13 +51,13 @@ public function load(array $ids = NULL);
   /**
    * Load a specific entity revision.
    *
-   * @param int $revision_id
+   * @param array $revision_ids
    *   The revision id.
    *
    * @return Drupal\Core\Entity\EntityInterface|false
    *   The specified entity revision or FALSE if not found.
    */
-  public function loadRevision($revision_id);
+  public function loadRevisions(array $revision_ids);
 
   /**
    * Load entities by their property values.
diff --git a/core/modules/comment/lib/Drupal/comment/CommentStorageController.php b/core/modules/comment/lib/Drupal/comment/CommentStorageController.php
index 4d447a5..8359d0f 100644
--- a/core/modules/comment/lib/Drupal/comment/CommentStorageController.php
+++ b/core/modules/comment/lib/Drupal/comment/CommentStorageController.php
@@ -27,8 +27,8 @@ class CommentStorageController extends DatabaseStorageController {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::buildQuery().
    */
-  protected function buildQuery($ids, $revision_id = FALSE) {
-    $query = parent::buildQuery($ids, $revision_id);
+  protected function buildQuery($ids, array $revision_ids = array()) {
+    $query = parent::buildQuery($ids, $revision_ids);
     // Specify additional fields from the user and node tables.
     $query->innerJoin('node', 'n', 'base.nid = n.nid');
     $query->addField('n', 'type', 'node_type');
@@ -41,7 +41,7 @@ protected function buildQuery($ids, $revision_id = FALSE) {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::attachLoad().
    */
-  protected function attachLoad(&$comments, $load_revision = FALSE) {
+  protected function attachLoad(array &$comments) {
     // Set up standard comment properties.
     foreach ($comments as $key => $comment) {
       $comment->name = $comment->uid ? $comment->registered_name : $comment->name;
@@ -49,7 +49,7 @@ protected function attachLoad(&$comments, $load_revision = FALSE) {
       $comment->node_type = 'comment_node_' . $comment->node_type;
       $comments[$key] = $comment;
     }
-    parent::attachLoad($comments, $load_revision);
+    parent::attachLoad($comments);
   }
 
   /**
diff --git a/core/modules/node/lib/Drupal/node/NodeStorageController.php b/core/modules/node/lib/Drupal/node/NodeStorageController.php
index 02e694e..e37e2f4 100644
--- a/core/modules/node/lib/Drupal/node/NodeStorageController.php
+++ b/core/modules/node/lib/Drupal/node/NodeStorageController.php
@@ -166,7 +166,7 @@ protected function saveRevision(EntityInterface $entity) {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::attachLoad().
    */
-  protected function attachLoad(&$nodes, $load_revision = FALSE) {
+  protected function attachLoad(array &$nodes) {
     // Create an array of nodes for each content type and pass this to the
     // object type specific callback.
     $typed_nodes = array();
@@ -186,16 +186,16 @@ protected function attachLoad(&$nodes, $load_revision = FALSE) {
     // hook_node_load(), containing a list of node types that were loaded.
     $argument = array_keys($typed_nodes);
     $this->hookLoadArguments = array($argument);
-    parent::attachLoad($nodes, $load_revision);
+    parent::attachLoad($nodes);
   }
 
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::buildQuery().
    */
-  protected function buildQuery($ids, $revision_id = FALSE) {
+  protected function buildQuery($ids, array $revision_ids = array()) {
     // Ensure that uid is taken from the {node} table,
     // alias timestamp to revision_timestamp and add revision_uid.
-    $query = parent::buildQuery($ids, $revision_id);
+    $query = parent::buildQuery($ids, $revision_ids);
     $fields =& $query->getFields();
     unset($fields['timestamp']);
     $query->addField('revision', 'timestamp', 'revision_timestamp');
diff --git a/core/modules/taxonomy/lib/Drupal/taxonomy/TermStorageController.php b/core/modules/taxonomy/lib/Drupal/taxonomy/TermStorageController.php
index c77cad5..084781d 100644
--- a/core/modules/taxonomy/lib/Drupal/taxonomy/TermStorageController.php
+++ b/core/modules/taxonomy/lib/Drupal/taxonomy/TermStorageController.php
@@ -43,8 +43,8 @@ public function create(array $values) {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::buildQuery().
    */
-  protected function buildQuery($ids, $revision_id = FALSE) {
-    $query = parent::buildQuery($ids, $revision_id);
+  protected function buildQuery($ids, array $revision_ids = array()) {
+    $query = parent::buildQuery($ids, $revision_ids);
     $query->addTag('translatable');
     $query->addTag('term_access');
 
diff --git a/core/modules/taxonomy/lib/Drupal/taxonomy/VocabularyStorageController.php b/core/modules/taxonomy/lib/Drupal/taxonomy/VocabularyStorageController.php
index dd5b478..28080c7 100644
--- a/core/modules/taxonomy/lib/Drupal/taxonomy/VocabularyStorageController.php
+++ b/core/modules/taxonomy/lib/Drupal/taxonomy/VocabularyStorageController.php
@@ -18,8 +18,8 @@ class VocabularyStorageController extends DatabaseStorageController {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::buildQuery().
    */
-  protected function buildQuery($ids, $revision_id = FALSE) {
-    $query = parent::buildQuery($ids, $revision_id);
+  protected function buildQuery($ids, array $revision_ids = array()) {
+    $query = parent::buildQuery($ids, $revision_ids);
     $query->addTag('translatable');
     $query->orderBy('base.weight');
     $query->orderBy('base.name');
diff --git a/core/modules/user/lib/Drupal/user/UserStorageController.php b/core/modules/user/lib/Drupal/user/UserStorageController.php
index 2660300..b482e58 100644
--- a/core/modules/user/lib/Drupal/user/UserStorageController.php
+++ b/core/modules/user/lib/Drupal/user/UserStorageController.php
@@ -22,7 +22,7 @@ class UserStorageController extends DatabaseStorageController {
   /**
    * Overrides Drupal\Core\Entity\DatabaseStorageController::attachLoad().
    */
-  function attachLoad(&$queried_users, $load_revision = FALSE) {
+  function attachLoad(array &$queried_users) {
     // Build an array of user picture IDs so that these can be fetched later.
     $picture_fids = array();
     foreach ($queried_users as $key => $record) {
@@ -56,7 +56,7 @@ function attachLoad(&$queried_users, $load_revision = FALSE) {
     }
     // Call the default attachLoad() method. This will add fields and call
     // hook_user_load().
-    parent::attachLoad($queried_users, $load_revision);
+    parent::attachLoad($queried_users);
   }
 
   /**
-- 
1.7.11.1

