class SearchLinks in Admin Toolbar 8.2

Extra search links.

Hierarchy

• class \Drupal\admin_toolbar_search\SearchLinks uses StringTranslationTrait

1 file declares its use of SearchLinks

AdminToolbarSearchController.php in admin_toolbar_search/src/Controller/AdminToolbarSearchController.php

1 string reference to 'SearchLinks'

admin_toolbar_search.services.yml in admin_toolbar_search/admin_toolbar_search.services.yml

admin_toolbar_search/admin_toolbar_search.services.yml

1 service uses SearchLinks

admin_toolbar_search.search_links in admin_toolbar_search/admin_toolbar_search.services.yml

Drupal\admin_toolbar_search\SearchLinks

File

admin_toolbar_search/src/SearchLinks.php, line 20

Namespace

Drupal\admin_toolbar_search

class SearchLinks {
  use StringTranslationTrait;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

  /**
   * The cache context manager service.
   *
   * @var \Drupal\Core\Cache\Context\CacheContextsManager
   */
  protected $cacheContextManager;

  /**
   * The toolbar cache bin.
   *
   * @var \Drupal\Core\Cache\CacheBackendInterface
   */
  protected $toolbarCache;

  /**
   * The admin toolbar tools configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * Constructs a SearchLinks object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
   *   The route provider.
   * @param \Drupal\Core\Cache\Context\CacheContextsManager $cache_context_manager
   *   The cache contexts manager.
   * @param \Drupal\Core\Cache\CacheBackendInterface $toolbar_cache
   *   Cache backend instance to use.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory mservice.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, ModuleHandlerInterface $module_handler, RouteProviderInterface $route_provider, CacheContextsManager $cache_context_manager, CacheBackendInterface $toolbar_cache, ConfigFactoryInterface $config_factory) {
    $this->entityTypeManager = $entity_type_manager;
    $this->moduleHandler = $module_handler;
    $this->routeProvider = $route_provider;
    $this->cacheContextManager = $cache_context_manager;
    $this->toolbarCache = $toolbar_cache;
    $this->config = $config_factory
      ->get('admin_toolbar_tools.settings');
  }

  /**
   * Gets extra links for admin toolbar search feature.
   *
   * @return array
   *   An array of link data for the JSON used for search.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getLinks() {
    $max_bundle_number = $this->config
      ->get('max_bundle_number');
    $additional_keys = $this->cacheContextManager
      ->convertTokensToKeys([
      'languages:' . LanguageInterface::TYPE_INTERFACE,
      'user.permissions',
    ])
      ->getKeys();
    $cid_parts = array_merge([
      'admin_toolbar_search:links',
    ], $additional_keys);
    $cid = implode(':', $cid_parts);
    if ($cache = $this->toolbarCache
      ->get($cid)) {
      return $cache->data;
    }
    $links = [];
    $cache_tags = [];
    $content_entities = $this
      ->getBundleableEntitiesList();

    // Adds common links to entities.
    foreach ($content_entities as $entities) {
      $content_entity_bundle = $entities['content_entity_bundle'];
      $content_entity = $entities['content_entity'];

      // Load the remaining items that were not loaded by the toolbar.
      $content_entity_bundle_storage = $this->entityTypeManager
        ->getStorage($content_entity_bundle);
      $bundles_ids = $content_entity_bundle_storage
        ->getQuery()
        ->range($max_bundle_number)
        ->execute();
      if (!empty($bundles_ids)) {
        $bundles = $this->entityTypeManager
          ->getStorage($content_entity_bundle)
          ->loadMultiple($bundles_ids);
        foreach ($bundles as $machine_name => $bundle) {
          $cache_tags = Cache::mergeTags($cache_tags, $bundle
            ->getEntityType()
            ->getListCacheTags());
          $tparams = [
            '@entity_type' => $bundle
              ->getEntityType()
              ->getLabel(),
            '@bundle' => $bundle
              ->label(),
          ];
          $label_base = $this
            ->t('@entity_type > @bundle', $tparams);
          $params = [
            $content_entity_bundle => $machine_name,
          ];
          if ($this
            ->routeExists('entity.' . $content_entity_bundle . '.overview_form')) {

            // Some bundles have an overview/list form that make a better root
            // link.
            $url = Url::fromRoute('entity.' . $content_entity_bundle . '.overview_form', $params);
            if ($url
              ->access()) {
              $url_string = $url
                ->toString();
              $links[] = [
                'labelRaw' => $label_base,
                'value' => $url_string,
              ];
            }
          }
          if ($this
            ->routeExists('entity.' . $content_entity_bundle . '.edit_form')) {
            $url = Url::fromRoute('entity.' . $content_entity_bundle . '.edit_form', $params);
            if ($url
              ->access()) {
              $url_string = $url
                ->toString();
              $links[] = [
                'labelRaw' => $label_base . ' > ' . $this
                  ->t('Edit'),
                'value' => $url_string,
              ];
            }
          }
          if ($this->moduleHandler
            ->moduleExists('field_ui')) {
            if ($this
              ->routeExists('entity.' . $content_entity . '.field_ui_fields')) {
              $url = Url::fromRoute('entity.' . $content_entity . '.field_ui_fields', $params);
              if ($url
                ->access()) {
                $url_string = $url
                  ->toString();
                $links[] = [
                  'labelRaw' => $label_base . ' > ' . $this
                    ->t('Manage fields'),
                  'value' => $url_string,
                ];
              }
            }
            if ($this
              ->routeExists('entity.entity_form_display.' . $content_entity . '.default')) {
              $url = Url::fromRoute('entity.entity_form_display.' . $content_entity . '.default', $params);
              if ($url
                ->access()) {
                $url_string = $url
                  ->toString();
                $links[] = [
                  'labelRaw' => $label_base . ' > ' . $this
                    ->t('Manage form display'),
                  'value' => $url_string,
                ];
              }
            }
            if ($this
              ->routeExists('entity.entity_view_display.' . $content_entity . '.default')) {
              $url = Url::fromRoute('entity.entity_view_display.' . $content_entity . '.default', $params);
              if ($url
                ->access()) {
                $url_string = $url
                  ->toString();
                $links[] = [
                  'labelRaw' => $label_base . ' > ' . $this
                    ->t('Manage display'),
                  'value' => $url_string,
                ];
              }
            }
            if ($this->moduleHandler
              ->moduleExists('devel') && $this
              ->routeExists('entity.' . $content_entity_bundle . '.devel_load')) {
              $url = Url::fromRoute($route_name = 'entity.' . $content_entity_bundle . '.devel_load', $params);
              if ($url
                ->access()) {
                $url_string = $url
                  ->toString();
                $links[] = [
                  'labelRaw' => $label_base . ' > ' . $this
                    ->t('Devel'),
                  'value' => $url_string,
                ];
              }
            }
            if ($this
              ->routeExists('entity.' . $content_entity_bundle . '.delete_form')) {
              $url = Url::fromRoute('entity.' . $content_entity_bundle . '.delete_form', $params);
              if ($url
                ->access()) {
                $url_string = $url
                  ->toString();
                $links[] = [
                  'labelRaw' => $label_base . ' > ' . $this
                    ->t('Delete'),
                  'value' => $url_string,
                ];
              }
            }
          }
        }
      }
    }

    // Add menu links.
    if ($this->moduleHandler
      ->moduleExists('menu_ui')) {
      $menus = $this->entityTypeManager
        ->getStorage('menu')
        ->loadMultiple();
      uasort($menus, [
        Menu::class,
        'sort',
      ]);
      $menus = array_slice($menus, $max_bundle_number);
      $cache_tags = Cache::mergeTags($cache_tags, [
        'config:menu_list',
      ]);
      foreach ($menus as $menu_id => $menu) {
        $route_name = 'entity.menu.edit_form';
        $params = [
          'menu' => $menu_id,
        ];
        $url = Url::fromRoute($route_name, $params);
        if ($url
          ->access()) {
          $url_string = $url
            ->toString();
          $links[] = [
            'labelRaw' => $this
              ->t('Menus > @menu_label', [
              '@menu_label' => $menu
                ->label(),
            ]),
            'value' => $url_string,
          ];
        }
        $route_name = 'entity.menu.add_link_form';
        $params = [
          'menu' => $menu_id,
        ];
        $url = Url::fromRoute($route_name, $params);
        if ($url
          ->access()) {
          $url_string = $url
            ->toString();
          $links[] = [
            'labelRaw' => $this
              ->t('Menus > @menu_label > ', [
              '@menu_label' => $menu
                ->label(),
            ]) . $this
              ->t('Add link'),
            'value' => $url_string,
          ];
        }
        $menus = [
          'admin',
          'devel',
          'footer',
          'main',
          'tools',
          'account',
        ];
        if (!in_array($menu_id, $menus)) {
          $route_name = 'entity.menu.delete_form';
          $params = [
            'menu' => $menu_id,
          ];
          $url = Url::fromRoute($route_name, $params);
          if ($url
            ->access()) {
            $url_string = $url
              ->toString();
            $links[] = [
              'labelRaw' => $this
                ->t('Menus > @menu_label > ', [
                '@menu_label' => $menu
                  ->label(),
              ]) . $this
                ->t('Delete'),
              'value' => $url_string,
            ];
          }
        }
        if ($this->moduleHandler
          ->moduleExists('devel') && $this
          ->routeExists('entity.menu.devel_load')) {
          $route_name = 'entity.menu.devel_load';
          $params = [
            'menu' => $menu_id,
          ];
          $url = Url::fromRoute($route_name, $params);
          if ($url
            ->access()) {
            $url_string = $url
              ->toString();
            $links[] = [
              'labelRaw' => $this
                ->t('Menus > @menu_label > ', [
                '@menu_label' => $menu
                  ->label(),
              ]) . $this
                ->t('Devel'),
              'value' => $url_string,
            ];
          }
        }
      }
    }
    $this->toolbarCache
      ->set($cid, $links, Cache::PERMANENT, $cache_tags);
    return $links;
  }

  /**
   * Gets a list of content entities.
   *
   * @return array
   *   An array of metadata about content entities.
   */
  protected function getBundleableEntitiesList() {
    $entity_types = $this->entityTypeManager
      ->getDefinitions();
    $content_entities = [];
    foreach ($entity_types as $key => $entity_type) {
      if ($entity_type
        ->getBundleEntityType() && $entity_type
        ->get('field_ui_base_route') != '') {
        $content_entities[$key] = [
          'content_entity' => $key,
          'content_entity_bundle' => $entity_type
            ->getBundleEntityType(),
        ];
      }
    }
    return $content_entities;
  }

  /**
   * Determine if a route exists by name.
   *
   * @param string $route_name
   *   The name of the route to check.
   *
   * @return bool
   *   Whether a route with that route name exists.
   */
  public function routeExists($route_name) {
    return count($this->routeProvider
      ->getRoutesByNames([
      $route_name,
    ])) === 1;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchLinks::$cacheContextManager	protected	property	The cache context manager service.
SearchLinks::$config	protected	property	The admin toolbar tools configuration.
SearchLinks::$entityTypeManager	protected	property	The entity type manager.
SearchLinks::$moduleHandler	protected	property	The module handler.
SearchLinks::$routeProvider	protected	property	The route provider.
SearchLinks::$toolbarCache	protected	property	The toolbar cache bin.
SearchLinks::getBundleableEntitiesList	protected	function	Gets a list of content entities.
SearchLinks::getLinks	public	function	Gets extra links for admin toolbar search feature.
SearchLinks::routeExists	public	function	Determine if a route exists by name.
SearchLinks::__construct	public	function	Constructs a SearchLinks object.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.