Skip to content

Commit a109c4b

Browse files
committed
minor #4537 Update link to remove absolute URL (jms85, dangarzon)
This PR was merged into the 2.3 branch. Discussion ---------- Update link to remove absolute URL Commits ------- 7282965 Change symfony-docs internal links avoiding absolute urls in introduction article ffa17b2 Change symfony-docs internal links avoiding absolute urls in security article c7f9cf5 Remove unused links 079bd64 Change symfony-docs internal links avoiding absolute urls cf32b4c Remove absolutes url ae877f2 Remove absolute url from override_dir_structure link f7de50e Update link to remove absolute URL
2 parents 05f5dba + 7282965 commit a109c4b

File tree

7 files changed

+31
-50
lines changed

7 files changed

+31
-50
lines changed

best_practices/controllers.rst

+1-2
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,6 @@ Pre and Post Hooks
206206
------------------
207207

208208
If you need to execute some code before or after the execution of your controllers,
209-
you can use the EventDispatcher component to `set up before/after filters`_.
209+
you can use the EventDispatcher component to :doc:`/cookbook/event_dispatcher/before_after_filters`.
210210

211211
.. _`ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
212-
.. _`set up before/after filters`: http://symfony.com/doc/current/cookbook/event_dispatcher/before_after_filters.html

best_practices/creating-the-project.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,8 @@ Extending the Directory Structure
220220
---------------------------------
221221

222222
If your project or infrastructure requires some changes to the default directory
223-
structure of Symfony, you can `override the location of the main directories`_:
223+
structure of Symfony, you can
224+
:doc:`override the location of the main directories </cookbook/configuration/override_dir_structure>`:
224225
``cache/``, ``logs/`` and ``web/``.
225226

226227
In addition, Symfony3 will use a slightly different directory structure when
@@ -247,6 +248,5 @@ the Symfony2 directory structure.
247248
.. _`Composer`: https://getcomposer.org/
248249
.. _`Get Started`: https://getcomposer.org/doc/00-intro.md
249250
.. _`Composer download page`: https://getcomposer.org/download/
250-
.. _`override the location of the main directories`: http://symfony.com/doc/current/cookbook/configuration/override_dir_structure.html
251251
.. _`public checksums repository`: https://github.com/sensiolabs/checksums
252252
.. _`these steps`: http://fabien.potencier.org/article/73/signing-project-releases

best_practices/forms.rst

+6-9
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,11 @@ To use the class, use ``createForm`` and instantiate the new class:
6969
Registering Forms as Services
7070
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7171

72-
You can also `register your form type as a service`_. But this is *not* recommended
73-
unless you plan to reuse the new form type in many places or embed it in
74-
other forms directly or via the `collection type`_.
72+
You can also
73+
:ref:`register your form type as a service <form-cookbook-form-field-service>`.
74+
But this is *not* recommended unless you plan to reuse the new form type in many
75+
places or embed it in other forms directly or via the
76+
:doc:`collection type </reference/forms/types/collection>`.
7577

7678
For most forms that are used only to edit or create something, registering
7779
the form as a service is over-kill, and makes it more difficult to figure
@@ -169,7 +171,7 @@ fields:
169171

170172
If you need more control over how your fields are rendered, then you should
171173
remove the ``form_widget(form)`` function and render your fields individually.
172-
See `How to Customize Form Rendering`_ for more information on this and how
174+
See :doc:`/cookbook/form/form_customization` for more information on this and how
173175
you can control *how* the form renders at a global level using form theming.
174176

175177
Handling Form Submits
@@ -210,8 +212,3 @@ Second, we recommend using ``$form->isSubmitted()`` in the ``if`` statement
210212
for clarity. This isn't technically needed, since ``isValid()`` first calls
211213
``isSubmitted()``. But without this, the flow doesn't read well as it *looks*
212214
like the form is *always* processed (even on the GET request).
213-
214-
.. _`register your form type as a service`: http://symfony.com/doc/current/cookbook/form/create_custom_field_type.html#creating-your-field-type-as-a-service
215-
.. _`collection type`: http://symfony.com/doc/current/reference/forms/types/collection.html
216-
.. _`How to Customize Form Rendering`: http://symfony.com/doc/current/cookbook/form/form_customization.html
217-
.. _`form event system`: http://symfony.com/doc/current/cookbook/form/dynamic_form_modification.html

best_practices/introduction.rst

+1-5
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Who this Book Is for (Hint: It's not a Tutorial)
5959
Any Symfony developer, whether you are an expert or a newcomer, can read this
6060
guide. But since this isn't a tutorial, you'll need some basic knowledge of
6161
Symfony to follow everything. If you are totally new to Symfony, welcome!
62-
Start with `The Quick Tour`_ tutorial first.
62+
Start with :doc:`The Quick Tour </quick_tour/the_big_picture>` tutorial first.
6363

6464
We've deliberately kept this guide short. We won't repeat explanations that
6565
you can find in the vast Symfony documentation, like discussions about dependency
@@ -95,7 +95,3 @@ practices**. The reasons for not doing it are various:
9595
your tests or adding features that provide real value to the end users.
9696

9797
.. _`Fabien Potencier`: https://connect.sensiolabs.com/profile/fabpot
98-
.. _`The Quick Tour`: http://symfony.com/doc/current/quick_tour/the_big_picture.html
99-
.. _`The Official Symfony Book`: http://symfony.com/doc/current/book/index.html
100-
.. _`The Symfony Cookbook`: http://symfony.com/doc/current/cookbook/index.html
101-
.. _`github.com/.../...`: http://github.com/.../...

best_practices/security.rst

+12-19
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ Authentication and Firewalls (i.e. Getting the User's Credentials)
66

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

1112
Regardless of your needs, authentication is configured in ``security.yml``,
1213
primarily under the ``firewalls`` key.
@@ -72,8 +73,9 @@ Authorization (i.e. Denying Access)
7273
-----------------------------------
7374

7475
Symfony gives you several ways to enforce authorization, including the ``access_control``
75-
configuration in `security.yml`_, the :ref:`@Security annotation <best-practices-security-annotation>`
76-
and using :ref:`isGranted <best-practices-directy-isGranted>` on the ``security.context``
76+
configuration in :doc:`security.yml </reference/configuration/security>` the
77+
:ref:`@Security annotation <best-practices-security-annotation>` and using
78+
:ref:`isGranted <best-practices-directy-isGranted>` on the ``security.context``
7779
service directly.
7880

7981
.. best-practice::
@@ -240,8 +242,8 @@ Security Voters
240242

241243
If your security logic is complex and can't be centralized into a method
242244
like ``isAuthor()``, you should leverage custom voters. These are an order
243-
of magnitude easier than `ACL's`_ and will give you the flexibility you need
244-
in almost all cases.
245+
of magnitude easier than :doc:`ACL's </cookbook/security/acl>` and will give
246+
you the flexibility you need in almost all cases.
245247

246248
First, create a voter class. The following example shows a voter that implements
247249
the same ``getAuthorEmail`` logic you used above:
@@ -337,27 +339,18 @@ The `FOSUserBundle`_, developed by the Symfony community, adds support for a
337339
database-backed user system in Symfony2. It also handles common tasks like
338340
user registration and forgotten password functionality.
339341

340-
Enable the `Remember Me feature`_ to allow your users to stay logged in for
341-
a long period of time.
342+
Enable the :doc:`Remember Me feature </cookbook/security/remember_me>` to
343+
allow your users to stay logged in for a long period of time.
342344

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

347349
If your company uses a user login method not supported by Symfony, you can
348-
develop `your own user provider`_ and `your own authentication provider`_.
350+
develop :doc:`your own user provider </cookbook/security/custom_provider>` and
351+
:doc:`your own authentication provider </cookbook/security/custom_authentication_provider>`.
349352

350-
.. _`Security Cookbook Section`: http://symfony.com/doc/current/cookbook/security/index.html
351-
.. _`security.yml`: http://symfony.com/doc/current/reference/configuration/security.html
352353
.. _`ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
353354
.. _`@Security annotation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/security.html
354-
.. _`security.yml`: http://symfony.com/doc/current/reference/configuration/security.html
355-
.. _`security voter`: http://symfony.com/doc/current/cookbook/security/voters_data_permission.html
356-
.. _`Acces Control List`: http://symfony.com/doc/current/cookbook/security/acl.html
357-
.. _`ACL's`: http://symfony.com/doc/current/cookbook/security/acl.html
358355
.. _`expression`: http://symfony.com/doc/current/components/expression_language/introduction.html
359356
.. _`FOSUserBundle`: https://github.com/FriendsOfSymfony/FOSUserBundle
360-
.. _`Remember Me feature`: http://symfony.com/doc/current/cookbook/security/remember_me.html
361-
.. _`impersonate users`: http://symfony.com/doc/current/cookbook/security/impersonating_user.html
362-
.. _`your own user provider`: http://symfony.com/doc/current/cookbook/security/custom_provider.html
363-
.. _`your own authentication provider`: http://symfony.com/doc/current/cookbook/security/custom_authentication_provider.html

best_practices/templates.rst

-4
Original file line numberDiff line numberDiff line change
@@ -156,9 +156,5 @@ name is irrelevant because you never use it in your own code):
156156
tags:
157157
- { name: twig.extension }
158158
159-
160159
.. _`Twig`: http://twig.sensiolabs.org/
161160
.. _`Parsedown`: http://parsedown.org/
162-
.. _`Twig global variables`: http://symfony.com/doc/master/cookbook/templating/global_variables.html
163-
.. _`override error pages`: http://symfony.com/doc/current/cookbook/controller/error_pages.html
164-
.. _`render a template without using a controller`: http://symfony.com/doc/current/cookbook/templating/render_without_controller.html

best_practices/web-assets.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,9 @@ 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-
`Assetic`_ is an asset manager capable of compiling assets developed with
53-
a lot of different frontend technologies like LESS, Sass and CoffeeScript.
52+
:doc:`Assetic </cookbook/assetic/asset_management>` is an asset manager capable
53+
of compiling assets developed with a lot of different frontend technologies
54+
like LESS, Sass and CoffeeScript.
5455
Combining all your assets with Assetic is a matter of wrapping all the assets
5556
with a single Twig tag:
5657

@@ -86,12 +87,11 @@ separating the repositories if you want).
8687
Learn More about Assetic
8788
------------------------
8889

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

94-
.. _`Assetic`: http://symfony.com/doc/current/cookbook/assetic/asset_management.html
95-
.. _`using UglifyCSS/UglifyJS`: http://symfony.com/doc/current/cookbook/assetic/uglifyjs.html
96-
.. _`compress images`: http://symfony.com/doc/current/cookbook/assetic/jpeg_optimize.html
9797
.. _`official Assetic documentation`: https://github.com/kriswallsmith/assetic

0 commit comments

Comments
 (0)