8000 minor #8742 Add instructions to install dependencies before using the… · symfony/symfony-docs@554d8e7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 554d8e7

Browse files
weaverryanweaverryan
committed
minor #8742 Add instructions to install dependencies before using them (javiereguiluz)
This PR was merged into the 4.0 branch. Discussion ---------- Add instructions to install dependencies before using them The missing ones are being taken care of in other PRs (doctrine, translation, etc.) Commits ------- 94fd2e9 Add instructions to install dependencies before using them
2 parents d450dab + 94fd2e9 commit 554d8e7

File tree

8 files changed

+80
-16
lines changed

8 files changed

+80
-16
lines changed

‎email.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ own mail servers as well as using popular email providers like `Mandrill`_,
1212
Installation
1313
------------
1414

15-
In applications using :doc:`Symfony Flex </setup/flex>`, execute this command to
16-
install and enable the mailer:
15+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
16+
install the Swift Mailer based mailer before using it:
1717

1818
.. code-block:: terminal
1919

‎forms.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ a web developer. Symfony integrates a Form component that makes dealing with
99
forms easy. In this article, you'll build a complex form from the ground up,
1010
learning the most important features of the form library along the way.
1111

12+
Installation
13+
------------
14+
15+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
16+
install the form feature before using it:
17+
18+
.. code-block:: terminal
19+
20+
$ composer require form
21+
1222
.. note::
1323

1424
The Symfony Form component is a standalone library that can be used outside

‎logging.rst

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
11
Logging with Monolog
22
====================
33

4-
Symfony comes with an outside library - called Monolog_ - that allows you to create
5-
logs that can be stored in a variety of different places.
4+
Symfony integrates seamlessly with `Monolog`_, the most popular PHP logging
5+
library, to create and store log messages in a variety of different places.
6+
7+
Installation
8+
------------
9+
10+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
11+
install the Monolog based logger before using it:
12+
13+
.. code-block:: terminal
14+
15+
$ composer require logger
616
717
Logging a Message
818
-----------------
@@ -19,7 +29,7 @@ your controller::
1929

2030
$logger->info('I just got the logger');
2131
$logger->error('An error occurred');
22-
32+
2333
$logger->critical('I left the oven on!', array(
2434
// include extra "context" info in your logs
2535
'cause' => 'in_hurry',

‎profiler.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
Profiler
22
========
33

4+
Symfony provides a powerful profiler to get detailed information about the
5+
execution of any request.
6+
7+
Installation
8+
------------
9+
10+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
11+
install the profiler before using it:
12+
13+
.. code-block:: terminal
14+
15+
$ composer require profiler
16+
417
.. toctree::
518
:maxdepth: 1
619

‎security.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ is both flexible and (hopefully) fun to work with.
1414
Since there's a lot to talk about, this article is organized into a few big
1515
sections:
1616

17+
#. Installing security support;
18+
1719
#. Initial ``security.yml`` setup (*authentication*);
1820

1921
#. Denying access to your app (*authorization*);
@@ -24,6 +26,16 @@ These are followed by a number of small (but still captivating) sections,
2426
like :ref:`logging out <security-logging-out>` and
2527
:doc:`encoding user passwords </security/password_encoding>`.
2628

29+
Installation
30+
------------
31+
32+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
33+
install the security feature before using it:
34+
35+
.. code-block:: terminal
36+
37+
$ composer require security
38+
2739
.. _security-firewalls:
2840
.. _firewalls-authentication:
2941

‎serializer.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ its philosophy and the normalizers and encoders terminology.
1111

1212
.. _activating_the_serializer:
1313

14-
Installing the Serializer
15-
-------------------------
14+
Installation
15+
------------
1616

17-
Before using the serializer, run this command to install it in your application:
17+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
18+
install the serializer before using it:
1819

1920
.. code-block:: terminal
2021

‎validation.rst

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,18 @@ Validation is a very common task in web applications. Data entered in forms
88
needs to be validated. Data also needs to be validated before it is written
99
into a database or passed to a web service.
1010

11-
Symfony ships with a `Validator`_ component that makes this task easy and
12-
transparent. This component is based on the
13-
`JSR303 Bean Validation specification`_.
11+
Symfony provides a `Validator`_ component that makes this task easy and
12+
transparent. This component is based on the `JSR303 Bean Validation specification`_.
13+
14+
Installation
15+
------------
16+
17+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
18+
install the validator before using it:
19+
20+
.. code-block:: terminal
21+
22+
$ composer require validator
1423
1524
.. index::
1625
single: Validation; The basics

‎workflow/usage.rst

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@
44
How to Create and Use Workflows
55
===============================
66

7-
Before creating your first workflow, execute this command to install the
8-
:doc:`Workflow component </components/workflow>` in your application:
7+
Installation
8+
------------
9+
10+
In applications using :doc:`Symfony Flex </setup/flex>`, run this command to
11+
install the workflow feature before using it:
912

1013
.. code-block:: terminal
1114
1215
$ composer require workflow
1316
17+
Creating a Workflow
18+
-------------------
19+
1420
A workflow is a process or a lifecycle that your objects go through. Each
< B470 /td>
1521
step or stage in the process is called a *place*. You do also define *transitions*
1622
to that describes the action to get from one place to another.
@@ -163,9 +169,12 @@ like this:
163169
value ``marking``) attributes of the ``marking_store`` option are optional.
164170
If omitted, their default values will be used.
165171

166-
With this workflow named ``blog_publishing``, you can now decide what actions
167-
are allowed on a blog post. For example, inside a controller of an application
168-
using the :ref:`default services.yaml configuration <service-container-services-load-example>`,
172+
Using a Workflow
173+
----------------
174+
175+
Once the ``blog_publishing`` workflow has been created, you can now use it to
176+
decide what actions are allowed on a blog post. For example, inside a controller
177+
of an application using the :ref:`default services.yaml configuration <service-container-services-load-example>`,
169178
you can get the workflow by injecting the Workflow registry service::
170179

171180
// ...

0 commit comments

Comments
 (0)
0