comparison core/lib/Drupal/Core/Entity/entity.api.php @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1

 
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Entity\DynamicallyFieldableEntityStorageInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
+use Drupal\Core\Field\FieldDefinition;
 use Drupal\Core\Render\Element;
 use Drupal\language\Entity\ContentLanguageSettings;
 use Drupal\node\Entity\NodeType;
 
 /**

  * @section load_query Loading, querying, and rendering entities
  * To load entities, use the entity storage manager, which is an object
  * implementing \Drupal\Core\Entity\EntityStorageInterface that you can
  * retrieve with:
  * @code
- * $storage = \Drupal::entityManager()->getStorage('your_entity_type');
+ * $storage = \Drupal::entityTypeManager()->getStorage('your_entity_type');
  * // Or if you have a $container variable:
- * $storage = $container->get('entity.manager')->getStorage('your_entity_type');
+ * $storage = $container->get('entity_type.manager')->getStorage('your_entity_type');
  * @endcode
  * Here, 'your_entity_type' is the machine name of your entity type ('id'
  * annotation property on the entity class), and note that you should use
  * dependency injection to retrieve this object if possible. See the
  * @link container Services and Dependency Injection topic @endlink for more

  * developers can interact with. This is described in the
  * @link node_access Node access topic. @endlink
  *
  * @see i18n
  * @see entity_crud
- * @see \Drupal\Core\Entity\EntityManagerInterface::getTranslationFromContext()
+ * @see \Drupal\Core\Entity\EntityRepositoryInterface::getTranslationFromContext()
  * @}
  */
 
 /**
  * @addtogroup hooks

  * Alter the view modes for entity types.
  *
  * @param array $view_modes
  *   An array of view modes, keyed first by entity type, then by view mode name.
  *
- * @see \Drupal\Core\Entity\EntityManagerInterface::getAllViewModes()
- * @see \Drupal\Core\Entity\EntityManagerInterface::getViewModes()
+ * @see \Drupal\Core\Entity\EntityDisplayRepositoryInterface::getAllViewModes()
+ * @see \Drupal\Core\Entity\EntityDisplayRepositoryInterface::getViewModes()
  */
 function hook_entity_view_mode_info_alter(&$view_modes) {
   $view_modes['user']['full']['status'] = TRUE;
 }
 

  * @return array
  *   An associative array of all entity bundles, keyed by the entity
  *   type name, and then the bundle name, with the following keys:
  *   - label: The human-readable name of the bundle.
  *   - uri_callback: (optional) The same as the 'uri_callback' key defined for
- *     the entity type in the EntityManager, but for the bundle only. When
+ *     the entity type in the EntityTypeManager, but for the bundle only. When
  *     determining the URI of an entity, if a 'uri_callback' is defined for both
  *     the entity type and the bundle, the one for the bundle is used.
  *   - translatable: (optional) A boolean value specifying whether this bundle
  *     has translation support enabled. Defaults to FALSE.
  *

   // synchronized from the default revision.
   $new_revision->set('untranslatable_field', $entity->get('untranslatable_field'));
 }
 
 /**
+ * Act on an array of entity IDs before they are loaded.
+ *
+ * This hook can be used by modules that need, for example, to return a
+ * different revision than the default one.
+ *
+ * @param array $ids
+ *   An array of entity IDs that have to be loaded.
+ * @param string $entity_type_id
+ *   The type of entities being loaded (i.e. node, user, comment).
+ *
+ * @return \Drupal\Core\Entity\EntityInterface[]
+ *   An array of pre-loaded entity objects.
+ *
+ * @ingroup entity_crud
+ */
+function hook_entity_preload(array $ids, $entity_type_id) {
+  $entities = [];
+
+  foreach ($ids as $id) {
+    $entities[] = mymodule_swap_revision($id);
+  }
+
+  return $entities;
+}
+
+/**
  * Act on entities when loaded.
  *
  * This is a generic load hook called for all entity types loaded via the
  * entity API.
  *

  * @ingroup entity_crud
  * @see hook_ENTITY_TYPE_insert()
  */
 function hook_entity_insert(Drupal\Core\Entity\EntityInterface $entity) {
   // Insert the new entity into a fictional table of all entities.
-  db_insert('example_entity')
+  \Drupal::database()->insert('example_entity')
     ->fields([
       'type' => $entity->getEntityTypeId(),
       'id' => $entity->id(),
       'created' => REQUEST_TIME,
       'updated' => REQUEST_TIME,

  * @ingroup entity_crud
  * @see hook_entity_insert()
  */
 function hook_ENTITY_TYPE_insert(Drupal\Core\Entity\EntityInterface $entity) {
   // Insert the new entity into a fictional table of this type of entity.
-  db_insert('example_entity')
+  \Drupal::database()->insert('example_entity')
     ->fields([
       'id' => $entity->id(),
       'created' => REQUEST_TIME,
       'updated' => REQUEST_TIME,
     ])

  * @ingroup entity_crud
  * @see hook_ENTITY_TYPE_update()
  */
 function hook_entity_update(Drupal\Core\Entity\EntityInterface $entity) {
   // Update the entity's entry in a fictional table of all entities.
-  db_update('example_entity')
+  \Drupal::database()->update('example_entity')
     ->fields([
       'updated' => REQUEST_TIME,
     ])
     ->condition('type', $entity->getEntityTypeId())
     ->condition('id', $entity->id())

  * @ingroup entity_crud
  * @see hook_entity_update()
  */
 function hook_ENTITY_TYPE_update(Drupal\Core\Entity\EntityInterface $entity) {
   // Update the entity's entry in a fictional table of this type of entity.
-  db_update('example_entity')
+  \Drupal::database()->update('example_entity')
     ->fields([
       'updated' => REQUEST_TIME,
     ])
     ->condition('id', $entity->id())
     ->execute();

  *
  * @ingroup entity_crud
  * @see hook_ENTITY_TYPE_predelete()
  */
 function hook_entity_predelete(Drupal\Core\Entity\EntityInterface $entity) {
+  $connection = \Drupal::database();
   // Count references to this entity in a custom table before they are removed
   // upon entity deletion.
   $id = $entity->id();
   $type = $entity->getEntityTypeId();
-  $count = db_select('example_entity_data')
+  $count = \Drupal::database()->select('example_entity_data')
     ->condition('type', $type)
     ->condition('id', $id)
     ->countQuery()
     ->execute()
     ->fetchField();
 
   // Log the count in a table that records this statistic for deleted entities.
-  db_merge('example_deleted_entity_statistics')
+  $connection->merge('example_deleted_entity_statistics')
     ->key(['type' => $type, 'id' => $id])
     ->fields(['count' => $count])
     ->execute();
 }
 

  *
  * @ingroup entity_crud
  * @see hook_entity_predelete()
  */
 function hook_ENTITY_TYPE_predelete(Drupal\Core\Entity\EntityInterface $entity) {
+  $connection = \Drupal::database();
   // Count references to this entity in a custom table before they are removed
   // upon entity deletion.
   $id = $entity->id();
   $type = $entity->getEntityTypeId();
-  $count = db_select('example_entity_data')
+  $count = \Drupal::database()->select('example_entity_data')
     ->condition('type', $type)
     ->condition('id', $id)
     ->countQuery()
     ->execute()
     ->fetchField();
 
   // Log the count in a table that records this statistic for deleted entities.
-  db_merge('example_deleted_entity_statistics')
+  $connection->merge('example_deleted_entity_statistics')
     ->key(['type' => $type, 'id' => $id])
     ->fields(['count' => $count])
     ->execute();
 }
 

  * @ingroup entity_crud
  * @see hook_ENTITY_TYPE_delete()
  */
 function hook_entity_delete(Drupal\Core\Entity\EntityInterface $entity) {
   // Delete the entity's entry from a fictional table of all entities.
-  db_delete('example_entity')
+  \Drupal::database()->delete('example_entity')
     ->condition('type', $entity->getEntityTypeId())
     ->condition('id', $entity->id())
     ->execute();
 }
 

  * @ingroup entity_crud
  * @see hook_entity_delete()
  */
 function hook_ENTITY_TYPE_delete(Drupal\Core\Entity\EntityInterface $entity) {
   // Delete the entity's entry from a fictional table of all entities.
-  db_delete('example_entity')
+  \Drupal::database()->delete('example_entity')
     ->condition('type', $entity->getEntityTypeId())
     ->condition('id', $entity->id())
     ->execute();
 }
 

  *
  * @see hook_entity_base_field_info_alter()
  * @see hook_entity_bundle_field_info()
  * @see hook_entity_bundle_field_info_alter()
  * @see \Drupal\Core\Field\FieldDefinitionInterface
- * @see \Drupal\Core\Entity\EntityManagerInterface::getFieldDefinitions()
+ * @see \Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()
  */
 function hook_entity_base_field_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type) {
   if ($entity_type->id() == 'node') {
     $fields = [];
     $fields['mymodule_text'] = BaseFieldDefinition::create('string')

  * @see hook_entity_base_field_info_alter()
  * @see hook_entity_field_storage_info()
  * @see hook_entity_field_storage_info_alter()
  * @see hook_entity_bundle_field_info_alter()
  * @see \Drupal\Core\Field\FieldDefinitionInterface
- * @see \Drupal\Core\Entity\EntityManagerInterface::getFieldDefinitions()
+ * @see \Drupal\Core\Field\FieldDefinition
+ * @see \Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()
  *
  * @todo WARNING: This hook will be changed in
  * https://www.drupal.org/node/2346347.
  */
 function hook_entity_bundle_field_info(\Drupal\Core\Entity\EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
   // Add a property only to nodes of the 'article' bundle.
   if ($entity_type->id() == 'node' && $bundle == 'article') {
     $fields = [];
-    $fields['mymodule_text_more'] = BaseFieldDefinition::create('string')
-      ->setLabel(t('More text'))
-      ->setComputed(TRUE)
-      ->setClass('\Drupal\mymodule\EntityComputedMoreText');
+    $storage_definitions = mymodule_entity_field_storage_info($entity_type);
+    $fields['mymodule_bundle_field'] = FieldDefinition::createFromFieldStorageDefinition($storage_definitions['mymodule_bundle_field'])
+      ->setLabel(t('Bundle Field'));
     return $fields;
   }
+
 }
 
 /**
  * Alter bundle field definitions.
  *