quickedit.module 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <?php
  2. /**
  3. * @file
  4. * Provides in-place content editing functionality for fields.
  5. *
  6. * The Quick Edit module makes content editable in-place. Rather than having to
  7. * visit a separate page to edit content, it may be edited in-place.
  8. *
  9. * Technically, this module adds classes and data- attributes to fields and
  10. * entities, enabling them for in-place editing.
  11. */
  12. use Drupal\Core\Entity\EntityInterface;
  13. use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
  14. use Drupal\Core\Routing\RouteMatchInterface;
  15. /**
  16. * Implements hook_help().
  17. */
  18. function quickedit_help($route_name, RouteMatchInterface $route_match) {
  19. switch ($route_name) {
  20. case 'help.page.quickedit':
  21. $output = '<h3>' . t('About') . '</h3>';
  22. $output .= '<p>' . t('The Quick Edit module allows users with the <a href=":quickedit_permission">Access in-place editing</a> and <a href=":contextual_permission">Use contextual links</a> permissions to edit field content without visiting a separate page. For more information, see the <a href=":handbook_url">online documentation for the Quick Edit module</a>.', [':handbook_url' => 'https://www.drupal.org/documentation/modules/edit', ':quickedit_permission' => \Drupal::url('user.admin_permissions', [], ['fragment' => 'module-quickedit']), ':contextual_permission' => \Drupal::url('user.admin_permissions', [], ['fragment' => 'module-contextual'])]) . '</p>';
  23. $output .= '<h3>' . t('Uses') . '</h3>';
  24. $output .= '<dl>';
  25. $output .= '<dt>' . t('Editing content in-place') . '</dt>';
  26. $output .= '<dd>';
  27. $output .= '<p>' . t('To edit content in place, you need to activate quick edit mode for a content item. Activate quick edit mode by choosing Quick edit from the contextual links for an area displaying the content (see the <a href=":contextual">Contextual Links module help</a> for more information about how to use contextual links).', [':contextual' => \Drupal::url('help.page', ['name' => 'contextual'])]) . '</p>';
  28. $output .= '<p>' . t('Once quick edit mode is activated, you will be able to edit the individual fields of your content. In the default theme, with a JavaScript-enabled browser and a mouse, the output of different fields in your content is outlined in blue, a pop-up gives the field name as you hover over the field output, and clicking on a field activates the editor. Closing the pop-up window ends quick edit mode.') . '</p>';
  29. $output .= '</dd>';
  30. $output .= '</dl>';
  31. return $output;
  32. }
  33. }
  34. /**
  35. * Implements hook_page_attachments().
  36. *
  37. * Adds the quickedit library to the page for any user who has the 'access
  38. * in-place editing' permission.
  39. */
  40. function quickedit_page_attachments(array &$page) {
  41. if (!\Drupal::currentUser()->hasPermission('access in-place editing')) {
  42. return;
  43. }
  44. // In-place editing is only supported on the front-end.
  45. if (\Drupal::service('router.admin_context')->isAdminRoute()) {
  46. return;
  47. }
  48. $page['#attached']['library'][] = 'quickedit/quickedit';
  49. }
  50. /**
  51. * Implements hook_library_info_alter().
  52. *
  53. * Includes additional stylesheets defined by the admin theme to allow it to
  54. * customize the Quick Edit toolbar appearance.
  55. *
  56. * An admin theme can specify CSS files to make the front-end administration
  57. * experience of in-place editing match the administration experience in the
  58. * back-end.
  59. *
  60. * The CSS files can be specified via the "edit_stylesheets" property in the
  61. * .info.yml file:
  62. * @code
  63. * quickedit_stylesheets:
  64. * - css/quickedit.css
  65. * @endcode
  66. */
  67. function quickedit_library_info_alter(&$libraries, $extension) {
  68. if ($extension === 'quickedit' && isset($libraries['quickedit'])) {
  69. $theme = Drupal::config('system.theme')->get('admin');
  70. // First let the base theme modify the library, then the actual theme.
  71. $alter_library = function(&$library, $theme) use (&$alter_library) {
  72. if (isset($theme) && $theme_path = drupal_get_path('theme', $theme)) {
  73. $info = system_get_info('theme', $theme);
  74. // Recurse to process base theme(s) first.
  75. if (isset($info['base theme'])) {
  76. $alter_library($library, $info['base theme']);
  77. }
  78. if (isset($info['quickedit_stylesheets'])) {
  79. foreach ($info['quickedit_stylesheets'] as $path) {
  80. $library['css']['theme']['/' . $theme_path . '/' . $path] = [];
  81. }
  82. }
  83. }
  84. };
  85. $alter_library($libraries['quickedit'], $theme);
  86. }
  87. }
  88. /**
  89. * Implements hook_field_formatter_info_alter().
  90. *
  91. * Quick Edit extends the @FieldFormatter annotation with the following keys:
  92. * - quickedit: currently only contains one subkey 'editor' which indicates
  93. * which in-place editor should be used. Possible values are 'form',
  94. * 'plain_text', 'disabled' or another in-place editor other than the ones
  95. * Quick Edit module provides.
  96. */
  97. function quickedit_field_formatter_info_alter(&$info) {
  98. foreach ($info as $key => $settings) {
  99. // Set in-place editor to 'form' if none is supplied.
  100. if (empty($settings['quickedit'])) {
  101. $info[$key]['quickedit'] = ['editor' => 'form'];
  102. }
  103. }
  104. }
  105. /**
  106. * Implements hook_preprocess_HOOK() for the page title template.
  107. */
  108. function quickedit_preprocess_page_title(&$variables) {
  109. $variables['#cache']['contexts'][] = 'user.permissions';
  110. if (\Drupal::currentUser()->hasPermission('access in-place editing')) {
  111. $variables['title_attributes']['class'][] = 'js-quickedit-page-title';
  112. }
  113. }
  114. /**
  115. * Implements hook_preprocess_HOOK() for field templates.
  116. */
  117. function quickedit_preprocess_field(&$variables) {
  118. $variables['#cache']['contexts'][] = 'user.permissions';
  119. if (!\Drupal::currentUser()->hasPermission('access in-place editing')) {
  120. return;
  121. }
  122. $element = $variables['element'];
  123. /** @var $entity \Drupal\Core\Entity\EntityInterface */
  124. $entity = $element['#object'];
  125. // Quick Edit module only supports view modes, not dynamically defined
  126. // "display options" (which \Drupal\Core\Field\FieldItemListInterface::view()
  127. // always names the "_custom" view mode).
  128. // @see \Drupal\Core\Field\FieldItemListInterface::view()
  129. // @see https://www.drupal.org/node/2120335
  130. if ($element['#view_mode'] === '_custom') {
  131. return;
  132. }
  133. // Fields that are computed fields are not editable.
  134. $definition = $entity->getFieldDefinition($element['#field_name']);
  135. if (!$definition->isComputed()) {
  136. $variables['attributes']['data-quickedit-field-id'] = $entity->getEntityTypeId() . '/' . $entity->id() . '/' . $element['#field_name'] . '/' . $element['#language'] . '/' . $element['#view_mode'];
  137. }
  138. }
  139. /**
  140. * Implements hook_entity_view_alter().
  141. */
  142. function quickedit_entity_view_alter(&$build, EntityInterface $entity, EntityViewDisplayInterface $display) {
  143. $build['#cache']['contexts'][] = 'user.permissions';
  144. if (!\Drupal::currentUser()->hasPermission('access in-place editing')) {
  145. return;
  146. }
  147. $build['#attributes']['data-quickedit-entity-id'] = $entity->getEntityTypeId() . '/' . $entity->id();
  148. }