Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit e7cba20

Browse filesBrowse files
fabpotfabpot
committed
Merge branch '2.5' into 2.6
* 2.5: removed more references to documentation from external sources Removed more references to third party docs removed references to documentation from external sources changes from xabbuh Correct link to scopes page update best practices index
2 parents 97943e8 + 5a92261 commit e7cba20
Copy full SHA for e7cba20

File tree

Expand file treeCollapse file tree

15 files changed

+54
-109
lines changed
Filter options
Expand file treeCollapse file tree

15 files changed

+54
-109
lines changed

‎.gitignore

Copy file name to clipboard
-6Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,2 @@
11
/_build
2-
/bundles/DoctrineFixturesBundle
3-
/bundles/DoctrineMigrationsBundle
4-
/bundles/DoctrineMongoDBBundle
5-
/bundles/SensioFrameworkExtraBundle
6-
/bundles/SensioGeneratorBundle
7-
/cmf
82
/_exts

‎.travis.yml

Copy file name to clipboardExpand all lines: .travis.yml
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ python:
44
- "2.7"
55

66
install:
7-
- "bash install.sh"
87
- "pip install -q -r requirements.txt --use-mirrors"
98

109
script: sphinx-build -nW -b html -d _build/doctrees . _build/html

‎best_practices/index.rst

Copy file name to clipboardExpand all lines: best_practices/index.rst
+3Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ Official Symfony Best Practices
22
===============================
33

44
.. toctree::
5+
:hidden:
56

67
introduction
78
creating-the-project
@@ -14,3 +15,5 @@ Official Symfony Best Practices
1415
security
1516
web-assets
1617
tests
18+
19+
.. include:: /best_practices/map.rst.inc

‎best_practices/map.rst.inc

Copy file name to clipboard
+11Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
* :doc:`/best_practices/introduction`
2+
* :doc:`/best_practices/creating-the-project`
3+
* :doc:`/best_practices/configuration`
4+
* :doc:`/best_practices/business-logic`
5+
* :doc:`/best_practices/controllers`
6+
* :doc:`/best_practices/templates`
7+
* :doc:`/best_practices/forms`
8+
* :doc:`/best_practices/i18n`
9+
* :doc:`/best_practices/security`
10+
* :doc:`/best_practices/web-assets`
11+
* :doc:`/best_practices/tests`

‎book/doctrine.rst

Copy file name to clipboardExpand all lines: book/doctrine.rst
+14-11Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ can be.
2222
easy, and explained in the ":doc:`/cookbook/doctrine/dbal`" cookbook entry.
2323

2424
You can also persist data to `MongoDB`_ using Doctrine ODM library. For
25-
more information, read the ":doc:`/bundles/DoctrineMongoDBBundle/index`"
25+
more information, read the "`DoctrineMongoDBBundle`_"
2626
documentation.
2727

2828
A Simple Example: A Product
@@ -471,10 +471,10 @@ in your application. To do this, run:
471471
new column to the existing ``product`` table.
472472

473473
An even better way to take advantage of this functionality is via
474-
:doc:`migrations </bundles/DoctrineMigrationsBundle/index>`, which allow you to
475-
generate these SQL statements and store them in migration classes that
476-
can be run systematically on your production server in order to track
477-
and migrate your database schema safely and reliably.
474+
`migrations`_, which allow you to generate these SQL statements and store
475+
them in migration classes that can be run systematically on your production
476+
server in order to track and migrate your database schema safely and
477+
reliably.
478478

479479
Your database now has a fully-functional ``product`` table with columns that
480480
match the metadata you've specified.
@@ -559,7 +559,7 @@ an ``UPDATE`` query if the record already exists in the database.
559559

560560
Doctrine provides a library that allows you to programmatically load testing
561561
data into your project (i.e. "fixture data"). For information, see
562-
:doc:`/bundles/DoctrineFixturesBundle/index`.
562+
the "`DoctrineFixturesBundle`_" documentation.
563563

564564
Fetching Objects from the Database
565565
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -586,8 +586,7 @@ on its ``id`` value::
586586
.. tip::
587587

588588
You can achieve the equivalent of this without writing any code by using
589-
the ``@ParamConverter`` shortcut. See the
590-
:doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/converters>`
589+
the ``@ParamConverter`` shortcut. See the `FrameworkExtraBundle documentation`_
591590
for more details.
592591

593592
When you query for a particular type of object, you always use what's known
@@ -1083,7 +1082,7 @@ table, and ``product.category_id`` column, and new foreign key:
10831082

10841083
This task should only be really used during development. For a more robust
10851084
method of systematically updating your production database, read about
1086-
:doc:`Doctrine migrations </bundles/DoctrineMigrationsBundle/index>`.
1085+
`migrations`_.
10871086

10881087
Saving Related Entities
10891088
~~~~~~~~~~~~~~~~~~~~~~~
@@ -1400,8 +1399,8 @@ For more information about Doctrine, see the *Doctrine* section of the
14001399

14011400
* :doc:`/cookbook/doctrine/common_extensions`
14021401
* :doc:`/cookbook/doctrine/console`
1403-
* :doc:`/bundles/DoctrineFixturesBundle/index`
1404-
* :doc:`/bundles/DoctrineMongoDBBundle/index`
1402+
* `DoctrineFixturesBundle`_
1403+
* `DoctrineMongoDBBundle`_
14051404

14061405
.. _`Doctrine`: http://www.doctrine-project.org/
14071406
.. _`MongoDB`: http://www.mongodb.org/
@@ -1414,3 +1413,7 @@ For more information about Doctrine, see the *Doctrine* section of the
14141413
.. _`Lifecycle Events documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/events.html#lifecycle-events
14151414
.. _`Reserved SQL keywords documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#quoting-reserved-words
14161415
.. _`Persistent classes`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#persistent-classes
1416+
.. _`DoctrineMongoDBBundle`: http://symfony.com/doc/current/bundles/DoctrineMongoDBBundle/index.html
1417+
.. _`migrations`: http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html
1418+
.. _`DoctrineFixturesBundle`: http://symfony.com/doc/current/bundles/DoctrineFixturesBundle/index.html
1419+
.. _`FrameworkExtraBundle documentation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html

‎book/http_cache.rst

Copy file name to clipboardExpand all lines: book/http_cache.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -764,7 +764,7 @@ at some interval (the expiration) to verify that the content is still valid.
764764

765765
You can also define HTTP caching headers for expiration and validation by using
766766
annotations. See the
767-
:doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/cache>`.
767+
`FrameworkExtraBundle documentation <http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/cache.html>`_.
768768

769769
.. index::
770770
pair: Cache; Configuration

‎bundles/index.rst

Copy file name to clipboardExpand all lines: bundles/index.rst
-13Lines changed: 0 additions & 13 deletions
This file was deleted.

‎bundles/map.rst.inc

Copy file name to clipboardExpand all lines: bundles/map.rst.inc
-5Lines changed: 0 additions & 5 deletions
This file was deleted.

‎components/http_kernel/introduction.rst

Copy file name to clipboardExpand all lines: components/http_kernel/introduction.rst
+17-17Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -288,16 +288,15 @@ on the event object that's passed to listeners on this event.
288288
the Symfony Framework, and many deal with collecting profiler data when
289289
the profiler is enabled.
290290

291-
One interesting listener comes from the :doc:`SensioFrameworkExtraBundle </bundles/SensioFrameworkExtraBundle/index>`,
291+
One interesting listener comes from the `SensioFrameworkExtraBundle`_,
292292
which is packaged with the Symfony Standard Edition. This listener's
293-
:doc:`@ParamConverter </bundles/SensioFrameworkExtraBundle/annotations/converters>`
294-
functionality allows you to pass a full object (e.g. a ``Post`` object)
295-
to your controller instead of a scalar value (e.g. an ``id`` parameter
296-
that was on your route). The listener - ``ParamConverterListener`` - uses
297-
reflection to look at each of the arguments of the controller and tries
298-
to use different methods to convert those to objects, which are then
299-
stored in the ``attributes`` property of the ``Request`` object. Read the
300-
next section to see why this is important.
293+
`@ParamConverter`_ functionality allows you to pass a full object (e.g. a
294+
``Post`` object) to your controller instead of a scalar value (e.g. an
295+
``id`` parameter that was on your route). The listener -
296+
``ParamConverterListener`` - uses reflection to look at each of the
297+
arguments of the controller and tries to use different methods to convert
298+
those to objects, which are then stored in the ``attributes`` property of
299+
the ``Request`` object. Read the next section to see why this is important.
301300

302301
4) Getting the Controller Arguments
303302
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -395,14 +394,12 @@ return a ``Response``.
395394
.. sidebar:: ``kernel.view`` in the Symfony Framework
396395

397396
There is no default listener inside the Symfony Framework for the ``kernel.view``
398-
event. However, one core bundle -
399-
:doc:`SensioFrameworkExtraBundle </bundles/SensioFrameworkExtraBundle/index>` -
400-
*does* add a listener to this event. If your controller returns an array,
401-
and you place the :doc:`@Template </bundles/SensioFrameworkExtraBundle/annotations/view>`
402-
annotation above the controller, then this listener renders a template,
403-
passes the array you returned from your controller to that template,
404-
and creates a ``Response`` containing the returned content from that
405-
template.
397+
event. However, one core bundle - `SensioFrameworkExtraBundle`_ - *does*
398+
add a listener to this event. If your controller returns an array,
399+
and you place the `@Template`_ annotation above the controller, then this
400+
listener renders a template, passes the array you returned from your
401+
controller to that template, and creates a ``Response`` containing the
402+
returned content from that template.
406403

407404
Additionally, a popular community bundle `FOSRestBundle`_ implements
408405
a listener on this event which aims to give you a robust view layer
@@ -705,3 +702,6 @@ look like this::
705702
.. _FOSRestBundle: https://github.com/friendsofsymfony/FOSRestBundle
706703
.. _`Create your own framework... on top of the Symfony2 Components`: http://fabien.potencier.org/article/50/create-your-own-framework-on-top-of-the-symfony2-components-part-1
707704
.. _`PHP FPM`: http://php.net/manual/en/install.fpm.php
705+
.. _`SensioFrameworkExtraBundle`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
706+
.. _`@ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
707+
.. _`@Template`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/view.html

‎contributing/documentation/format.rst

Copy file name to clipboardExpand all lines: contributing/documentation/format.rst
-1Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,6 @@ submitting your documentation, follow these steps:
209209

210210
* Install Sphinx_;
211211
* Install the Sphinx extensions using git submodules: ``$ git submodule update --init``;
212-
* (Optionally) Install the bundle docs and CMF docs: ``$ bash install.sh``;
213212
* Run ``make html`` and view the generated HTML in the ``build/`` directory.
214213

215214
.. _reStructuredText: http://docutils.sourceforge.net/rst.html

‎cookbook/console/console_command.rst

Copy file name to clipboardExpand all lines: cookbook/console/console_command.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ service container. In other words, you have access to any configured service::
8787
// ...
8888
}
8989

90-
However, due to the `container scopes </cookbook/service_container/scopes>`_ this
90+
However, due to the :doc:`container scopes </cookbook/service_container/scopes>` this
9191
code doesn't work for some services. For instance, if you try to get the ``request``
9292
service or any other service related to it, you'll get the following error:
9393

‎cookbook/controller/service.rst

Copy file name to clipboardExpand all lines: cookbook/controller/service.rst
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,8 @@ the route ``_controller`` value:
132132
.. tip::
133133

134134
You can also use annotations to configure routing using a controller
135-
defined as a service. See the
136-
:doc:`FrameworkExtraBundle documentation </bundles/SensioFrameworkExtraBundle/annotations/routing>`
137-
for details.
135+
defined as a service. See the `FrameworkExtraBundle documentation`_ for
136+
details.
138137

139138
.. versionadded:: 2.6
140139
If your controller service implements the ``__invoke`` method, you can simply refer to the service id
@@ -271,3 +270,4 @@ inject *only* the exact service(s) that you need directly into the controller.
271270

272271
.. _`Controller class source code`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
273272
.. _`base Controller class`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
273+
.. _`FrameworkExtraBundle documentation`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/routing.html

‎cookbook/templating/PHP.rst

Copy file name to clipboardExpand all lines: cookbook/templating/PHP.rst
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,10 @@ below renders the ``index.html.php`` template::
6060
);
6161
}
6262

63-
You can also use the :doc:`/bundles/SensioFrameworkExtraBundle/annotations/view`
64-
shortcut to render the default ``AcmeHelloBundle:Hello:index.html.php`` template::
63+
You can also use the `@Template`_ shortcut to render the default
64+
``AcmeHelloBundle:Hello:index.html.php`` template::
6565

6666
// src/Acme/HelloBundle/Controller/HelloController.php
67-
6867
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
6968

7069
// ...
@@ -368,3 +367,5 @@ within an HTML context. The second argument lets you change the context. For
368367
instance, to output something in a JavaScript script, use the ``js`` context::
369368

370369
<?php echo $view->escape($var, 'js') ?>
370+
371+
.. _`@Template`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/view`

‎index.rst

Copy file name to clipboardExpand all lines: index.rst
-23Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,29 +77,6 @@ Get answers quickly with reference documents:
7777

7878
.. include:: /reference/map.rst.inc
7979

80-
Bundles
81-
-------
82-
83-
The Symfony Standard Edition comes with some bundles. Learn more about them:
84-
85-
.. toctree::
86-
:hidden:
87-
88-
bundles/index
89-
90-
.. include:: /bundles/map.rst.inc
91-
92-
CMF
93-
---
94-
95-
The Symfony CMF project makes it easier for developers to add CMS functionality
96-
to applications built with the Symfony PHP framework.
97-
98-
.. toctree::
99-
:hidden:
100-
101-
cmf/index
102-
10380
Contributing
10481
------------
10582

‎install.sh

Copy file name to clipboardExpand all lines: install.sh
-24Lines changed: 0 additions & 24 deletions
This file was deleted.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.