' . t('The Admin Toolbar module enhances the Toolbar module by providing fast access to all the administrative links at the top of your site. Admin Toolbar remains a very "lightweight" module by closely integrating with all Toolbar functionality. It can be used in conjunction with all the sub modules included on Admin Toolbar, for quick access to system commands such as Flush all caches, Run cron, Run Updates, etc.', $variables) . '
'; - $output .= '' . t('The Admin Toolbar greatly improves the user experience for those who regularly interact with the site Toolbar by providing fast, full access to all links in the site Toolbar without having to click to get there.') . '
'; - return $output; - } + return \Drupal::service(AdminToolbarHooks::class)->help($route_name); } /** * Implements hook_toolbar_alter(). */ +#[LegacyHook] function admin_toolbar_toolbar_alter(&$items) { - $items['administration']['tray']['toolbar_administration']['#pre_render'] = [ - [AdminToolbar::class, 'preRenderTray'], - ]; - $admin_toolbar_config = \Drupal::config('admin_toolbar.settings'); - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree'; - - // Add sticky behavior libraries based on the configuration. - $sticky_behavior = $admin_toolbar_config->get('sticky_behavior') ?? 'enabled'; - switch ($sticky_behavior) { - case 'disabled': - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.disable_sticky'; - break; - - case 'hide_on_scroll_down': - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.sticky_behavior'; - break; - - default: - break; - } - // Add the hoverIntent behavior library if enabled. - $hoverintent_behavior = $admin_toolbar_config->get('hoverintent_behavior'); - if (!empty($hoverintent_behavior['enabled'])) { - // Use the hoverIntent plugin library. - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree.hoverintent'; - // Add the configured hoverIntent settings values to the JS of the toolbar. - $items['administration']['#attached']['drupalSettings']['hoverIntentTimeout'] = $hoverintent_behavior['timeout']; - } - else { - // Use default Admin Toolbar hover library. - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree.hover'; - } - - // Add the toggle toolbar keyboard shortcut library if enabled. - if ($admin_toolbar_config->get('enable_toggle_shortcut')) { - $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.toggle_shortcut'; - } + \Drupal::service(AdminToolbarHooks::class)->toolbarAlter($items); } /** diff --git a/admin_toolbar.services.yml b/admin_toolbar.services.yml new file mode 100644 index 0000000..3758f5e --- /dev/null +++ b/admin_toolbar.services.yml @@ -0,0 +1,5 @@ + +services: + Drupal\admin_toolbar\Hook\AdminToolbarHooks: + class: Drupal\admin_toolbar\Hook\AdminToolbarHooks + autowire: true diff --git a/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.install b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.install index 42bc764..7996666 100644 --- a/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.install +++ b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.install @@ -1,5 +1,12 @@ #3463291 and #348724 ':issue_url1' => 'https://www.drupal.org/node/3463291', ':issue_url2' => 'https://www.drupal.org/node/3487246', ]), - 'severity' => REQUIREMENT_ERROR, + 'severity' => DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.2.0', fn() => RequirementSeverity::Error, fn() => REQUIREMENT_ERROR), ]; } } diff --git a/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.module b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.module index f6cc614..36a6c44 100644 --- a/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.module +++ b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.module @@ -5,6 +5,8 @@ * This module don't show menu links that you don't have access permission for. */ +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\admin_toolbar_links_access_filter\Hook\AdminToolbarLinksAccessFilterHooks; use Drupal\Core\Routing\RouteMatchInterface; use Drupal\Core\Session\AccountInterface; use Drupal\user\Entity\Role; @@ -13,16 +15,9 @@ use Symfony\Component\Routing\Exception\RouteNotFoundException; /** * Implements hook_help(). */ +#[LegacyHook] function admin_toolbar_links_access_filter_help($route_name, RouteMatchInterface $route_match) { - switch ($route_name) { - // Main module help. - case 'help.page.admin_toolbar_links_access_filter': - $output = ''; - $output .= '' . t('The Admin Toolbar Links Access Filter module provides a workaround for the common problem that users with Use the administration pages and help permission see menu links they done not have access permission for.') . '
'; - - return $output; - } + return \Drupal::service(AdminToolbarLinksAccessFilterHooks::class)->help($route_name, $route_match); } /** @@ -30,28 +25,9 @@ function admin_toolbar_links_access_filter_help($route_name, RouteMatchInterface * * Hides links from admin menu, if user doesn't have access rights. */ +#[LegacyHook] function admin_toolbar_links_access_filter_preprocess_menu(&$variables) { - if (empty($variables['items'])) { - // Additional empty check to prevent exotic situations, where the preprocess - // function is entered even without items. - // @see https://www.drupal.org/node/2833885 - return; - } - // Ensure that menu_name exists. - if (!isset($variables['menu_name'])) { - // In rare cases (for unknown reasons) menu_name may not be set. - // As fallback, we can fetch it from the first menu item. - $first_link = reset($variables['items']); - /** @var Drupal\Core\Menu\MenuLinkDefault $original_link */ - // Fetch the menu_name from the original link. - $original_link = $first_link['original_link']; - $variables['menu_name'] = $original_link->getMenuName(); - } - if ($variables['menu_name'] == 'admin') { - if (!admin_toolbar_links_access_filter_user_has_admin_role($variables['user'])) { - admin_toolbar_links_access_filter_filter_non_accessible_links($variables['items']); - } - } + \Drupal::service(AdminToolbarLinksAccessFilterHooks::class)->preprocessMenu($variables); } /** diff --git a/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.services.yml b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.services.yml new file mode 100644 index 0000000..64255e7 --- /dev/null +++ b/admin_toolbar_links_access_filter/admin_toolbar_links_access_filter.services.yml @@ -0,0 +1,5 @@ + +services: + Drupal\admin_toolbar_links_access_filter\Hook\AdminToolbarLinksAccessFilterHooks: + class: Drupal\admin_toolbar_links_access_filter\Hook\AdminToolbarLinksAccessFilterHooks + autowire: true diff --git a/admin_toolbar_links_access_filter/src/Hook/AdminToolbarLinksAccessFilterHooks.php b/admin_toolbar_links_access_filter/src/Hook/AdminToolbarLinksAccessFilterHooks.php new file mode 100644 index 0000000..3ce2754 --- /dev/null +++ b/admin_toolbar_links_access_filter/src/Hook/AdminToolbarLinksAccessFilterHooks.php @@ -0,0 +1,60 @@ +' . $this->t('About') . ''; + $output .= '' . $this->t('The Admin Toolbar Links Access Filter module provides a workaround for the common problem that users with Use the administration pages and help permission see menu links they done not have access permission for.') . '
'; + return $output; + } + } + + /** + * Implements hook_preprocess_menu(). + * + * Hides links from admin menu, if user doesn't have access rights. + */ + #[Hook('preprocess_menu')] + public static function preprocessMenu(&$variables) { + if (empty($variables['items'])) { + // Additional empty check to prevent exotic situations, where the preprocess + // function is entered even without items. + // @see https://www.drupal.org/node/2833885 + return; + } + // Ensure that menu_name exists. + if (!isset($variables['menu_name'])) { + // In rare cases (for unknown reasons) menu_name may not be set. + // As fallback, we can fetch it from the first menu item. + $first_link = reset($variables['items']); + /** @var Drupal\Core\Menu\MenuLinkDefault $original_link */ + // Fetch the menu_name from the original link. + $original_link = $first_link['original_link']; + $variables['menu_name'] = $original_link->getMenuName(); + } + if ($variables['menu_name'] == 'admin') { + if (!admin_toolbar_links_access_filter_user_has_admin_role($variables['user'])) { + admin_toolbar_links_access_filter_filter_non_accessible_links($variables['items']); + } + } + } + +} diff --git a/admin_toolbar_search/admin_toolbar_search.install b/admin_toolbar_search/admin_toolbar_search.install index 5826632..f58d798 100644 --- a/admin_toolbar_search/admin_toolbar_search.install +++ b/admin_toolbar_search/admin_toolbar_search.install @@ -1,5 +1,11 @@ get('display_menu_item'); // Update the configuration settings. - $admin_toolbar_search_config + DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '11.4.0', fn() => $admin_toolbar_search_config + // Convert the existing field value from an integer to a boolean. + ->set('display_menu_item', (bool) $display_menu_item) + // Enable the keyboard shortcut by default. + ->set('enable_keyboard_shortcut', TRUE)->save(), fn() => $admin_toolbar_search_config // Convert the existing field value from an integer to a boolean. ->set('display_menu_item', (bool) $display_menu_item) // Enable the keyboard shortcut by default. ->set('enable_keyboard_shortcut', TRUE) - ->save(TRUE); + ->save(TRUE)); } /** diff --git a/admin_toolbar_search/admin_toolbar_search.module b/admin_toolbar_search/admin_toolbar_search.module index 3ed6cab..01a8cf8 100644 --- a/admin_toolbar_search/admin_toolbar_search.module +++ b/admin_toolbar_search/admin_toolbar_search.module @@ -7,24 +7,15 @@ declare(strict_types=1); -use Drupal\admin_toolbar_search\Constants\AdminToolbarSearchConstants; -use Drupal\Component\Utility\NestedArray; -use Drupal\Core\Url; +use Drupal\Core\Hook\Attribute\LegacyHook; +use Drupal\admin_toolbar_search\Hook\AdminToolbarSearchHooks; /** * Implements hook_help(). */ +#[LegacyHook] function admin_toolbar_search_help($route_name) { - switch ($route_name) { - // Main user documentation page for the Admin Toolbar Search module. - case 'help.page.admin_toolbar_search': - $output = ''; - $output .= '' . t('Type text to quickly search for menu links in the Admin Toolbar!
') . '
' . t('The Admin Toolbar Search module adds an easy-to-use JS autocomplete filter of the links in the Administration menu.
It is very convenient for finding quickly an administration configuration page without knowing where its menu link could be in the Administration dropdown menu or the organization of the site.') . '
' . $this->t('Type text to quickly search for menu links in the Admin Toolbar!
') . '
' . $this->t('The Admin Toolbar Search module adds an easy-to-use JS autocomplete filter of the links in the Administration menu.
It is very convenient for finding quickly an administration configuration page without knowing where its menu link could be in the Administration dropdown menu or the organization of the site.') . '
'; - $output .= t('The Admin Toolbar Extra Tools module comes packaged with the Admin Toolbar module and adds functionality to it. The additional functionality is accessed through extra links on the main administration Toolbar. Some links to Admin Toolbar Extra Tools administration pages are located at the bottom of this page.
' . t('To use Admin Toolbar Extra Tools just install it like any other module. There is no other configuration required.') . '
'; - return $output; - } + return \Drupal::service(AdminToolbarToolsHooks::class)->help($route_name, $route_match); } /** * Implements hook_entity_insert(). */ +#[LegacyHook] function admin_toolbar_tools_entity_insert(EntityInterface $entity) { - // Skip rebuild during config sync because rebuild should - // always be a post-sync step. - if (!\Drupal::isConfigSyncing()) { - $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); - if (in_array($entity->getEntityTypeId(), $entities)) { - \Drupal::service('plugin.manager.menu.link')->rebuild(); - } - } + \Drupal::service(AdminToolbarToolsHooks::class)->entityInsert($entity); } /** * Implements hook_entity_update(). */ +#[LegacyHook] function admin_toolbar_tools_entity_update(EntityInterface $entity) { - // Skip rebuild during config sync because rebuild should - // always be a post-sync step. - if (!\Drupal::isConfigSyncing()) { - $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); - if (in_array($entity->getEntityTypeId(), $entities)) { - \Drupal::service('plugin.manager.menu.link')->rebuild(); - } - } + \Drupal::service(AdminToolbarToolsHooks::class)->entityUpdate($entity); } /** * Implements hook_entity_delete(). */ +#[LegacyHook] function admin_toolbar_tools_entity_delete(EntityInterface $entity) { - // Skip rebuild during config sync because rebuild should - // always be a post-sync step. - if (!\Drupal::isConfigSyncing()) { - $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); - if (in_array($entity->getEntityTypeId(), $entities)) { - \Drupal::service('plugin.manager.menu.link')->rebuild(); - } - } + \Drupal::service(AdminToolbarToolsHooks::class)->entityDelete($entity); } /** * Implements hook_form_FORM_ID_alter(). */ +#[LegacyHook] function admin_toolbar_tools_form_project_browser_settings_alter(&$form) { - // Project browser settings form: Add a submit handler to rebuild menu items. - $form['#submit'][] = 'admin_toolbar_tools_project_browser_settings_submit'; + \Drupal::service(AdminToolbarToolsHooks::class)->formProjectBrowserSettingsAlter($form); } /** diff --git a/admin_toolbar_tools/admin_toolbar_tools.services.yml b/admin_toolbar_tools/admin_toolbar_tools.services.yml index f910183..0f35fe6 100644 --- a/admin_toolbar_tools/admin_toolbar_tools.services.yml +++ b/admin_toolbar_tools/admin_toolbar_tools.services.yml @@ -6,3 +6,7 @@ services: - '@plugin.manager.menu.local_task' - '@current_route_match' - '@config.factory' + + Drupal\admin_toolbar_tools\Hook\AdminToolbarToolsHooks: + class: Drupal\admin_toolbar_tools\Hook\AdminToolbarToolsHooks + autowire: true diff --git a/admin_toolbar_tools/src/Controller/ToolbarController.php b/admin_toolbar_tools/src/Controller/ToolbarController.php index f16cb1b..3ced572 100644 --- a/admin_toolbar_tools/src/Controller/ToolbarController.php +++ b/admin_toolbar_tools/src/Controller/ToolbarController.php @@ -4,6 +4,7 @@ declare(strict_types=1); namespace Drupal\admin_toolbar_tools\Controller; +use Drupal\Component\Utility\DeprecationHelper; use Drupal\Core\Controller\ControllerBase; use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\HttpFoundation\RedirectResponse; @@ -189,7 +190,7 @@ class ToolbarController extends ControllerBase { // @todo Remove deprecated code when support for core:10.2 is dropped. if (floatval(\Drupal::VERSION) < 10.2) { // @phpstan-ignore-next-line - _drupal_flush_css_js(); + DeprecationHelper::backwardsCompatibleCall(\Drupal::VERSION, '10.2.0', fn() => \Drupal::service('asset.query_string')->reset(), fn() => _drupal_flush_css_js()); } else { $this->assetQueryString->reset(); diff --git a/admin_toolbar_tools/src/Hook/AdminToolbarToolsHooks.php b/admin_toolbar_tools/src/Hook/AdminToolbarToolsHooks.php new file mode 100644 index 0000000..ffc15ce --- /dev/null +++ b/admin_toolbar_tools/src/Hook/AdminToolbarToolsHooks.php @@ -0,0 +1,120 @@ + 'toolbar_item', + 'tab' => [ + '#type' => 'link', + '#attributes' => [ + 'class' => [ + 'toolbar-icon', + 'toolbar-icon-admin-toolbar-tools-help', + ], + ], + ], + '#attached' => [ + 'library' => [ + 'admin_toolbar_tools/toolbar.icon', + ], + ], + ]; + // Toolbar item for primary local tasks. + $items['admin_toolbar_local_tasks'] = \Drupal::service('admin_toolbar_tools.helper')->buildLocalTasksToolbar(); + return $items; + } + + /** + * Implements hook_help(). + */ + #[Hook('help')] + public function help($route_name, RouteMatchInterface $route_match) { + switch ($route_name) { + case 'help.page.admin_toolbar_tools': + $output = ''; + $output .= ''; + $output .= $this->t('The Admin Toolbar Extra Tools module comes packaged with the Admin Toolbar module and adds functionality to it. The additional functionality is accessed through extra links on the main administration Toolbar. Some links to Admin Toolbar Extra Tools administration pages are located at the bottom of this page.', [ + ':admin-toolbar' => Url::fromRoute('help.page', [ + 'name' => 'admin_toolbar', + ])->toString(), + ]); + $output .= '
'; + $output .= '' . $this->t('To use Admin Toolbar Extra Tools just install it like any other module. There is no other configuration required.') . '
'; + return $output; + } + } + + /** + * Implements hook_entity_insert(). + */ + #[Hook('entity_insert')] + public static function entityInsert(EntityInterface $entity) { + // Skip rebuild during config sync because rebuild should + // always be a post-sync step. + if (!\Drupal::isConfigSyncing()) { + $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); + if (in_array($entity->getEntityTypeId(), $entities)) { + \Drupal::service('plugin.manager.menu.link')->rebuild(); + } + } + } + + /** + * Implements hook_entity_update(). + */ + #[Hook('entity_update')] + public static function entityUpdate(EntityInterface $entity) { + // Skip rebuild during config sync because rebuild should + // always be a post-sync step. + if (!\Drupal::isConfigSyncing()) { + $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); + if (in_array($entity->getEntityTypeId(), $entities)) { + \Drupal::service('plugin.manager.menu.link')->rebuild(); + } + } + } + + /** + * Implements hook_entity_delete(). + */ + #[Hook('entity_delete')] + public static function entityDelete(EntityInterface $entity) { + // Skip rebuild during config sync because rebuild should + // always be a post-sync step. + if (!\Drupal::isConfigSyncing()) { + $entities = \Drupal::service('admin_toolbar_tools.helper')->getRebuildEntityTypes(); + if (in_array($entity->getEntityTypeId(), $entities)) { + \Drupal::service('plugin.manager.menu.link')->rebuild(); + } + } + } + + /** + * Implements hook_form_FORM_ID_alter(). + */ + #[Hook('form_project_browser_settings_alter')] + public static function formProjectBrowserSettingsAlter(&$form) { + // Project browser settings form: Add a submit handler to rebuild menu items. + $form['#submit'][] = 'admin_toolbar_tools_project_browser_settings_submit'; + } + +} diff --git a/src/Hook/AdminToolbarHooks.php b/src/Hook/AdminToolbarHooks.php new file mode 100644 index 0000000..2130f32 --- /dev/null +++ b/src/Hook/AdminToolbarHooks.php @@ -0,0 +1,85 @@ + Url::fromRoute('help.page', [ + 'name' => 'toolbar', + ])->toString(), + ':automated_cron' => \Drupal::moduleHandler()->moduleExists('automated_cron') ? Url::fromRoute('help.page', [ + 'name' => 'automated_cron', + ])->toString() : '#', + ]; + $output = ''; + $output .= '' . $this->t('The Admin Toolbar module enhances the Toolbar module by providing fast access to all the administrative links at the top of your site. Admin Toolbar remains a very "lightweight" module by closely integrating with all Toolbar functionality. It can be used in conjunction with all the sub modules included on Admin Toolbar, for quick access to system commands such as Flush all caches, Run cron, Run Updates, etc.', $variables) . '
'; + $output .= '' . $this->t('The Admin Toolbar greatly improves the user experience for those who regularly interact with the site Toolbar by providing fast, full access to all links in the site Toolbar without having to click to get there.') . '
'; + return $output; + } + } + + /** + * Implements hook_toolbar_alter(). + */ + #[Hook('toolbar_alter')] + public static function toolbarAlter(&$items) { + $items['administration']['tray']['toolbar_administration']['#pre_render'] = [ + [ + AdminToolbar::class, + 'preRenderTray', + ], + ]; + $admin_toolbar_config = \Drupal::config('admin_toolbar.settings'); + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree'; + // Add sticky behavior libraries based on the configuration. + $sticky_behavior = $admin_toolbar_config->get('sticky_behavior') ?? 'enabled'; + switch ($sticky_behavior) { + case 'disabled': + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.disable_sticky'; + break; + + case 'hide_on_scroll_down': + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.sticky_behavior'; + break; + + default: + break; + } + // Add the hoverIntent behavior library if enabled. + $hoverintent_behavior = $admin_toolbar_config->get('hoverintent_behavior'); + if (!empty($hoverintent_behavior['enabled'])) { + // Use the hoverIntent plugin library. + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree.hoverintent'; + // Add the configured hoverIntent settings values to the JS of the toolbar. + $items['administration']['#attached']['drupalSettings']['hoverIntentTimeout'] = $hoverintent_behavior['timeout']; + } + else { + // Use default Admin Toolbar hover library. + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.tree.hover'; + } + // Add the toggle toolbar keyboard shortcut library if enabled. + if ($admin_toolbar_config->get('enable_toggle_shortcut')) { + $items['administration']['#attached']['library'][] = 'admin_toolbar/toolbar.toggle_shortcut'; + } + } + +}