Skip to content

Commit dc97c65

Browse files
authored
Merge pull request #46 from sensiolabs/fix_references
Fix all references
2 parents f45eff4 + 91805f1 commit dc97c65

File tree

157 files changed

+434
-439
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+434
-439
lines changed

assetic/asset_management.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ To include an image you can use the ``image`` tag.
181181
<?php endforeach ?>
182182

183183
You can also use Assetic for image optimization. More information in
184-
:doc:`/cookbook/assetic/jpeg_optimize`.
184+
:doc:`/assetic/jpeg_optimize`.
185185

186186
.. tip::
187187

@@ -441,7 +441,7 @@ into your template:
441441
<?php endforeach ?>
442442
443443
A more detailed guide about configuring and using Assetic filters as well as
444-
details of Assetic's debug mode can be found in :doc:`/cookbook/assetic/uglifyjs`.
444+
details of Assetic's debug mode can be found in :doc:`/assetic/uglifyjs`.
445445

446446
Controlling the URL Used
447447
------------------------

assetic/yuicompressor.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ How to Minify JavaScripts and Stylesheets with YUI Compressor
88

99
The YUI Compressor is `no longer maintained by Yahoo`_. That's why you are
1010
**strongly advised to avoid using YUI utilities** unless strictly necessary.
11-
Read :doc:`/cookbook/assetic/uglifyjs` for a modern and up-to-date alternative.
11+
Read :doc:`/assetic/uglifyjs` for a modern and up-to-date alternative.
1212

1313
Yahoo! provides an excellent utility for minifying JavaScripts and stylesheets
1414
so they travel over the wire faster, the `YUI Compressor`_. Thanks to Assetic,

best_practices/configuration.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ add an extra layer of configuration that's not needed because you don't need
7878
or want these configuration values to change on each server.
7979

8080
The configuration options defined in the ``config.yml`` file usually vary from
81-
one :doc:`environment </cookbook/configuration/environments>` to another. That's
81+
one :doc:`environment </configuration/environments>` to another. That's
8282
why Symfony already includes ``app/config/config_dev.yml`` and ``app/config/config_prod.yml``
8383
files so that you can override specific values for each environment.
8484

@@ -160,7 +160,7 @@ Semantic Configuration: Don't Do It
160160

161161
Don't define a semantic dependency injection configuration for your bundles.
162162

163-
As explained in :doc:`/cookbook/bundles/extension` article, Symfony bundles
163+
As explained in :doc:`/bundles/extension` article, Symfony bundles
164164
have two choices on how to handle configuration: normal service configuration
165165
through the ``services.yml`` file and semantic configuration through a special
166166
``*Extension`` class.
@@ -176,7 +176,7 @@ Moving Sensitive Options Outside of Symfony Entirely
176176
When dealing with sensitive options, like database credentials, we also recommend
177177
that you store them outside the Symfony project and make them available
178178
through environment variables. Learn how to do it in the following article:
179-
:doc:`/cookbook/configuration/external_parameters`
179+
:doc:`/configuration/external_parameters`.
180180

181181
.. _`feature toggles`: https://en.wikipedia.org/wiki/Feature_toggle
182182
.. _`constant() function`: http://twig.sensiolabs.org/doc/functions/constant.html

best_practices/controllers.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,6 @@ Pre and Post Hooks
208208

209209
If you need to execute some code before or after the execution of your controllers,
210210
you can use the EventDispatcher component to
211-
:doc:`set up before and after filters </cookbook/event_dispatcher/before_after_filters>`.
211+
:doc:`set up before and after filters </event_dispatcher/before_after_filters>`.
212212

213213
.. _`ParamConverter`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html

best_practices/creating-the-project.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Installer**, which has to be installed before creating your first project.
1212

1313
Use the Symfony Installer to create new Symfony-based projects.
1414

15-
Read the :doc:`installation chapter </book/installation>` of the Symfony Book to
15+
Read the :doc:`installation chapter </installation>` of the Symfony Book to
1616
learn how to install and use the Symfony Installer.
1717

1818
.. _linux-and-mac-os-x-systems:
@@ -119,7 +119,7 @@ Symfony documentation uses the AppBundle name.
119119
.. note::
120120

121121
Another reason to create a new bundle is when you're overriding something
122-
in a vendor's bundle (e.g. a controller). See :doc:`/cookbook/bundles/inheritance`.
122+
in a vendor's bundle (e.g. a controller). See :doc:`/bundles/inheritance`.
123123

124124
All in all, this is the typical directory structure of a Symfony application
125125
that follows these best practices:
@@ -154,7 +154,7 @@ Extending the Directory Structure
154154

155155
If your project or infrastructure requires some changes to the default directory
156156
structure of Symfony, you can
157-
:doc:`override the location of the main directories </cookbook/configuration/override_dir_structure>`:
157+
:doc:`override the location of the main directories </configuration/override_dir_structure>`:
158158
``cache/``, ``logs/`` and ``web/``.
159159

160160
In addition, Symfony3 will use a slightly different directory structure when
@@ -181,4 +181,4 @@ the Symfony directory structure.
181181
.. _`Composer`: https://getcomposer.org/
182182
.. _`Phar extension`: http://php.net/manual/en/intro.phar.php
183183
.. _`public checksums repository`: https://github.com/sensiolabs/checksums
184-
.. _`these steps`: http://fabien.potencier.org/signing-project-releases.html
184+
.. _`these steps`: http://fabien.potencier.org/signing-project-releases.html

best_practices/forms.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ all of the fields:
171171

172172
If you need more control over how your fields are rendered, then you should
173173
remove the ``form_widget(form)`` function and render your fields individually.
174-
See the :doc:`/cookbook/form/form_customization` cookbook article for more information
174+
See the :doc:`/form/form_customization` cookbook article for more information
175175
on this and how you can control *how* the form renders at a global level
176176
using form theming.
177177

best_practices/security.rst

+9-10
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ Authentication and Firewalls (i.e. Getting the User's Credentials)
55
------------------------------------------------------------------
66

77
You can configure Symfony to authenticate your users using any method you
8-
want and to load user information from any source. This is a complex topic,
9-
but the :doc:`Security Cookbook Section </cookbook/security/index>` has a
10-
lot of information about this.
8+
want and to load user information from any source. This is a complex topic, but
9+
the :doc:`Security Cookbook Section </security>` has a lot of information about
10+
this.
1111

1212
Regardless of your needs, authentication is configured in ``security.yml``,
1313
primarily under the ``firewalls`` key.
@@ -127,7 +127,7 @@ Using ``@Security``, this looks like:
127127
Using Expressions for Complex Security Restrictions
128128
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129129

130-
If your security logic is a little bit more complex, you can use an `expression`_
130+
If your security logic is a little bit more complex, you can use an :doc:`expression </components/expression_language>`
131131
inside ``@Security``. In the following example, a user can only access the
132132
controller if their email matches the value returned by the ``getAuthorEmail``
133133
method on the ``Post`` object:
@@ -254,7 +254,7 @@ Security Voters
254254

255255
If your security logic is complex and can't be centralized into a method
256256
like ``isAuthor()``, you should leverage custom voters. These are an order
257-
of magnitude easier than :doc:`ACLs </cookbook/security/acl>` and will give
257+
of magnitude easier than :doc:`ACLs </security/acl>` and will give
258258
you the flexibility you need in almost all cases.
259259

260260
First, create a voter class. The following example shows a voter that implements
@@ -358,18 +358,17 @@ The `FOSUserBundle`_, developed by the Symfony community, adds support for a
358358
database-backed user system in Symfony. It also handles common tasks like
359359
user registration and forgotten password functionality.
360360

361-
Enable the :doc:`Remember Me feature </cookbook/security/remember_me>` to
361+
Enable the :doc:`Remember Me feature </security/remember_me>` to
362362
allow your users to stay logged in for a long period of time.
363363

364364
When providing customer support, sometimes it's necessary to access the application
365365
as some *other* user so that you can reproduce the problem. Symfony provides
366-
the ability to :doc:`impersonate users </cookbook/security/impersonating_user>`.
366+
the ability to :doc:`impersonate users </security/impersonating_user>`.
367367

368368
If your company uses a user login method not supported by Symfony, you can
369-
develop :doc:`your own user provider </cookbook/security/custom_provider>` and
370-
:doc:`your own authentication provider </cookbook/security/custom_authentication_provider>`.
369+
develop :doc:`your own user provider </security/custom_provider>` and
370+
:doc:`your own authentication provider </security/custom_authentication_provider>`.
371371

372372
.. _`ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
373373
.. _`@Security annotation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/security.html
374-
.. _`expression`: http://symfony.com/doc/current/components/expression_language/introduction.html
375374
.. _`FOSUserBundle`: https://github.com/FriendsOfSymfony/FOSUserBundle

best_practices/web-assets.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ tools like GruntJS.
4949
Use Assetic to compile, combine and minimize web assets, unless you're
5050
comfortable with frontend tools like GruntJS.
5151

52-
:doc:`Assetic </cookbook/assetic/asset_management>` is an asset manager capable
52+
:doc:`Assetic </assetic/asset_management>` is an asset manager capable
5353
of compiling assets developed with a lot of different frontend technologies
5454
like LESS, Sass and CoffeeScript. Combining all your assets with Assetic is a
5555
matter of wrapping all the assets with a single Twig tag:
@@ -87,8 +87,8 @@ Learn More about Assetic
8787
------------------------
8888

8989
Assetic can also minimize CSS and JavaScript assets
90-
:doc:`using UglifyCSS/UglifyJS </cookbook/assetic/uglifyjs>` to speed up your
91-
websites. You can even :doc:`compress images </cookbook/assetic/jpeg_optimize>`
90+
:doc:`using UglifyCSS/UglifyJS </assetic/uglifyjs>` to speed up your
91+
websites. You can even :doc:`compress images </assetic/jpeg_optimize>`
9292
with Assetic to reduce their size before serving them to the user. Check out
9393
the `official Assetic documentation`_ to learn more about all the available
9494
features.

bundles.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ in your application and to optimize them the way you want.
1616

1717
.. note::
1818

19-
While you'll learn the basics here, an entire cookbook entry is devoted
20-
to the organization and best practices of :doc:`bundles </cookbook/bundles/best_practices>`.
19+
While you'll learn the basics here, an entire cookbook entry is devoted
20+
to the organization and best practices of :doc:`bundles </bundles/best_practices>`.
2121

2222
A bundle is simply a structured set of files within a directory that implement
2323
a single feature. You might create a BlogBundle, a ForumBundle or

bundles/best_practices.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ Templates ``Resources/views/`` Yes
131131
Unit and Functional Tests ``Tests/`` No
132132
=============================== ============================= ================
133133

134-
[1] See :doc:`/cookbook/doctrine/mapping_model_classes` for how to handle the
134+
[1] See :doc:`/doctrine/mapping_model_classes` for how to handle the
135135
mapping with a compiler pass.
136136

137137
Classes
@@ -362,7 +362,7 @@ Retrieve the configuration parameters in your code from the container::
362362
$container->getParameter('acme_blog.author.email');
363363

364364
Even if this mechanism is simple enough, you should consider using the more
365-
advanced :doc:`semantic bundle configuration </cookbook/bundles/configuration>`.
365+
advanced :doc:`semantic bundle configuration </bundles/configuration>`.
366366

367367
Versioning
368368
----------
@@ -381,7 +381,7 @@ be :ref:`defined as private <container-private-services>`.
381381
.. seealso::
382382

383383
You can learn much more about service loading in bundles reading this article:
384-
:doc:`How to Load Service Configuration inside a Bundle </cookbook/bundles/extension>`.
384+
:doc:`How to Load Service Configuration inside a Bundle </bundles/extension>`.
385385

386386
Composer Metadata
387387
-----------------
@@ -466,7 +466,7 @@ API is being used. The following code, would work for *all* users::
466466
Learn more from the Cookbook
467467
----------------------------
468468

469-
* :doc:`/cookbook/bundles/extension`
469+
* :doc:`/bundles/extension`
470470

471471
.. _`PSR-0`: http://www.php-fig.org/psr/psr-0/
472472
.. _`PSR-4`: http://www.php-fig.org/psr/psr-4/

bundles/configuration.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ bundle configuration would look like:
104104
105105
.. seealso::
106106

107-
Read more about the extension in :doc:`/cookbook/bundles/extension`.
107+
Read more about the extension in :doc:`/bundles/extension`.
108108

109109
.. tip::
110110

@@ -118,14 +118,14 @@ bundle configuration would look like:
118118
.. seealso::
119119

120120
For parameter handling within a dependency injection container see
121-
:doc:`/cookbook/configuration/using_parameters_in_dic`.
121+
:doc:`/configuration/using_parameters_in_dic`.
122122

123123

124124
Processing the ``$configs`` Array
125125
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126126

127127
First things first, you have to create an extension class as explained in
128-
:doc:`extension`.
128+
:doc:`/bundles/extension`.
129129

130130
Whenever a user includes the ``acme_social`` key (which is the DI alias) in a
131131
configuration file, the configuration under it is added to an array of
@@ -285,7 +285,7 @@ to allow one ``Extension`` class to modify the configuration passed to another
285285
bundle's ``Extension`` class, as if the end-developer has actually placed that
286286
configuration in their ``app/config/config.yml`` file. This can be achieved
287287
using a prepend extension. For more details, see
288-
:doc:`/cookbook/bundles/prepend_extension`.
288+
:doc:`/bundles/prepend_extension`.
289289

290290
Dump the Configuration
291291
----------------------

bundles/extension.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Using Configuration to Change the Services
124124

125125
The Extension is also the class that handles the configuration for that
126126
particular bundle (e.g. the configuration in ``app/config/config.yml``). To
127-
read more about it, see the ":doc:`/cookbook/bundles/configuration`" article.
127+
read more about it, see the ":doc:`/bundles/configuration`" article.
128128

129129
Adding Classes to Compile
130130
-------------------------

bundles/installation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ The only thing you need to do now is register the bundle in ``AppKernel``::
7272
}
7373

7474
In a few rare cases, you may want a bundle to be *only* enabled in the development
75-
:doc:`environment </cookbook/configuration/environments>`. For example,
75+
:doc:`environment </configuration/environments>`. For example,
7676
the DoctrineFixturesBundle helps to load dummy data - something you probably
7777
only want to do while developing. To only load this bundle in the ``dev``
7878
and ``test`` environments, register the bundle in this way::

bundles/override.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Templates
1313
For information on overriding templates, see
1414

1515
* :ref:`overriding-bundle-templates`.
16-
* :doc:`/cookbook/bundles/inheritance`
16+
* :doc:`/bundles/inheritance`
1717

1818
Routing
1919
-------
@@ -31,7 +31,7 @@ Controllers
3131

3232
Assuming the third-party bundle involved uses non-service controllers (which
3333
is almost always the case), you can easily override controllers via bundle
34-
inheritance. For more information, see :doc:`/cookbook/bundles/inheritance`.
34+
inheritance. For more information, see :doc:`/bundles/inheritance`.
3535
If the controller is a service, see the next section on how to override it.
3636

3737
Services & Configuration
@@ -89,7 +89,7 @@ something beyond just the class name, you should use a compiler pass::
8989
In this example you fetch the service definition of the original service, and set
9090
its class name to your own class.
9191

92-
See :doc:`/cookbook/service_container/compiler_passes` for information on how to use
92+
See :doc:`/service_container/compiler_passes` for information on how to use
9393
compiler passes. If you want to do something beyond just overriding the class,
9494
like adding a method call, you can only use the compiler pass method.
9595

@@ -192,7 +192,7 @@ can override the translations from any translation file, as long as it is in
192192
sure that the bundle containing *your* translations is loaded after any
193193
bundle whose translations you're overriding. This is done in ``AppKernel``.
194194

195-
Translation files are also not aware of :doc:`bundle inheritance </cookbook/bundles/inheritance>`.
195+
Translation files are also not aware of :doc:`bundle inheritance </bundles/inheritance>`.
196196
If you want to override translations from the parent bundle, be sure that the
197197
parent bundle is loaded before the child bundle in the ``AppKernel`` class.
198198

cache/varnish.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ authentication, have Varnish remove the corresponding header from requests to
7878
prevent clients from bypassing the cache. In practice, you will need sessions
7979
at least for some parts of the site, e.g. when using forms with
8080
:ref:`CSRF Protection <forms-csrf>`. In this situation, make sure to
81-
:doc:`only start a session when actually needed </cookbook/session/avoid_session_start>`
81+
:doc:`only start a session when actually needed </session/avoid_session_start>`
8282
and clear the session when it is no longer needed. Alternatively, you can look
83-
into :doc:`/cookbook/cache/form_csrf_caching`.
83+
into :doc:`/cache/form_csrf_caching`.
8484

8585
Cookies created in JavaScript and used only in the frontend, e.g. when using
8686
Google Analytics, are nonetheless sent to the server. These cookies are not

components/asset.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ that path over and over again::
177177
Request Context Aware Assets
178178
............................
179179

180-
If you are also using the :doc:`HttpFoundation </components/http_foundation/introduction>`
180+
If you are also using the :doc:`HttpFoundation </components/http_foundation>`
181181
component in your project (for instance, in a Symfony application), the ``PathPackage``
182182
class can take into account the context of the current request::
183183

components/browser_kit.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This method accepts a request and should return a response::
4848
For a simple implementation of a browser based on the HTTP layer, have a look
4949
at `Goutte`_. For an implementation based on ``HttpKernelInterface``, have
5050
a look at the :class:`Symfony\\Component\\HttpKernel\\Client` provided by
51-
the :doc:`HttpKernel component </components/http_kernel/introduction>`.
51+
the :doc:`HttpKernel component </components/http_kernel>`.
5252

5353
Making Requests
5454
~~~~~~~~~~~~~~~

components/class_loader.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Additionally, the Symfony ClassLoader component ships with a wrapper class
3434
which makes it possible
3535
:doc:`to cache the results of a class loader </components/class_loader/cache_class_loader>`.
3636

37-
When using the :doc:`Debug component </components/debug/introduction>`, you
37+
When using the :doc:`Debug component </components/debug>`, you
3838
can also use a special :doc:`DebugClassLoader </components/debug/class_loader>`
3939
that eases debugging by throwing more helpful exceptions when a class could
4040
not be found by a class loader.

components/console.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ without actually printing.
264264
The MonologBridge provides a :class:`Symfony\\Bridge\\Monolog\\Handler\\ConsoleHandler`
265265
class that allows you to display messages on the console. This is cleaner
266266
than wrapping your output calls in conditions. For an example use in
267-
the Symfony Framework, see :doc:`/cookbook/logging/monolog_console`.
267+
the Symfony Framework, see :doc:`/logging/monolog_console`.
268268

269269
Using Command Arguments
270270
-----------------------

components/console/logger.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ may not be sent to the :class:`Symfony\\Component\\Console\\Output\\OutputInterf
7575
instance.
7676

7777
By default, the console logger behaves like the
78-
:doc:`Monolog's Console Handler </cookbook/logging/monolog_console>`.
78+
:doc:`Monolog's Console Handler </logging/monolog_console>`.
7979
The association between the log level and the verbosity can be configured
8080
through the second parameter of the :class:`Symfony\\Component\\Console\\ConsoleLogger`
8181
constructor::

components/console/usage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ commands, then you can run ``help`` like this:
139139
140140
If you have commands using ``:`` to namespace commands then you just have
141141
to type the shortest unambiguous text for each part. If you have created the
142-
``demo:greet`` as shown in :doc:`/components/console/introduction` then you
142+
``demo:greet`` as shown in :doc:`/components/console` then you
143143
can run it with:
144144

145145
.. code-block:: bash

components/debug.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ and more useful::
6969

7070
.. note::
7171

72-
If the :doc:`HttpFoundation component </components/http_foundation/introduction>` is
72+
If the :doc:`HttpFoundation component </components/http_foundation` is
7373
available, the handler uses a Symfony Response object; if not, it falls
7474
back to a regular PHP response.
7575

0 commit comments

Comments
 (0)