Skip to content

Commit 81fcfb2

Browse files
committed
minor #9840 Added notes in the components doc to point to the main Symfony articles (javiereguiluz)
This PR was merged into the 2.8 branch. Discussion ---------- Added notes in the components doc to point to the main Symfony articles This fixes #9357. Commits ------- 4185aa8 Added notes in the components doc to point to the main Symfony articles
2 parents 1905113 + 4185aa8 commit 81fcfb2

18 files changed

+107
-3
lines changed

components/browser_kit.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ Alternatively, you can clone the `<https://github.com/symfony/browser-kit>`_ rep
2828
Basic Usage
2929
-----------
3030

31+
.. seealso::
32+
33+
This article explains how to use the BrowserKit features as an independent
34+
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
35+
article to learn about how to use it in Symfony applications.
36+
3137
Creating a Client
3238
~~~~~~~~~~~~~~~~~
3339

components/console.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ Alternatively, you can clone the `<https://github.com/symfony/console>`_ reposit
2626
Creating a Console Application
2727
------------------------------
2828

29+
.. seealso::
30+
31+
This article explains how to use the Console features as an independent
32+
component in any PHP application. Read the :doc:`/console` article to
33+
learn about how to use it in Symfony applications.
34+
2935
First, you need to create a PHP script to define the console application::
3036

3137
#!/usr/bin/env php

components/css_selector.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ Alternatively, you can clone the `<https://github.com/symfony/css-selector>`_ re
2121
Usage
2222
-----
2323

24+
.. seealso::
25+
26+
This article explains how to use the CssSelector features as an independent
27+
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
28+
article to learn about how to use it when creating Symfony tests.
29+
2430
Why to Use CSS selectors?
2531
~~~~~~~~~~~~~~~~~~~~~~~~~
2632

components/dependency_injection.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ Alternatively, you can clone the `<https://github.com/symfony/dependency-injecti
2525
Basic Usage
2626
-----------
2727

28+
.. seealso::
29+
30+
This article explains how to use the DependencyInjection features as an
31+
independent component in any PHP application. Read the :doc:`/service_container`
32+
article to learn about how to use it in Symfony applications.
33+
2834
You might have a simple class like the following ``Mailer`` that
2935
you want to make available as a service::
3036

components/dom_crawler.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,12 @@ Alternatively, you can clone the `<https://github.com/symfony/dom-crawler>`_ rep
2626
Usage
2727
-----
2828

29+
.. seealso::
30+
31+
This article explains how to use the DomCrawler features as an independent
32+
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
33+
article to learn about how to use it when creating Symfony tests.
34+
2935
The :class:`Symfony\\Component\\DomCrawler\\Crawler` class provides methods
3036
to query and manipulate HTML and XML documents.
3137

components/event_dispatcher.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,12 @@ Alternatively, you can clone the `<https://github.com/symfony/event-dispatcher>`
6363
Usage
6464
-----
6565

66+
.. seealso::
67+
68+
This article explains how to use the EventDispatcher features as an
69+
independent component in any PHP application. Read the :doc:`/event_dispatcher`
70+
article to learn about how to use it in Symfony applications.
71+
6672
Events
6773
~~~~~~
6874

components/form.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ Alternatively, you can clone the `<https://github.com/symfony/form>`_ repository
2727
Configuration
2828
-------------
2929

30-
.. tip::
30+
.. seealso::
3131

32-
If you are working with the full-stack Symfony Framework, the Form component
33-
is already configured for you. In this case, skip to :ref:`component-form-intro-create-simple-form`.
32+
This article explains how to use the Form features as an independent
33+
component in any PHP application. Read the :doc:`/forms` article to learn
34+
about how to use it in Symfony applications.
3435

3536
In Symfony, forms are represented by objects and these objects are built
3637
by using a *form factory*. Building a form factory is simple::

components/http_foundation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ Alternatively, you can clone the `<https://github.com/symfony/http-foundation>`_
2727

2828
.. include:: /components/require_autoload.rst.inc
2929

30+
.. seealso::
31+
32+
This article explains how to use the HttpFoundation features as an
33+
independent component in any PHP application. In Symfony applications
34+
everything is already configured and ready to use. Read the :doc:`/controller`
35+
article to learn about how to use these features when creating controllers.
36+
3037
.. _component-http-foundation-request:
3138

3239
Request

components/http_kernel.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ Alternatively, you can clone the `<https://github.com/symfony/http-kernel>`_ rep
2525
The Workflow of a Request
2626
-------------------------
2727

28+
.. seealso::
29+
30+
This article explains how to use the HttpKernel features as an independent
31+
component in any PHP application. In Symfony applications everything is
32+
already configured and ready to use. Read the :doc:`/controller` and
33+
:doc:`/event_dispatcher` articles to learn about how to use it to create
34+
controllers and define events in Symfony applications.
35+
36+
2837
Every HTTP web interaction begins with a request and ends with a response.
2938
Your job as a developer is to create PHP code that reads the request information
3039
(e.g. the URL) and creates and returns a response (e.g. an HTML page or JSON string).

components/intl.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ The Intl Component
1717
The replacement layer is limited to the locale "en". If you want to use
1818
other locales, you should `install the intl extension`_ instead.
1919

20+
.. seealso::
21+
22+
This article explains how to use the Intl features as an independent component
23+
in any PHP application. Read the :doc:`/translation` article to learn about
24+
how to internationalize and manage the user locale in Symfony applications.
25+
2026
Installation
2127
------------
2228

components/phpunit_bridge.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,12 @@ Alternatively, you can clone the `<https://github.com/symfony/phpunit-bridge>`_
4545
Usage
4646
-----
4747

48+
.. seealso::
49+
50+
This article explains how to use the PhpUnitBridge features as an independent
51+
component in any PHP application. Read the :doc:`/testing` article to learn
52+
about how to use it in Symfony applications.
53+
4854
Once the component is installed, a ``simple-phpunit`` script is created in the
4955
``vendor/`` directory to run tests. This script wraps the original PHPUnit binary
5056
to provide more features:

components/routing.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Alternatively, you can clone the `<https://github.com/symfony/routing>`_ reposit
2222
Usage
2323
-----
2424

25+
.. seealso::
26+
27+
This article explains how to use the Routing features as an independent
28+
component in any PHP application. Read the :doc:`/routing` article to learn
29+
about how to use it in Symfony applications.
30+
2531
In order to set up a basic routing system you need three parts:
2632

2733
* A :class:`Symfony\\Component\\Routing\\RouteCollection`, which contains the route definitions (instances of the class :class:`Symfony\\Component\\Routing\\Route`)

components/security.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ used separately:
3939
``symfony/security-acl``
4040
It provides a fine grained permissions mechanism based on Access Control Lists.
4141

42+
.. seealso::
43+
44+
This article explains how to use the Security features as an independent
45+
component in any PHP application. Read the :doc:`/security` article to learn
46+
about how to use it in Symfony applications.
47+
4248
Learn More
4349
----------
4450

components/serializer.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ must also be installed.
4141
Usage
4242
-----
4343

44+
.. seealso::
45+
46+
This article explains how to use the Serializer features as an independent
47+
component in any PHP application. Read the :doc:`/serializer` article to
48+
learn about how to use it in Symfony applications.
49+
4450
Using the Serializer component is really simple. You just need to set up
4551
the :class:`Symfony\\Component\\Serializer\\Serializer` specifying
4652
which encoders and normalizer are going to be available::

components/templating.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Alternatively, you can clone the `<https://github.com/symfony/templating>`_ repo
2727
Usage
2828
-----
2929

30+
.. seealso::
31+
32+
This article explains how to use the Templating features as an independent
33+
component in any PHP application. Read the :doc:`/templating` article to
34+
learn about how to work with templates in Symfony applications.
35+
3036
The :class:`Symfony\\Component\\Templating\\PhpEngine` class is the entry point
3137
of the component. It needs a
3238
template name parser (:class:`Symfony\\Component\\Templating\\TemplateNameParserInterface`)

components/translation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ Alternatively, you can clone the `<https://github.com/symfony/translation>`_ rep
1919

2020
.. include:: /components/require_autoload.rst.inc
2121

22+
.. seealso::
23+
24+
This article explains how to use the Translation features as an independent
25+
component in any PHP application. Read the :doc:`/translation` article to
26+
learn about how to internationalize and manage the user locale in Symfony
27+
applications.
28+
2229
Constructing the Translator
2330
---------------------------
2431

components/validator.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ Alternatively, you can clone the `<https://github.com/symfony/validator>`_ repos
2222
Usage
2323
-----
2424

25+
.. seealso::
26+
27+
This article explains how to use the Validator features as an independent
28+
component in any PHP application. Read the :doc:`/validation` article to
29+
learn about how to validate data and entities in Symfony applications.
30+
2531
The Validator component behavior is based on two concepts:
2632

2733
* Constraints, which define the rules to be validated;

testing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,8 @@ Running tests for a given file or directory is also very easy:
116116
.. index::
117117
single: Tests; Functional tests
118118

119+
.. _functional-tests:
120+
119121
Functional Tests
120122
----------------
121123

0 commit comments

Comments
 (0)