Renamed URL to URI

Author: dantleech

bundles/routing_auto/conflict_resolvers.rst

@@ -22,13 +22,13 @@ it finds a path which *doesn't* exist.
     .. code-block:: yaml
 
         stdClass:
-            url_schema: /cmf/blog
+            uri_schema: /cmf/blog
             conflict_resolver: auto_increment
 
     .. code-block:: xml
 
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="stdClass" url-schema="/cmf/blog">
+            <mapping class="stdClass" uri-schema="/cmf/blog">
                 <conflict-resolver name="auto_increment" />
             </mapping>
         </auto-mapping>
@@ -44,13 +44,13 @@ This is the default action.
     .. code-block:: yaml
 
         stdClass:
-            url_schema: /cmf/blog
+            uri_schema: /cmf/blog
             conflict_resolver: throw_exception
 
     .. code-block:: xml
 
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="stdClass" url-schema="/cmf/blog">
+            <mapping class="stdClass" uri-schema="/cmf/blog">
                 <conflict-resolver name="throw_exception" />
             </mapping>
         </auto-mapping>

bundles/routing_auto/customization.rst

@@ -10,7 +10,7 @@ Token Providers
 ~~~~~~~~~~~~~~~
 
 The goal of a ``TokenProvider`` class is to provide values for tokens in the
-URL schema. Such values can be derived form the object for which the route
+URI schema. Such values can be derived form the object for which the route
 is being generated, or from the environment (e.g. the you could use the
 current locale in the route).
 
@@ -21,14 +21,14 @@ The following token provider will simply provide the value "foobar"::
 
     use Symfony\Cmf\Component\RoutingAuto\TokenProviderInterface;
     use Symfony\Component\OptionsResolver\OptionsResolverInterface;
-    use Symfony\Cmf\Component\RoutingAuto\UrlContext;
+    use Symfony\Cmf\Component\RoutingAuto\UriContext;
 
     class FoobarTokenProvider implements TokenProviderInterface
     {
         /**
          * {@inheritDoc}
          */
-        public function provideValue(UrlContext $urlContext, $options)
+        public function provideValue(UriContext $uriContext, $options)
         {
             return 'foobar';
         }
@@ -52,7 +52,7 @@ To use the path provider you must register it in the container and add the
             acme_cms.token_provider.foobar:
                 class: Acme\CmsBundle\RoutingAuto\PathProvider\FoobarTokenProvider
                 tags:
-                    - { name: cmf_routing_auto.token_provider, alias: "foobar"}
+                    - { name: cmf_routing_auto.token_provider, alias: "foobar" }
 
     .. code-block:: xml
 
@@ -84,20 +84,20 @@ Conflict Resolvers
 Conflict resolvers decide what happens if a generated route already exists in
 the route repository and is not related to the context object.
 
-The following example will append an unique string to the URL to resolve a
+The following example will append an unique string to the URI to resolve a
 conflict::
 
     namespace Symfony\Cmf\Component\RoutingAuto\ConflictResolver;
 
     use Symfony\Cmf\Component\RoutingAuto\ConflictResolverInterface;
-    use Symfony\Cmf\Component\RoutingAuto\UrlContext;
+    use Symfony\Cmf\Component\RoutingAuto\UriContext;
     use Symfony\Cmf\Component\RoutingAuto\Adapter\AdapterInterface;
 
     class UniqidConflictResolver implements ConflictResolverInterface
     {
-        public function resolveConflict(UrlContext $urlContext)
+        public function resolveConflict(UriContext $uriContext)
         {
-            $url = $urlContext->getUrl();
+            $uri = $uriContext->getUri();
             return sprintf('%s-%s', uniqid());
         }
     }
@@ -139,15 +139,15 @@ Defunct Route Handlers
 ~~~~~~~~~~~~~~~~~~~~~~
 
 Defunct Route Handlers decide what happens to old routes when an object is
-updated and its generated URL changes.
+updated and its generated URI changes.
 
 They are not all-together trivial - the following handler removes old routes and is
 the default handler::
 
     namespace Symfony\Cmf\Component\RoutingAuto\DefunctRouteHandler;
 
     use Symfony\Cmf\Component\RoutingAuto\DefunctRouteHandlerInterface;
-    use Symfony\Cmf\Component\RoutingAuto\UrlContextCollection;
+    use Symfony\Cmf\Component\RoutingAuto\UriContextCollection;
     use Symfony\Cmf\Component\RoutingAuto\Adapter\AdapterInterface;
 
     class RemoveDefunctRouteHandler implements DefunctRouteHandlerInterface
@@ -159,13 +159,13 @@ the default handler::
             $this->adapter = $adapter;
         }
 
-        public function handleDefunctRoutes(UrlContextCollection $urlContextCollection)
+        public function handleDefunctRoutes(UriContextCollection $uriContextCollection)
         {
-            $referringAutoRouteCollection = $this->adapter->getReferringAutoRoutes($urlContextCollection->getSubjectObject());
+            $referringAutoRouteCollection = $this->adapter->getReferringAutoRoutes($uriContextCollection->getSubjectObject());
 
             foreach ($referringAutoRouteCollection as $referringAutoRoute) {
-                if (false === $urlContextCollection->containsAutoRoute($referringAutoRoute)) {
-                    $newRoute = $urlContextCollection->getAutoRouteByTag($referringAutoRoute->getAutoRouteTag());
+                if (false === $uriContextCollection->containsAutoRoute($referringAutoRoute)) {
+                    $newRoute = $uriContextCollection->getAutoRouteByTag($referringAutoRoute->getAutoRouteTag());
 
                     $this->adapter->migrateAutoRouteChildren($referringAutoRoute, $newRoute);
                     $this->adapter->removeAutoRoute($referringAutoRoute);

bundles/routing_auto/defunct_route_handlers.rst

@@ -6,7 +6,7 @@ Defunct Route Handlers
 
 .. _routingauto_customization_defunctroutehandlers:
 
-When an already-persisted document is updated and the URL generated by the
+When an already-persisted document is updated and the URI generated by the
 RoutingAuto system is changed, a *new* route is always created. Defunct route
 handlers decide what to do with the *old* routes.
 
@@ -21,13 +21,13 @@ action.
     .. code-block:: yaml
 
         stdClass:
-            url_schema: /cmf/blog
+            uri_schema: /cmf/blog
             defunct_route_handler: remove
 
     .. code-block:: xml
 
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="stdClass" url-schema="/cmf/blog">
+            <mapping class="stdClass" uri-schema="/cmf/blog">
                 <defunct-route-handler name="remove" />
             </mapping>
         </auto-mapping>
@@ -53,13 +53,13 @@ path.
     .. code-block:: yaml
 
         stdClass:
-            url_schema: /cmf/blog
+            uri_schema: /cmf/blog
             defunct_route_handler: leave_redirect
 
     .. code-block:: xml
 
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="stdClass" url-schema="/cmf/blog">
+            <mapping class="stdClass" uri-schema="/cmf/blog">
                 <defunct-route-handler name="leave_redirect" />
             </mapping>
         </auto-mapping>

bundles/routing_auto/introduction.rst

@@ -6,7 +6,7 @@ RoutingAutoBundle
 =================
 
 The RoutingAutoBundle allows you to automatically persist routes when
-documents are persisted based on URL schemas and contextual information.
+documents are persisted based on URI schemas and contextual information.
 
 This implies a separation of the ``Route`` and ``Content`` documents. If your
 needs are simple this bundle may not be for you and you should have a look at
@@ -28,7 +28,7 @@ content documents - a category and the topics. These documents are called
 If you create a new category with the title "My New Category", the
 RoutingAutoBundle will automatically create the route
 ``/forum/my-new-cateogry``. For each new ``Topic`` it could create a route
-like ``/forum/my-new-category/my-new-topic``. This URL resolves to a special
+like ``/forum/my-new-category/my-new-topic``. This URI resolves to a special
 type of route that is called an *auto route*.
 
 By default, when you update a content document that has an auto route, the
@@ -49,13 +49,13 @@ pattern ``/forum/my-new-forum/{topic}``, which could be handled by a controller.
 Why not just do that?
 
 #. By having a route for each page in the system, the application has a
-   knowledge of which URLs are accessible. This can be very useful, for
+   knowledge of which URIs are accessible. This can be very useful, for
    example, when specifying endpoints for menu items that are used when generating
    a site map;
 #. By separating the route from the content you allow the route to be
    customized independently of the content, for example, a topic may have
-   the same title as another topic but might need a different URL;
-#. Separate route documents are translateable - this means you can have a URL
+   the same title as another topic but might need a different URI;
+#. Separate route documents are translateable - this means you can have a URI
    for *each language*, "/welcome" and "/bienvenue" would each reference the
    same document in English and French respectively. This would be difficult
    if the slug was embedded in the content document;
@@ -67,12 +67,12 @@ Usage
 -----
 
 Imagine you have a fictional forum application and that you want to access the
-forum topic with the following fictional URL:
+forum topic with the following fictional URI:
 
 - ``https://mywebsite.com/my-forum/drinks/coffee``
 
-The RoutingAutoBundle uses a URL schema to define how routes are generated. A
-schema for the above URL would look like this (the bundle does not care about
+The RoutingAutoBundle uses a URI schema to define how routes are generated. A
+schema for the above URI would look like this (the bundle does not care about
 the host or protocol):
 
 - ``/my-forum/{category}/{title}``
@@ -98,7 +98,7 @@ document could be defined as follows:
 
         # src/Acme/ForumBundle/Resources/config/routing_auto.yml
         Acme\ForumBundle\Document\Topic:
-            url_schema: /my-forum/{category}/{title}
+            uri_schema: /my-forum/{category}/{title}
             token_providers:
                 category: [content_method, {method: getCategoryTitle, slugify: true} ]
                 title: [content_method, {method: getTitle} ] # slugify is true by default
@@ -108,7 +108,7 @@ document could be defined as follows:
         <?xml version="1.0" ?>
         <!-- src/Acme/ForumBundle/Resources/config/routing_auto.xml -->
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="Acme\ForumBundle\Document\Topic" url-schema="/my-forum/{category}/{title}">
+            <mapping class="Acme\ForumBundle\Document\Topic" uri-schema="/my-forum/{category}/{title}">
                 <token-provider token="category" name="content_method">
                     <option name="method">getCategoryName</option>
                     <option name="slugify">true</option>
@@ -155,7 +155,7 @@ idea.
 
 This is just a basic example. You can also configure what should happen when
 a route already exists (confict resolution) and what to do with old routes
-when the generated URL is changed (defunct route handling).
+when the generated URI is changed (defunct route handling).
 
 Read more
 ---------

bundles/routing_auto/token_providers.rst

@@ -4,7 +4,7 @@
 Token Providers
 ---------------
 
-Token providers provide values for the tokens specified in the URL schemas.
+Token providers provide values for the tokens specified in the URI schemas.
 
 content_method
 ~~~~~~~~~~~~~~
@@ -26,7 +26,7 @@ Options
 
         # src/Acme/ForumBundle/Resources/config/routing_auto.yml
         Acme\ForumBundle\Document\Topic:
-            url_schema: /my-forum/{title}
+            uri_schema: /my-forum/{title}
             token_providers:
                 title: [content_method, {method: getTitle} ]
 
@@ -35,7 +35,7 @@ Options
         <?xml version="1.0" ?>
         <!-- src/Acme/ForumBundle/Resources/config/routing_auto.xml -->
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="Acme\ForumBundle\Document\Topic" url-schema="/my-forum/{title}">
+            <mapping class="Acme\ForumBundle\Document\Topic" uri-schema="/my-forum/{title}">
                 <token-provider token="category" name="content_method">
                     <option name="method">getCategoryName</option>
                 </token-provider>
@@ -64,7 +64,7 @@ object provided by a designated method on the content document.
 
         # src/Acme/ForumBundle/Resources/config/routing_auto.yml
         Acme\ForumBundle\Document\Topic:
-            url_schema: /blog/{date}/my-post
+            uri_schema: /blog/{date}/my-post
             token_providers:
                 date: [content_datetime, {method: getDate} ]
 
@@ -73,7 +73,7 @@ object provided by a designated method on the content document.
         <?xml version="1.0" ?>
         <!-- src/Acme/ForumBundle/Resources/config/routing_auto.xml -->
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="Acme\ForumBundle\Document\Topic" url-schema="/blog/{date}/my-post">
+            <mapping class="Acme\ForumBundle\Document\Topic" uri-schema="/blog/{date}/my-post">
                 <token-provider token="date" name="content_datetime">
                     <option name="method">getDate</option>
                 </token-provider>
@@ -103,7 +103,7 @@ feature.
 
         # src/Acme/ForumBundle/Resources/config/routing_auto.yml
         Acme\ForumBundle\Document\Topic:
-            url_schema: /blog/{locale}/my-post
+            uri_schema: /blog/{locale}/my-post
             token_providers:
                 locale: [content_locale ]
 
@@ -112,7 +112,7 @@ feature.
         <?xml version="1.0" ?>
         <!-- src/Acme/ForumBundle/Resources/config/routing_auto.xml -->
         <auto-mapping xmlns="http://cmf.symfony.com/schema/routing_auto">
-            <mapping class="Acme\ForumBundle\Document\Topic" url-schema="/blog/{locale}/my-post">
+            <mapping class="Acme\ForumBundle\Document\Topic" uri-schema="/blog/{locale}/my-post">
                 <token-provider token="locale" name="content_locale" />
             </mapping>
         </auto-mapping>