From dd663c405e32200fbba290209a093d0685aebb19 Mon Sep 17 00:00:00 2001 From: Alex Pott Date: Thu, 12 Dec 2013 23:34:44 +0000 Subject: [PATCH] Issue #2031725 by fgm, fago, vladan.me, Nebel54, Berdir: Move all entity display interfaces to the core component. --- core/includes/entity.inc | 8 ++++---- .../Entity/Display/EntityDisplayInterface.php} | 16 +++++++--------- .../Display/EntityFormDisplayInterface.php | 15 +++++++++++++++ .../Display/EntityViewDisplayInterface.php | 15 +++++++++++++++ .../Drupal/Core/Entity/EntityFormController.php | 5 +---- .../Entity/EntityFormControllerInterface.php | 6 +++--- .../Drupal/Core/Entity/EntityViewBuilder.php | 7 +++---- .../custom_block/CustomBlockViewBuilder.php | 4 ++-- core/modules/book/book.module | 6 ++---- core/modules/comment/comment.api.php | 8 ++++---- core/modules/comment/comment.module | 6 +++--- .../lib/Drupal/comment/CommentViewBuilder.php | 4 ++-- core/modules/edit/edit.module | 7 ++----- .../modules/edit/tests/modules/edit_test.module | 4 ++-- .../lib/Drupal/entity/Entity/EntityDisplay.php | 6 ++---- .../Drupal/entity/Entity/EntityFormDisplay.php | 4 +--- .../lib/Drupal/entity/EntityDisplayBase.php | 3 ++- .../Drupal/entity/EntityDisplayInterface.php | 17 ----------------- .../entity/EntityFormDisplayInterface.php | 17 ----------------- core/modules/field/field.deprecated.inc | 6 +++--- .../lib/Drupal/field_ui/DisplayOverview.php | 5 ++--- .../lib/Drupal/field_ui/DisplayOverviewBase.php | 11 +++++------ .../lib/Drupal/field_ui/FormDisplayOverview.php | 4 ++-- core/modules/history/history.module | 4 ++-- .../node/lib/Drupal/node/NodeViewBuilder.php | 4 ++-- core/modules/node/node.api.php | 8 ++++---- core/modules/node/node.module | 10 ++++------ .../tests/modules/node_test/node_test.module | 4 ++-- core/modules/statistics/statistics.module | 4 ++-- core/modules/system/entity.api.php | 16 ++++++++-------- .../lib/Drupal/taxonomy/TermViewBuilder.php | 4 ++-- core/modules/taxonomy/taxonomy.api.php | 8 ++++---- .../text/Tests/Formatter/TextPlainUnitTest.php | 6 +++--- core/modules/user/user.api.php | 8 ++++---- core/modules/user/user.module | 4 ++-- 35 files changed, 121 insertions(+), 143 deletions(-) rename core/{modules/entity/lib/Drupal/entity/EntityDisplayBaseInterface.php => lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php} (82%) create mode 100644 core/lib/Drupal/Core/Entity/Display/EntityFormDisplayInterface.php create mode 100644 core/lib/Drupal/Core/Entity/Display/EntityViewDisplayInterface.php delete mode 100644 core/modules/entity/lib/Drupal/entity/EntityDisplayInterface.php delete mode 100644 core/modules/entity/lib/Drupal/entity/EntityFormDisplayInterface.php diff --git a/core/includes/entity.inc b/core/includes/entity.inc index 91cbc1e143..4dddce1cae 100644 --- a/core/includes/entity.inc +++ b/core/includes/entity.inc @@ -639,7 +639,7 @@ function entity_view_multiple(array $entities, $view_mode, $langcode = NULL, $re * The view mode, or 'default' to retrieve the 'default' display object for * this bundle. * - * @return \Drupal\entity\Entity\EntityDisplay + * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface * The display object associated to the view mode. */ function entity_get_display($entity_type, $bundle, $view_mode) { @@ -682,7 +682,7 @@ function entity_get_display($entity_type, $bundle, $view_mode) { * @param string $view_mode * The view mode being rendered. * - * @return \Drupal\entity\Entity\EntityDisplay + * @return \Drupal\Core\Entity\Display\EntityViewDisplayInterface * The display object that should be used to render the entity. * * @see entity_get_display(). @@ -751,7 +751,7 @@ function entity_get_render_display(EntityInterface $entity, $view_mode) { * @param string $form_mode * The form mode. * - * @return \Drupal\entity\Entity\EntityFormDisplay + * @return \Drupal\Core\Entity\Display\EntityFormDisplayInterface * The EntityFormDisplay object associated to the form mode. */ function entity_get_form_display($entity_type, $bundle, $form_mode) { @@ -790,7 +790,7 @@ function entity_get_form_display($entity_type, $bundle, $form_mode) { * @param string $form_mode * The form mode being rendered. * - * @return \Drupal\entity\Entity\EntityFormDisplay + * @return \Drupal\Core\Entity\Display\EntityFormDisplayInterface * The form display object that should be used to render the entity form. * * @see entity_get_form_display(). diff --git a/core/modules/entity/lib/Drupal/entity/EntityDisplayBaseInterface.php b/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php similarity index 82% rename from core/modules/entity/lib/Drupal/entity/EntityDisplayBaseInterface.php rename to core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php index 93fa3bbb0c..b5837c70a9 100644 --- a/core/modules/entity/lib/Drupal/entity/EntityDisplayBaseInterface.php +++ b/core/lib/Drupal/Core/Entity/Display/EntityDisplayInterface.php @@ -2,17 +2,15 @@ /** * @file - * Contains \Drupal\entity\EntityDisplayBaseInterface. + * Contains \Drupal\Core\Entity\Display\EntityDisplayInterface. */ -namespace Drupal\entity; - -use Drupal\Core\Config\Entity\ConfigEntityInterface; +namespace Drupal\Core\Entity\Display; /** - * Provides an interface defining an entity display entity. + * Provides a common interface for entity displays. */ -interface EntityDisplayBaseInterface extends ConfigEntityInterface { +interface EntityDisplayInterface { /** * Creates a duplicate of the EntityDisplay object on a different view mode. @@ -23,7 +21,7 @@ interface EntityDisplayBaseInterface extends ConfigEntityInterface { * @param $view_mode * The view mode for the new object. * - * @return \Drupal\entity\Entity\EntityDisplay + * @return self * The new object. */ public function createCopy($view_mode); @@ -56,7 +54,7 @@ public function getComponent($name); * @param array $options * The display options. * - * @return \Drupal\entity\Entity\EntityDisplay + * @return self * The EntityDisplay object. */ public function setComponent($name, array $options = array()); @@ -67,7 +65,7 @@ public function setComponent($name, array $options = array()); * @param string $name * The name of the component. * - * @return \Drupal\entity\Entity\EntityDisplay + * @return self * The EntityDisplay object. */ public function removeComponent($name); diff --git a/core/lib/Drupal/Core/Entity/Display/EntityFormDisplayInterface.php b/core/lib/Drupal/Core/Entity/Display/EntityFormDisplayInterface.php new file mode 100644 index 0000000000..1929d9ad5c --- /dev/null +++ b/core/lib/Drupal/Core/Entity/Display/EntityFormDisplayInterface.php @@ -0,0 +1,15 @@ +isNew() && $view_mode == 'full') { diff --git a/core/modules/book/book.module b/core/modules/book/book.module index 6a28f7c4ca..ec8cf4cf87 100644 --- a/core/modules/book/book.module +++ b/core/modules/book/book.module @@ -9,10 +9,8 @@ use Drupal\node\NodeInterface; use Drupal\node\NodeTypeInterface; use Drupal\Core\Language\Language; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Template\Attribute; -use Drupal\menu_link\Entity\MenuLink; -use Drupal\menu_link\MenuLinkStorageController; /** * Implements hook_help(). @@ -448,7 +446,7 @@ function book_node_load($nodes) { /** * Implements hook_node_view(). */ -function book_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) { +function book_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { if ($view_mode == 'full') { if (!empty($node->book['bid']) && empty($node->in_preview)) { $book_navigation = array( '#theme' => 'book_navigation', '#book_link' => $node->book); diff --git a/core/modules/comment/comment.api.php b/core/modules/comment/comment.api.php index fac954728d..375f6da8cb 100644 --- a/core/modules/comment/comment.api.php +++ b/core/modules/comment/comment.api.php @@ -86,7 +86,7 @@ function hook_comment_load(Drupal\comment\Comment $comments) { * * @param \Drupal\comment\Entity\Comment $comment $comment * Passes in the comment the action is being performed on. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * comment components. * @param $view_mode @@ -96,7 +96,7 @@ function hook_comment_load(Drupal\comment\Comment $comments) { * * @see hook_entity_view() */ -function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) { +function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // node type in hook_field_extra_fields(). @@ -124,14 +124,14 @@ function hook_comment_view(\Drupal\comment\Entity\Comment $comment, \Drupal\enti * A renderable array representing the comment. * @param \Drupal\comment\Entity\Comment $comment * The comment being rendered. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * comment components. * * @see comment_view() * @see hook_entity_view_alter() */ -function hook_comment_view_alter(&$build, \Drupal\comment\Entity\Comment $comment, \Drupal\entity\Entity\EntityDisplay $display) { +function hook_comment_view_alter(&$build, \Drupal\comment\Entity\Comment $comment, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { // Check for the existence of a field added by another module. if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. diff --git a/core/modules/comment/comment.module b/core/modules/comment/comment.module index fa5caee9bb..8debaef99c 100644 --- a/core/modules/comment/comment.module +++ b/core/modules/comment/comment.module @@ -14,7 +14,7 @@ use Drupal\Core\Entity\EntityChangedInterface; use Drupal\comment\CommentInterface; use Drupal\comment\Entity\Comment; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\field\FieldInstanceInterface; use Drupal\field\FieldInterface; use Drupal\file\FileInterface; @@ -456,7 +456,7 @@ function theme_comment_block($variables) { /** * Implements hook_entity_view(). */ -function comment_entity_view(EntityInterface $entity, EntityDisplay $display, $view_mode, $langcode) { +function comment_entity_view(EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode) { if ($entity->entityType() != 'node') { // Comment links are only added to node entity type for backwards // compatibility. Should you require comment links for other entity types @@ -594,7 +594,7 @@ function comment_entity_view(EntityInterface $entity, EntityDisplay $display, $v /** * Implements hook_node_view_alter(). */ -function comment_node_view_alter(&$build, EntityInterface $node, EntityDisplay $display) { +function comment_node_view_alter(&$build, EntityInterface $node, EntityViewDisplayInterface $display) { if (\Drupal::moduleHandler()->moduleExists('history')) { $build['#attributes']['data-history-node-id'] = $node->id(); } diff --git a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php index 7911daa05b..be9c41f27d 100644 --- a/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php +++ b/core/modules/comment/lib/Drupal/comment/CommentViewBuilder.php @@ -9,12 +9,12 @@ use Drupal\Core\Access\CsrfTokenGenerator; use Drupal\Core\Entity\EntityControllerInterface; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Entity\EntityViewBuilderInterface; use Drupal\Core\Extension\ModuleHandlerInterface; use Drupal\Core\Entity\EntityViewBuilder; -use Drupal\entity\Entity\EntityDisplay; use Drupal\field\FieldInfo; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -271,7 +271,7 @@ protected static function buildLinks(CommentInterface $entity, EntityInterface $ /** * {@inheritdoc} */ - protected function alterBuild(array &$build, EntityInterface $comment, EntityDisplay $display, $view_mode, $langcode = NULL) { + protected function alterBuild(array &$build, EntityInterface $comment, EntityViewDisplayInterface $display, $view_mode, $langcode = NULL) { parent::alterBuild($build, $comment, $display, $view_mode, $langcode); if (empty($comment->in_preview)) { $prefix = ''; diff --git a/core/modules/edit/edit.module b/core/modules/edit/edit.module index 3db2de6b94..b7de2d8195 100644 --- a/core/modules/edit/edit.module +++ b/core/modules/edit/edit.module @@ -12,10 +12,7 @@ */ use Drupal\Core\Entity\EntityInterface; -use Drupal\edit\Form\EditFieldForm; -use Drupal\Component\Utility\NestedArray; -use Drupal\entity\Entity\EntityDisplay; -use Drupal\user\TempStoreFactory; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; /** * Implements hook_menu(). @@ -197,7 +194,7 @@ function edit_preprocess_field(&$variables) { /** * Implements hook_entity_view_alter(). */ -function edit_entity_view_alter(&$build, EntityInterface $entity, EntityDisplay $display) { +function edit_entity_view_alter(&$build, EntityInterface $entity, EntityViewDisplayInterface $display) { $build['#attributes']['data-edit-entity-id'] = $entity->entityType() . '/' . $entity->id(); } diff --git a/core/modules/edit/tests/modules/edit_test.module b/core/modules/edit/tests/modules/edit_test.module index 75d5e22e24..157350d71d 100644 --- a/core/modules/edit/tests/modules/edit_test.module +++ b/core/modules/edit/tests/modules/edit_test.module @@ -7,12 +7,12 @@ use Drupal\Core\Language\Language; use Drupal\Core\Entity\EntityInterface; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; /** * Implements hook_entity_view_alter(). */ -function edit_test_entity_view_alter(&$build, EntityInterface $entity, EntityDisplay $display) { +function edit_test_entity_view_alter(&$build, EntityInterface $entity, EntityViewDisplayInterface $display) { if ($entity->entityType() == 'node' && $entity->bundle() == 'article') { $build['pseudo'] = array( '#theme' => 'field', diff --git a/core/modules/entity/lib/Drupal/entity/Entity/EntityDisplay.php b/core/modules/entity/lib/Drupal/entity/Entity/EntityDisplay.php index 3fe074354a..70deb3e396 100644 --- a/core/modules/entity/lib/Drupal/entity/Entity/EntityDisplay.php +++ b/core/modules/entity/lib/Drupal/entity/Entity/EntityDisplay.php @@ -7,10 +7,8 @@ namespace Drupal\entity\Entity; -use Drupal\Core\Entity\Annotation\EntityType; -use Drupal\Core\Annotation\Translation; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\entity\EntityDisplayBase; -use Drupal\entity\EntityDisplayInterface; /** * Configuration entity that contains display options for all components of a @@ -30,7 +28,7 @@ * } * ) */ -class EntityDisplay extends EntityDisplayBase implements EntityDisplayInterface { +class EntityDisplay extends EntityDisplayBase implements EntityViewDisplayInterface { /** * {@inheritdoc} diff --git a/core/modules/entity/lib/Drupal/entity/Entity/EntityFormDisplay.php b/core/modules/entity/lib/Drupal/entity/Entity/EntityFormDisplay.php index c4637f7646..a21a8493df 100644 --- a/core/modules/entity/lib/Drupal/entity/Entity/EntityFormDisplay.php +++ b/core/modules/entity/lib/Drupal/entity/Entity/EntityFormDisplay.php @@ -7,10 +7,8 @@ namespace Drupal\entity\Entity; -use Drupal\Core\Entity\Annotation\EntityType; -use Drupal\Core\Annotation\Translation; +use Drupal\Core\Entity\Display\EntityFormDisplayInterface; use Drupal\entity\EntityDisplayBase; -use Drupal\entity\EntityFormDisplayInterface; /** * Configuration entity that contains widget options for all components of a diff --git a/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php b/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php index e96959ff3f..310520c162 100644 --- a/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php +++ b/core/modules/entity/lib/Drupal/entity/EntityDisplayBase.php @@ -8,13 +8,14 @@ namespace Drupal\entity; use Drupal\Core\Config\Entity\ConfigEntityBase; +use Drupal\Core\Entity\Display\EntityDisplayInterface; use Drupal\Core\Entity\ContentEntityInterface; /** * Base class for config entity types that store configuration for entity forms * and displays. */ -abstract class EntityDisplayBase extends ConfigEntityBase implements EntityDisplayBaseInterface { +abstract class EntityDisplayBase extends ConfigEntityBase implements EntityDisplayInterface { /** * Unique ID for the config entity. diff --git a/core/modules/entity/lib/Drupal/entity/EntityDisplayInterface.php b/core/modules/entity/lib/Drupal/entity/EntityDisplayInterface.php deleted file mode 100644 index 08d49c0d85..0000000000 --- a/core/modules/entity/lib/Drupal/entity/EntityDisplayInterface.php +++ /dev/null @@ -1,17 +0,0 @@ -getComponent($field_id); diff --git a/core/modules/field_ui/lib/Drupal/field_ui/DisplayOverviewBase.php b/core/modules/field_ui/lib/Drupal/field_ui/DisplayOverviewBase.php index 37073e8c35..a9749370c0 100644 --- a/core/modules/field_ui/lib/Drupal/field_ui/DisplayOverviewBase.php +++ b/core/modules/field_ui/lib/Drupal/field_ui/DisplayOverviewBase.php @@ -8,11 +8,10 @@ namespace Drupal\field_ui; use Drupal\Component\Plugin\PluginManagerBase; +use Drupal\Core\Entity\Display\EntityDisplayInterface; use Drupal\Core\Entity\EntityManagerInterface; use Drupal\Core\Field\FieldTypePluginManager; -use Drupal\entity\EntityDisplayBaseInterface; use Drupal\field\FieldInstanceInterface; -use Drupal\field_ui\OverviewBase; use Symfony\Component\DependencyInjection\ContainerInterface; /** @@ -209,7 +208,7 @@ public function buildForm(array $form, array &$form_state, $entity_type = NULL, * The field ID. * @param \Drupal\field\FieldInstanceInterface $instance * The field instance. - * @param \Drupal\entity\EntityDisplayBaseInterface $entity_display + * @param \Drupal\Core\Entity\Display\EntityDisplayInterface $entity_display * The entity display. * @param array $form * An associative array containing the structure of the form. @@ -219,7 +218,7 @@ public function buildForm(array $form, array &$form_state, $entity_type = NULL, * @return array * A table row array. */ - protected function buildFieldRow($field_id, FieldInstanceInterface $instance, EntityDisplayBaseInterface $entity_display, array $form, array &$form_state) { + protected function buildFieldRow($field_id, FieldInstanceInterface $instance, EntityDisplayInterface $entity_display, array $form, array &$form_state) { $display_options = $entity_display->getComponent($field_id); $label = $instance->getLabel(); @@ -388,7 +387,7 @@ protected function buildFieldRow($field_id, FieldInstanceInterface $instance, En * The field ID. * @param array $extra_field * The pseudo-field element. - * @param \Drupal\entity\EntityDisplayBaseInterface $entity_display + * @param \Drupal\Core\Entity\Display\EntityDisplayInterface $entity_display * The entity display. * * @return array @@ -626,7 +625,7 @@ public function multistepAjax($form, &$form_state) { * @param string $mode * A view or form mode. * - * @return \Drupal\entity\EntityDisplayBaseInterface + * @return \Drupal\Core\Entity\Display\EntityDisplayInterface * An entity display. */ abstract protected function getEntityDisplay($mode); diff --git a/core/modules/field_ui/lib/Drupal/field_ui/FormDisplayOverview.php b/core/modules/field_ui/lib/Drupal/field_ui/FormDisplayOverview.php index e35b33ab7b..ec256c3455 100644 --- a/core/modules/field_ui/lib/Drupal/field_ui/FormDisplayOverview.php +++ b/core/modules/field_ui/lib/Drupal/field_ui/FormDisplayOverview.php @@ -8,7 +8,7 @@ namespace Drupal\field_ui; use Drupal\Component\Utility\NestedArray; -use Drupal\entity\EntityDisplayBaseInterface; +use Drupal\Core\Entity\Display\EntityDisplayInterface; use Drupal\field\FieldInstanceInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -49,7 +49,7 @@ public function buildForm(array $form, array &$form_state, $entity_type = NULL, /** * {@inheritdoc} */ - protected function buildFieldRow($field_id, FieldInstanceInterface $instance, EntityDisplayBaseInterface $entity_display, array $form, array &$form_state) { + protected function buildFieldRow($field_id, FieldInstanceInterface $instance, EntityDisplayInterface $entity_display, array $form, array &$form_state) { $field_row = parent::buildFieldRow($field_id, $instance, $entity_display, $form, $form_state); // Update the (invisible) title of the 'plugin' column. diff --git a/core/modules/history/history.module b/core/modules/history/history.module index 8aeb74eac1..19056ad65e 100644 --- a/core/modules/history/history.module +++ b/core/modules/history/history.module @@ -10,7 +10,7 @@ */ use Drupal\Core\Entity\EntityInterface; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; /** * Entities changed before this time are always shown as read. @@ -131,7 +131,7 @@ function history_cron() { /** * Implements hook_node_view_alter(). */ -function history_node_view_alter(&$build, EntityInterface $node, EntityDisplay $display) { +function history_node_view_alter(&$build, EntityInterface $node, EntityViewDisplayInterface $display) { // Update the history table, stating that this user viewed this node. if (($display->originalMode === 'full') && \Drupal::currentUser()->isAuthenticated()) { $build['#attached'] = array( diff --git a/core/modules/node/lib/Drupal/node/NodeViewBuilder.php b/core/modules/node/lib/Drupal/node/NodeViewBuilder.php index 17030d096b..eda9b4c812 100644 --- a/core/modules/node/lib/Drupal/node/NodeViewBuilder.php +++ b/core/modules/node/lib/Drupal/node/NodeViewBuilder.php @@ -7,9 +7,9 @@ namespace Drupal\node; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityViewBuilder; -use Drupal\entity\Entity\EntityDisplay; /** * Render controller for nodes. @@ -136,7 +136,7 @@ protected static function buildLinks(NodeInterface $entity, $view_mode) { /** * {@inheritdoc} */ - protected function alterBuild(array &$build, EntityInterface $entity, EntityDisplay $display, $view_mode, $langcode = NULL) { + protected function alterBuild(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode = NULL) { parent::alterBuild($build, $entity, $display, $view_mode, $langcode); if ($entity->id()) { $build['#contextual_links']['node'] = array( diff --git a/core/modules/node/node.api.php b/core/modules/node/node.api.php index ee6e3fc563..d53673c0d8 100644 --- a/core/modules/node/node.api.php +++ b/core/modules/node/node.api.php @@ -788,7 +788,7 @@ function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$fo * * @param \Drupal\Core\Entity\EntityInterface $node * The node that is being assembled for rendering. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * node components. * @param string $view_mode @@ -801,7 +801,7 @@ function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$fo * * @ingroup node_api_hooks */ -function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) { +function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // node type in hook_field_extra_fields(). @@ -830,7 +830,7 @@ function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entit * A renderable array representing the node content. * @param \Drupal\Core\Entity\EntityInterface $node * The node being rendered. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * node components. * @@ -839,7 +839,7 @@ function hook_node_view(\Drupal\Core\Entity\EntityInterface $node, \Drupal\entit * * @ingroup node_api_hooks */ -function hook_node_view_alter(&$build, \Drupal\Core\Entity\EntityInterface $node, \Drupal\entity\Entity\EntityDisplay $display) { +function hook_node_view_alter(&$build, \Drupal\Core\Entity\EntityInterface $node, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. $build['an_additional_field']['#weight'] = -10; diff --git a/core/modules/node/node.module b/core/modules/node/node.module index 89f14faddd..a850c8ac84 100644 --- a/core/modules/node/node.module +++ b/core/modules/node/node.module @@ -14,14 +14,12 @@ use Drupal\Core\Cache\CacheBackendInterface; use Drupal\Core\Database\Query\AlterableInterface; use Drupal\Core\Database\Query\SelectInterface; -use Drupal\Core\Datetime\DrupalDateTime; use Drupal\node\NodeTypeInterface; use Drupal\Core\Entity\EntityInterface; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; +use Drupal\Core\Entity\Display\EntityFormDisplayInterface; use Drupal\Core\Template\Attribute; -use Drupal\entity\Entity\EntityDisplay; -use Drupal\entity\Entity\EntityFormDisplay; use Drupal\file\Entity\File; -use Drupal\user\UserInterface; /** * Denotes that the node is not published. @@ -194,7 +192,7 @@ function node_entity_bundle_info() { /** * Implements hook_entity_display_alter(). */ -function node_entity_display_alter(EntityDisplay $display, $context) { +function node_entity_display_alter(EntityViewDisplayInterface $display, $context) { if ($context['entity_type'] == 'node') { // Hide field labels in search index. if ($context['view_mode'] == 'search_index') { @@ -217,7 +215,7 @@ function node_entity_display_alter(EntityDisplay $display, $context) { /** * Implements hook_entity_form_display_alter(). */ -function node_entity_form_display_alter(EntityFormDisplay $form_display, $context) { +function node_entity_form_display_alter(EntityFormDisplayInterface $form_display, $context) { if ($context['entity_type'] == 'node') { // @todo Manage base field displays in the YAML: // https://drupal.org/node/2144919. diff --git a/core/modules/node/tests/modules/node_test/node_test.module b/core/modules/node/tests/modules/node_test/node_test.module index 1c067fc205..d999462db6 100644 --- a/core/modules/node/tests/modules/node_test/node_test.module +++ b/core/modules/node/tests/modules/node_test/node_test.module @@ -9,13 +9,13 @@ */ use Drupal\Core\Entity\EntityInterface; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\node\NodeInterface; /** * Implements hook_node_view(). */ -function node_test_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) { +function node_test_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { if ($view_mode == 'rss') { // Add RSS elements and namespaces when building the RSS feed. $node->rss_elements[] = array( diff --git a/core/modules/statistics/statistics.module b/core/modules/statistics/statistics.module index f0393bec1c..a5fad17c1b 100644 --- a/core/modules/statistics/statistics.module +++ b/core/modules/statistics/statistics.module @@ -6,8 +6,8 @@ */ use Drupal\Core\Entity\EntityInterface; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\node\NodeInterface; -use Drupal\entity\Entity\EntityDisplay; /** * Implements hook_help(). @@ -48,7 +48,7 @@ function statistics_permission() { /** * Implements hook_node_view(). */ -function statistics_node_view(EntityInterface $node, EntityDisplay $display, $view_mode) { +function statistics_node_view(EntityInterface $node, EntityViewDisplayInterface $display, $view_mode) { if (!$node->isNew() && $view_mode == 'full' && node_is_page($node) && empty($node->in_preview)) { $node->content['#attached']['library'][] = array('statistics', 'drupal.statistics'); $settings = array('data' => array('nid' => $node->id()), 'url' => url(drupal_get_path('module', 'statistics') . '/statistics.php')); diff --git a/core/modules/system/entity.api.php b/core/modules/system/entity.api.php index 3cf953526e..5b880cde90 100644 --- a/core/modules/system/entity.api.php +++ b/core/modules/system/entity.api.php @@ -436,7 +436,7 @@ function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity object. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * entity components. * @param $view_mode @@ -453,7 +453,7 @@ function hook_entity_query_alter(\Drupal\Core\Entity\Query\QueryInterface $query * @see hook_node_view() * @see hook_user_view() */ -function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) { +function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // entity bundle in hook_field_extra_fields(). @@ -482,7 +482,7 @@ function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\e * A renderable array representing the entity content. * @param \Drupal\Core\Entity\EntityInterface $entity * The entity object being rendered. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * entity components. * @@ -492,7 +492,7 @@ function hook_entity_view(\Drupal\Core\Entity\EntityInterface $entity, \Drupal\e * @see hook_taxonomy_term_view_alter() * @see hook_user_view_alter() */ -function hook_entity_view_alter(&$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\entity\Entity\EntityDisplay $display) { +function hook_entity_view_alter(&$build, Drupal\Core\Entity\EntityInterface $entity, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. $build['an_additional_field']['#weight'] = -10; @@ -561,7 +561,7 @@ function hook_entity_view_mode_alter(&$view_mode, Drupal\Core\Entity\EntityInter /** * Alters the settings used for displaying an entity. * - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object that will be used to display the entity * components. * @param array $context @@ -570,7 +570,7 @@ function hook_entity_view_mode_alter(&$view_mode, Drupal\Core\Entity\EntityInter * - bundle: The bundle, e.g., 'page' or 'article'. * - view_mode: The view mode, e.g. 'full', 'teaser'... */ -function hook_entity_display_alter(\Drupal\entity\Entity\EntityDisplay $display, array $context) { +function hook_entity_display_alter(\Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, array $context) { // Leave field labels out of the search index. if ($context['entity_type'] == 'node' && $context['view_mode'] == 'search_index') { foreach ($display->getComponents() as $name => $options) { @@ -610,7 +610,7 @@ function hook_entity_prepare_form(\Drupal\Core\Entity\EntityInterface $entity, $ /** * Alters the settings used for displaying an entity form. * - * @param \Drupal\entity\Entity\EntityFormDisplay $form_display + * @param \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display * The entity_form_display object that will be used to display the entity form * components. * @param array $context @@ -619,7 +619,7 @@ function hook_entity_prepare_form(\Drupal\Core\Entity\EntityInterface $entity, $ * - bundle: The bundle, e.g., 'page' or 'article'. * - form_mode: The form mode, e.g. 'default', 'profile', 'register'... */ -function hook_entity_form_display_alter(\Drupal\entity\Entity\EntityFormDisplay $form_display, array $context) { +function hook_entity_form_display_alter(\Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display, array $context) { // Hide the 'user_picture' field from the register form. if ($context['entity_type'] == 'user' && $context['form_mode'] == 'register') { $form_display->setComponent('user_picture', array( diff --git a/core/modules/taxonomy/lib/Drupal/taxonomy/TermViewBuilder.php b/core/modules/taxonomy/lib/Drupal/taxonomy/TermViewBuilder.php index af56597500..1d9d6c004e 100644 --- a/core/modules/taxonomy/lib/Drupal/taxonomy/TermViewBuilder.php +++ b/core/modules/taxonomy/lib/Drupal/taxonomy/TermViewBuilder.php @@ -7,9 +7,9 @@ namespace Drupal\taxonomy; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityViewBuilder; -use Drupal\entity\Entity\EntityDisplay; /** * Render controller for taxonomy terms. @@ -53,7 +53,7 @@ protected function getBuildDefaults(EntityInterface $entity, $view_mode, $langco /** * {@inheritdoc} */ - protected function alterBuild(array &$build, EntityInterface $entity, EntityDisplay $display, $view_mode, $langcode = NULL) { + protected function alterBuild(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode, $langcode = NULL) { parent::alterBuild($build, $entity, $display, $view_mode, $langcode); $build['#attached']['css'][] = drupal_get_path('module', 'taxonomy') . '/css/taxonomy.module.css'; $build['#contextual_links']['taxonomy_term'] = array( diff --git a/core/modules/taxonomy/taxonomy.api.php b/core/modules/taxonomy/taxonomy.api.php index 8de2d337ec..5ddc3c0641 100644 --- a/core/modules/taxonomy/taxonomy.api.php +++ b/core/modules/taxonomy/taxonomy.api.php @@ -249,7 +249,7 @@ function hook_taxonomy_term_delete(Drupal\taxonomy\Term $term) { * * @param \Drupal\taxonomy\Entity\Term $term * The term that is being assembled for rendering. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * term components. * @param $view_mode @@ -259,7 +259,7 @@ function hook_taxonomy_term_delete(Drupal\taxonomy\Term $term) { * * @see hook_entity_view() */ -function hook_taxonomy_term_view(\Drupal\taxonomy\Entity\Term $term, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) { +function hook_taxonomy_term_view(\Drupal\taxonomy\Entity\Term $term, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // vocabulary in hook_field_extra_fields(). @@ -288,13 +288,13 @@ function hook_taxonomy_term_view(\Drupal\taxonomy\Entity\Term $term, \Drupal\ent * A renderable array representing the taxonomy term content. * @param \Drupal\taxonomy\Entity\Term $term * The taxonomy term being rendered. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * term components. * * @see hook_entity_view_alter() */ -function hook_taxonomy_term_view_alter(&$build, \Drupal\taxonomy\Entity\Term $term, \Drupal\entity\Entity\EntityDisplay $display) { +function hook_taxonomy_term_view_alter(&$build, \Drupal\taxonomy\Entity\Term $term, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { if ($build['#view_mode'] == 'full' && isset($build['an_additional_field'])) { // Change its weight. $build['an_additional_field']['#weight'] = -10; diff --git a/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php b/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php index 72c0fe9769..9f986abbc1 100644 --- a/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php +++ b/core/modules/text/lib/Drupal/text/Tests/Formatter/TextPlainUnitTest.php @@ -9,7 +9,7 @@ use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Language\Language; -use Drupal\entity\Entity\EntityDisplay; +use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\simpletest\DrupalUnitTestBase; /** @@ -118,10 +118,10 @@ protected function createEntity($values = array()) { * * @param \Drupal\Core\Entity\EntityInterface $entity * The entity object with attached fields to render. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The display to render the fields in. */ - protected function renderEntityFields(EntityInterface $entity, EntityDisplay $display) { + protected function renderEntityFields(EntityInterface $entity, EntityViewDisplayInterface $display) { $content = field_attach_view($entity, $display); $this->content = drupal_render($content); return $this->content; diff --git a/core/modules/user/user.api.php b/core/modules/user/user.api.php index 6533c0e891..2d2fbd9a47 100644 --- a/core/modules/user/user.api.php +++ b/core/modules/user/user.api.php @@ -313,7 +313,7 @@ function hook_user_logout($account) { * * @param \Drupal\user\UserInterface $account * The user object on which the operation is being performed. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * user components. * @param $view_mode @@ -324,7 +324,7 @@ function hook_user_logout($account) { * @see hook_user_view_alter() * @see hook_entity_view() */ -function hook_user_view(\Drupal\user\UserInterface $account, \Drupal\entity\Entity\EntityDisplay $display, $view_mode, $langcode) { +function hook_user_view(\Drupal\user\UserInterface $account, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display, $view_mode, $langcode) { // Only do the extra work if the component is configured to be displayed. // This assumes a 'mymodule_addition' extra field has been defined for the // user entity type in hook_field_extra_fields(). @@ -353,14 +353,14 @@ function hook_user_view(\Drupal\user\UserInterface $account, \Drupal\entity\Enti * A renderable array representing the user. * @param \Drupal\user\UserInterface $account * The user account being rendered. - * @param \Drupal\entity\Entity\EntityDisplay $display + * @param \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display * The entity_display object holding the display options configured for the * user components. * * @see user_view() * @see hook_entity_view_alter() */ -function hook_user_view_alter(&$build, \Drupal\user\UserInterface $account, \Drupal\entity\Entity\EntityDisplay $display) { +function hook_user_view_alter(&$build, \Drupal\user\UserInterface $account, \Drupal\Core\Entity\Display\EntityViewDisplayInterface $display) { // Check for the existence of a field added by another module. if (isset($build['an_additional_field'])) { // Change its weight. diff --git a/core/modules/user/user.module b/core/modules/user/user.module index 14f71d3a43..6744e9ecae 100644 --- a/core/modules/user/user.module +++ b/core/modules/user/user.module @@ -3,7 +3,7 @@ use Drupal\Component\Utility\Crypt; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Session\AccountInterface; -use Drupal\entity\Entity\EntityDisplay; +use \Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\file\Entity\File; use Drupal\user\Entity\User; use Drupal\user\UserInterface; @@ -494,7 +494,7 @@ function user_permission() { /** * Implements hook_user_view(). */ -function user_user_view(UserInterface $account, EntityDisplay $display) { +function user_user_view(UserInterface $account, EntityViewDisplayInterface $display) { if ($display->getComponent('member_for')) { $account->content['member_for'] = array( '#type' => 'item', -- GitLab