class SearchPageRoutes

Same name in other branches
  1. 9 core/modules/search/src/Routing/SearchPageRoutes.php \Drupal\search\Routing\SearchPageRoutes
  2. 8.9.x core/modules/search/src/Routing/SearchPageRoutes.php \Drupal\search\Routing\SearchPageRoutes
  3. 11.x core/modules/search/src/Routing/SearchPageRoutes.php \Drupal\search\Routing\SearchPageRoutes

Provides dynamic routes for search.

Hierarchy

Expanded class hierarchy of SearchPageRoutes

File

core/modules/search/src/Routing/SearchPageRoutes.php, line 13

Namespace

Drupal\search\Routing
View source
class SearchPageRoutes implements ContainerInjectionInterface {
    
    /**
     * The search page repository.
     *
     * @var \Drupal\search\SearchPageRepositoryInterface
     */
    protected $searchPageRepository;
    
    /**
     * Constructs a new search route subscriber.
     *
     * @param \Drupal\search\SearchPageRepositoryInterface $search_page_repository
     *   The search page repository.
     */
    public function __construct(SearchPageRepositoryInterface $search_page_repository) {
        $this->searchPageRepository = $search_page_repository;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('search.search_page_repository'));
    }
    
    /**
     * Returns an array of route objects.
     *
     * @return \Symfony\Component\Routing\Route[]
     *   An array of route objects.
     */
    public function routes() {
        $routes = [];
        // @todo Decide if /search should continue to redirect to /search/$default,
        //   or just perform the appropriate search.
        if ($default_page = $this->searchPageRepository
            ->getDefaultSearchPage()) {
            $routes['search.view'] = new Route('/search', [
                '_controller' => 'Drupal\\search\\Controller\\SearchController::redirectSearchPage',
                '_title' => 'Search',
                'entity' => $default_page,
            ], [
                '_entity_access' => 'entity.view',
                '_permission' => 'search content',
            ], [
                'parameters' => [
                    'entity' => [
                        'type' => 'entity:search_page',
                    ],
                ],
            ]);
        }
        $active_pages = $this->searchPageRepository
            ->getActiveSearchPages();
        foreach ($active_pages as $entity_id => $entity) {
            $routes["search.view_{$entity_id}"] = new Route('/search/' . $entity->getPath(), [
                '_controller' => 'Drupal\\search\\Controller\\SearchController::view',
                '_title' => 'Search',
                'entity' => $entity_id,
            ], [
                '_entity_access' => 'entity.view',
                '_permission' => 'search content',
            ], [
                'parameters' => [
                    'entity' => [
                        'type' => 'entity:search_page',
                    ],
                ],
            ]);
            $routes["search.help_{$entity_id}"] = new Route('/search/' . $entity->getPath() . '/help', [
                '_controller' => 'Drupal\\search\\Controller\\SearchController::searchHelp',
                '_title' => 'About searching',
                'entity' => $entity_id,
            ], [
                '_entity_access' => 'entity.view',
                '_permission' => 'search content',
            ], [
                'parameters' => [
                    'entity' => [
                        'type' => 'entity:search_page',
                    ],
                ],
            ]);
            if ($entity->getPlugin()
                ->usesAdminTheme()) {
                $routes["search.view_{$entity_id}"]->setOption('_admin_route', TRUE);
                $routes["search.help_{$entity_id}"]->setOption('_admin_route', TRUE);
            }
        }
        return $routes;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
SearchPageRoutes::$searchPageRepository protected property The search page repository.
SearchPageRoutes::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create
SearchPageRoutes::routes public function Returns an array of route objects.
SearchPageRoutes::__construct public function Constructs a new search route subscriber.

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