comparison core/includes/entity.inc @ 17:129ea1e6d783

Update, including to Drupal core 8.6.10

  * @deprecated in Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   The method overriding Entity::load() for the entity type, e.g.
  *   \Drupal\node\Entity\Node::load() if the entity type is known. If the
  *   entity type is variable, use the entity manager service to load the entity
  *   from the entity storage:
- * @code
- * \Drupal::entityTypeManager()->getStorage($entity_type)->load($id);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()->getStorage($entity_type)->load($id);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityInterface::load()
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::load()
  * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorage

  *   id.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity storage's loadRevision() method to load a specific entity
  *   revision:
- * @code
- * \Drupal::entityTypeManager()
- *   ->getStorage($entity_type)
- *   ->loadRevision($revision_id);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()
+ *       ->getStorage($entity_type)
+ *       ->loadRevision($revision_id);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::loadRevision()
  * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorage
  */

  *   The revision ID to delete.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity storage's deleteRevision() method to delete a specific entity
  *   revision:
- * @code
- * \Drupal::entityTypeManager()
- *   ->getStorage($entity_type)
- *   ->deleteRevision($revision_id);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()
+ *       ->getStorage($entity_type)
+ *       ->deleteRevision($revision_id);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::deleteRevision()
  */
 function entity_revision_delete($entity_type, $revision_id) {

  * @deprecated in Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   The method overriding Entity::loadMultiple() for the entity type, e.g.
  *   \Drupal\node\Entity\Node::loadMultiple() if the entity type is known. If
  *   the entity type is variable, use the entity manager service to load the
  *   entity from the entity storage:
- * @code
- * \Drupal::entityTypeManager()->getStorage($entity_type)->loadMultiple($id);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()->getStorage($entity_type)->loadMultiple($id);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityInterface::loadMultiple()
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::loadMultiple()
  * @see \Drupal\Core\Entity\Sql\SqlContentEntityStorage

  *   no matching entities are found.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity storage's loadByProperties() method to load an entity by their
  *   property values:
- * @code
- * \Drupal::entityTypeManager()
- *   ->getStorage($entity_type)
- *   ->loadByProperties($values);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()
+ *       ->getStorage($entity_type)
+ *       ->loadByProperties($values);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::loadByProperties()
  */
 function entity_load_multiple_by_properties($entity_type, array $values) {

  * @return \Drupal\Core\Entity\EntityInterface|null
  *   The unchanged entity, or FALSE if the entity cannot be loaded.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity storage's loadUnchanged() method to load an unchanged entity:
- * @code
- * \Drupal::entityTypeManager()->getStorage($entity_type)->loadUnchanged($id);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()->getStorage($entity_type)->loadUnchanged($id);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::loadUnchanged()
  */
 function entity_load_unchanged($entity_type, $id) {

  * @param array $ids
  *   An array of entity IDs of the entities to delete.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity storage's delete() method to delete multiple entities:
- * @code
- * $storage_handler = \Drupal::entityTypeManager()->getStorage($entity_type);
- * $entities = $storage_handler->loadMultiple($ids);
- * $storage_handler->delete($entities);
- * @endcode
+ *   @code
+ *     $storage_handler = \Drupal::entityTypeManager()->getStorage($entity_type);
+ *     $entities = $storage_handler->loadMultiple($ids);
+ *     $storage_handler->delete($entities);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::loadMultiple()
  * @see \Drupal\Core\Entity\EntityStorageInterface::delete()
  */

  * @deprecated in Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   The method overriding Entity::create() for the entity type, e.g.
  *   \Drupal\node\Entity\Node::create() if the entity type is known. If the
  *   entity type is variable, use the entity storage's create() method to
  *   construct a new entity:
- * @code
- * \Drupal::entityTypeManager()->getStorage($entity_type)->create($values);
- * @endcode
+ *   @code
+ *     \Drupal::entityTypeManager()->getStorage($entity_type)->create($values);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getStorage()
  * @see \Drupal\Core\Entity\EntityStorageInterface::create()
  */
 function entity_create($entity_type, array $values = []) {

  * @return string|null
  *   The label of the entity, or NULL if there is no label defined.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0. Use
  *   the entity's label() method to get the label of the entity:
- * @code
- * $entity->label($langcode);
- * @endcode
+ *   @code
+ *     $entity->label($langcode);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityInterface::label()
  */
 function entity_page_label(EntityInterface $entity, $langcode = NULL) {
   return $entity->label($langcode);

  * @return array
  *   A render array for the entity.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0.
  *   Use the entity view builder's view() method for creating a render array:
- * @code
- * $view_builder = \Drupal::entityTypeManager()
- *   ->getViewBuilder($entity->getEntityTypeId());
- * return $view_builder->view($entity, $view_mode, $langcode);
- * @endcode
+ *   @code
+ *     $view_builder = \Drupal::entityTypeManager()
+ *       ->getViewBuilder($entity->getEntityTypeId());
+ *     return $view_builder->view($entity, $view_mode, $langcode);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getViewBuilder()
  * @see \Drupal\Core\Entity\EntityViewBuilderInterface::view()
  */
 function entity_view(EntityInterface $entity, $view_mode, $langcode = NULL, $reset = FALSE) {

  *   entities array passed in $entities.
  *
  * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0.
  *   Use the entity view builder's viewMultiple() method for creating a render
  *   array for the provided entities:
- * @code
- * $view_builder = \Drupal::entityTypeManager()
- *   ->getViewBuilder($entity->getEntityTypeId());
- * return $view_builder->viewMultiple($entities, $view_mode, $langcode);
- * @endcode
+ *   @code
+ *     $view_builder = \Drupal::entityTypeManager()
+ *       ->getViewBuilder($entity->getEntityTypeId());
+ *     return $view_builder->viewMultiple($entities, $view_mode, $langcode);
+ *   @endcode
  *
  * @see \Drupal\Core\Entity\EntityTypeManagerInterface::getViewBuilder()
  * @see \Drupal\Core\Entity\EntityViewBuilderInterface::viewMultiple()
  */
 function entity_view_multiple(array $entities, $view_mode, $langcode = NULL, $reset = FALSE) {