' . t("View modes allow you to display and manipulate pieces of content (entities) on your site depending on their context. You're probably familiar with the default Drupal view modes 'full content' and 'teaser', and configuring field visibility, formatters, and template files for each. Any number of custom view modes can be created for each entity type through the view mode administration page, allowing for a very flexible system of configurable contextual display.") . '
'; + $output .= '' . t("@todo") . '
'; + $output .= '' . t("@todo") . '
'; + $output .= '' . t("@todo") . '
'; + $output .= '' . t("@todo") . '
'; + return $output; + + case 'admin/config/system/view-modes': + return '' . t("View modes allow entities to be displayed and manipulated depending on their context. A common example is configuring different field visibility, formatters, and template files for a content type's teaser and full content view modes.") . '
'; + + } +} + +/** + * Implements hook_permission(). + */ +function entity_ui_permission() { + return array( + 'administer view modes' => array( + 'title' => t('Add, edit and delete view modes.'), + ), + ); +} + +/** + * Implements hook_entity_info_alter(). + */ +function entity_ui_entity_info_alter(&$entity_info) { + // Add a list and form controller for the view mode entity type. + $entity_info['view_mode']['list controller class'] = 'Drupal\entity_ui\ViewModeListController'; + $entity_info['view_mode']['form controller class'] = array( + 'default' => 'Drupal\entity_ui\ViewModeFormController', + ); +} + +/** + * Implements hook_menu(). + */ +function entity_ui_menu() { + $items['admin/config/system/view-modes'] = array( + 'title' => 'View modes', + 'description' => 'Create and manage view modes for displaying content in different contexts.', + 'page callback' => 'entity_ui_view_mode_list', + 'access arguments' => array('administer view modes'), + 'file' => 'entity_ui.admin.inc', + ); + $items['admin/config/system/view-modes/add/%'] = array( + 'title' => 'Add view mode', + 'page callback' => 'entity_ui_view_mode_add', + 'page arguments' => array(5), + 'access arguments' => array('administer view modes'), + 'file' => 'entity_ui.admin.inc', + ); + $items['admin/config/system/view-modes/%view_mode/edit'] = array( + 'title' => 'Edit view mode', + 'page callback' => 'entity_get_form', + 'page arguments' => array(4), + 'access arguments' => array('administer view modes'), + ); + $items['admin/config/system/view-modes/%view_mode/delete'] = array( + 'title' => 'Delete view mode', + 'page callback' => 'drupal_get_form', + 'page arguments' => array('entity_ui_view_mode_delete_form', 4), + 'access arguments' => array('administer view modes'), + 'file' => 'entity_ui.admin.inc', + ); + + return $items; +} + +/** + * Loads a view mode by machine name. + */ +function view_mode_load($machine_name) { + return entity_load('view_mode', $machine_name); +} + +/** + * Checks for an existing view mode. + */ +function entity_ui_view_mode_exists($machine_name, $element) { + return entity_load('view_mode', $element['#entity_type'] . ".$machine_name"); +} + +/** + * Implements hook_view_mode_presave(). + */ +function entity_ui_view_mode_presave(EntityInterface $entity) { + entity_info_cache_clear(); + state()->set('menu_rebuild_needed', TRUE); +} + +/** + * Implements hook_view_mode_delete(). + */ +function entity_ui_view_mode_delete(EntityInterface $entity) { + entity_info_cache_clear(); + state()->set('menu_rebuild_needed', TRUE); +} diff --git a/core/modules/entity_ui/lib/Drupal/entity_ui/Tests/ViewModeTest.php b/core/modules/entity_ui/lib/Drupal/entity_ui/Tests/ViewModeTest.php new file mode 100644 index 0000000..5114d91 --- /dev/null +++ b/core/modules/entity_ui/lib/Drupal/entity_ui/Tests/ViewModeTest.php @@ -0,0 +1,78 @@ + 'View modes', + 'description' => 'Tests for managing view modes.', + 'group' => 'Entity UI', + ); + } + + function setUp() { + parent::setUp(); + + $this->drupalLogin($this->drupalCreateUser(array('administer content types', 'administer users', 'administer view modes', 'access administration pages'))); + $this->drupalCreateContentType(array('type' => 'article', 'name' => 'Article')); + } + + /** + * Tests managing view modes. + */ + function testManageViewModes() { + $edit = array( + 'name' => 'Testing', + 'machine_name' => 'testing', + ); + $this->drupalPost('admin/config/system/view-modes/add/node', $edit, t('Save')); + $this->assertText(format_string('Saved the !name view mode.', array('!name' => $edit['name']))); + + // Create the same and assert it already exists. + $this->drupalPost('admin/config/system/view-modes/add/node', $edit, t('Save')); + $this->assertText('The machine-readable name is already in use. It must be unique.', 'View mode testing already exists.'); + + // Assert it's found on the Field UI for article. + $this->drupalGet('admin/structure/types/manage/article/display'); + $this->assertRaw('view_modes_custom[testing]', 'Testing view mode found on node article.'); + + // Assert it's not found on the Field UI for user. + $this->drupalGet('admin/config/people/accounts/display'); + $this->assertNoRaw('view_modes_custom[testing]', 'Testing view mode not found on user.'); + + // Update view mode label. + $edit = array( + 'name' => 'Testing 2', + ); + $this->drupalPost('admin/config/system/view-modes/node.testing/edit', $edit, t('Save')); + $this->assertText('Saved the Testing 2 view mode.', 'Testing label updated.'); + + // Remove a view mode. + $this->drupalPost('admin/config/system/view-modes/node.testing/delete', array(), t('Delete')); + $this->assertText('Deleted the Testing 2 view mode', 'Deleted the Testing view mode.'); + + // Assert the view mode is gone at the manage display screen. + $this->drupalGet('admin/structure/types/manage/article/display'); + $this->assertNoRaw('view_modes_custom[testing]', 'Testing view mode not found on node article.'); + } + +} diff --git a/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeFormController.php b/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeFormController.php new file mode 100644 index 0000000..5fd192c --- /dev/null +++ b/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeFormController.php @@ -0,0 +1,99 @@ +type); + $form['type'] = array( + '#type' => 'item', + '#title' => t('Entity type'), + '#markup' => check_plain($entity_info['label']), + ); + $form['name'] = array( + '#type' => 'textfield', + '#title' => t('Name'), + '#default_value' => $view_mode->label(), + '#required' => TRUE, + ); + + $form['machine_name'] = array( + '#type' => 'machine_name', + '#machine_name' => array( + 'source' => array('name'), + 'exists' => 'entity_ui_view_mode_exists', + ), + '#entity_type' => $view_mode->type, + '#default_value' => $view_mode->name(), + '#disabled' => !$view_mode->isNew(), + '#field_prefix' => "$view_mode->type.", + ); + + return $form; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::actions(). + */ + protected function actions(array $form, array &$form_state) { + $view_mode = $this->getEntity($form_state); + $actions = parent::actions($form, $form_state); + $actions['delete']['#access'] = !$view_mode->locked; + return $actions; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::validate(). + */ + public function validate(array $form, array &$form_state) { + $entity = clone $this->getEntity($form_state); + form_set_value($form['machine_name'], $entity->type . '.' . $form_state['values']['machine_name'], $form_state); + parent::validate($form, $form_state); + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::save(). + * + * @todo Move this code to the base controller: http://drupal.org/node/1728786 + */ + public function save(array $form, array &$form_state) { + $view_mode = $this->getEntity($form_state); + $view_mode->save(); + drupal_set_message(t('Saved the %view-mode view mode.', array( + '%view-mode' => $view_mode->label(), + ))); + + $form_state['redirect'] = 'admin/config/system/view-modes'; + } + + /** + * Overrides Drupal\Core\Entity\EntityFormController::delete(). + * + * @todo Move this code to the base controller: http://drupal.org/node/1728786 + */ + public function delete(array $form, array &$form_state) { + $destination = array(); + if (isset($_GET['destination'])) { + $destination = drupal_get_destination(); + unset($_GET['destination']); + } + $view_mode = $this->getEntity($form_state); + $form_state['redirect'] = array('admin/config/system/view-modes/' . $view_mode->id() . '/delete', array('query' => $destination)); + } + +} diff --git a/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeListController.php b/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeListController.php new file mode 100644 index 0000000..f612d91 --- /dev/null +++ b/core/modules/entity_ui/lib/Drupal/entity_ui/ViewModeListController.php @@ -0,0 +1,86 @@ +type = entity_get_info($type); + $this->type['type'] = $type; + return $this; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::load(). + */ + public function load() { + $type = $this->type['type']; + return array_filter(parent::load(), function ($entity) use ($type) { + return $entity->type == $type; + }); + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::buildHeader(); + */ + public function buildHeader() { + $header['name'] = t('Name'); + $header['operations'] = t('Operations'); + return $header; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::buildRow(); + */ + public function buildRow(EntityInterface $view_mode) { + $row['name'] = check_plain($view_mode->label()); + $row['operations']['data'] = $this->buildOperations($view_mode); + $row['operations']['class'] = array('operations'); + return $row; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::getOperations(); + */ + public function getOperations(EntityInterface $view_mode) { + $operations = parent::getOperations($view_mode); + if ($view_mode->locked) { + unset($operations['delete']); + } + return $operations; + } + + /** + * Overrides Drupal\Core\Entity\EntityListController::buildRow(); + */ + public function render() { + $build = parent::render(); + $build['#rows']['_add_new'][] = array( + 'data' => array( + '#type' => 'link', + '#href' => 'admin/config/system/view-modes/add/' . $this->type['type'], + '#title' => t('Add new %type view mode', array('%type' => $this->type['label'])), + '#options' => array( + 'html' => TRUE, + ), + ), + 'colspan' => count($build['#header']), + ); + $build['#caption'] = check_plain($this->type['label']); + return $build; + } + +} diff --git a/core/modules/field_ui/field_ui.module b/core/modules/field_ui/field_ui.module index 0e92ef0..87c7a50 100644 --- a/core/modules/field_ui/field_ui.module +++ b/core/modules/field_ui/field_ui.module @@ -1,9 +1,12 @@ 'filename', 'uuid' => 'uuid', ), - 'view modes' => array( - 'full' => array( - 'label' => t('File default'), - 'custom settings' => FALSE, - ), - ), 'static cache' => FALSE, ), ); diff --git a/core/modules/node/config/view_mode.node.full.yml b/core/modules/node/config/view_mode.node.full.yml new file mode 100644 index 0000000..0e667c5 --- /dev/null +++ b/core/modules/node/config/view_mode.node.full.yml @@ -0,0 +1,5 @@ +machine_name: node.full +name: Full content +custom: '0' +type: node +locked: '1' diff --git a/core/modules/node/config/view_mode.node.rss.yml b/core/modules/node/config/view_mode.node.rss.yml new file mode 100644 index 0000000..7b36134 --- /dev/null +++ b/core/modules/node/config/view_mode.node.rss.yml @@ -0,0 +1,5 @@ +machine_name: node.rss +name: RSS +custom: '0' +type: node +locked: '1' diff --git a/core/modules/node/config/view_mode.node.teaser.yml b/core/modules/node/config/view_mode.node.teaser.yml new file mode 100644 index 0000000..63efd07 --- /dev/null +++ b/core/modules/node/config/view_mode.node.teaser.yml @@ -0,0 +1,5 @@ +machine_name: node.teaser +name: Teaser +custom: '1' +type: node +locked: '1' diff --git a/core/modules/node/node.module b/core/modules/node/node.module index 55989de..ae33873 100644 --- a/core/modules/node/node.module +++ b/core/modules/node/node.module @@ -218,20 +218,6 @@ function node_entity_info() { ), 'bundles' => array(), 'render controller class' => 'Drupal\node\NodeRenderController', - 'view modes' => array( - 'full' => array( - 'label' => t('Full content'), - 'custom settings' => FALSE, - ), - 'teaser' => array( - 'label' => t('Teaser'), - 'custom settings' => TRUE, - ), - 'rss' => array( - 'label' => t('RSS'), - 'custom settings' => FALSE, - ), - ), ), ); @@ -240,21 +226,6 @@ function node_entity_info() { $return['node']['translation']['node'] = TRUE; } - // Search integration is provided by node.module, so search-related - // view modes for nodes are defined here and not in search.module. - if (module_exists('search')) { - $return['node']['view modes'] += array( - 'search_index' => array( - 'label' => t('Search index'), - 'custom settings' => FALSE, - ), - 'search_result' => array( - 'label' => t('Search result'), - 'custom settings' => FALSE, - ), - ); - } - // Bundles must provide a human readable name so we can create help and error // messages, and the path to attach Field admin pages to. node_type_cache_reset(); diff --git a/core/modules/search/config/view_mode.node.search_index.yml b/core/modules/search/config/view_mode.node.search_index.yml new file mode 100644 index 0000000..0324aba --- /dev/null +++ b/core/modules/search/config/view_mode.node.search_index.yml @@ -0,0 +1,5 @@ +machine_name: node.search_index +name: Search index +custom: '0' +type: node +locked: '1' diff --git a/core/modules/search/config/view_mode.node.search_result.yml b/core/modules/search/config/view_mode.node.search_result.yml new file mode 100644 index 0000000..da28216 --- /dev/null +++ b/core/modules/search/config/view_mode.node.search_result.yml @@ -0,0 +1,5 @@ +machine_name: node.search_result +name: Search result +custom: '0' +type: node +locked: '1' diff --git a/core/modules/system/lib/Drupal/system/Tests/Upgrade/FilledStandardUpgradePathTest.php b/core/modules/system/lib/Drupal/system/Tests/Upgrade/FilledStandardUpgradePathTest.php index da4034b..654bea7 100644 --- a/core/modules/system/lib/Drupal/system/Tests/Upgrade/FilledStandardUpgradePathTest.php +++ b/core/modules/system/lib/Drupal/system/Tests/Upgrade/FilledStandardUpgradePathTest.php @@ -86,5 +86,13 @@ public function testFilledStandardUpgrade() { $blog_type = node_type_load('blog'); $this->assertEqual($blog_type->module, 'node', "Content type 'blog' has been reassigned from the blog module to the node module."); $this->assertEqual($blog_type->base, 'node_content', "The base string used to construct callbacks corresponding to content type 'Blog' has been reassigned to 'node_content'."); + + // Verify all core view modes have been converted to config. + $entity_info = entity_get_info(); + foreach ($entity_info as $type => $info) { + if (!empty($info['fieldable'])) { + $this->assertTrue(!empty($info['view modes']), format_string('View modes for @entity_type have been converted', array('@entity_type' => $info['label']))); + } + } } } diff --git a/core/modules/system/system.install b/core/modules/system/system.install index d0deae1..9f6c28a 100644 --- a/core/modules/system/system.install +++ b/core/modules/system/system.install @@ -2188,6 +2188,51 @@ function system_update_8030() { } /** + * Moves entity view modes to config. + * + * @ingroup config_upgrade + */ +function system_update_8031() { + // We can't call entity_info() in an update hook, so we hardcode them. + // We only care about the core view modes as hook_entity_info_alter() will + // still work since that was the only way to add custom view modes in D7. + $entity_view_modes = array( + 'node' => array( + 'full' => 'Full content', + 'teaser' => 'Teaser', + 'rss' => 'RSS', + 'search_index' => 'Search index', + 'search_result' => 'Search result', + 'print' => 'Print', + ), + 'file' => array( + 'full' => 'File default', + ), + 'comment' => array( + 'full' => 'Full comment', + ), + 'user' => array( + 'full' => 'User account', + ), + 'taxonomy_term' => array( + 'full' => 'Taxonomy term page', + ), + ); + + foreach ($entity_view_modes as $entity_type => $view_modes) { + foreach ($view_modes as $key => $name) { + config('view_mode.' . $entity_type . '.' . $key) + ->set('machine_name', $entity_type . '.' . $key) + ->set('name', $name) + ->set('type', $entity_type) + ->set('locked', TRUE) + ->set('custom', FALSE) + ->save(); + } + } +} + +/** * @} End of "defgroup updates-7.x-to-8.x". * The next series of updates should start at 9000. */ diff --git a/core/modules/system/system.module b/core/modules/system/system.module index ea3dadc..2a1809b 100644 --- a/core/modules/system/system.module +++ b/core/modules/system/system.module @@ -1079,6 +1079,30 @@ function system_menu() { } /** + * Implements hook_entity_info(). + */ +function system_entity_info() { + // This entity type is provided on behalf of the entity system. + // @todo Remove from system module after http://drupal.org/node/1763974. + $return = array( + 'view_mode' => array( + 'label' => t('View mode'), + 'entity class' => 'Drupal\Core\Entity\ViewMode\EntityViewMode', + 'controller class' => 'Drupal\Core\Config\Entity\ConfigStorageController', + 'config prefix' => 'view_mode', + 'fieldable' => FALSE, + 'entity keys' => array( + 'id' => 'machine_name', + 'label' => 'name', + 'uuid' => 'uuid', + ), + ), + ); + + return $return; +} + +/** * Page callback; Execute cron tasks. * * @see system_cron_access(). diff --git a/core/modules/taxonomy/config/view_mode.taxonomy_term.full.yml b/core/modules/taxonomy/config/view_mode.taxonomy_term.full.yml new file mode 100644 index 0000000..99dca2d --- /dev/null +++ b/core/modules/taxonomy/config/view_mode.taxonomy_term.full.yml @@ -0,0 +1,5 @@ +machine_name: taxonomy_term.full +name: Taxonomy term page +custom: '0' +type: taxonomy_term +locked: '1' diff --git a/core/modules/taxonomy/taxonomy.module b/core/modules/taxonomy/taxonomy.module index 874c78a..3d142b5 100644 --- a/core/modules/taxonomy/taxonomy.module +++ b/core/modules/taxonomy/taxonomy.module @@ -131,13 +131,6 @@ function taxonomy_entity_info() { ), 'bundles' => array(), 'render controller class' => 'Drupal\taxonomy\TermRenderController', - 'view modes' => array( - // @todo View mode for display as a field (when attached to nodes etc). - 'full' => array( - 'label' => t('Taxonomy term page'), - 'custom settings' => FALSE, - ), - ), ), ); foreach (taxonomy_vocabulary_get_names() as $machine_name => $vocabulary) { @@ -164,12 +157,6 @@ function taxonomy_entity_info() { 'label' => 'name', ), 'fieldable' => FALSE, - 'view modes' => array( - 'full' => array( - 'label' => t('Taxonomy vocabulary default'), - 'custom settings' => FALSE, - ), - ), ); return $return; diff --git a/core/modules/user/config/view_mode.user.full.yml b/core/modules/user/config/view_mode.user.full.yml new file mode 100644 index 0000000..283935e --- /dev/null +++ b/core/modules/user/config/view_mode.user.full.yml @@ -0,0 +1,5 @@ +machine_name: user.full +name: User account +custom: '0' +type: user +locked: '1' diff --git a/core/modules/user/user.module b/core/modules/user/user.module index c064427..454afd5 100644 --- a/core/modules/user/user.module +++ b/core/modules/user/user.module @@ -169,12 +169,6 @@ function user_entity_info() { ), ), 'render controller class' => 'Drupal\user\UserRenderController', - 'view modes' => array( - 'full' => array( - 'label' => t('User account'), - 'custom settings' => FALSE, - ), - ), ), ); } diff --git a/core/profiles/standard/standard.info b/core/profiles/standard/standard.info index 8b8a33b..28db9c6 100644 --- a/core/profiles/standard/standard.info +++ b/core/profiles/standard/standard.info @@ -22,3 +22,4 @@ dependencies[] = overlay dependencies[] = field_ui dependencies[] = file dependencies[] = rdf +dependencies[] = entity_ui