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

Breadcrumb

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

class CompiledRoute

Same name in this branch
  1. 11.1.x core/lib/Drupal/Core/Routing/CompiledRoute.php \Drupal\Core\Routing\CompiledRoute

CompiledRoutes are returned by the RouteCompiler class.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\Routing\CompiledRoute implements \Symfony\Component\Routing\Serializable

Expanded class hierarchy of CompiledRoute

1 file declares its use of CompiledRoute
CompiledRoute.php in core/lib/Drupal/Core/Routing/CompiledRoute.php

File

vendor/symfony/routing/CompiledRoute.php, line 19

Namespace

Symfony\Component\Routing
View source
class CompiledRoute implements \Serializable {
    
    /**
     * @param string      $staticPrefix  The static prefix of the compiled route
     * @param string      $regex         The regular expression to use to match this route
     * @param array       $tokens        An array of tokens to use to generate URL for this route
     * @param array       $pathVariables An array of path variables
     * @param string|null $hostRegex     Host regex
     * @param array       $hostTokens    Host tokens
     * @param array       $hostVariables An array of host variables
     * @param array       $variables     An array of variables (variables defined in the path and in the host patterns)
     */
    public function __construct(string $staticPrefix, string $regex, array $tokens, array $pathVariables, ?string $hostRegex = null, array $hostTokens = [], array $hostVariables = [], array $variables = []) {
    }
    public function __serialize() : array {
        return [
            'vars' => $this->variables,
            'path_prefix' => $this->staticPrefix,
            'path_regex' => $this->regex,
            'path_tokens' => $this->tokens,
            'path_vars' => $this->pathVariables,
            'host_regex' => $this->hostRegex,
            'host_tokens' => $this->hostTokens,
            'host_vars' => $this->hostVariables,
        ];
    }
    
    /**
     * @internal
     */
    public final function serialize() : string {
        throw new \BadMethodCallException('Cannot serialize ' . __CLASS__);
    }
    public function __unserialize(array $data) : void {
        $this->variables = $data['vars'];
        $this->staticPrefix = $data['path_prefix'];
        $this->regex = $data['path_regex'];
        $this->tokens = $data['path_tokens'];
        $this->pathVariables = $data['path_vars'];
        $this->hostRegex = $data['host_regex'];
        $this->hostTokens = $data['host_tokens'];
        $this->hostVariables = $data['host_vars'];
    }
    
    /**
     * @internal
     */
    public final function unserialize(string $serialized) : void {
        $this->__unserialize(unserialize($serialized, [
            'allowed_classes' => false,
        ]));
    }
    
    /**
     * Returns the static prefix.
     */
    public function getStaticPrefix() : string {
        return $this->staticPrefix;
    }
    
    /**
     * Returns the regex.
     */
    public function getRegex() : string {
        return $this->regex;
    }
    
    /**
     * Returns the host regex.
     */
    public function getHostRegex() : ?string {
        return $this->hostRegex;
    }
    
    /**
     * Returns the tokens.
     */
    public function getTokens() : array {
        return $this->tokens;
    }
    
    /**
     * Returns the host tokens.
     */
    public function getHostTokens() : array {
        return $this->hostTokens;
    }
    
    /**
     * Returns the variables.
     */
    public function getVariables() : array {
        return $this->variables;
    }
    
    /**
     * Returns the path variables.
     */
    public function getPathVariables() : array {
        return $this->pathVariables;
    }
    
    /**
     * Returns the host variables.
     */
    public function getHostVariables() : array {
        return $this->hostVariables;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overrides
CompiledRoute::getHostRegex public function Returns the host regex.
CompiledRoute::getHostTokens public function Returns the host tokens.
CompiledRoute::getHostVariables public function Returns the host variables.
CompiledRoute::getPathVariables public function Returns the path variables.
CompiledRoute::getRegex public function Returns the regex.
CompiledRoute::getStaticPrefix public function Returns the static prefix.
CompiledRoute::getTokens public function Returns the tokens.
CompiledRoute::getVariables public function Returns the variables.
CompiledRoute::serialize final public function @internal
CompiledRoute::unserialize final public function @internal
CompiledRoute::__construct public function 1
CompiledRoute::__serialize public function 1
CompiledRoute::__unserialize public function 1

API Navigation

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