interface PartialMatcherInterface

A PartialMatcher works like a UrlMatcher, but will return multiple candidate routes.

Hierarchy

Expanded class hierarchy of PartialMatcherInterface

All classes that implement PartialMatcherInterface

File

drupal/core/lib/Drupal/Core/Routing/PartialMatcherInterface.php, line 16
Definition of Drupal\Core\Routing\PathMatcherInterface.

Namespace

Drupal\Core\Routing
View source
interface PartialMatcherInterface {

  /**
   * Sets the route collection this matcher should use.
   *
   * @param \Symfony\Component\Routing\RouteCollection $collection
   *   The collection against which to match.
   *
   * @return \Drupal\Core\Routing\PartialMatcherInterface
   *   The current matcher.
   */
  public function setCollection(RouteCollection $collection);

  /**
   * Matches a request against multiple routes.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   A Request object against which to match.
   *
   * @return \Symfony\Component\Routing\RouteCollection
   *   A RouteCollection of matched routes.
   */
  public function matchRequestPartial(Request $request);

}

Members

Namesort descending Modifiers Type Description Overrides
PartialMatcherInterface::matchRequestPartial public function Matches a request against multiple routes. 2
PartialMatcherInterface::setCollection public function Sets the route collection this matcher should use. 1