Issue #2144631 by fago: Add a revisionable key to field definitions.

core/lib/Drupal/Core/Entity/EntityManager.php

@@ -353,15 +353,17 @@ class EntityManager extends PluginManagerBase implements EntityManagerInterface
     // Invoke alter hook.
     $this->moduleHandler->alter('entity_base_field_info', $base_field_definitions, $entity_type);
 
-    // Ensure all basic fields are not defined as translatable.
-    $keys = array_intersect_key(array_filter($entity_type->getKeys()), array_flip(array('id', 'revision', 'uuid', 'bundle')));
-    $untranslatable_fields = array_flip(array('langcode') + $keys);
-    foreach ($base_field_definitions as $field_name => $definition) {
-      if (isset($untranslatable_fields[$field_name]) && $definition->isTranslatable()) {
-        throw new \LogicException(String::format('The @field field cannot be translatable.', array('@field' => $definition->getLabel())));
+    // Ensure defined entity keys are there and have proper revisionable and
+    // translatable values.
+    $keys = array_filter($entity_type->getKeys() + array('langcode' => 'langcode'));
+    foreach ($keys as $key => $field_name) {
+      if (isset($base_field_definitions[$field_name]) && in_array($key, array('id', 'revision', 'uuid', 'bundle')) && $base_field_definitions[$field_name]->isRevisionable()) {
+        throw new \LogicException(String::format('The @field field cannot be revisionable as it is used as @key entity key.', array('@field' => $base_field_definitions[$field_name]->getLabel(), '@key' => $key)));
+      }
+      if (isset($base_field_definitions[$field_name]) && in_array($key, array('id', 'revision', 'uuid', 'bundle', 'langcode')) && $base_field_definitions[$field_name]->isTranslatable()) {
+        throw new \LogicException(String::format('The @field field cannot be translatable as it is used as @key entity key.', array('@field' => $base_field_definitions[$field_name]->getLabel(), '@key' => $key)));
       }
     }
-
     return $base_field_definitions;
   }
 

core/lib/Drupal/Core/Field/FieldDefinition.php

@@ -161,7 +161,7 @@ class FieldDefinition extends ListDataDefinition implements FieldDefinitionInter
    * @param bool $translatable
    *   Whether the field is translatable.
    *
-   * @return static
+   * @return $this
    *   The object itself for chaining.
    */
   public function setTranslatable($translatable) {
@@ -169,6 +169,27 @@ class FieldDefinition extends ListDataDefinition implements FieldDefinitionInter
     return $this;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function isRevisionable() {
+    return !empty($this->definition['revisionable']);
+  }
+
+  /**
+   * Sets whether the field is revisionable.
+   *
+   * @param bool $revisionable
+   *   Whether the field is revisionable.
+   *
+   * @return $this
+   *   The object itself for chaining.
+   */
+  public function setRevisionable($revisionable) {
+    $this->definition['revisionable'] = $revisionable;
+    return $this;
+  }
+
   /**
    * {@inheritdoc}
    */

core/lib/Drupal/Core/Field/FieldDefinitionInterface.php

@@ -111,6 +111,14 @@ interface FieldDefinitionInterface extends ListDataDefinitionInterface {
    */
   public function isTranslatable();
 
+  /**
+   * Returns whether the field is revisionable.
+   *
+   * @return bool
+   *   TRUE if the field is revisionable.
+   */
+  public function isRevisionable();
+
   /**
    * Returns whether the display for the field can be configured.
    *

core/modules/field/lib/Drupal/field/Entity/FieldConfig.php

@@ -560,6 +560,14 @@ class FieldConfig extends ConfigEntityBase implements FieldConfigInterface {
     return $this->translatable;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function isRevisionable() {
+    // All configurable fields are revisionable.
+    return TRUE;
+  }
+
   /**
    * Sets whether the field is translatable.
    *

core/modules/field/lib/Drupal/field/Entity/FieldInstanceConfig.php

@@ -512,6 +512,13 @@ class FieldInstanceConfig extends ConfigEntityBase implements FieldInstanceConfi
     return $this->field->translatable;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function isRevisionable() {
+    return $this->field->isRevisionable();
+  }
+
   /**
    * {@inheritdoc}
    */

core/modules/node/lib/Drupal/node/Entity/Node.php

@@ -362,6 +362,7 @@ class Node extends ContentEntityBase implements NodeInterface {
       ->setDescription(t('The title of this node, always treated as non-markup plain text.'))
       ->setRequired(TRUE)
       ->setTranslatable(TRUE)
+      ->setRevisionable(TRUE)
       ->setSettings(array(
         'default_value' => '',
         'max_length' => 255,
@@ -380,6 +381,7 @@ class Node extends ContentEntityBase implements NodeInterface {
     $fields['uid'] = FieldDefinition::create('entity_reference')
       ->setLabel(t('User ID'))
       ->setDescription(t('The user ID of the node author.'))
+      ->setRevisionable(TRUE)
       ->setSettings(array(
         'target_type' => 'user',
         'default_value' => 0,
@@ -387,38 +389,46 @@ class Node extends ContentEntityBase implements NodeInterface {
 
     $fields['status'] = FieldDefinition::create('boolean')
       ->setLabel(t('Publishing status'))
-      ->setDescription(t('A boolean indicating whether the node is published.'));
+      ->setDescription(t('A boolean indicating whether the node is published.'))
+      ->setRevisionable(TRUE);
 
     $fields['created'] = FieldDefinition::create('created')
       ->setLabel(t('Created'))
-      ->setDescription(t('The time that the node was created.'));
+      ->setDescription(t('The time that the node was created.'))
+      ->setRevisionable(TRUE);
 
     $fields['changed'] = FieldDefinition::create('changed')
       ->setLabel(t('Changed'))
-      ->setDescription(t('The time that the node was last edited.'));
+      ->setDescription(t('The time that the node was last edited.'))
+      ->setRevisionable(TRUE);
 
     $fields['promote'] = FieldDefinition::create('boolean')
       ->setLabel(t('Promote'))
-      ->setDescription(t('A boolean indicating whether the node should be displayed on the front page.'));
+      ->setDescription(t('A boolean indicating whether the node should be displayed on the front page.'))
+      ->setRevisionable(TRUE);
 
     $fields['sticky'] = FieldDefinition::create('boolean')
       ->setLabel(t('Sticky'))
-      ->setDescription(t('A boolean indicating whether the node should be displayed at the top of lists in which it appears.'));
+      ->setDescription(t('A boolean indicating whether the node should be displayed at the top of lists in which it appears.'))
+      ->setRevisionable(TRUE);
 
     $fields['revision_timestamp'] = FieldDefinition::create('timestamp')
       ->setLabel(t('Revision timestamp'))
       ->setDescription(t('The time that the current revision was created.'))
-      ->setQueryable(FALSE);
+      ->setQueryable(FALSE)
+      ->setRevisionable(TRUE);
 
     $fields['revision_uid'] = FieldDefinition::create('entity_reference')
       ->setLabel(t('Revision user ID'))
       ->setDescription(t('The user ID of the author of the current revision.'))
       ->setSettings(array('target_type' => 'user'))
-      ->setQueryable(FALSE);
+      ->setQueryable(FALSE)
+      ->setRevisionable(TRUE);
 
     $fields['log'] = FieldDefinition::create('string')
       ->setLabel(t('Log'))
-      ->setDescription(t('The log entry explaining the changes in this revision.'));
+      ->setDescription(t('The log entry explaining the changes in this revision.'))
+      ->setRevisionable(TRUE);
 
     return $fields;
   }

core/tests/Drupal/Tests/Core/Entity/FieldDefinitionTest.php

@@ -170,6 +170,18 @@ class FieldDefinitionTest extends UnitTestCase {
     $this->assertFalse($definition->isTranslatable());
   }
 
+  /**
+   * Tests field revisionable methods.
+   */
+  public function testFieldRevisionable() {
+    $definition = FieldDefinition::create($this->fieldType);
+    $this->assertFalse($definition->isRevisionable());
+    $definition->setRevisionable(TRUE);
+    $this->assertTrue($definition->isRevisionable());
+    $definition->setRevisionable(FALSE);
+    $this->assertFalse($definition->isRevisionable());
+  }
+
   /**
    * Tests field cardinality.
    */