Skip to content

GitLab

Commit 3c3eb990 authored by catch's avatar catch
Browse files

Issue #1810350 by plach, kfritsche, boran, YesCT: Remove menu_* entity keys... 

Issue #1810350 by plach, kfritsche, boran, YesCT: Remove menu_* entity keys and replace them with entity links.
parent 72c63698
Hide whitespace changes
Inline Side-by-side
core/lib/Drupal/Core/Entity/Annotation/EntityType.php
View file @ 3c3eb990
......@@ -236,37 +236,6 @@ class EntityType extends Plugin {
*/
public $route_base_path;
/**
* The base menu router path to which the entity admin user interface responds.
*
* It can be used to generate UI links and to attach additional router items
* to the entity UI in a generic fashion.
*
* @var string (optional)
*/
public $menu_base_path;
/**
* The menu router path to be used to view the entity.
*
* @var string (optional)
*/
public $menu_view_path;
/**
* The menu router path to be used to edit the entity.
*
* @var string (optional)
*/
public $menu_edit_path;
/**
* A string identifying the menu loader in the router path.
*
* @var string (optional)
*/
public $menu_path_wildcard;
/**
* Link templates using the URI template syntax.
*
......
core/modules/block/custom_block/lib/Drupal/custom_block/Entity/CustomBlock.php
View file @ 3c3eb990
......@@ -37,8 +37,10 @@
* base_table = "custom_block",
* revision_table = "custom_block_revision",
* route_base_path = "admin/structure/block/custom-blocks/manage/{bundle}",
* menu_base_path = "block/%custom_block",
* menu_edit_path = "block/%custom_block",
* links = {
* "canonical" = "/block/{custom_block}",
* "edit-form" = "/block/{custom_block}"
* },
* fieldable = TRUE,
* translatable = TRUE,
* entity_keys = {
......@@ -174,19 +176,6 @@ protected function init() {
unset($this->new);
}
/**
* {@inheritdoc}
*/
public function uri() {
return array(
'path' => 'block/' . $this->id(),
'options' => array(
'entity_type' => $this->entityType,
'entity' => $this,
)
);
}
/**
* {@inheritdoc}
*/
......
core/modules/comment/lib/Drupal/comment/Tests/CommentTranslationUITest.php
View file @ 3c3eb990
......@@ -68,7 +68,7 @@ function setupBundle() {
* Overrides \Drupal\content_translation\Tests\ContentTranslationUITest::getTranslatorPermission().
*/
protected function getTranslatorPermissions() {
return array_merge(parent::getTranslatorPermissions(), array('post comments', 'administer comments'));
return array_merge(parent::getTranslatorPermissions(), array('post comments', 'administer comments', 'access comments'));
}
/**
......@@ -134,11 +134,11 @@ protected function assertPublishedStatus() {
$languages = language_list();
// Check that simple users cannot see unpublished field translations.
$path = $this->controller->getViewPath($entity);
$uri = $entity->uri();
foreach ($this->langcodes as $index => $langcode) {
$translation = $this->getTranslation($entity, $langcode);
$value = $this->getValue($translation, 'comment_body', $langcode);
$this->drupalGet($path, array('language' => $languages[$langcode]));
$this->drupalGet($uri['path'], array('language' => $languages[$langcode]));
if ($index > 0) {
$this->assertNoRaw($value, 'Unpublished field translation is not shown.');
}
......
core/modules/content_translation/content_translation.module
View file @ 3c3eb990
......@@ -78,40 +78,33 @@ function content_translation_language_types_info_alter(array &$language_types) {
function content_translation_entity_info_alter(array &$entity_info) {
// Provide defaults for translation info.
foreach ($entity_info as $entity_type => &$info) {
if (empty($info['translatable'])) {
continue;
}
if (!empty($info['translatable'])) {
// Every fieldable entity type must have a translation controller class,
// no matter if it is enabled for translation or not. As a matter of fact
// we might need it to correctly switch field translatability when a field
// is shared accross different entities.
$info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');
if (!isset($info['translation']['content_translation'])) {
$info['translation']['content_translation'] = array();
}
if (!isset($info['translation']['content_translation'])) {
$info['translation']['content_translation'] = array();
}
if (!empty($info['links']['canonical'])) {
// Provide default links for the translation paths.
$info['links'] += array(
'drupal:content-translation-overview' => $info['links']['canonical'] . '/translations',
);
// Every fieldable entity type must have a translation controller class, no
// matter if it is enabled for translation or not. As a matter of fact we
// might need it to correctly switch field translatability when a field is
// shared accross different entities.
$info['controllers'] += array('translation' => 'Drupal\content_translation\ContentTranslationController');
// If no menu base path is provided we default to the usual
// "entity_type/%entity_type" pattern.
if (!isset($info['menu_base_path'])) {
$path = "$entity_type/%$entity_type";
$info['menu_base_path'] = $path;
$parts = explode('/', trim($info['links']['canonical'], '/'));
$entity_position = array_search("{{$entity_type}}", $parts);
if ($entity_position !== FALSE) {
$info['translation']['content_translation'] += array(
'access_callback' => 'content_translation_translate_access',
'access_arguments' => array($entity_position),
);
}
}
}
$path = $info['menu_base_path'];
$info += array(
'menu_view_path' => $path,
'menu_edit_path' => "$path/edit",
'menu_path_wildcard' => "%$entity_type",
);
$entity_position = count(explode('/', $path)) - 1;
$info['translation']['content_translation'] += array(
'access_callback' => 'content_translation_translate_access',
'access_arguments' => array($entity_position),
);
}
}
......@@ -156,6 +149,9 @@ function content_translation_entity_field_info_alter(&$info, $entity_type) {
/**
* Implements hook_menu().
*
* @todo Split this into route definition and menu link definition. See
* https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
*/
function content_translation_menu() {
$items = array();
......@@ -164,7 +160,7 @@ function content_translation_menu() {
foreach (entity_get_info() as $entity_type => $info) {
// Provide the translation UI only for enabled types.
if (content_translation_enabled($entity_type)) {
$path = $info['menu_base_path'];
$path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
$entity_position = count(explode('/', $path)) - 1;
$keys = array_flip(array('theme_callback', 'theme_arguments', 'access_callback', 'access_arguments', 'load_arguments'));
$menu_info = array_intersect_key($info['translation']['content_translation'], $keys) + array('file' => 'content_translation.pages.inc');
......@@ -228,6 +224,9 @@ function content_translation_menu() {
/**
* Implements hook_menu_alter().
*
* @todo Split this into route definition and menu link definition. See
* https://drupal.org/node/1987882 and https://drupal.org/node/2047633.
*/
function content_translation_menu_alter(array &$items) {
// Clarify where translation settings are located.
......@@ -237,7 +236,7 @@ function content_translation_menu_alter(array &$items) {
// Check that the declared menu base paths are actually valid.
foreach (entity_get_info() as $entity_type => $info) {
if (content_translation_enabled($entity_type)) {
$path = $info['menu_base_path'];
$path = _content_translation_link_to_router_path($entity_type, $info['links']['canonical']);
// If the base path is not defined we cannot provide the translation UI
// for this entity type. In some cases the actual base path might not have
......@@ -255,7 +254,7 @@ function content_translation_menu_alter(array &$items) {
}
else {
$entity_position = count(explode('/', $path)) - 1;
$edit_path = $info['menu_edit_path'];
$edit_path = $path . '/edit';
if (isset($items[$edit_path])) {
// If the edit path is a default local task we need to find the parent
......@@ -286,6 +285,24 @@ function content_translation_local_tasks_alter(&$local_tasks) {
$derivative->alterLocalTasks($local_tasks);
}
/**
* Convert an entity canonical link to a router path.
*
* @param string $link
* The entity link to be converted.
*
* @return string
* The resulting router path. For instance "/node/{node}" is turned into
* "node/%node".
*
* @todo Remove this and use the actual link values when all the Content
* Translation code is adapted to the new routing system.
*/
function _content_translation_link_to_router_path($entity_type, $link) {
$path = preg_replace('|{([^}]+)}|', '%$1', trim($link, '/'));
return str_replace('%id', '%' . $entity_type, $path);
}
/**
* Strips out menu loaders from the given path.
*
......@@ -482,9 +499,8 @@ function content_translation_set_config($entity_type, $bundle, $setting, $value)
*/
function content_translation_enabled($entity_type, $bundle = NULL) {
$enabled = FALSE;
$info = entity_get_info($entity_type);
if (!empty($info['translatable'])) {
if (content_translation_supported($entity_type)) {
$bundles = !empty($bundle) ? array($bundle) : array_keys(entity_get_bundles($entity_type));
foreach ($bundles as $bundle) {
if (content_translation_get_config($entity_type, $bundle, 'enabled')) {
......@@ -498,31 +514,17 @@ function content_translation_enabled($entity_type, $bundle = NULL) {
}
/**
* Returns all the translatable entity types.
* Checks whether an entity type supports translation.
*
* @param string $entity_type
* The entity type.
*
* @return array
* An array of entity types keyed by entity type.
* @return bool
* TRUE if an entity type is supported, FALSE otherwise.
*/
function content_translation_types_translatable() {
$entity_types = &drupal_static(__FUNCTION__, array());
foreach (entity_get_info() as $entity_type => $info) {
if (content_translation_enabled($entity_type)) {
// Lazy load router items.
if (!isset($items)) {
$items = menu_get_router();
}
// Check whether the required paths are defined. We need to strip out the
// menu loader and replace it with a plain "%" as router items have no
// menu loader in them.
$path = _content_translation_menu_strip_loaders($info['menu_base_path']);
if (!empty($items[$path]) && !empty($items[$path . '/translations'])) {
$entity_types[$entity_type] = $entity_type;
}
}
}
return $entity_types;
function content_translation_supported($entity_type) {
$info = entity_get_info($entity_type);
return !empty($info['translatable']) && !empty($info['links']['drupal:content-translation-overview']);
}
/**
......
core/modules/content_translation/content_translation.pages.inc
View file @ 3c3eb990
......@@ -25,14 +25,21 @@ function content_translation_overview(EntityInterface $entity) {
$translations = $entity->getTranslationLanguages();
$field_ui = \Drupal::moduleHandler()->moduleExists('field_ui') && user_access('administer ' . $entity->entityType() . ' fields');
$path = $controller->getViewPath($entity);
$base_path = $controller->getBasePath($entity);
$edit_path = $controller->getEditPath($entity);
$rel = array();
foreach (array('canonical', 'edit-form', 'drupal:content-translation-overview') as $name) {
$rel[$name] = $entity->uri($name);
}
$header = array(t('Language'), t('Translation'), t('Source language'), t('Status'), t('Operations'));
$rows = array();
if (language_multilingual()) {
// If we have a view path defined for the current entity get the switch
// links based on it.
if (!empty($rel['canonical'])) {
$links = _content_translation_get_switch_links($rel['canonical']['path']);
}
// Determine whether the current entity is translatable.
$translatable = FALSE;
foreach (field_info_instances($entity->entityType(), $entity->bundle()) as $instance) {
......@@ -45,16 +52,14 @@ function content_translation_overview(EntityInterface $entity) {
foreach ($languages as $language) {
$language_name = $language->name;
$langcode = $language->id;
$add_path = $base_path . '/translations/add/' . $original . '/' . $langcode;
$translate_path = $base_path . '/translations/edit/' . $langcode;
$delete_path = $base_path . '/translations/delete/' . $langcode;
if ($base_path) {
$add_links = _content_translation_get_switch_links($add_path);
$edit_links = _content_translation_get_switch_links($edit_path);
$translate_links = _content_translation_get_switch_links($translate_path);
$delete_links = _content_translation_get_switch_links($delete_path);
}
$add_path = $rel['drupal:content-translation-overview']['path'] . '/add/' . $original . '/' . $langcode;
$translate_path = $rel['drupal:content-translation-overview']['path'] . '/edit/' . $langcode;
$add_links = _content_translation_get_switch_links($add_path);
$edit_links = _content_translation_get_switch_links($rel['edit-form']['path']);
$translate_links = _content_translation_get_switch_links($translate_path);
$delete_links = _content_translation_get_switch_links($rel['drupal:content-translation-overview']['path'] . '/delete/' . $langcode);
$operations = array(
'data' => array(
......@@ -69,7 +74,7 @@ function content_translation_overview(EntityInterface $entity) {
$source = isset($entity->translation[$langcode]['source']) ? $entity->translation[$langcode]['source'] : '';
$is_original = $langcode == $original;
$label = $entity->getTranslation($langcode)->label();
$link = isset($links->links[$langcode]['href']) ? $links->links[$langcode] : array('href' => $path, 'language' => $language);
$link = isset($links->links[$langcode]['href']) ? $links->links[$langcode] : array('href' => $rel['canonical']['path'], 'language' => $language);
$row_title = l($label, $link['href'], $link);
if (empty($link['href'])) {
......@@ -79,8 +84,8 @@ function content_translation_overview(EntityInterface $entity) {
// If the user is allowed to edit the entity we point the edit link to
// the entity form, otherwise if we are not dealing with the original
// language we point the link to the translation form.
if ($edit_path && $entity->access('update')) {
$links['edit'] = isset($edit_links->links[$langcode]['href']) ? $edit_links->links[$langcode] : array('href' => $edit_path, 'language' => $language);
if ($entity->access('update')) {
$links['edit'] = isset($edit_links->links[$langcode]['href']) ? $edit_links->links[$langcode] : array('href' => $rel['edit-form']['path'], 'language' => $language);
}
elseif (!$is_original && $controller->getTranslationAccess($entity, 'update')) {
$links['edit'] = isset($translate_links->links[$langcode]['href']) ? $translate_links->links[$langcode] : array('href' => $translate_path, 'language' => $language);
......@@ -246,11 +251,12 @@ function content_translation_prepare_translation(EntityInterface $entity, Langua
*/
function content_translation_delete_confirm(array $form, array $form_state, EntityInterface $entity, Language $language) {
$controller = content_translation_controller($entity->entityType());
$uri = $entity->uri('drupal:content-translation-overview');
return confirm_form(
$form,
t('Are you sure you want to delete the @language translation of %label?', array('@language' => $language->name, '%label' => $entity->label())),
$controller->getEditPath($entity),
$uri['path'],
t('This action cannot be undone.'),
t('Delete'),
t('Cancel')
......@@ -271,9 +277,11 @@ function content_translation_delete_confirm_submit(array $form, array &$form_sta
// Remove any existing path alias for the removed translation.
// @todo This should be taken care of by the Path module.
if (\Drupal::moduleHandler()->moduleExists('path')) {
$conditions = array('source' => $controller->getViewPath($entity), 'langcode' => $language->id);
$uri = $entity->uri();
$conditions = array('source' => $uri['path'], 'langcode' => $language->id);
\Drupal::service('path.crud')->delete($conditions);
}
$form_state['redirect'] = $controller->getBasePath($entity) . '/translations';
$uri = $entity->uri('drupal:content-translation-overview');
$form_state['redirect'] = $uri['path'];
}
core/modules/content_translation/lib/Drupal/content_translation/ContentTranslationController.php
View file @ 3c3eb990
......@@ -53,27 +53,6 @@ public function retranslate(EntityInterface $entity, $langcode = NULL) {
}
}
/**
* Implements ContentTranslationControllerInterface::getBasePath().
*/
public function getBasePath(EntityInterface $entity) {
return $this->getPathInstance($this->entityInfo['menu_base_path'], $entity->id());
}
/**
* Implements ContentTranslationControllerInterface::getEditPath().
*/
public function getEditPath(EntityInterface $entity) {
return isset($this->entityInfo['menu_edit_path']) ? $this->getPathInstance($this->entityInfo['menu_edit_path'], $entity->id()) : FALSE;
}
/**
* Implements ContentTranslationControllerInterface::getViewPath().
*/
public function getViewPath(EntityInterface $entity) {
return isset($this->entityInfo['menu_view_path']) ? $this->getPathInstance($this->entityInfo['menu_view_path'], $entity->id()) : FALSE;
}
/**
* Implements ContentTranslationControllerInterface::getTranslationAccess().
*/
......@@ -446,7 +425,9 @@ public function entityFormSourceChange($form, &$form_state) {
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller->getEntity();
$source = $form_state['values']['source_langcode']['source'];
$path = $this->getBasePath($entity) . '/translations/add/' . $source . '/' . $form_controller->getFormLangcode($form_state);
$uri = $entity->uri('drupal:content-translation-overview');
$path = $uri['path'] . '/add/' . $source . '/' . $form_controller->getFormLangcode($form_state);
$form_state['redirect'] = $path;
$languages = language_list();
drupal_set_message(t('Source language set to: %language', array('%language' => $languages[$source]->name)));
......@@ -473,9 +454,9 @@ function entityFormDelete($form, &$form_state) {
function entityFormDeleteTranslation($form, &$form_state) {
$form_controller = content_translation_form_controller($form_state);
$entity = $form_controller->getEntity();
$base_path = $this->getBasePath($entity);
$uri = $entity->uri('drupal:content-translation-overview');
$form_langcode = $form_controller->getFormLangcode($form_state);
$form_state['redirect'] = $base_path . '/translations/delete/' . $form_langcode;
$form_state['redirect'] = $uri['path'] . '/delete/' . $form_langcode;
}
/**
......@@ -488,17 +469,4 @@ protected function entityFormTitle(EntityInterface $entity) {
return $entity->label();
}
/**
* Returns an instance of the given path.
*
* @param $path
* An internal path containing the entity id wildcard.
*
* @return string
* The instantiated path.
*/
protected function getPathInstance($path, $entity_id) {
$wildcard = $this->entityInfo['menu_path_wildcard'];
return str_replace($wildcard, $entity_id, $path);
}
}
core/modules/content_translation/lib/Drupal/content_translation/ContentTranslationControllerInterface.php
View file @ 3c3eb990
......@@ -22,95 +22,26 @@
* To make Content Translation automatically support an entity type some keys
* may need to be defined, but none of them is required unless the entity path
* is different from ENTITY_TYPE/%ENTITY_TYPE (e.g. taxonomy/term/1), in which
* case at least the 'menu_base_path' key must be defined. This is used to
* determine the view and edit paths if they follow the standard path patterns.
* Otherwise the 'menu_view_path' and 'menu_edit_path' keys must be defined. If
* an entity type is enabled for translation and no menu path key is defined,
* the following defaults will be assumed:
* - menu_base_path: ENTITY_TYPE/%ENTITY_TYPE
* - menu_view_path: ENTITY_TYPE/%ENTITY_TYPE
* - menu_edit_path: ENTITY_TYPE/%ENTITY_TYPE/edit
* The menu base path is also used to reliably alter menu router information to
* provide the translation overview page for any entity.
* If the entity uses a menu loader different from %ENTITY_TYPE also the 'menu
* path wildcard' info key needs to be defined.
* case at least the 'canonical' key in the 'links' entity info property must be
* defined.
*
* Every entity type needs a translation controller to be translated. This can
* be specified through the "controllers['translation']" key in the entity
* info. If an entity type is enabled for translation and no translation
* controller is defined, Drupal\content_translation\ContentTranslationController
* will be assumed. Every translation controller class must implement
* Drupal\content_translation\ContentTranslationControllerInterface.
* controller is defined,
* \Drupal\content_translation\ContentTranslationController will be assumed.
* Every translation controller class must implement
* \Drupal\content_translation\ContentTranslationControllerInterface.
*
* If the entity paths match the default patterns above and there is no need for
* an entity-specific translation controller class, Content Translation will
* provide built-in support for the entity. It will still be required to enable
* translation for each translatable bundle.
*
* Additionally some more entity info keys can be defined to further customize
* the translation UI. The content translation info is an associative array that
* has to match the following structure. Two nested arrays keyed respectively
* by the 'translation' key and the 'content_translation' key. Elements:
* - access callback: The access callback for the translation pages. Defaults to
* 'entity_translation_translate_access'.
* - access arguments: The access arguments for the translation pages. By
* default only the entity object is passed to the access callback.
*
* This is how entity info would look for a module defining a new translatable
* entity type:
* @code
* function mymodule_entity_info_alter(array &$info) {
* $info['myentity'] += array(
* 'menu_base_path' => 'mymodule/myentity/%my_entity_loader',
* 'menu_path_wildcard' => '%my_entity_loader',
* 'translation' => array(
* 'content_translation' => array(
* 'access_callback' => 'mymodule_myentity_translate_access',
* 'access_arguments' => array(2),
* ),
* ),
* );
* $info['myentity']['controllers'] += array('translation' => 'Drupal\mymodule\MyContentTranslationController');
* }
* @endcode
*
* @see \Drupal\Core\Entity\EntityManagerInterface
*/
interface ContentTranslationControllerInterface {
/**
* Returns the base path for the current entity.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to the path should refer to.
*
* @return string
* The entity base path.
*/
public function getBasePath(EntityInterface $entity);
/**
* Returns the path of the entity edit form.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to the path should refer to.
*
* @return string
* The entity edit path.
*/
public function getEditPath(EntityInterface $entity);
/**
* Returns the path of the entity view page.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity to the path should refer to.
*
* @return string
* The entity view path.
*/
public function getViewPath(EntityInterface $entity);
/**
* Checks if the user can perform the given operation on translations of the
* wrapped entity.
......
core/modules/content_translation/lib/Drupal/content_translation/Plugin/Derivative/ContentTranslationLocalTasks.php
View file @ 3c3eb990
......@@ -72,7 +72,7 @@ public static function create(ContainerInterface $container, $base_plugin_id) {
public function getDerivativeDefinitions(array $base_plugin_definition) {
// Create tabs for all possible entity types.
foreach ($this->entityManager->getDefinitions() as $entity_type => $entity_info) {
if ($entity_info['translatable'] && isset($entity_info['translation'])) {
if (!empty($entity_info['translatable'])) {
// Find the route name for the translation overview.
$translation_route_name = "content_translation.translation_overview_$entity_type";
$translation_tab = $translation_route_name;
......@@ -92,8 +92,8 @@ public function getDerivativeDefinitions(array $base_plugin_definition) {
*/
public function alterLocalTasks(array &$local_tasks) {
foreach ($this->entityManager->getDefinitions() as $entity_type => $entity_info) {
if ($entity_info['translatable'] && isset($entity_info['translation'])) {
$path = '/' . preg_replace('/%(.*)/', '{$1}', $entity_info['menu_base_path']);
if (!empty($entity_info['translatable']) && !empty($entity_info['links']['canonical'])) {
$path = $entity_info['links']['canonical'];
if ($routes = $this->routeProvider->getRoutesByPattern($path)->all()) {
// Find the route name for the entity page.
$entity_route_name = key($routes);
......
core/modules/content_translation/lib/Drupal/content_translation/Routing/ContentTranslationRouteSubscriber.php
View file @ 3c3eb990
......@@ -39,8 +39,9 @@ public function __construct(EntityManagerInterface $entityManager) {
*/
protected function routes(RouteCollection $collection) {
foreach ($this->entityManager->getDefinitions() as $entity_type => $entity_info) {
if ($entity_info['translatable'] && isset($entity_info['translation'])) {