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

Breadcrumb

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

class RoutingConfigurator

@author Nicolas Grekas <p@tchwork.com>

Hierarchy

  • class \Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator uses \Traits\AddTrait

Expanded class hierarchy of RoutingConfigurator

1 file declares its use of RoutingConfigurator
PhpFileLoader.php in vendor/symfony/routing/Loader/PhpFileLoader.php

File

vendor/symfony/routing/Loader/Configurator/RoutingConfigurator.php, line 20

Namespace

Symfony\Component\Routing\Loader\Configurator
View source
class RoutingConfigurator {
    use Traits\AddTrait;
    public function __construct(RouteCollection $collection, PhpFileLoader $loader, string $path, string $file, ?string $env = null) {
        $this->collection = $collection;
    }
    
    /**
     * @param string|string[]|null $exclude Glob patterns to exclude from the import
     */
    public final function import(string|array $resource, ?string $type = null, bool $ignoreErrors = false, string|array|null $exclude = null) : ImportConfigurator {
        $this->loader
            ->setCurrentDir(\dirname($this->path));
        $imported = $this->loader
            ->import($resource, $type, $ignoreErrors, $this->file, $exclude) ?: [];
        if (!\is_array($imported)) {
            return new ImportConfigurator($this->collection, $imported);
        }
        $mergedCollection = new RouteCollection();
        foreach ($imported as $subCollection) {
            $mergedCollection->addCollection($subCollection);
        }
        return new ImportConfigurator($this->collection, $mergedCollection);
    }
    public final function collection(string $name = '') : CollectionConfigurator {
        return new CollectionConfigurator($this->collection, $name);
    }
    
    /**
     * Get the current environment to be able to write conditional configuration.
     */
    public final function env() : ?string {
        return $this->env;
    }
    public final function withPath(string $path) : static {
        $clone = clone $this;
        $clone->path = $clone->file = $path;
        return $clone;
    }

}

Members

Title Sort descending Modifiers Object type Summary
RoutingConfigurator::collection final public function
RoutingConfigurator::env final public function Get the current environment to be able to write conditional configuration.
RoutingConfigurator::import final public function
RoutingConfigurator::withPath final public function
RoutingConfigurator::__construct public function
RSS feed
Powered by Drupal