class MenuSelectAutocompleteController in Menu Select 2.0.x

Defines a controller class with methods for auto complete.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\menu_select\Controller\MenuSelectAutocompleteController

File

src/Controller/MenuSelectAutocompleteController.php, line 14

Namespace

Drupal\menu_select\Controller

class MenuSelectAutocompleteController extends ControllerBase {

  /**
   * The tree builder service.
   *
   * @var \Drupal\menu_select\MenuSelectTreeBuilderInterface
   */
  protected $treeBuilder;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->treeBuilder = $container
      ->get('menu_select.tree_builder');
    return $instance;
  }

  /**
   * Returns autocomplete content for the given search queries.
   *
   * @return \Symfony\Component\HttpFoundation\JsonResponse
   *   A JSON response.
   */
  public function autocomplete($menus, $max_depth, Request $request) {
    $keyword = $request->query
      ->get('q');
    $menu_ids = explode(':', $menus);
    $matching_links = $this
      ->getMatchingLinks($keyword, $menu_ids, $max_depth);
    $autocomplete = [];
    foreach ($matching_links as $key => $label) {
      $autocomplete[] = [
        'value' => (string) $key,
        'label' => $label,
      ];
    }
    return new JsonResponse($autocomplete);
  }

  /**
   * Get links matching the given keyword.
   *
   * @param string $keyword
   *   The keyword to search for.
   * @param array $menus
   *   An array of menus to search.
   * @param int $max_depth
   *   The maximum depth to search.
   *
   * @return array
   *   An array of link options matching the keyword.
   */
  protected function getMatchingLinks($keyword, array $menus, $max_depth) {
    $options = [];
    foreach ($menus as $menu_name) {
      $tree = $this->treeBuilder
        ->loadMenuTree($menu_name, $max_depth);
      $candidates = [];
      $this
        ->buildCandidateLinks($tree, $menu_name, $candidates);
      foreach ($candidates as $key => $menu_link_label) {
        if (stripos($menu_link_label, $keyword) !== FALSE) {
          $options[$key] = $menu_link_label;
        }
      }
    }
    return $options;
  }

  /**
   * Build a recursive list of all candidates.
   *
   * @param array $tree
   *   A menu tree.
   * @param string $menu_name
   *   The menu name.
   * @param array $options
   *   An array of options, built recurwsively.
   */
  protected function buildCandidateLinks(array $tree, $menu_name, array &$options) {
    foreach ($tree as $data) {
      $title = $data->link
        ->getTitle();
      $options[$menu_name . ':' . $data->link
        ->getPluginId()] = $title;
      if (!empty($data->subtree)) {
        $this
          ->buildCandidateLinks($data->subtree, $menu_name, $options);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MenuSelectAutocompleteController::$treeBuilder	protected	property	The tree builder service.
MenuSelectAutocompleteController::autocomplete	public	function	Returns autocomplete content for the given search queries.
MenuSelectAutocompleteController::buildCandidateLinks	protected	function	Build a recursive list of all candidates.
MenuSelectAutocompleteController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
MenuSelectAutocompleteController::getMatchingLinks	protected	function	Get links matching the given keyword.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.