diff --git a/core/modules/rest/rest.post_update.php b/core/modules/rest/rest.post_update.php index 6d45178804..1975b8ead0 100644 --- a/core/modules/rest/rest.post_update.php +++ b/core/modules/rest/rest.post_update.php @@ -61,3 +61,9 @@ function rest_post_update_resource_granularity() { } } } + +/** + * Empty post-update hook to force a rebuild. + */ +function rest_post_update_enable_menus() { +} diff --git a/core/modules/rest/src/Plugin/views/display/RestExport.php b/core/modules/rest/src/Plugin/views/display/RestExport.php index 52daee05f0..cae15f7918 100644 --- a/core/modules/rest/src/Plugin/views/display/RestExport.php +++ b/core/modules/rest/src/Plugin/views/display/RestExport.php @@ -4,6 +4,7 @@ use Drupal\Core\Cache\CacheableMetadata; use Drupal\Core\Cache\CacheableResponse; +use Drupal\Core\Entity\EntityStorageInterface; use Drupal\Core\Form\FormStateInterface; use Drupal\Core\Render\RenderContext; use Drupal\Core\Render\RendererInterface; @@ -26,6 +27,7 @@ * id = "rest_export", * title = @Translation("REST export"), * help = @Translation("Create a REST export resource."), + * uses_menu_links = TRUE, * uses_route = TRUE, * admin = @Translation("REST export"), * returns_response = TRUE @@ -116,6 +118,13 @@ class RestExport extends PathPluginBase implements ResponseDisplayPluginInterfac */ protected $formatProviders; + /** + * The menu storage. + * + * @var \Drupal\Core\Entity\EntityStorageInterface + */ + protected $menuStorage; + /** * Constructs a RestExport object. * @@ -135,8 +144,10 @@ class RestExport extends PathPluginBase implements ResponseDisplayPluginInterfac * The authentication providers, keyed by ID. * @param string[] $serializer_format_providers * The serialization format providers, keyed by format. + * @param \Drupal\Core\Entity\EntityStorageInterface $menu_storage + * The menu storage. */ - public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state, RendererInterface $renderer, array $authentication_providers, array $serializer_format_providers) { + public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteProviderInterface $route_provider, StateInterface $state, RendererInterface $renderer, array $authentication_providers, array $serializer_format_providers, EntityStorageInterface $menu_storage) { parent::__construct($configuration, $plugin_id, $plugin_definition, $route_provider, $state); $this->renderer = $renderer; @@ -149,6 +160,7 @@ public function __construct(array $configuration, $plugin_id, $plugin_definition // For BC reasons we keep around authenticationProviders as before. $this->authenticationProviders = $authentication_providers; $this->formatProviders = $serializer_format_providers; + $this->menuStorage = $menu_storage; } /** @@ -163,7 +175,8 @@ public static function create(ContainerInterface $container, array $configuratio $container->get('state'), $container->get('renderer'), $container->getParameter('authentication_providers'), - $container->getParameter('serializer.format_providers') + $container->getParameter('serializer.format_providers'), + $container->get('entity.manager')->getStorage('menu') ); } /** @@ -316,6 +329,8 @@ public function optionsSummary(&$categories, &$options) { 'value' => views_ui_truncate($auth, 24), ]; + $options['menu']['category'] = 'path'; + // Remove css/exposed form settings, as they are not used for the data // display. unset($options['exposed_form']); @@ -360,21 +375,11 @@ public function collectRoutes(RouteCollection $collection) { $display_id = $this->display['id']; if ($route = $collection->get("view.$view_id.$display_id")) { - $style_plugin = $this->getPlugin('style'); - // REST exports should only respond to GET methods. $route->setMethods(['GET']); - $formats = $style_plugin->getFormats(); - - // If there are no configured formats, add all formats that serialization - // is known to support. - if (!$formats) { - $formats = $this->getFormatOptions(); - } - // Format as a string using pipes as a delimiter. - $route->setRequirement('_format', implode('|', $formats)); + $route->setRequirement('_format', implode('|', $this->getFormats())); // Add authentication to the route if it was set. If no authentication was // set, the default authentication will be used, which is cookie based by @@ -504,6 +509,11 @@ public function calculateDependencies() { : NULL; }, $this->getOption('auth')))); + $menu = $this->getOption('menu'); + if ($menu['type'] === 'normal' && ($menu_entity = $this->menuStorage->load($menu['menu_name']))) { + $dependencies[$menu_entity->getConfigDependencyKey()][] = $menu_entity->getConfigDependencyName(); + } + return $dependencies; } @@ -518,4 +528,45 @@ protected function getFormatOptions() { return array_combine($formats, $formats); } + /** + * {@inheritdoc} + */ + protected function getRoute($view_id, $display_id) { + $route = parent::getRoute($view_id, $display_id); + + $route->setRequirement('_format', implode('|', $this->getFormats())); + + return $route; + } + + /** + * Returns the list of formats provided by this display. + * + * @return string[] + * An array of format ids. + */ + protected function getFormats() { + $style_plugin = $this->getPlugin('style'); + + $formats = $style_plugin->getFormats(); + + // If there are no configured formats, add all formats that serialization + // is known to support. + if (!$formats) { + $formats = $this->getFormatOptions(); + } + + return $formats; + } + + /** + * {@inheritdoc} + */ + public function getPath() { + $path = parent::getPath(); + $formats = $this->getFormats(); + + return $path . '?_format=' . reset($formats); + } + } diff --git a/core/modules/rest/tests/modules/rest_test_views/test_views/views.view.test_rest_display_menu.yml b/core/modules/rest/tests/modules/rest_test_views/test_views/views.view.test_rest_display_menu.yml new file mode 100644 index 0000000000..bbceddff5c --- /dev/null +++ b/core/modules/rest/tests/modules/rest_test_views/test_views/views.view.test_rest_display_menu.yml @@ -0,0 +1,231 @@ +langcode: en +status: true +dependencies: + config: + - system.menu.main + module: + - node + - rest + - serialization + - user +id: test_rest_display_menu +label: 'REST Display Menu Test' +module: views +description: '' +tag: '' +base_table: node_field_data +base_field: nid +core: 8.x +display: + default: + display_plugin: default + id: default + display_title: Master + position: 0 + display_options: + access: + type: perm + options: + perm: 'access content' + cache: + type: tag + options: { } + query: + type: views_query + options: + disable_sql_rewrite: false + distinct: false + replica: false + query_comment: '' + query_tags: { } + exposed_form: + type: basic + options: + submit_button: Apply + reset_button: false + reset_button_label: Reset + exposed_sorts_label: 'Sort by' + expose_sort_order: true + sort_asc_label: Asc + sort_desc_label: Desc + pager: + type: mini + options: + items_per_page: 10 + offset: 0 + id: 0 + total_pages: null + expose: + items_per_page: false + items_per_page_label: 'Items per page' + items_per_page_options: '5, 10, 25, 50' + items_per_page_options_all: false + items_per_page_options_all_label: '- All -' + offset: false + offset_label: Offset + tags: + previous: ‹‹ + next: ›› + style: + type: default + options: + grouping: { } + row_class: '' + default_row_class: true + uses_fields: false + row: + type: fields + options: + inline: { } + separator: '' + hide_empty: false + default_field_elements: true + fields: + title: + id: title + table: node_field_data + field: title + entity_type: node + entity_field: title + label: '' + alter: + alter_text: false + make_link: false + absolute: false + trim: false + word_boundary: false + ellipsis: false + strip_tags: false + html: false + hide_empty: false + empty_zero: false + settings: + link_to_entity: true + plugin_id: field + relationship: none + group_type: group + admin_label: '' + exclude: false + element_type: '' + element_class: '' + element_label_type: '' + element_label_class: '' + element_label_colon: true + element_wrapper_type: '' + element_wrapper_class: '' + element_default_classes: true + empty: '' + hide_alter_empty: true + click_sort_column: value + type: string + group_column: value + group_columns: { } + group_rows: true + delta_limit: 0 + delta_offset: 0 + delta_reversed: false + delta_first_last: false + multi_type: separator + separator: ', ' + field_api_classes: false + filters: + status: + value: '1' + table: node_field_data + field: status + plugin_id: boolean + entity_type: node + entity_field: status + id: status + expose: + operator: '' + group: 1 + sorts: + created: + id: created + table: node_field_data + field: created + order: DESC + entity_type: node + entity_field: created + plugin_id: date + relationship: none + group_type: group + admin_label: '' + exposed: false + expose: + label: '' + granularity: second + header: { } + footer: { } + empty: { } + relationships: { } + arguments: { } + display_extenders: { } + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url.query_args + - 'user.node_grants:view' + - user.permissions + tags: { } + page_1: + display_plugin: page + id: page_1 + display_title: Page + position: 1 + display_options: + display_extenders: { } + path: test-view/rest-menu/page + menu: + type: normal + title: Page + description: '' + expanded: false + parent: '' + weight: 0 + context: '0' + menu_name: main + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url.query_args + - 'user.node_grants:view' + - user.permissions + tags: { } + rest_export_1: + display_plugin: rest_export + id: rest_export_1 + display_title: 'REST export' + position: 2 + display_options: + display_extenders: { } + path: test-view/rest-menu/json + menu: + type: normal + title: JSON + description: '' + expanded: false + parent: '' + weight: 1 + context: '0' + menu_name: main + style: + type: serializer + options: + uses_fields: false + formats: + json: json + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - request_format + - 'user.node_grants:view' + - user.permissions + tags: { } diff --git a/core/modules/rest/tests/src/Functional/Views/RestDisplayMenuTest.php b/core/modules/rest/tests/src/Functional/Views/RestDisplayMenuTest.php new file mode 100644 index 0000000000..301893d1d5 --- /dev/null +++ b/core/modules/rest/tests/src/Functional/Views/RestDisplayMenuTest.php @@ -0,0 +1,64 @@ +drupalLogin($this->drupalCreateUser(['access content', 'administer views'])); + + $this->drupalPlaceBlock('system_menu_block:main', [ + 'id' => 'test_menu', + ]); + } + + /** + * + */ + public function testRestMenuOption() { + $this->drupalGet('admin/structure/views'); + $this->assertSession()->statusCodeEquals(200); + + $this->drupalGet('admin/structure/views/view/test_rest_display_menu/edit/page_1'); + $this->assertSession()->statusCodeEquals(200); + $this->assertSession()->linkByHrefExists('admin/structure/views/nojs/display/test_rest_display_menu/page_1/menu'); + + $this->drupalGet('admin/structure/views/view/test_rest_display_menu/edit/rest_export_1'); + $this->assertSession()->statusCodeEquals(200); + $this->assertSession()->linkByHrefExists('admin/structure/views/nojs/display/test_rest_display_menu/rest_export_1/menu'); + + $this->drupalGet(''); + $this->assertSession()->statusCodeEquals(200); + $this->assertSession()->linkExists('Page'); + $this->assertSession()->linkByHrefExists('test-view/rest-menu/page'); + $this->assertSession()->linkExists('JSON'); + $this->assertSession()->linkByHrefExists('test-view/rest-menu/json?_format=json'); + } + +} diff --git a/core/modules/rest/tests/src/Unit/CollectRoutesTest.php b/core/modules/rest/tests/src/Unit/CollectRoutesTest.php index e171e047c8..3ef46d2fbb 100644 --- a/core/modules/rest/tests/src/Unit/CollectRoutesTest.php +++ b/core/modules/rest/tests/src/Unit/CollectRoutesTest.php @@ -86,6 +86,12 @@ protected function setUp() { $container->setParameter('serializer.format_providers', ['json']); + $entity_manager = $this->getMock('\Drupal\Core\Entity\EntityManagerInterface'); + $container->set('entity.manager', $entity_manager); + $entity_manager->expects($this->any()) + ->method('getStorage') + ->will($this->returnValue($this->getMock('\Drupal\Core\Entity\EntityStorageInterface'))); + \Drupal::setContainer($container); $this->restExport = RestExport::create($container, [], "test_routes", []); diff --git a/core/modules/views/config/schema/views.display.schema.yml b/core/modules/views/config/schema/views.display.schema.yml index 3e696143f1..5eba421c2b 100644 --- a/core/modules/views/config/schema/views.display.schema.yml +++ b/core/modules/views/config/schema/views.display.schema.yml @@ -13,11 +13,6 @@ views_display_path: route_name: type: string label: 'Route name' - -views.display.page: - type: views_display_path - label: 'Page display options' - mapping: menu: type: mapping label: 'Menu' @@ -69,6 +64,10 @@ views.display.page: type: string label: 'Menu name' +views.display.page: + type: views_display_path + label: 'Page display options' + views.display.block: type: views_display label: 'Block display options' diff --git a/core/modules/views/src/Plugin/views/display/Page.php b/core/modules/views/src/Plugin/views/display/Page.php index baf1434449..7f4a3b2bcc 100644 --- a/core/modules/views/src/Plugin/views/display/Page.php +++ b/core/modules/views/src/Plugin/views/display/Page.php @@ -4,7 +4,6 @@ use Drupal\Component\Utility\Xss; use Drupal\Core\Entity\EntityStorageInterface; -use Drupal\Core\Form\FormStateInterface; use Drupal\Core\State\StateInterface; use Drupal\Core\Routing\RouteProviderInterface; use Symfony\Component\DependencyInjection\ContainerInterface; @@ -124,37 +123,6 @@ public static function &getPageRenderArray() { return static::$pageRenderArray; } - /** - * {@inheritdoc} - */ - protected function defineOptions() { - $options = parent::defineOptions(); - - $options['menu'] = [ - 'contains' => [ - 'type' => ['default' => 'none'], - 'title' => ['default' => ''], - 'description' => ['default' => ''], - 'weight' => ['default' => 0], - 'enabled' => ['default' => TRUE], - 'menu_name' => ['default' => 'main'], - 'parent' => ['default' => ''], - 'context' => ['default' => ''], - 'expanded' => ['default' => FALSE], - ], - ]; - $options['tab_options'] = [ - 'contains' => [ - 'type' => ['default' => 'none'], - 'title' => ['default' => ''], - 'description' => ['default' => ''], - 'weight' => ['default' => 0], - ], - ]; - - return $options; - } - /** * {@inheritdoc} */ @@ -194,327 +162,6 @@ public function execute() { return $render; } - /** - * {@inheritdoc} - */ - public function optionsSummary(&$categories, &$options) { - parent::optionsSummary($categories, $options); - - $menu = $this->getOption('menu'); - if (!is_array($menu)) { - $menu = ['type' => 'none']; - } - switch ($menu['type']) { - case 'none': - default: - $menu_str = $this->t('No menu'); - break; - case 'normal': - $menu_str = $this->t('Normal: @title', ['@title' => $menu['title']]); - break; - case 'tab': - case 'default tab': - $menu_str = $this->t('Tab: @title', ['@title' => $menu['title']]); - break; - } - - $options['menu'] = [ - 'category' => 'page', - 'title' => $this->t('Menu'), - 'value' => views_ui_truncate($menu_str, 24), - ]; - - // This adds a 'Settings' link to the style_options setting if the style - // has options. - if ($menu['type'] == 'default tab') { - $options['menu']['setting'] = $this->t('Parent menu item'); - $options['menu']['links']['tab_options'] = $this->t('Change settings for the parent menu'); - } - } - - /** - * {@inheritdoc} - */ - public function buildOptionsForm(&$form, FormStateInterface $form_state) { - parent::buildOptionsForm($form, $form_state); - - switch ($form_state->get('section')) { - case 'menu': - $form['#title'] .= $this->t('Menu item entry'); - $form['menu'] = [ - '#prefix' => '
', - '#suffix' => '
', - '#tree' => TRUE, - ]; - $menu = $this->getOption('menu'); - if (empty($menu)) { - $menu = ['type' => 'none', 'title' => '', 'weight' => 0, 'expanded' => FALSE]; - } - $form['menu']['type'] = [ - '#prefix' => '
', - '#suffix' => '
', - '#title' => $this->t('Type'), - '#type' => 'radios', - '#options' => [ - 'none' => $this->t('No menu entry'), - 'normal' => $this->t('Normal menu entry'), - 'tab' => $this->t('Menu tab'), - 'default tab' => $this->t('Default menu tab') - ], - '#default_value' => $menu['type'], - ]; - - $form['menu']['title'] = [ - '#prefix' => '
', - '#title' => $this->t('Menu link title'), - '#type' => 'textfield', - '#default_value' => $menu['title'], - '#states' => [ - 'visible' => [ - [ - ':input[name="menu[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'tab'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'default tab'], - ], - ], - ], - ]; - $form['menu']['description'] = [ - '#title' => $this->t('Description'), - '#type' => 'textfield', - '#default_value' => $menu['description'], - '#description' => $this->t("Shown when hovering over the menu link."), - '#states' => [ - 'visible' => [ - [ - ':input[name="menu[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'tab'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'default tab'], - ], - ], - ], - ]; - $form['menu']['expanded'] = [ - '#title' => $this->t('Show as expanded'), - '#type' => 'checkbox', - '#default_value' => !empty($menu['expanded']), - '#description' => $this->t('If selected and this menu link has children, the menu will always appear expanded.'), - ]; - - // Only display the parent selector if Menu UI module is enabled. - $menu_parent = $menu['menu_name'] . ':' . $menu['parent']; - if (\Drupal::moduleHandler()->moduleExists('menu_ui')) { - $menu_link = 'views_view:views.' . $form_state->get('view')->id() . '.' . $form_state->get('display_id'); - $form['menu']['parent'] = \Drupal::service('menu.parent_form_selector')->parentSelectElement($menu_parent, $menu_link); - $form['menu']['parent'] += [ - '#title' => $this->t('Parent'), - '#description' => $this->t('The maximum depth for a link and all its children is fixed. Some menu links may not be available as parents if selecting them would exceed this limit.'), - '#attributes' => ['class' => ['menu-title-select']], - '#states' => [ - 'visible' => [ - [ - ':input[name="menu[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'tab'], - ], - ], - ], - ]; - } - else { - $form['menu']['parent'] = [ - '#type' => 'value', - '#value' => $menu_parent, - ]; - $form['menu']['markup'] = [ - '#markup' => $this->t('Menu selection requires the activation of Menu UI module.'), - ]; - } - $form['menu']['weight'] = [ - '#title' => $this->t('Weight'), - '#type' => 'textfield', - '#default_value' => isset($menu['weight']) ? $menu['weight'] : 0, - '#description' => $this->t('In the menu, the heavier links will sink and the lighter links will be positioned nearer the top.'), - '#states' => [ - 'visible' => [ - [ - ':input[name="menu[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'tab'], - ], - [ - ':input[name="menu[type]"]' => ['value' => 'default tab'], - ], - ], - ], - ]; - $form['menu']['context'] = [ - '#title' => $this->t('Context'), - '#suffix' => '
', - '#type' => 'checkbox', - '#default_value' => !empty($menu['context']), - '#description' => $this->t('Displays the link in contextual links'), - '#states' => [ - 'visible' => [ - ':input[name="menu[type]"]' => ['value' => 'tab'], - ], - ], - ]; - break; - case 'tab_options': - $form['#title'] .= $this->t('Default tab options'); - $tab_options = $this->getOption('tab_options'); - if (empty($tab_options)) { - $tab_options = ['type' => 'none', 'title' => '', 'weight' => 0]; - } - - $form['tab_markup'] = [ - '#markup' => '
' . $this->t('When providing a menu item as a tab, Drupal needs to know what the parent menu item of that tab will be. Sometimes the parent will already exist, but other times you will need to have one created. The path of a parent item will always be the same path with the last part left off. i.e, if the path to this view is foo/bar/baz, the parent path would be foo/bar.') . '
', - ]; - - $form['tab_options'] = [ - '#prefix' => '
', - '#suffix' => '
', - '#tree' => TRUE, - ]; - $form['tab_options']['type'] = [ - '#prefix' => '
', - '#suffix' => '
', - '#title' => $this->t('Parent menu item'), - '#type' => 'radios', - '#options' => ['none' => $this->t('Already exists'), 'normal' => $this->t('Normal menu item'), 'tab' => $this->t('Menu tab')], - '#default_value' => $tab_options['type'], - ]; - $form['tab_options']['title'] = [ - '#prefix' => '
', - '#title' => $this->t('Title'), - '#type' => 'textfield', - '#default_value' => $tab_options['title'], - '#description' => $this->t('If creating a parent menu item, enter the title of the item.'), - '#states' => [ - 'visible' => [ - [ - ':input[name="tab_options[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="tab_options[type]"]' => ['value' => 'tab'], - ], - ], - ], - ]; - $form['tab_options']['description'] = [ - '#title' => $this->t('Description'), - '#type' => 'textfield', - '#default_value' => $tab_options['description'], - '#description' => $this->t('If creating a parent menu item, enter the description of the item.'), - '#states' => [ - 'visible' => [ - [ - ':input[name="tab_options[type]"]' => ['value' => 'normal'], - ], - [ - ':input[name="tab_options[type]"]' => ['value' => 'tab'], - ], - ], - ], - ]; - $form['tab_options']['weight'] = [ - '#suffix' => '
', - '#title' => $this->t('Tab weight'), - '#type' => 'textfield', - '#default_value' => $tab_options['weight'], - '#size' => 5, - '#description' => $this->t('If the parent menu item is a tab, enter the weight of the tab. Heavier tabs will sink and the lighter tabs will be positioned nearer to the first menu item.'), - '#states' => [ - 'visible' => [ - ':input[name="tab_options[type]"]' => ['value' => 'tab'], - ], - ], - ]; - break; - } - } - - /** - * {@inheritdoc} - */ - public function validateOptionsForm(&$form, FormStateInterface $form_state) { - parent::validateOptionsForm($form, $form_state); - - if ($form_state->get('section') == 'menu') { - $path = $this->getOption('path'); - $menu_type = $form_state->getValue(['menu', 'type']); - if ($menu_type == 'normal' && strpos($path, '%') !== FALSE) { - $form_state->setError($form['menu']['type'], $this->t('Views cannot create normal menu items for paths with a % in them.')); - } - - if ($menu_type == 'default tab' || $menu_type == 'tab') { - $bits = explode('/', $path); - $last = array_pop($bits); - if ($last == '%') { - $form_state->setError($form['menu']['type'], $this->t('A display whose path ends with a % cannot be a tab.')); - } - } - - if ($menu_type != 'none' && $form_state->isValueEmpty(['menu', 'title'])) { - $form_state->setError($form['menu']['title'], $this->t('Title is required for this menu type.')); - } - } - } - - /** - * {@inheritdoc} - */ - public function submitOptionsForm(&$form, FormStateInterface $form_state) { - parent::submitOptionsForm($form, $form_state); - - switch ($form_state->get('section')) { - case 'menu': - $menu = $form_state->getValue('menu'); - list($menu['menu_name'], $menu['parent']) = explode(':', $menu['parent'], 2); - $this->setOption('menu', $menu); - // send ajax form to options page if we use it. - if ($form_state->getValue(['menu', 'type']) == 'default tab') { - $form_state->get('view')->addFormToStack('display', $this->display['id'], 'tab_options'); - } - break; - case 'tab_options': - $this->setOption('tab_options', $form_state->getValue('tab_options')); - break; - } - } - - /** - * {@inheritdoc} - */ - public function validate() { - $errors = parent::validate(); - - $menu = $this->getOption('menu'); - if (!empty($menu['type']) && $menu['type'] != 'none' && empty($menu['title'])) { - $errors[] = $this->t('Display @display is set to use a menu but the menu link text is not set.', ['@display' => $this->display['display_title']]); - } - - if ($menu['type'] == 'default tab') { - $tab_options = $this->getOption('tab_options'); - if (!empty($tab_options['type']) && $tab_options['type'] != 'none' && empty($tab_options['title'])) { - $errors[] = $this->t('Display @display is set to use a parent menu but the parent menu link text is not set.', ['@display' => $this->display['display_title']]); - } - } - - return $errors; - } - /** * {@inheritdoc} */ diff --git a/core/modules/views/src/Plugin/views/display/PathPluginBase.php b/core/modules/views/src/Plugin/views/display/PathPluginBase.php index 17d8663ed1..4193f7d298 100644 --- a/core/modules/views/src/Plugin/views/display/PathPluginBase.php +++ b/core/modules/views/src/Plugin/views/display/PathPluginBase.php @@ -111,6 +111,27 @@ protected function defineOptions() { $options = parent::defineOptions(); $options['path'] = ['default' => '']; $options['route_name'] = ['default' => '']; + $options['menu'] = [ + 'contains' => [ + 'type' => ['default' => 'none'], + 'title' => ['default' => ''], + 'description' => ['default' => ''], + 'weight' => ['default' => 0], + 'enabled' => ['default' => TRUE], + 'menu_name' => ['default' => 'main'], + 'parent' => ['default' => ''], + 'context' => ['default' => ''], + 'expanded' => ['default' => FALSE], + ], + ]; + $options['tab_options'] = [ + 'contains' => [ + 'type' => ['default' => 'none'], + 'title' => ['default' => ''], + 'description' => ['default' => ''], + 'weight' => ['default' => 0], + ], + ]; return $options; } @@ -426,6 +447,68 @@ public function optionsSummary(&$categories, &$options) { 'title' => $this->t('Path'), 'value' => views_ui_truncate($path, 24), ]; + + $menu = $this->getOption('menu'); + if (!is_array($menu)) { + $menu = ['type' => 'none']; + } + switch ($menu['type']) { + case 'none': + default: + $menu_str = $this->t('No menu'); + break; + case 'normal': + $menu_str = $this->t('Normal: @title', ['@title' => $menu['title']]); + break; + case 'tab': + case 'default tab': + $menu_str = $this->t('Tab: @title', ['@title' => $menu['title']]); + break; + } + + $options['menu'] = [ + 'category' => 'page', + 'title' => $this->t('Menu'), + 'value' => views_ui_truncate($menu_str, 24), + ]; + + // This adds a 'Settings' link to the style_options setting if the style + // has options. + if ($menu['type'] == 'default tab') { + $options['menu']['setting'] = $this->t('Parent menu item'); + $options['menu']['links']['tab_options'] = $this->t('Change settings for the parent menu'); + } + + $menu = $this->getOption('menu'); + if (!is_array($menu)) { + $menu = ['type' => 'none']; + } + switch ($menu['type']) { + case 'none': + default: + $menu_str = $this->t('No menu'); + break; + case 'normal': + $menu_str = $this->t('Normal: @title', ['@title' => $menu['title']]); + break; + case 'tab': + case 'default tab': + $menu_str = $this->t('Tab: @title', ['@title' => $menu['title']]); + break; + } + + $options['menu'] = [ + 'category' => 'page', + 'title' => $this->t('Menu'), + 'value' => views_ui_truncate($menu_str, 24), + ]; + + // This adds a 'Settings' link to the style_options setting if the style + // has options. + if ($menu['type'] == 'default tab') { + $options['menu']['setting'] = $this->t('Parent menu item'); + $options['menu']['links']['tab_options'] = $this->t('Change settings for the parent menu'); + } } /** @@ -449,6 +532,209 @@ public function buildOptionsForm(&$form, FormStateInterface $form_state) { '#maxlength' => 254, ]; break; + case 'menu': + $form['#title'] .= $this->t('Menu item entry'); + $form['menu'] = [ + '#prefix' => '
', + '#suffix' => '
', + '#tree' => TRUE, + ]; + $menu = $this->getOption('menu'); + if (empty($menu)) { + $menu = ['type' => 'none', 'title' => '', 'weight' => 0, 'expanded' => FALSE]; + } + $form['menu']['type'] = [ + '#prefix' => '
', + '#suffix' => '
', + '#title' => $this->t('Type'), + '#type' => 'radios', + '#options' => [ + 'none' => $this->t('No menu entry'), + 'normal' => $this->t('Normal menu entry'), + 'tab' => $this->t('Menu tab'), + 'default tab' => $this->t('Default menu tab') + ], + '#default_value' => $menu['type'], + ]; + + $form['menu']['title'] = [ + '#prefix' => '
', + '#title' => $this->t('Menu link title'), + '#type' => 'textfield', + '#default_value' => $menu['title'], + '#states' => [ + 'visible' => [ + [ + ':input[name="menu[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'tab'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'default tab'], + ], + ], + ], + ]; + $form['menu']['description'] = [ + '#title' => $this->t('Description'), + '#type' => 'textfield', + '#default_value' => $menu['description'], + '#description' => $this->t("Shown when hovering over the menu link."), + '#states' => [ + 'visible' => [ + [ + ':input[name="menu[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'tab'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'default tab'], + ], + ], + ], + ]; + $form['menu']['expanded'] = [ + '#title' => $this->t('Show as expanded'), + '#type' => 'checkbox', + '#default_value' => !empty($menu['expanded']), + '#description' => $this->t('If selected and this menu link has children, the menu will always appear expanded.'), + ]; + + // Only display the parent selector if Menu UI module is enabled. + $menu_parent = $menu['menu_name'] . ':' . $menu['parent']; + if (\Drupal::moduleHandler()->moduleExists('menu_ui')) { + $menu_link = 'views_view:views.' . $form_state->get('view')->id() . '.' . $form_state->get('display_id'); + $form['menu']['parent'] = \Drupal::service('menu.parent_form_selector')->parentSelectElement($menu_parent, $menu_link); + $form['menu']['parent'] += [ + '#title' => $this->t('Parent'), + '#description' => $this->t('The maximum depth for a link and all its children is fixed. Some menu links may not be available as parents if selecting them would exceed this limit.'), + '#attributes' => ['class' => ['menu-title-select']], + '#states' => [ + 'visible' => [ + [ + ':input[name="menu[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'tab'], + ], + ], + ], + ]; + } + else { + $form['menu']['parent'] = [ + '#type' => 'value', + '#value' => $menu_parent, + ]; + $form['menu']['markup'] = [ + '#markup' => $this->t('Menu selection requires the activation of Menu UI module.'), + ]; + } + $form['menu']['weight'] = [ + '#title' => $this->t('Weight'), + '#type' => 'textfield', + '#default_value' => isset($menu['weight']) ? $menu['weight'] : 0, + '#description' => $this->t('In the menu, the heavier links will sink and the lighter links will be positioned nearer the top.'), + '#states' => [ + 'visible' => [ + [ + ':input[name="menu[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'tab'], + ], + [ + ':input[name="menu[type]"]' => ['value' => 'default tab'], + ], + ], + ], + ]; + $form['menu']['context'] = [ + '#title' => $this->t('Context'), + '#suffix' => '
', + '#type' => 'checkbox', + '#default_value' => !empty($menu['context']), + '#description' => $this->t('Displays the link in contextual links'), + '#states' => [ + 'visible' => [ + ':input[name="menu[type]"]' => ['value' => 'tab'], + ], + ], + ]; + break; + case 'tab_options': + $form['#title'] .= $this->t('Default tab options'); + $tab_options = $this->getOption('tab_options'); + if (empty($tab_options)) { + $tab_options = ['type' => 'none', 'title' => '', 'weight' => 0]; + } + + $form['tab_markup'] = [ + '#markup' => '
' . $this->t('When providing a menu item as a tab, Drupal needs to know what the parent menu item of that tab will be. Sometimes the parent will already exist, but other times you will need to have one created. The path of a parent item will always be the same path with the last part left off. i.e, if the path to this view is foo/bar/baz, the parent path would be foo/bar.') . '
', + ]; + + $form['tab_options'] = [ + '#prefix' => '
', + '#suffix' => '
', + '#tree' => TRUE, + ]; + $form['tab_options']['type'] = [ + '#prefix' => '
', + '#suffix' => '
', + '#title' => $this->t('Parent menu item'), + '#type' => 'radios', + '#options' => ['none' => $this->t('Already exists'), 'normal' => $this->t('Normal menu item'), 'tab' => $this->t('Menu tab')], + '#default_value' => $tab_options['type'], + ]; + $form['tab_options']['title'] = [ + '#prefix' => '
', + '#title' => $this->t('Title'), + '#type' => 'textfield', + '#default_value' => $tab_options['title'], + '#description' => $this->t('If creating a parent menu item, enter the title of the item.'), + '#states' => [ + 'visible' => [ + [ + ':input[name="tab_options[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="tab_options[type]"]' => ['value' => 'tab'], + ], + ], + ], + ]; + $form['tab_options']['description'] = [ + '#title' => $this->t('Description'), + '#type' => 'textfield', + '#default_value' => $tab_options['description'], + '#description' => $this->t('If creating a parent menu item, enter the description of the item.'), + '#states' => [ + 'visible' => [ + [ + ':input[name="tab_options[type]"]' => ['value' => 'normal'], + ], + [ + ':input[name="tab_options[type]"]' => ['value' => 'tab'], + ], + ], + ], + ]; + $form['tab_options']['weight'] = [ + '#suffix' => '
', + '#title' => $this->t('Tab weight'), + '#type' => 'textfield', + '#default_value' => $tab_options['weight'], + '#size' => 5, + '#description' => $this->t('If the parent menu item is a tab, enter the weight of the tab. Heavier tabs will sink and the lighter tabs will be positioned nearer to the first menu item.'), + '#states' => [ + 'visible' => [ + ':input[name="tab_options[type]"]' => ['value' => 'tab'], + ], + ], + ]; + break; } } @@ -467,6 +753,26 @@ public function validateOptionsForm(&$form, FormStateInterface $form_state) { // Automatically remove '/' and trailing whitespace from path. $form_state->setValue('path', trim($form_state->getValue('path'), '/ ')); } + + if ($form_state->get('section') == 'menu') { + $path = $this->getOption('path'); + $menu_type = $form_state->getValue(['menu', 'type']); + if ($menu_type == 'normal' && strpos($path, '%') !== FALSE) { + $form_state->setError($form['menu']['type'], $this->t('Views cannot create normal menu items for paths with a % in them.')); + } + + if ($menu_type == 'default tab' || $menu_type == 'tab') { + $bits = explode('/', $path); + $last = array_pop($bits); + if ($last == '%') { + $form_state->setError($form['menu']['type'], $this->t('A display whose path ends with a % cannot be a tab.')); + } + } + + if ($menu_type != 'none' && $form_state->isValueEmpty(['menu', 'title'])) { + $form_state->setError($form['menu']['title'], $this->t('Title is required for this menu type.')); + } + } } /** @@ -475,8 +781,22 @@ public function validateOptionsForm(&$form, FormStateInterface $form_state) { public function submitOptionsForm(&$form, FormStateInterface $form_state) { parent::submitOptionsForm($form, $form_state); - if ($form_state->get('section') == 'path') { - $this->setOption('path', $form_state->getValue('path')); + switch ($form_state->get('section')) { + case 'path': + $this->setOption('path', $form_state->getValue('path')); + break; + case 'menu': + $menu = $form_state->getValue('menu'); + list($menu['menu_name'], $menu['parent']) = explode(':', $menu['parent'], 2); + $this->setOption('menu', $menu); + // send ajax form to options page if we use it. + if ($form_state->getValue(['menu', 'type']) == 'default tab') { + $form_state->get('view')->addFormToStack('display', $this->display['id'], 'tab_options'); + } + break; + case 'tab_options': + $this->setOption('tab_options', $form_state->getValue('tab_options')); + break; } } @@ -529,6 +849,18 @@ public function validate() { $errors += $this->validatePath($this->getOption('path')); + $menu = $this->getOption('menu'); + if (!empty($menu['type']) && $menu['type'] != 'none' && empty($menu['title'])) { + $errors[] = $this->t('Display @display is set to use a menu but the menu link text is not set.', ['@display' => $this->display['display_title']]); + } + + if ($menu['type'] == 'default tab') { + $tab_options = $this->getOption('tab_options'); + if (!empty($tab_options['type']) && $tab_options['type'] != 'none' && empty($tab_options['title'])) { + $errors[] = $this->t('Display @display is set to use a parent menu but the parent menu link text is not set.', ['@display' => $this->display['display_title']]); + } + } + return $errors; }