10000 Update most important book articles to follow the best practices by wouterj · Pull Request #4427 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Update most important book articles to follow the best practices #4427

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Nov 7, 2014
Merged

Update most important book articles to follow the best practices #4427

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
87b324a
Renamed AcmeHelloBundle to AppBundle
wouterj Nov 5, 2014
0ef1c68
Moved templates to app/Resources/views
wouterj Nov 5, 2014
b735642
Fixed some other minor stuff
wouterj Nov 5, 2014
c8f5ad5
Updated to use AppBundle
wouterj Nov 5, 2014
18e3a31
Moved templates to app
wouterj Nov 5, 2014
ab2e2c7
Other fixes
wouterj Nov 5, 2014
db3086d
Moved templates to app and controllers to AppBundle
wouterj Nov 6, 2014
a8a75d7
Changed Bundle:Controller:Template to bundle:dir:file
wouterj Nov 6, 2014
10b3c7c
Other random fixes
wouterj Nov 6, 2014
4da1bcf
Use AppBundle
wouterj Nov 6, 2014
210bb4b
Some minor things
wouterj Nov 6, 2014
91c8981
Used annotations for routing
wouterj Nov 7, 2014
51773f4
Proofread routing article
wouterj Nov 7, 2014
9678b61
Proofread templating
wouterj Nov 7, 2014
e56c272
Fixed error
wouterj Nov 7, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Proofread routing article
  • Loading branch information
@wouterj
wouterj committed Nov 7, 2014
commit 51773f4d55656b25f26c319a641e839e23dedb7b
103 changes: 51 additions & 52 deletions book/routing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1150,17 +1150,19 @@ Including External Routing Resources
------------------------------------

All routes are loaded via a single configuration file - usually
``app/config/routing.yml`` (see `Creating Routes`_ above). Commonly, however,
you'll want to load routes from other places, like a routing file that lives
inside a bundle. This can be done by "importing" that file:
``app/config/routing.yml`` (see `Creating Routes`_ above). However, if you use
routing annotations, you'll need to point the router to the controllers with
the annotations. This can be done by "importing" directories into the routing
configuration:

.. configuration-block::

.. code-block:: yaml

# app/config/routing.yml
app:
resource: "@AppBundle/Resources/config/routing.yml"
resource: "@AppBundle/Controller/"
type: annotation # required to enable the Annotation reader for this resource

.. code-block:: xml

Expand All @@ -1171,7 +1173,8 @@ inside a bundle. This can be done by "importing" that file:
xsi:schemaLocation="http://symfony.com/schema/routing
http://symfony.com/schema/routing/routing-1.0.xsd">

<import resource="@AppBundle/Resources/config/routing.xml" />
<!-- the type is required to enable the annotation reader for this resource -->
<import resource="@AppBundle/Controller/" type="annotation"/>
</routes>

.. code-block:: php
Expand All @@ -1181,7 +1184,9 @@ inside a bundle. This can be done by "importing" that file:

$collection = new RouteCollection();
$collection->addCollection(
$loader->import("@AppBundle/Resources/config/routing.php")
// second argument is the type, which is required to enable the annotation reader
// for this resource
$loader->import("@AppBundle/Controller/", "annotation")
);

return $collection;
Expand All @@ -1192,64 +1197,63 @@ inside a bundle. This can be done by "importing" that file:
Just be sure that it's unique so no other lines override it.

The ``resource`` key loads the given routing resource. In this example the
resource is the full path to a file, where the ``@AppBundle`` shortcut
syntax resolves to the path of that bundle. The imported file might look
like this:
resource is a directory, where the ``@AppBundle`` shortcut syntax resolves to
the full path of the AppBundle. When pointing to a directory, all files in that
directory are parsed and put into the routing.

.. configuration-block::
.. note::

.. code-block:: yaml
You can also include other routing configuration files, this is often used
to import the routing of third party bundles:

# src/AppBundle/Resources/config/routing.yml
app:
path: /hello/{name}
defaults: { _controller: AppBundle:Hello:index }
.. configuration-block::

.. code-block:: xml
.. code-block:: yaml

<!-- src/AppBundle/Resources/config/routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/routing
http://symfony.com/schema/routing/routing-1.0.xsd">
# app/config/routing.yml
app:
resource: "@AcmeOtherBundle/Resources/config/routing.yml"

<route id="acme_hello" path="/hello/{name}">
<default key="_controller">AppBundle:Hello:index</default>
</route>
</routes>
.. code-block:: xml

.. code-block:: php
<!-- app/config/routing.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/routing
http://symfony.com/schema/routing/routing-1.0.xsd">

// src/AppBundle/Resources/config/routing.php
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Routing\Route;
<import resource="@AcmeOtherBundle/Resources/config/routing.xml" />
</routes>

$collection = new RouteCollection();
$collection->add('acme_hello', new Route('/hello/{name}', array(
'_controller' => 'AppBundle:Hello:index',
)));
.. code-block:: php

return $collection;
// app/config/routing.php
use Symfony\Component\Routing\RouteCollection;

The routes from this file are parsed and loaded in the same way as the main
routing file.
$collection = new RouteCollection();
$collection->addCollection(
$loader->import("@AcmeOtherBundle/Resources/config/routing.php")
);

return $collection;

Prefixing Imported Routes
~~~~~~~~~~~~~~~~~~~~~~~~~

You can also choose to provide a "prefix" for the imported routes. For example,
suppose you want the ``app`` routes to have a final path of ``/admin/hello/{name}``
instead of simply ``/hello/{name}``:
suppose you want to prefix all routes in the AppBundle with ``/site`` (e.g.
``/site/blog/{slug}`` instead of ``/blog/{slug}``):

.. configuration-block::

.. code-block:: yaml

# app/config/routing.yml
app:
resource: "@AppBundle/Resources/config/routing.yml"
prefix: /admin
resource: "@AppBundle/Controller/"
type: annotation
prefix: /site

.. code-block:: xml

Expand All @@ -1261,32 +1265,27 @@ instead of simply ``/hello/{name}``:
http://symfony.com/schema/routing/routing-1.0.xsd">

<import
resource="@AppBundle/Resources/config/routing.xml"
prefix="/admin" />
resource="@AppBundle/Controller/"
type="annotation"
prefix="/site" />
</routes>

.. code-block:: php

// app/config/routing.php
use Symfony\Component\Routing\RouteCollection;

$app = $loader->import('@AppBundle/Resources/config/routing.php');
$app->addPrefix('/admin');
$app = $loader->import('@AppBundle/Controller/');
$app->addPrefix('/site');

$collection = new RouteCollection();
$collection->addCollection($app);

return $collection;

The string ``/admin`` will now be prepended to the path of each route loaded
The string ``/site`` will now be prepended to the path of each route loaded
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to ask you to reconsider the use of the word prepend. Traditional English dictionaries don't include it as a valid word, although Wiktionary does here. It could be replaced by preffix and preffixed respectively.

from the new routing resource.

.. tip::

You can also define routes using annotations. See the
:doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/routing>`
to see how.

Adding a Host Requirement to Imported Routes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
0