From 11ea50e3583c64772a055c0b61c99cbe556375a4 Mon Sep 17 00:00:00 2001
From: Wouter de Jong <wouter@wouterj.nl>
Date: Fri, 27 Mar 2020 21:04:41 +0100
Subject: [PATCH] Removed Routing component docs

---
 _build/redirection_map                    |   5 +-
 components/config/resources.rst           |   8 +-
 components/http_kernel.rst                |   4 +-
 components/routing.rst                    | 321 ----------------------
 create_framework/routing.rst              |  10 +-
 introduction/from_flat_php_to_symfony.rst |   4 +-
 6 files changed, 18 insertions(+), 334 deletions(-)
 delete mode 100644 components/routing.rst

diff --git a/_build/redirection_map b/_build/redirection_map
index 8114a00ebbf..6d591d7ffc5 100644
--- a/_build/redirection_map
+++ b/_build/redirection_map
@@ -345,8 +345,8 @@
 /components/http_kernel/index /components/http_kernel
 /components/property_access/introduction /components/property_access
 /components/property_access/index /components/property_access
-/components/routing/index /components/routing
-/components/routing/introduction /components/routing
+/components/routing/index https://github.com/symfony/routing
+/components/routing/introduction https://github.com/symfony/routing
 /components/routing/hostname_pattern /routing/hostname_pattern
 /components/security/introduction /components/security
 /components/security/index /components/security
@@ -478,3 +478,4 @@
 /components/translation/usage /translation
 /components/translation/custom_formats https://github.com/symfony/translation
 /components/translation/custom_message_formatter https://github.com/symfony/translation
+/components/routing https://github.com/symfony/routing
diff --git a/components/config/resources.rst b/components/config/resources.rst
index 3ee380a9828..73d28a5db78 100644
--- a/components/config/resources.rst
+++ b/components/config/resources.rst
@@ -11,7 +11,11 @@ Loading Resources
     parameters to string values. To set parameters to other data types
     (e.g. boolean, integer, etc), the other loaders are recommended.
     
-Loaders populate the application's configuration from different sources like YAML files. The Config component defines the interface for such loaders. The :doc:`Dependency Injection </components/dependency_injection>` and :doc:`Routing </components/routing>` components come with specialized loaders for different file formats.
+Loaders populate the application's configuration from different sources
+like YAML files. The Config component defines the interface for such
+loaders. The :doc:`Dependency Injection </components/dependency_injection>`
+and `Routing`_ components come with specialized loaders for different file
+formats.
 
 Locating Resources
 ------------------
@@ -95,3 +99,5 @@ the resource::
     // YamlUserLoader is used to load this resource because it supports
     // files with the '.yaml' extension
     $delegatingLoader->load(__DIR__.'/users.yaml');
+
+.. _Routing: https://github.com/symfony/routing
diff --git a/components/http_kernel.rst b/components/http_kernel.rst
index dfceb7fe6c4..9a1d5a31049 100644
--- a/components/http_kernel.rst
+++ b/components/http_kernel.rst
@@ -200,8 +200,8 @@ attributes).
     is the :class:`Symfony\\Component\\HttpKernel\\EventListener\\RouterListener`.
     This class executes the routing layer, which returns an *array* of information
     about the matched request, including the ``_controller`` and any placeholders
-    that are in the route's pattern (e.g. ``{slug}``). See
-    :doc:`Routing component </components/routing>`.
+    that are in the route's pattern (e.g. ``{slug}``). See the
+    :doc:`Routing documentation </routing>`.
 
     This array of information is stored in the :class:`Symfony\\Component\\HttpFoundation\\Request`
     object's ``attributes`` array. Adding the routing information here doesn't
diff --git a/components/routing.rst b/components/routing.rst
deleted file mode 100644
index f01b94defb1..00000000000
--- a/components/routing.rst
+++ /dev/null
@@ -1,321 +0,0 @@
-.. index::
-   single: Routing
-   single: Components; Routing
-
-The Routing Component
-=====================
-
-    The Routing component maps an HTTP request to a set of configuration
-    variables. It's used to build routing systems for web applications where
-    each URL is associated with some code to execute.
-
-Installation
-------------
-
-.. code-block:: terminal
-
-    $ composer require symfony/routing
-
-.. include:: /components/require_autoload.rst.inc
-
-Usage
------
-
-The main :doc:`Symfony routing </routing>` article explains all the features of
-this component when used inside a Symfony application. This article only
-explains the things you need to do to use it in a non-Symfony PHP application.
-
-Routing System Setup
---------------------
-
-A routing system has three parts:
-
-* A :class:`Symfony\\Component\\Routing\\RouteCollection`, which contains the
-  route definitions (instances of the :class:`Symfony\\Component\\Routing\\Route` class);
-* A :class:`Symfony\\Component\\Routing\\RequestContext`, which has information
-  about the request;
-* A :class:`Symfony\\Component\\Routing\\Matcher\\UrlMatcher`, which performs
-  the mapping of the path to a single route.
-
-Here is a quick example::
-
-    use App\Controller\BlogController;
-    use Symfony\Component\Routing\Generator\UrlGenerator;
-    use Symfony\Component\Routing\Matcher\UrlMatcher;
-    use Symfony\Component\Routing\RequestContext;
-    use Symfony\Component\Routing\Route;
-    use Symfony\Component\Routing\RouteCollection;
-
-    $route = new Route('/blog/{slug}', ['_controller' => BlogController::class]);
-    $routes = new RouteCollection();
-    $routes->add('blog_show', $route);
-
-    $context = new RequestContext('/');
-
-    // Routing can match routes with incoming requests
-    $matcher = new UrlMatcher($routes, $context);
-    $parameters = $matcher->match('/blog/lorem-ipsum');
-    // $parameters = [
-    //     '_controller' => 'App\Controller\BlogController',
-    //     'slug' => 'lorem-ipsum',
-    //     '_route' => 'blog_show'
-    // ]
-
-    // Routing can also generate URLs for a given route
-    $generator = new UrlGenerator($routes, $context);
-    $url = $generator->generate('blog_show', [
-        'slug' => 'my-blog-post',
-    ]);
-    // $url = '/blog/my-blog-post'
-
-The :method:`RouteCollection::add() <Symfony\\Component\\Routing\\RouteCollection::add>`
-method takes two arguments. The first is the name of the route. The second
-is a :class:`Symfony\\Component\\Routing\\Route` object, which expects a
-URL path and some array of custom variables in its constructor. This array
-of custom variables can be *anything* that's significant to your application,
-and is returned when that route is matched.
-
-The :method:`UrlMatcher::match() <Symfony\\Component\\Routing\\Matcher\\UrlMatcher::match>`
-returns the variables you set on the route as well as the route parameters.
-Your application can now use this information to continue processing the request.
-In addition to the configured variables, a ``_route`` key is added, which holds
-the name of the matched route.
-
-If no matching route can be found, a
-:class:`Symfony\\Component\\Routing\\Exception\\ResourceNotFoundException` will
-be thrown.
-
-Defining Routes
----------------
-
-A full route definition can contain up to eight parts::
-
-    $route = new Route(
-        '/archive/{month}', // path
-        ['_controller' => 'showArchive'], // default values
-        ['month' => '[0-9]{4}-[0-9]{2}', 'subdomain' => 'www|m'], // requirements
-        [], // options
-        '{subdomain}.example.com', // host
-        [], // schemes
-        [], // methods
-        'context.getHost() matches "/(secure|admin).example.com/"' // condition
-    );
-
-    // ...
-
-    $parameters = $matcher->match('/archive/2012-01');
-    // [
-    //     '_controller' => 'showArchive',
-    //     'month' => '2012-01',
-    //     'subdomain' => 'www',
-    //     '_route' => ...
-    // ]
-
-    $parameters = $matcher->match('/archive/foo');
-    // throws ResourceNotFoundException
-
-Route Collections
------------------
-
-You can add routes or other instances of
-:class:`Symfony\\Component\\Routing\\RouteCollection` to *another* collection.
-This way you can build a tree of routes. Additionally you can define common
-options for all routes of a subtree using methods provided by the
-``RouteCollection`` class::
-
-    $rootCollection = new RouteCollection();
-
-    $subCollection = new RouteCollection();
-    $subCollection->add(...);
-    $subCollection->add(...);
-    $subCollection->addPrefix('/prefix');
-    $subCollection->addDefaults([...]);
-    $subCollection->addRequirements([...]);
-    $subCollection->addOptions([...]);
-    $subCollection->setHost('{subdomain}.example.com');
-    $subCollection->setMethods(['POST']);
-    $subCollection->setSchemes(['https']);
-    $subCollection->setCondition('context.getHost() matches "/(secure|admin).example.com/"');
-
-    $rootCollection->addCollection($subCollection);
-
-Setting the Request Parameters
-------------------------------
-
-The :class:`Symfony\\Component\\Routing\\RequestContext` provides information
-about the current request. You can define all parameters of an HTTP request
-with this class via its constructor::
-
-    public function __construct(
-        $baseUrl = '',
-        $method = 'GET',
-        $host = 'localhost',
-        $scheme = 'http',
-        $httpPort = 80,
-        $httpsPort = 443,
-        $path = '/',
-        $queryString = ''
-    )
-
-.. _components-routing-http-foundation:
-
-Normally you can pass the values from the ``$_SERVER`` variable to populate the
-:class:`Symfony\\Component\\Routing\\RequestContext`. But if you use the
-:doc:`HttpFoundation </components/http_foundation>` component, you can use its
-:class:`Symfony\\Component\\HttpFoundation\\Request` class to feed the
-:class:`Symfony\\Component\\Routing\\RequestContext` in a shortcut::
-
-    use Symfony\Component\HttpFoundation\Request;
-
-    $context = new RequestContext();
-    $context->fromRequest(Request::createFromGlobals());
-
-Loading Routes
---------------
-
-The Routing component comes with a number of loader classes, each giving you the
-ability to load a collection of route definitions from external resources.
-
-File Routing Loaders
-~~~~~~~~~~~~~~~~~~~~
-
-Each loader expects a :class:`Symfony\\Component\\Config\\FileLocator` instance
-as the constructor argument. You can use the :class:`Symfony\\Component\\Config\\FileLocator`
-to define an array of paths in which the loader will look for the requested files.
-If the file is found, the loader returns a :class:`Symfony\\Component\\Routing\\RouteCollection`.
-
-If you're using the ``YamlFileLoader``, then route definitions look like this:
-
-.. code-block:: yaml
-
-    # routes.yaml
-    route1:
-        path:       /foo
-        controller: MyController::fooAction
-        methods:    GET|HEAD
-    route2:
-        path:       /foo/bar
-        controller: FooBarInvokableController
-        methods:    PUT
-
-To load this file, you can use the following code. This assumes that your
-``routes.yaml`` file is in the same directory as the below code::
-
-    use Symfony\Component\Config\FileLocator;
-    use Symfony\Component\Routing\Loader\YamlFileLoader;
-
-    // looks inside *this* directory
-    $fileLocator = new FileLocator([__DIR__]);
-    $loader = new YamlFileLoader($fileLocator);
-    $routes = $loader->load('routes.yaml');
-
-Besides :class:`Symfony\\Component\\Routing\\Loader\\YamlFileLoader` there are two
-other loaders that work the same way:
-
-* :class:`Symfony\\Component\\Routing\\Loader\\XmlFileLoader`
-* :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader`
-
-If you use the :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader` you
-have to provide the name of a PHP file which returns a callable handling a
-:class:`Symfony\\Component\\Routing\\Loader\\Configurator\\RoutingConfigurator`.
-This class allows to chain imports, collections or simple route definition calls::
-
-    // RouteProvider.php
-    use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
-
-    return function (RoutingConfigurator $routes) {
-        $routes->add('route_name', '/foo')
-            ->controller('ExampleController')
-            // ...
-        ;
-    };
-
-Closure Routing Loaders
-~~~~~~~~~~~~~~~~~~~~~~~
-
-There is also the :class:`Symfony\\Component\\Routing\\Loader\\ClosureLoader`, which
-calls a closure and uses the result as a :class:`Symfony\\Component\\Routing\\RouteCollection`::
-
-    use Symfony\Component\Routing\Loader\ClosureLoader;
-
-    $closure = function () {
-        return new RouteCollection();
-    };
-
-    $loader = new ClosureLoader();
-    $routes = $loader->load($closure);
-
-Annotation Routing Loaders
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Last but not least there are
-:class:`Symfony\\Component\\Routing\\Loader\\AnnotationDirectoryLoader` and
-:class:`Symfony\\Component\\Routing\\Loader\\AnnotationFileLoader` to load
-route definitions from class annotations::
-
-    use Doctrine\Common\Annotations\AnnotationReader;
-    use Symfony\Bundle\FrameworkBundle\Routing\AnnotatedRouteControllerLoader;
-    use Symfony\Component\Config\FileLocator;
-    use Symfony\Component\Routing\Loader\AnnotationDirectoryLoader;
-
-    $loader = new AnnotationDirectoryLoader(
-        new FileLocator(__DIR__.'/app/controllers/'),
-        new AnnotatedRouteControllerLoader(
-            new AnnotationReader()
-        )
-    );
-
-    $routes = $loader->load(__DIR__.'/app/controllers/');
-    // ...
-
-.. include:: /_includes/_annotation_loader_tip.rst.inc
-
-The all-in-one Router
-~~~~~~~~~~~~~~~~~~~~~
-
-The :class:`Symfony\\Component\\Routing\\Router` class is an all-in-one package
-to use the Routing component. The constructor expects a loader instance,
-a path to the main route definition and some other settings::
-
-    public function __construct(
-        LoaderInterface $loader,
-        $resource,
-        array $options = [],
-        RequestContext $context = null,
-        LoggerInterface $logger = null
-    );
-
-With the ``cache_dir`` option you can enable route caching (if you provide a
-path) or disable caching (if it's set to ``null``). The caching is done
-automatically in the background if you want to use it. A basic example of the
-:class:`Symfony\\Component\\Routing\\Router` class would look like::
-
-    $fileLocator = new FileLocator([__DIR__]);
-    $requestContext = new RequestContext('/');
-
-    $router = new Router(
-        new YamlFileLoader($fileLocator),
-        'routes.yaml',
-        ['cache_dir' => __DIR__.'/cache'],
-        $requestContext
-    );
-    $parameters = $router->match('/foo/bar');
-    $url = $router->generate('some_route', ['parameter' => 'value']);
-
-.. note::
-
-    If you use caching, the Routing component will compile new classes which
-    are saved in the ``cache_dir``. This means your script must have write
-    permissions for that location.
-
-Learn more
-----------
-
-.. toctree::
-    :maxdepth: 1
-    :glob:
-
-    /routing
-    /routing/*
-    /controller
-    /controller/*
diff --git a/create_framework/routing.rst b/create_framework/routing.rst
index dacb248c5c6..d381daed2eb 100644
--- a/create_framework/routing.rst
+++ b/create_framework/routing.rst
@@ -70,12 +70,10 @@ of default values for route attributes (``['name' => 'World']``).
 
 .. note::
 
-    Read the
-    :doc:`Routing component documentation </components/routing>` to
-    learn more about its many features like URL generation, attribute
-    requirements, HTTP method enforcement, loaders for YAML or XML files,
-    dumpers to PHP or Apache rewrite rules for enhanced performance and much
-    more.
+    Read the :doc:`Routing documentation </routing>` to learn more about
+    its many features like URL generation, attribute requirements, HTTP
+    method enforcement, loaders for YAML or XML files, dumpers to PHP or
+    Apache rewrite rules for enhanced performance and much more.
 
 Based on the information stored in the ``RouteCollection`` instance, a
 ``UrlMatcher`` instance can match URL paths::
diff --git a/introduction/from_flat_php_to_symfony.rst b/introduction/from_flat_php_to_symfony.rst
index e9bbf16167c..fdfe7f359af 100644
--- a/introduction/from_flat_php_to_symfony.rst
+++ b/introduction/from_flat_php_to_symfony.rst
@@ -532,8 +532,8 @@ a simple application. Along the way, you've made a simple routing
 system and a method using ``ob_start()`` and ``ob_get_clean()`` to render
 templates. If, for some reason, you needed to continue building this "framework"
 from scratch, you could at least use Symfony's standalone
-:doc:`Routing </components/routing>` component and :doc:`Twig </templates>`,
-which already solve these problems.
+:doc:`Routing </routing>` component and :doc:`Twig </templates>`, which
+already solve these problems.
 
 Instead of re-solving common problems, you can let Symfony take care of
 them for you. Here's the same sample application, now built in Symfony::

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/13431.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/13431.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/13431.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/symfony/symfony-docs/pull/13431.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>