' . t("To view a list of displays with meta tags set up, click on a view name. To view a summary of meta tags configuration for a particular display, click on the display name. If you need to set metatags for a specific view, choose Add views meta tags. Reverting the meta tags removes the specific configuration and falls back to defaults.") . '
', + ]; + + // Iterate over the values and build the whole UI. + // 1. Top level is a collapsible fieldset with a view name (details) + // 2. Inside each fieldset we have 2 columns -> Display and Operations. + // Display contains point 3. + // Operations contain edit and revert + // 3. In each display there is a table that has 2 columns: tag name and tag + // value. + $tagged_views = $this->getTaggedViews(); + foreach ($tagged_views as $view_id => $displays) { + $elements[$view_id] = [ + '#type' => 'details', + '#title' => $this->t($this->viewLabels[$view_id]['#label']), + 'details' => $this->buildViewDetails($view_id, $displays), + ]; + } + + return $elements; + } + + /** + * Builds the second "level" of the UI - table with display fieldset and operations. + * + * @param $view_id + * @param $displays + * @return array + */ + protected function buildViewDetails($view_id, $displays) { + $element = [ + '#type' => 'table', + '#collapsible' => TRUE, + '#header' => [$this->t('Display'), $this->t('Operations')], + ]; + + foreach ($displays as $display_id => $metatags) { + $metatags = array_filter($metatags); + + $element[$display_id]['details'] = [ + '#type' => 'details', + '#title' => $this->viewLabels[$view_id][$display_id], + ]; + + $params = ['view_id' => $view_id, 'display_id' => $display_id]; + + // Generate the operations. + $element[$display_id]['ops'] = [ + '#type' => 'operations', + '#links' => [ + 'edit' => [ + 'title' => t('Edit'), + 'url' => Url::fromRoute('metatag_views.metatags.edit', $params), + ], + 'translate' => [ + 'title' => t('Translate'), + 'url' => Url::fromRoute('metatag_views.metatags.translate_overview', $params), + ], + 'revert' => [ + 'title' => t('Revert'), + 'url' => Url::fromRoute('metatag_views.metatags.revert', $params), + ], + ], + ]; + + // Build the rows for each of the metatag types. + $element[$display_id]['details']['table'] = $this->buildDisplayDetailsTable($metatags); + } + + return $element; + } + + /** + * Build the table with metatags values summary. + * + * @param $tags + * @return array + */ + protected function buildDisplayDetailsTable($tags) { + $element = [ + '#type' => 'table', + ]; + + $i = 0; + foreach ($tags as $tag_name => $tag_value) { + // This is for the case where we have a subarray. + $tag_value = $this->prepareTagValue($tag_value); + if (!$tag_value) { + continue; + } + + $element[$i]['tag_name'] = [ + '#type' => 'markup', + '#markup' => $tag_name, + ]; + + $element[$i]['tag_value'] = [ + '#type' => 'markup', + '#markup' => $tag_value, + ]; + $i++; + } + + return $element; + } + + /** + * Massage the tag value. Returns an imploded string for metatags that + * are nested (ex. robots). + * + * @param $value + * @return string + */ + protected function prepareTagValue($value) { + if (is_array($value)) { + $value = implode(', ', array_filter($value)); + } + + return $value; + } + + /** + * Gets label values for the views and their displays. + */ + protected function getViewsAndDisplaysLabels() { + /** @var ViewEntityInterface[] $views */ + $views = $this->viewStorage->loadByProperties(['status' => 1]); + + $labels = []; + + foreach ($views as $view_id => $view) { + $displays = $view->get('display'); + $labels[$view_id]['#label'] = $view->label(); + foreach (array_keys($displays) as $display_id) { + $labels[$view_id][$display_id] = $displays[$display_id]['display_title']; + } + } + + $this->viewLabels = $labels; + } +} diff --git a/metatag_views/src/Controller/MetatagViewsTranslationController.php b/metatag_views/src/Controller/MetatagViewsTranslationController.php new file mode 100644 index 0000000..bf2ce5a --- /dev/null +++ b/metatag_views/src/Controller/MetatagViewsTranslationController.php @@ -0,0 +1,148 @@ +viewStorage = $viewStorage; + $this->metatagManager = $metatagManager; + $this->languageManager = $languageManager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('entity_type.manager')->getStorage('view'), + $container->get('metatag.manager'), + $container->get('language_manager') + ); + } + + /** + * Language translations overview page for a views. + * + * @return array + * Page render array. + */ + public function itemPage() { + $view_id = \Drupal::request()->get('view_id'); + $display_id = \Drupal::request()->get('display_id'); + + $view = $this->viewStorage->load($view_id); + $original_langcode = $view->language()->getId(); + + $config_name = $view->getConfigDependencyName(); + $config_path = 'display.' . $display_id . '.display_options.display_extenders.metatag_display_extender.metatags'; + + $access_manager = \Drupal::service('access_manager'); + $configuration = \Drupal::service('config.factory')->get($config_name); + $config_source = $configuration->getOriginal($config_path, FALSE); + + $page['languages'] = [ + '#type' => 'table', + '#header' => [$this->t('Language'), $this->t('Operations')], + ]; + + $languages = $this->languageManager->getLanguages(); + foreach ($languages as $language) { + $langcode = $language->getId(); + $language_name = $language->getName(); + $operations = []; + + // Prepare the language name and the operations depending on whether this + // is the original language or not. + if ($langcode == $original_langcode) { + $language_name = '' . $this->t('@language (original)', [ + '@language' => $language_name, + ]) . ''; + + // Default language can only be edited, no add/delete. + $operations['edit'] = [ + 'title' => $this->t('Edit'), + 'url' => Url::fromRoute('metatag_views.metatags.edit', [ + 'view_id' => $view_id, + 'display_id' => $display_id, + ]), + ]; + } + else { + // Get the metatag translation for this language. + $config_translation = $this->languageManager + ->getLanguageConfigOverride($langcode, $config_name) + ->get($config_path); + + // If no translation exists for this language, link to add one. + if (!$config_translation || $config_translation == $config_source) { + $operations['add'] = [ + 'title' => $this->t('Add'), + 'url' => Url::fromRoute('metatag_views.metatags.translate', [ + 'view_id' => $view_id, + 'display_id' => $display_id, + 'langcode' => $langcode, + ]), + ]; + } + else { + // Otherwise, link to edit the existing translation. + $operations['edit'] = [ + 'title' => $this->t('Edit'), + 'url' => Url::fromRoute('metatag_views.metatags.translate', [ + 'view_id' => $view_id, + 'display_id' => $display_id, + 'langcode' => $langcode, + ]), + ]; + // @todo: operations delete. + } + } + + $page['languages'][$langcode]['language'] = [ + '#markup' => $language_name, + ]; + + $page['languages'][$langcode]['operations'] = [ + '#type' => 'operations', + '#links' => $operations, + // Even if the mapper contains multiple language codes, the source + // configuration can still be edited. + // '#access' => ($langcode == $original_langcode) || $operations_access, + ]; + } + + return $page; + } +} diff --git a/metatag_views/src/Form/MetatagViewsAddForm.php b/metatag_views/src/Form/MetatagViewsAddForm.php new file mode 100644 index 0000000..7e859aa --- /dev/null +++ b/metatag_views/src/Form/MetatagViewsAddForm.php @@ -0,0 +1,49 @@ + $displays) { + foreach (array_keys($displays) as $display_id) { + unset($views[$view_id][$view_id . ':' . $display_id]); + } + } + $views = array_filter($views); + + // Need to create that AFTER the $form['metatags'] as the whole form + // is passed to the $metatagManager->form() which causes duplicated field. + $form['view']['#type'] = 'select'; + $form['view']['#options'] = $views; + $form['view']['#empty_option'] = $this->t('- Select a view -'); + + return $form; + } + +} diff --git a/metatag_views/src/Form/MetatagViewsEditForm.php b/metatag_views/src/Form/MetatagViewsEditForm.php new file mode 100644 index 0000000..4398c23 --- /dev/null +++ b/metatag_views/src/Form/MetatagViewsEditForm.php @@ -0,0 +1,188 @@ +metatagManager = $metatag_manager; + $this->viewsManager = $entity_manager->getStorage('view'); + } + + public static function create(ContainerInterface $container) { + return new static( + $container->get('metatag.manager'), + $container->get('entity_type.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'metatag_views_edit_form'; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state) { + // Get the parameters from request. + $view_id = \Drupal::request()->get('view_id'); + $display_id = \Drupal::request()->get('display_id'); + + // Get metatags from the view entity. + $metatags = []; + if ($view_id && $display_id) { + $metatags = metatag_get_view_tags($view_id, $display_id); + } + + $form['metatags'] = $this->metatagManager->form($metatags, $form, ['view']); + $form['metatags']['#title'] = t('Metatags'); + $form['metatags']['#type'] = 'fieldset'; + + // Need to create that AFTER the $form['metatags'] as the whole form + // is passed to the $metatagManager->form() which causes duplicated field. + $form['view'] = [ + '#type' => 'value', + '#title' => $this->t('View'), + '#weight' => -100, + '#default_value' => $view_id . ':' . $display_id, + '#required' => TRUE, + ]; + + $form['submit'] = array( + '#type' => 'submit', + '#value' => t('Submit'), + ); + + return $form; + } + + /** + * {@inheritdoc} + */ + public function form(array $values, array $element, array $token_types = [], array $included_groups = NULL, array $included_tags = NULL) { + + // Add the outer fieldset. + $element += [ + '#type' => 'details', + ]; + + $element += $this->tokenService->tokenBrowser($token_types); + + $groups_and_tags = $this->sortedGroupsWithTags(); + + $first = TRUE; + foreach ($groups_and_tags as $group_id => $group) { + // Only act on groups that have tags and are in the list of included + // groups (unless that list is null). + if (isset($group['tags']) && (is_null($included_groups) || in_array($group_id, $included_groups))) { + // Create the fieldset. + $element[$group_id]['#type'] = 'details'; + $element[$group_id]['#title'] = $group['label']; + $element[$group_id]['#description'] = $group['description']; + $element[$group_id]['#open'] = $first; + $first = FALSE; + + foreach ($group['tags'] as $tag_id => $tag) { + // Only act on tags in the included tags list, unless that is null. + if (is_null($included_tags) || in_array($tag_id, $included_tags)) { + // Make an instance of the tag. + $tag = $this->tagPluginManager->createInstance($tag_id); + + // Set the value to the stored value, if any. + $tag_value = isset($values[$tag_id]) ? $values[$tag_id] : NULL; + $tag->setValue($tag_value); + + // Create the bit of form for this tag. + $element[$group_id][$tag_id] = $tag->form($element); + } + } + } + } + + return $element; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + // Get the submitted form values. + $view_name = $form_state->getValue('view'); + list($view_id, $display_id) = explode(':', $view_name); + + $metatags = $form_state->getValues(); + unset($metatags['view']); + $metatags = $this->clearMetatagViewsDisallowedValues($metatags); + + /** @var ViewEntityInterface $view */ + $view = $this->viewsManager->load($view_id); + + // Store the metatags on the view. + $config_name = $view->getConfigDependencyName(); + $config_path = 'display.' . $display_id . '.display_options.display_extenders.metatag_display_extender.metatags'; + + // Set configuration values based on form submission. + // This always edits the original language. + $configuration = $this->configFactory()->getEditable($config_name); + if (empty($this->removeEmptyTags($metatags))) { + $configuration->clear($config_path); + } + else { + $configuration->set($config_path, $metatags); + } + $configuration->save(); + + // Redirect back to the views list. + $form_state->setRedirect('metatag_views.metatags.list'); + + drupal_set_message($this->t('Metatags for @view : @display have been saved.', [ + '@view' => $view->label(), + '@display' => $view->getDisplay($display_id)['display_title'], + ])); + } + +} diff --git a/metatag_views/src/Form/MetatagViewsRevertForm.php b/metatag_views/src/Form/MetatagViewsRevertForm.php new file mode 100644 index 0000000..6f7af55 --- /dev/null +++ b/metatag_views/src/Form/MetatagViewsRevertForm.php @@ -0,0 +1,136 @@ +viewsManager = $entity_manager->getStorage('view'); + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('entity_type.manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'metatag_views_revert_form'; + } + + /** + * {@inheritdoc} + */ + public function getQuestion() { + return $this->t('Do you want to revert metatags for @view_name : @display_name?', [ + '@view_name' => $this->view->label(), + '@display_name' => $this->view->getDisplay($this->display_id)['display_title'], + ]); + } + + /** + * {@inheritdoc} + */ + public function getCancelUrl() { + return new Url('metatag_views.metatags.list'); + } + + /** + * {@inheritdoc} + */ + public function getDescription() { + return $this->t('You are about to revert the custom metatags for the %display_name display on the %view_name view. This action cannot be undone.', [ + '%view_name' => $this->view->label(), + '%display_name' => $this->view->getDisplay($this->display_id)['display_title'], + ]); + } + + /** + * {@inheritdoc} + */ + public function getConfirmText() { + return $this->t('Revert'); + } + + /** + * {@inheritdoc} + */ + public function getCancelText() { + return $this->t('Cancel'); + } + + /** + * {@inheritdoc} + * + * @param int $id + * (optional) The ID of the item to be deleted. + */ + public function buildForm(array $form, FormStateInterface $form_state, $view_id = NULL, $display_id = NUL) { + $this->view = $this->viewsManager->load($view_id); + $this->display_id = $display_id; + + return parent::buildForm($form, $form_state); + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + // Removed metatags from the view. + $config_name = $this->view->getConfigDependencyName(); + $config_path = 'display.' . $this->display_id . '.display_options.display_extenders.metatag_display_extender.metatags'; + + $configuration = $this->configFactory()->getEditable($config_name) + ->clear($config_path) + ->save(); + + // Redirect back to the views list. + $form_state->setRedirect('metatag_views.metatags.list'); + + drupal_set_message($this->t('Reverted metatags for @view_name : @display_name', [ + '@view_name' => $this->view->label(), + '@display_name' => $this->view->getDisplay($this->display_id)['display_title'], + ])); + } + +} diff --git a/metatag_views/src/Form/MetatagViewsTranslationForm.php b/metatag_views/src/Form/MetatagViewsTranslationForm.php new file mode 100644 index 0000000..bdc8868 --- /dev/null +++ b/metatag_views/src/Form/MetatagViewsTranslationForm.php @@ -0,0 +1,248 @@ +metatagManager = $metatag_manager; + $this->viewsManager = $entity_manager->getStorage('view'); + $this->tokenService = $token; + $this->tagPluginManager = $tagPluginManager; + $this->languageManager = $language_manager; + } + + /** + * {@inheritdoc} + */ + public static function create(ContainerInterface $container) { + return new static( + $container->get('metatag.manager'), + $container->get('entity_type.manager'), + $container->get('metatag.token'), + $container->get('plugin.manager.metatag.tag'), + $container->get('language_manager') + ); + } + + /** + * {@inheritdoc} + */ + public function getFormId() { + return 'metatag_views_translate_form'; + } + + /** + * Gets the translated values while storing a copy of the original values. + */ + protected function prepareValues() { + $config_name = $this->view->getConfigDependencyName(); + $config_path = 'display.' . $this->display_id . '.display_options.display_extenders.metatag_display_extender.metatags'; + + $configuration = \Drupal::service('config.factory')->get($config_name); + $this->baseData = $configuration->getOriginal($config_path, FALSE); + + // Set the translation target language on the configuration factory. + $original_language = $this->languageManager->getConfigOverrideLanguage(); + $this->languageManager->setConfigOverrideLanguage($this->language); + + // Read in translated values. + $configuration = \Drupal::service('config.factory')->get($config_name); + $translated_values = $configuration->get($config_path); + + // Set the configuration language back. + $this->languageManager->setConfigOverrideLanguage($original_language); + + return $translated_values; + } + + /** + * {@inheritdoc} + */ + public function buildForm(array $form, FormStateInterface $form_state) { + // Get the parameters from request. + $this->view_id = \Drupal::request()->get('view_id'); + $this->display_id = \Drupal::request()->get('display_id'); + $langcode = \Drupal::request()->get('langcode'); + + $this->view = $this->viewsManager->load($this->view_id); + $this->language = $this->languageManager->getLanguage($langcode); + $this->sourceLanguage = $this->view->language(); + + // Get metatags from the view entity. + $form['#tree'] = TRUE; + $form['#attached']['library'][] = 'config_translation/drupal.config_translation.admin'; + + $form['#title'] = $this->t('Edit @language translation for %view: %display metatags', [ + '%view' => $this->view->label(), + '%display' => $this->view->getDisplay($this->display_id)['display_title'], + '@language' => $this->language->getName(), + ]); + + $form['metatags'] = $this->form($form, $this->prepareValues()); + $form['metatags']['#title'] = t('Metatags'); + $form['metatags']['#type'] = 'fieldset'; + + $form['submit'] = [ + '#type' => 'submit', + '#value' => t('Submit'), + ]; + + return $form; + } + + /** + * Add the translation form element for metatags available in the source. + */ + public function form(array $element, array $translated_values) { + $translated_values = $this->clearMetatagViewsDisallowedValues($translated_values); + // Only offer form elements for tags present in the source language. + $source_values = $this->removeEmptyTags($this->baseData); + + // Add the outer fieldset. + $element += [ + '#type' => 'details', + ]; + $element += $this->tokenService->tokenBrowser(['view']); + + foreach ($source_values as $tag_id => $value) { + $tag = $this->tagPluginManager->createInstance($tag_id); + $tag->setValue($translated_values[$tag_id]); + + $form_element = $tag->form($element); + $element[$tag_id] = [ + '#theme' => 'config_translation_manage_form_element', + 'source' => [ + '#type' => 'item', + '#title' => $form_element['#title'], + '#markup' => $value, + ], + 'translation' => $form_element, + ]; + } + + return $element; + } + + /** + * {@inheritdoc} + */ + public function submitForm(array &$form, FormStateInterface $form_state) { + // Get the values of metatags. + $values = $form_state->getValue('metatags'); + $translated_values = array_combine(array_keys($values), array_column($values, 'translation')); + + $config_name = $this->view->getConfigDependencyName(); + $config_path = 'display.' . $this->display_id . '.display_options.display_extenders.metatag_display_extender.metatags'; + + // Set configuration values based on form submission and source values. + $base_config = $this->configFactory()->getEditable($config_name); + $config_translation = $this->languageManager->getLanguageConfigOverride($this->language->getId(), $config_name); + + // Save the configuration values, if they are different from the source + // values in the base configuration. Otherwise remove the override. + $source_values = $this->removeEmptyTags($base_config->get($config_path)); + if ($source_values !== $translated_values) { + $config_translation->set($config_path, $translated_values); + } + else { + $config_translation->clear($config_path); + } + + // If no overrides, delete language specific configuration file. + $saved_config = $config_translation->get(); + if (empty($saved_config)) { + $config_translation->delete(); + } + else { + $config_translation->save(); + } + + // Redirect back to the views list. + $form_state->setRedirect('metatag_views.metatags.translate_overview', [ + 'view_id' => $this->view_id, + 'display_id' => $this->display_id, + ]); + + drupal_set_message($this->t('Successfully updated @language translation.', [ + '@language' => $this->language->getName(), + ])); + } + +} diff --git a/metatag_views/src/MetatagViewsValuesCleanerTrait.php b/metatag_views/src/MetatagViewsValuesCleanerTrait.php new file mode 100644 index 0000000..4a1176a --- /dev/null +++ b/metatag_views/src/MetatagViewsValuesCleanerTrait.php @@ -0,0 +1,40 @@ +metatagManager->sortedTags(); + + // Return only common elements. + $metatags = array_intersect_key($metatags, $tags); + + return $metatags; + } + + public function removeEmptyTags($metatags) { + $metatags = array_filter($metatags, function($value) { + if (is_array($value)) { + return count(array_filter($value)) > 0; + } + else { + return $value !== ''; + } + }); + return $metatags; + } + +} diff --git a/metatag_views/src/Plugin/views/display_extender/MetatagDisplayExtender.php b/metatag_views/src/Plugin/views/display_extender/MetatagDisplayExtender.php new file mode 100644 index 0000000..deb6e5b --- /dev/null +++ b/metatag_views/src/Plugin/views/display_extender/MetatagDisplayExtender.php @@ -0,0 +1,130 @@ +get('section') == 'metatags') { + $form['#title'] .= t('The meta tags for this display'); + $metatags = $this->getMetatags(); + + // Build/inject the Metatag form. + $this->metatagManager = \Drupal::service('metatag.manager'); + $form['metatags'] = $this->metatagManager->form($metatags, $form, ['view']); + } + } + + /** + * Validate the options form. + */ + public function validateOptionsForm(&$form, FormStateInterface $form_state) { + } + + /** + * Handle any special handling on the validate form. + */ + public function submitOptionsForm(&$form, FormStateInterface $form_state) { + if ($form_state->get('section') == 'metatags') { + $metatags = $form_state->getValues(); + // Remove the unnecessary elements from values array. + $metatags = $this->clearMetatagViewsDisallowedValues($metatags); + $this->options['metatags'] = $metatags; + } + } + + /** + * Set up any variables on the view prior to execution. + */ + public function preExecute() { + } + + /** + * Inject anything into the query that the display_extender handler needs. + */ + public function query() { + } + + /** + * Provide the default summary for options in the views UI. + * + * This output is returned as an array. + */ + public function optionsSummary(&$categories, &$options) { + $categories['metatags'] = array( + 'title' => t('Meta tags'), + 'column' => 'second', + ); + $options['metatags'] = array( + 'category' => 'metatags', + 'title' => t('Meta tags'), + 'value' => $this->hasMetatags() ? t('Overridden') : t('Using defaults'), + ); + } + + /** + * Static member function to list which sections are defaultable + * and what items each section contains. + */ + public function defaultableSections(&$sections, $section = NULL) { + } + + /** + * Identify whether or not the current display has custom meta tags defined. + */ + protected function hasMetatags() { + $metatags = $this->getMetatags(); + return !empty($metatags); + + } + + /** + * Get the Metatag configuration for this display. + * + * @return array + * The meta tag values. + */ + public function getMetatags() { + $metatags = array(); + + if (!empty($this->options['metatags'])) { + $metatags = $this->options['metatags']; + } + + return $metatags; + } + + public function setMetatags($metatags) { + $this->options['metatags'] = $metatags; + } +} diff --git a/metatag_views/templates/config_translation_manage_form_element.html.twig b/metatag_views/templates/config_translation_manage_form_element.html.twig new file mode 100644 index 0000000..4c1459b --- /dev/null +++ b/metatag_views/templates/config_translation_manage_form_element.html.twig @@ -0,0 +1,23 @@ +{# +/** + * @file + * Default theme implementation for a form element in config_translation. + * + * Available variables: + * - element: Array that represents the element shown in the form. + * - source: The source of the translation. + * - translation: The translation for the target language. + * + * @see template_preprocess() + * + * @ingroup themeable + */ +#} +