Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Route.php

class Route

Same name in this branch
  1. 11.1.x vendor/symfony/routing/Route.php \Symfony\Component\Routing\Route
  2. 11.1.x core/modules/migrate/src/Plugin/migrate/process/Route.php \Drupal\migrate\Plugin\migrate\process\Route

@author Fabien Potencier <fabien@symfony.com> @author Alexander M. Turek <me@derrabus.de>

Hierarchy

  • class \Symfony\Component\Routing\Attribute\Route

Expanded class hierarchy of Route

1 file declares its use of Route
AttributeClassLoader.php in vendor/symfony/routing/Loader/AttributeClassLoader.php
25 string references to 'Route'
CommentBreadcrumbBuilder::applies in core/modules/comment/src/CommentBreadcrumbBuilder.php
Whether this breadcrumb builder should be used to build the breadcrumb.
CommentBreadcrumbBuilder::build in core/modules/comment/src/CommentBreadcrumbBuilder.php
Builds the breadcrumb.
core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml
core/config/schema/core.data_types.schema.yml
d6_menu_links.yml in core/modules/menu_link_content/migrations/d6_menu_links.yml
core/modules/menu_link_content/migrations/d6_menu_links.yml
d6_menu_links_localized.yml in core/modules/content_translation/migrations/d6_menu_links_localized.yml
core/modules/content_translation/migrations/d6_menu_links_localized.yml

... See full list

File

vendor/symfony/routing/Attribute/Route.php, line 18

Namespace

Symfony\Component\Routing\Attribute
View source
class Route {
    private ?string $path = null;
    private array $localizedPaths = [];
    private array $methods;
    private array $schemes;
    
    /**
     * @param string|array<string,string>|null $path         The route path (i.e. "/user/login")
     * @param string|null                      $name         The route name (i.e. "app_user_login")
     * @param array<string|\Stringable>        $requirements Requirements for the route attributes, @see https://symfony.com/doc/current/routing.html#parameters-validation
     * @param array<string, mixed>             $options      Options for the route (i.e. ['prefix' => '/api'])
     * @param array<string, mixed>             $defaults     Default values for the route attributes and query parameters
     * @param string|null                      $host         The host for which this route should be active (i.e. "localhost")
     * @param string|string[]                  $methods      The list of HTTP methods allowed by this route
     * @param string|string[]                  $schemes      The list of schemes allowed by this route (i.e. "https")
     * @param string|null                      $condition    An expression that must evaluate to true for the route to be matched, @see https://symfony.com/doc/current/routing.html#matching-expressions
     * @param int|null                         $priority     The priority of the route if multiple ones are defined for the same path
     * @param string|null                      $locale       The locale accepted by the route
     * @param string|null                      $format       The format returned by the route (i.e. "json", "xml")
     * @param bool|null                        $utf8         Whether the route accepts UTF-8 in its parameters
     * @param bool|null                        $stateless    Whether the route is defined as stateless or stateful, @see https://symfony.com/doc/current/routing.html#stateless-routes
     * @param string|null                      $env          The env in which the route is defined (i.e. "dev", "test", "prod")
     */
    public function __construct(string|array|null $path = null, ?string $name = null, array $requirements = [], array $options = [], array $defaults = [], ?string $host = null, array|string $methods = [], array|string $schemes = [], ?string $condition = null, ?int $priority = null, ?string $locale = null, ?string $format = null, ?bool $utf8 = null, ?bool $stateless = null, ?string $env = null) {
        if (\is_array($path)) {
            $this->localizedPaths = $path;
        }
        else {
            $this->path = $path;
        }
        $this->setMethods($methods);
        $this->setSchemes($schemes);
        if (null !== $locale) {
            $this->defaults['_locale'] = $locale;
        }
        if (null !== $format) {
            $this->defaults['_format'] = $format;
        }
        if (null !== $utf8) {
            $this->options['utf8'] = $utf8;
        }
        if (null !== $stateless) {
            $this->defaults['_stateless'] = $stateless;
        }
    }
    public function setPath(string $path) : void {
        $this->path = $path;
    }
    public function getPath() : ?string {
        return $this->path;
    }
    public function setLocalizedPaths(array $localizedPaths) : void {
        $this->localizedPaths = $localizedPaths;
    }
    public function getLocalizedPaths() : array {
        return $this->localizedPaths;
    }
    public function setHost(string $pattern) : void {
        $this->host = $pattern;
    }
    public function getHost() : ?string {
        return $this->host;
    }
    public function setName(string $name) : void {
        $this->name = $name;
    }
    public function getName() : ?string {
        return $this->name;
    }
    public function setRequirements(array $requirements) : void {
        $this->requirements = $requirements;
    }
    public function getRequirements() : array {
        return $this->requirements;
    }
    public function setOptions(array $options) : void {
        $this->options = $options;
    }
    public function getOptions() : array {
        return $this->options;
    }
    public function setDefaults(array $defaults) : void {
        $this->defaults = $defaults;
    }
    public function getDefaults() : array {
        return $this->defaults;
    }
    public function setSchemes(array|string $schemes) : void {
        $this->schemes = (array) $schemes;
    }
    public function getSchemes() : array {
        return $this->schemes;
    }
    public function setMethods(array|string $methods) : void {
        $this->methods = (array) $methods;
    }
    public function getMethods() : array {
        return $this->methods;
    }
    public function setCondition(?string $condition) : void {
        $this->condition = $condition;
    }
    public function getCondition() : ?string {
        return $this->condition;
    }
    public function setPriority(int $priority) : void {
        $this->priority = $priority;
    }
    public function getPriority() : ?int {
        return $this->priority;
    }
    public function setEnv(?string $env) : void {
        $this->env = $env;
    }
    public function getEnv() : ?string {
        return $this->env;
    }

}

Members

Title Sort descending Modifiers Object type Summary
Route::$localizedPaths private property
Route::$methods private property
Route::$path private property
Route::$schemes private property
Route::getCondition public function
Route::getDefaults public function
Route::getEnv public function
Route::getHost public function
Route::getLocalizedPaths public function
Route::getMethods public function
Route::getName public function
Route::getOptions public function
Route::getPath public function
Route::getPriority public function
Route::getRequirements public function
Route::getSchemes public function
Route::setCondition public function
Route::setDefaults public function
Route::setEnv public function
Route::setHost public function
Route::setLocalizedPaths public function
Route::setMethods public function
Route::setName public function
Route::setOptions public function
Route::setPath public function
Route::setPriority public function
Route::setRequirements public function
Route::setSchemes public function
Route::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal