class NullRouteMatch

Same name in other branches
  1. 9 core/lib/Drupal/Core/Routing/NullRouteMatch.php \Drupal\Core\Routing\NullRouteMatch
  2. 10 core/lib/Drupal/Core/Routing/NullRouteMatch.php \Drupal\Core\Routing\NullRouteMatch
  3. 11.x core/lib/Drupal/Core/Routing/NullRouteMatch.php \Drupal\Core\Routing\NullRouteMatch

Stub implementation of RouteMatchInterface for when there's no matched route.

Hierarchy

Expanded class hierarchy of NullRouteMatch

File

core/lib/Drupal/Core/Routing/NullRouteMatch.php, line 10

Namespace

Drupal\Core\Routing
View source 
class NullRouteMatch implements RouteMatchInterface {
    
    /**
     * {@inheritdoc}
     */
    public function getRouteName() {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRouteObject() {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getParameter($parameter_name) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getParameters() {
        return new ParameterBag();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRawParameter($parameter_name) {
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRawParameters() {
        return new ParameterBag();
    }

}

Members

Title Modifiers Object type Summary Overriden Title
NullRouteMatch::getParameter public function Returns the processed value of a named route parameter. Overrides RouteMatchInterface::getParameter
NullRouteMatch::getParameters public function Returns the bag of all processed route parameters. Overrides RouteMatchInterface::getParameters
NullRouteMatch::getRawParameter public function Returns the raw value of a named route parameter. Overrides RouteMatchInterface::getRawParameter
NullRouteMatch::getRawParameters public function Returns the bag of all raw route parameters. Overrides RouteMatchInterface::getRawParameters
NullRouteMatch::getRouteName public function Returns the route name. Overrides RouteMatchInterface::getRouteName
NullRouteMatch::getRouteObject public function Returns the route object. Overrides RouteMatchInterface::getRouteObject

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