class CategoryAutocompleteController

Same name and namespace in other branches
  1. 9 core/modules/block/src/Controller/CategoryAutocompleteController.php \Drupal\block\Controller\CategoryAutocompleteController
  2. 8.9.x core/modules/block/src/Controller/CategoryAutocompleteController.php \Drupal\block\Controller\CategoryAutocompleteController
  3. 11.x core/modules/block/src/Controller/CategoryAutocompleteController.php \Drupal\block\Controller\CategoryAutocompleteController

Returns autocomplete responses for block categories.

Hierarchy

Expanded class hierarchy of CategoryAutocompleteController

1 file declares its use of CategoryAutocompleteController
CategoryAutocompleteTest.php in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

File

core/modules/block/src/Controller/CategoryAutocompleteController.php, line 15

Namespace

Drupal\block\Controller
View source 
class CategoryAutocompleteController implements ContainerInjectionInterface {
    
    /**
     * The block manager.
     *
     * @var \Drupal\Core\Block\BlockManagerInterface
     */
    protected $blockManager;
    
    /**
     * Constructs a new CategoryAutocompleteController.
     *
     * @param \Drupal\Core\Block\BlockManagerInterface $block_manager
     *   The block manager.
     */
    public function __construct(BlockManagerInterface $block_manager) {
        $this->blockManager = $block_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('plugin.manager.block'));
    }
    
    /**
     * Retrieves suggestions for block category autocompletion.
     *
     * @param \Symfony\Component\HttpFoundation\Request $request
     *   The current request.
     *
     * @return \Symfony\Component\HttpFoundation\JsonResponse
     *   A JSON response containing autocomplete suggestions.
     */
    public function autocomplete(Request $request) {
        $typed_category = $request->query
            ->get('q');
        $matches = [];
        foreach ($this->blockManager
            ->getCategories() as $category) {
            if (stripos($category, $typed_category) === 0) {
                $matches[] = [
                    'value' => $category,
                    'label' => Html::escape($category),
                ];
            }
        }
        return new JsonResponse($matches);
    }

}

Members

Title Modifiers Object type Summary Overriden Title
CategoryAutocompleteController::$blockManager protected property The block manager.
CategoryAutocompleteController::autocomplete public function Retrieves suggestions for block category autocompletion.
CategoryAutocompleteController::create public static function Overrides ContainerInjectionInterface::create
CategoryAutocompleteController::__construct public function Constructs a new CategoryAutocompleteController.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.