Documentation fixes.
parent
ce54838752
commit
fa58bbefad
|
@ -1,5 +1,10 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* Definition of Drupal\Core\Routing\PathMatcher.
|
||||||
|
*/
|
||||||
|
|
||||||
namespace Drupal\Core\Routing;
|
namespace Drupal\Core\Routing;
|
||||||
|
|
||||||
use Symfony\Component\HttpFoundation\Request;
|
use Symfony\Component\HttpFoundation\Request;
|
||||||
|
@ -9,9 +14,7 @@ use Symfony\Component\Routing\Exception\ResourceNotFoundException;
|
||||||
use Drupal\Core\Database\Connection;
|
use Drupal\Core\Database\Connection;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Description of PathMatcher
|
* Initial matcher to match a route against a built database, by path.
|
||||||
*
|
|
||||||
* @author crell
|
|
||||||
*/
|
*/
|
||||||
class PathMatcher implements InitialMatcherInterface {
|
class PathMatcher implements InitialMatcherInterface {
|
||||||
/**
|
/**
|
||||||
|
@ -28,6 +31,14 @@ class PathMatcher implements InitialMatcherInterface {
|
||||||
*/
|
*/
|
||||||
protected $tableName;
|
protected $tableName;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Constructs a new PathMatcher.
|
||||||
|
*
|
||||||
|
* @param \Drupal\Core\Database\Connection $connection
|
||||||
|
* A database connection object.
|
||||||
|
* @param string $table
|
||||||
|
* The table in the database to use for matching.
|
||||||
|
*/
|
||||||
public function __construct(Connection $connection, $table = 'router') {
|
public function __construct(Connection $connection, $table = 'router') {
|
||||||
$this->connection = $connection;
|
$this->connection = $connection;
|
||||||
$this->tableName = $table;
|
$this->tableName = $table;
|
||||||
|
@ -36,10 +47,10 @@ class PathMatcher implements InitialMatcherInterface {
|
||||||
/**
|
/**
|
||||||
* Matches a request against multiple routes.
|
* Matches a request against multiple routes.
|
||||||
*
|
*
|
||||||
* @param Request $request
|
* @param \Symfony\Component\HttpFoundation\Request $request
|
||||||
* A Request object against which to match.
|
* A Request object against which to match.
|
||||||
*
|
*
|
||||||
* @return RouteCollection
|
* @return \Symfony\Component\Routing\RouteCollection
|
||||||
* A RouteCollection of matched routes.
|
* A RouteCollection of matched routes.
|
||||||
*/
|
*/
|
||||||
public function matchRequestPartial(Request $request) {
|
public function matchRequestPartial(Request $request) {
|
||||||
|
|
|
@ -1,12 +1,17 @@
|
||||||
<?php
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @file
|
||||||
|
* Definition of Drupal\Core\Routing\RouteCompiler.
|
||||||
|
*/
|
||||||
|
|
||||||
namespace Drupal\Core\Routing;
|
namespace Drupal\Core\Routing;
|
||||||
|
|
||||||
use Symfony\Component\Routing\RouteCompilerInterface;
|
use Symfony\Component\Routing\RouteCompilerInterface;
|
||||||
use Symfony\Component\Routing\Route;
|
use Symfony\Component\Routing\Route;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Description of RouteCompiler
|
* Compiler to generate derived information from a Route necessary for matching.
|
||||||
*/
|
*/
|
||||||
class RouteCompiler implements RouteCompilerInterface {
|
class RouteCompiler implements RouteCompilerInterface {
|
||||||
|
|
||||||
|
@ -15,12 +20,15 @@ class RouteCompiler implements RouteCompilerInterface {
|
||||||
*/
|
*/
|
||||||
const MAX_PARTS = 9;
|
const MAX_PARTS = 9;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Utility constant to use for regular expressions against the path.
|
||||||
|
*/
|
||||||
const REGEX_DELIMITER = '#';
|
const REGEX_DELIMITER = '#';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Compiles the current route instance.
|
* Compiles the current route instance.
|
||||||
*
|
*
|
||||||
* @param Route $route
|
* @param \Symfony\Component\Routing\Route $route
|
||||||
* A Route instance
|
* A Route instance
|
||||||
*
|
*
|
||||||
* @return CompiledRoute
|
* @return CompiledRoute
|
||||||
|
@ -50,7 +58,7 @@ class RouteCompiler implements RouteCompilerInterface {
|
||||||
* It is not factored out nicely there, so we cannot simply subclass it.
|
* It is not factored out nicely there, so we cannot simply subclass it.
|
||||||
* @todo Refactor Symfony's RouteCompiler so that it's useful to subclass.
|
* @todo Refactor Symfony's RouteCompiler so that it's useful to subclass.
|
||||||
*
|
*
|
||||||
* @param Route $route
|
* @param \Symfony\Component\Routing\Route $route
|
||||||
* The route object.
|
* The route object.
|
||||||
* @param string $pattern
|
* @param string $pattern
|
||||||
* The pattern for which we want a matching regex.
|
* The pattern for which we want a matching regex.
|
||||||
|
@ -208,7 +216,7 @@ class RouteCompiler implements RouteCompilerInterface {
|
||||||
* with default values don't make sense anyway, so that should not be a
|
* with default values don't make sense anyway, so that should not be a
|
||||||
* problem.
|
* problem.
|
||||||
*
|
*
|
||||||
* @param Route $route
|
* @param \Symfony\Component\Routing\Route $route
|
||||||
*
|
*
|
||||||
* @return string
|
* @return string
|
||||||
* The path string, stripped of placeholders that have default values.
|
* The path string, stripped of placeholders that have default values.
|
||||||
|
|
Loading…
Reference in New Issue