Skip to content

Added notes in the components doc to point to the main Symfony articles #9840

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.

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 1 commit into from
May 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions components/browser_kit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ Alternatively, you can clone the `<https://github.com/symfony/browser-kit>`_ rep
Basic Usage
-----------

.. seealso::

This article explains how to use the BrowserKit features as an independent
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
article to learn about how to use it in Symfony applications.

Creating a Client
~~~~~~~~~~~~~~~~~

Expand Down
6 changes: 6 additions & 0 deletions components/console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ Alternatively, you can clone the `<https://github.com/symfony/console>`_ reposit
Creating a Console Application
------------------------------

.. seealso::

This article explains how to use the Console features as an independent
component in any PHP application. Read the :doc:`/console` article to
learn about how to use it in Symfony applications.

First, you need to create a PHP script to define the console application::

#!/usr/bin/env php
Expand Down
6 changes: 6 additions & 0 deletions components/css_selector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ Alternatively, you can clone the `<https://github.com/symfony/css-selector>`_ re
Usage
-----

.. seealso::

This article explains how to use the CssSelector features as an independent
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
article to learn about how to use it when creating Symfony tests.

Why to Use CSS selectors?
~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
6 changes: 6 additions & 0 deletions components/dependency_injection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ Alternatively, you can clone the `<https://github.com/symfony/dependency-injecti
Basic Usage
-----------

.. seealso::

This article explains how to use the DependencyInjection features as an
independent component in any PHP application. Read the :doc:`/service_container`
article to learn about how to use it in Symfony applications.

You might have a simple class like the following ``Mailer`` that
you want to make available as a service::

Expand Down
6 changes: 6 additions & 0 deletions components/dom_crawler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ Alternatively, you can clone the `<https://github.com/symfony/dom-crawler>`_ rep
Usage
-----

.. seealso::

This article explains how to use the DomCrawler features as an independent
component in any PHP application. Read the :ref:`Symfony Functional Tests <functional-tests>`
article to learn about how to use it when creating Symfony tests.

The :class:`Symfony\\Component\\DomCrawler\\Crawler` class provides methods
to query and manipulate HTML and XML documents.

Expand Down
6 changes: 6 additions & 0 deletions components/event_dispatcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ Alternatively, you can clone the `<https://github.com/symfony/event-dispatcher>`
Usage
-----

.. seealso::

This article explains how to use the EventDispatcher features as an
independent component in any PHP application. Read the :doc:`/event_dispatcher`
article to learn about how to use it in Symfony applications.

Events
~~~~~~

Expand Down
7 changes: 4 additions & 3 deletions components/form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ Alternatively, you can clone the `<https://github.com/symfony/form>`_ repository
Configuration
-------------

.. tip::
.. seealso::

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

In Symfony, forms are represented by objects and these objects are built
by using a *form factory*. Building a form factory is simple::
Expand Down
7 changes: 7 additions & 0 deletions components/http_foundation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Alternatively, you can clone the `<https://github.com/symfony/http-foundation>`_

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

.. seealso::

This article explains how to use the HttpFoundation features as an
independent component in any PHP application. In Symfony applications
everything is already configured and ready to use. Read the :doc:`/controller`
article to learn about how to use these features when creating controllers.

.. _component-http-foundation-request:

Request
Expand Down
9 changes: 9 additions & 0 deletions components/http_kernel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,15 @@ Alternatively, you can clone the `<https://github.com/symfony/http-kernel>`_ rep
The Workflow of a Request
-------------------------

.. seealso::

This article explains how to use the HttpKernel features as an independent
component in any PHP application. In Symfony applications everything is
already configured and ready to use. Read the :doc:`/controller` and
:doc:`/event_dispatcher` articles to learn about how to use it to create
controllers and define events in Symfony applications.


Every HTTP web interaction begins with a request and ends with a response.
Your job as a developer is to create PHP code that reads the request information
(e.g. the URL) and creates and returns a response (e.g. an HTML page or JSON string).
Expand Down
6 changes: 6 additions & 0 deletions components/intl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ The Intl Component
The replacement layer is limited to the locale "en". If you want to use
other locales, you should `install the intl extension`_ instead.

.. seealso::

This article explains how to use the Intl features as an independent component
in any PHP application. Read the :doc:`/translation` article to learn about
how to internationalize and manage the user locale in Symfony applications.

Installation
------------

Expand Down
6 changes: 6 additions & 0 deletions components/phpunit_bridge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ Alternatively, you can clone the `<https://github.com/symfony/phpunit-bridge>`_
Usage
-----

.. seealso::

This article explains how to use the PhpUnitBridge features as an independent
component in any PHP application. Read the :doc:`/testing` article to learn
about how to use it in Symfony applications.

Once the component is installed, a ``simple-phpunit`` script is created in the
``vendor/`` directory to run tests. This script wraps the original PHPUnit binary
to provide more features:
Expand Down
6 changes: 6 additions & 0 deletions components/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Alternatively, you can clone the `<https://github.com/symfony/routing>`_ reposit
Usage
-----

.. seealso::

This article explains how to use the Routing features as an independent
component in any PHP application. Read the :doc:`/routing` article to learn
about how to use it in Symfony applications.

In order to set up a basic routing system you need three parts:

* A :class:`Symfony\\Component\\Routing\\RouteCollection`, which contains the route definitions (instances of the class :class:`Symfony\\Component\\Routing\\Route`)
Expand Down
6 changes: 6 additions & 0 deletions components/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ used separately:
``symfony/security-acl``
It provides a fine grained permissions mechanism based on Access Control Lists.

.. seealso::

This article explains how to use the Security features as an independent
component in any PHP application. Read the :doc:`/security` article to learn
about how to use it in Symfony applications.

Learn More
----------

Expand Down
6 changes: 6 additions & 0 deletions components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ must also be installed.
Usage
-----

.. seealso::

This article explains how to use the Serializer features as an independent
component in any PHP application. Read the :doc:`/serializer` article to
learn about how to use it in Symfony applications.

Using the Serializer component is really simple. You just need to set up
the :class:`Symfony\\Component\\Serializer\\Serializer` specifying
which encoders and normalizer are going to be available::
Expand Down
6 changes: 6 additions & 0 deletions components/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ Alternatively, you can clone the `<https://github.com/symfony/templating>`_ repo
Usage
-----

.. seealso::

This article explains how to use the Templating features as an independent
component in any PHP application. Read the :doc:`/templating` article to
learn about how to work with templates in Symfony applications.

The :class:`Symfony\\Component\\Templating\\PhpEngine` class is the entry point
of the component. It needs a
template name parser (:class:`Symfony\\Component\\Templating\\TemplateNameParserInterface`)
Expand Down
7 changes: 7 additions & 0 deletions components/translation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@ Alternatively, you can clone the `<https://github.com/symfony/translation>`_ rep

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

.. seealso::

This article explains how to use the Translation features as an independent
component in any PHP application. Read the :doc:`/translation` article to
learn about how to internationalize and manage the user locale in Symfony
applications.

Constructing the Translator
---------------------------

Expand Down
6 changes: 6 additions & 0 deletions components/validator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Alternatively, you can clone the `<https://github.com/symfony/validator>`_ repos
Usage
-----

.. seealso::

This article explains how to use the Validator features as an independent
component in any PHP application. Read the :doc:`/validation` article to
learn about how to validate data and entities in Symfony applications.

The Validator component behavior is based on two concepts:

* Constraints, which define the rules to be validated;
Expand Down
2 changes: 2 additions & 0 deletions testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,8 @@ Running tests for a given file or directory is also very easy:
.. index::
single: Tests; Functional tests

.. _functional-tests:

Functional Tests
----------------

Expand Down