Skip to content

Commit 8f2fe87

Browse files
committed
minor #4683 [Reference] update the configuration reference (xabbuh)
This PR was merged into the 2.3 branch. Discussion ---------- [Reference] update the configuration reference | Q | A | ------------- | --- | Doc fix? | no | New docs? | no | Applies to | all | Fixed tickets | Move some `versionadded` directive to right position and add missing type information. Commits ------- ee6291c [Reference] update the configuration reference
2 parents e889813 + ee6291c commit 8f2fe87

File tree

4 files changed

+114
-74
lines changed

4 files changed

+114
-74
lines changed

reference/configuration/doctrine.rst

+39-25
Original file line numberDiff line numberDiff line change
@@ -314,31 +314,45 @@ Explicit definition of all the mapped entities is the only necessary
314314
configuration for the ORM and there are several configuration options that
315315
you can control. The following configuration options exist for a mapping:
316316

317-
* ``type`` One of ``annotation``, ``xml``, ``yml``, ``php`` or ``staticphp``.
318-
This specifies which type of metadata type your mapping uses.
319-
320-
* ``dir`` Path to the mapping or entity files (depending on the driver).
321-
If this path is relative it is assumed to be relative to the bundle root.
322-
This only works if the name of your mapping is a bundle name. If you want
323-
to use this option to specify absolute paths you should prefix the path
324-
with the kernel parameters that exist in the DIC (for example ``%kernel.root_dir%``).
325-
326-
* ``prefix`` A common namespace prefix that all entities of this mapping
327-
share. This prefix should never conflict with prefixes of other defined
328-
mappings otherwise some of your entities cannot be found by Doctrine.
329-
This option defaults to the bundle namespace + ``Entity``, for example
330-
for an application bundle called ``AcmeHelloBundle`` prefix would be
331-
``Acme\HelloBundle\Entity``.
332-
333-
* ``alias`` Doctrine offers a way to alias entity namespaces to simpler,
334-
shorter names to be used in DQL queries or for Repository access. When
335-
using a bundle the alias defaults to the bundle name.
336-
337-
* ``is_bundle`` This option is a derived value from ``dir`` and by default
338-
is set to true if dir is relative proved by a ``file_exists()`` check
339-
that returns false. It is false if the existence check returns true. In
340-
this case an absolute path was specified and the metadata files are most
341-
likely in a directory outside of a bundle.
317+
type
318+
....
319+
320+
One of ``annotation``, ``xml``, ``yml``, ``php`` or ``staticphp``. This specifies
321+
which type of metadata type your mapping uses.
322+
323+
dir
324+
...
325+
326+
Path to the mapping or entity files (depending on the driver). If this path
327+
is relative it is assumed to be relative to the bundle root. This only works
328+
if the name of your mapping is a bundle name. If you want to use this option
329+
to specify absolute paths you should prefix the path with the kernel parameters
330+
that exist in the DIC (for example ``%kernel.root_dir%``).
331+
332+
prefix
333+
......
334+
335+
A common namespace prefix that all entities of this mapping share. This prefix
336+
should never conflict with prefixes of other defined mappings otherwise some
337+
of your entities cannot be found by Doctrine. This option defaults to the
338+
bundle namespace + ``Entity``, for example for an application bundle called
339+
``AcmeHelloBundle`` prefix would be ``Acme\HelloBundle\Entity``.
340+
341+
alias
342+
.....
343+
344+
Doctrine offers a way to alias entity namespaces to simpler, shorter names
345+
to be used in DQL queries or for Repository access. When using a bundle the
346+
alias defaults to the bundle name.
347+
348+
is_bundle
349+
.........
350+
351+
This option is a derived value from ``dir`` and by default is set to ``true``
352+
if dir is relative proved by a ``file_exists()`` check that returns ``false``.
353+
It is ``false`` if the existence check returns ``true``. In this case an
354+
absolute path was specified and the metadata files are most likely in a directory
355+
outside of a bundle.
342356

343357
.. index::
344358
single: Configuration; Doctrine DBAL

reference/configuration/framework.rst

+14-12
Original file line numberDiff line numberDiff line change
@@ -468,30 +468,32 @@ would be ``/images/logo.png?version=5``.
468468
profiler
469469
~~~~~~~~
470470

471-
.. versionadded:: 2.2
472-
The ``enabled`` option was introduced in Symfony 2.2. Previously, the profiler
473-
could only be disabled by omitting the ``framework.profiler`` configuration
474-
entirely.
475-
476471
.. _profiler.enabled:
477472

478473
enabled
479474
.......
480475

481-
**default**: ``true`` in the ``dev`` and ``test`` environments
476+
.. versionadded:: 2.2
477+
The ``enabled`` option was introduced in Symfony 2.2. Prior to Symfony
478+
2.2, the profiler could only be disabled by omitting the ``framework.profiler``
479+
configuration entirely.
480+
481+
**type**: ``boolean`` **default**: ``false``
482482

483-
The profiler can be disabled by setting this key to ``false``.
483+
The profiler can be enabled by setting this key to ``true``. When you are
484+
using the Symfony Standard Edition, the profiler is enabled in the ``dev``
485+
and ``test`` environments.
486+
487+
collect
488+
.......
484489

485490
.. versionadded:: 2.3
486491
The ``collect`` option was introduced in Symfony 2.3. Previously, when
487492
``profiler.enabled`` was ``false``, the profiler *was* actually enabled,
488493
but the collectors were disabled. Now, the profiler and the collectors
489494
can be controlled independently.
490495

491-
collect
492-
.......
493-
494-
**default**: ``true``
496+
**type**: ``boolean`` **default**: ``true``
495497

496498
This option configures the way the profiler behaves when it is enabled. If set
497499
to ``true``, the profiler collects data for all requests. If you want to only
@@ -515,7 +517,7 @@ Whether or not to enable the ``translator`` service in the service container.
515517
fallback
516518
........
517519

518-
**default**: ``en``
520+
**type**: ``string`` **default**: ``en``
519521

520522
This option is used when the translation key for the current locale wasn't found.
521523

reference/configuration/security.rst

+59-35
Original file line numberDiff line numberDiff line change
@@ -248,41 +248,65 @@ For even more details, see :doc:`/cookbook/security/form_login`.
248248
The Login Form and Process
249249
~~~~~~~~~~~~~~~~~~~~~~~~~~
250250

251-
* ``login_path`` (type: ``string``, default: ``/login``)
252-
This is the route or path that the user will be redirected to (unless
253-
``use_forward`` is set to ``true``) when they try to access a
254-
protected resource but isn't fully authenticated.
255-
256-
This path **must** be accessible by a normal, un-authenticated user,
257-
else you may create a redirect loop. For details, see
258-
":ref:`Avoid Common Pitfalls <book-security-common-pitfalls>`".
259-
260-
* ``check_path`` (type: ``string``, default: ``/login_check``)
261-
This is the route or path that your login form must submit to. The
262-
firewall will intercept any requests (``POST`` requests only, by default)
263-
to this URL and process the submitted login credentials.
264-
265-
Be sure that this URL is covered by your main firewall (i.e. don't create
266-
a separate firewall just for ``check_path`` URL).
267-
268-
* ``use_forward`` (type: ``Boolean``, default: ``false``)
269-
If you'd like the user to be forwarded to the login form instead of
270-
being redirected, set this option to ``true``.
271-
272-
* ``username_parameter`` (type: ``string``, default: ``_username``)
273-
This is the field name that you should give to the username field of
274-
your login form. When you submit the form to ``check_path``, the security
275-
system will look for a POST parameter with this name.
276-
277-
* ``password_parameter`` (type: ``string``, default: ``_password``)
278-
This is the field name that you should give to the password field of
279-
your login form. When you submit the form to ``check_path``, the security
280-
system will look for a POST parameter with this name.
281-
282-
* ``post_only`` (type: ``Boolean``, default: ``true``)
283-
By default, you must submit your login form to the ``check_path`` URL
284-
as a POST request. By setting this option to ``false``, you can send a
285-
GET request to the ``check_path`` URL.
251+
login_path
252+
..........
253+
254+
**type**: ``string`` **default**: ``/login``
255+
256+
This is the route or path that the user will be redirected to (unless ``use_forward``
257+
is set to ``true``) when they try to access a protected resource but isn't
258+
fully authenticated.
259+
260+
This path **must** be accessible by a normal, un-authenticated user, else
261+
you may create a redirect loop. For details, see
262+
":ref:`Avoid Common Pitfalls <book-security-common-pitfalls>`".
263+
264+
check_path
265+
..........
266+
267+
**type**: ``string`` **default**: ``/login_check``
268+
269+
This is the route or path that your login form must submit to. The firewall
270+
will intercept any requests (``POST`` requests only, by default) to this
271+
URL and process the submitted login credentials.
272+
273+
Be sure that this URL is covered by your main firewall (i.e. don't create
274+
a separate firewall just for ``check_path`` URL).
275+
276+
use_forward
277+
...........
278+
279+
**type**: ``Boolean`` **default**: ``false``
280+
281+
If you'd like the user to be forwarded to the login form instead of being
282+
redirected, set this option to ``true``.
283+
284+
username_parameter
285+
..................
286+
287+
**type**: ``string`` **default**: ``_username``
288+
289+
This is the field name that you should give to the username field of your
290+
login form. When you submit the form to ``check_path``, the security system
291+
will look for a POST parameter with this name.
292+
293+
password_parameter
294+
..................
295+
296+
**type**: ``string`` **default**: ``_password``
297+
298+
This is the field name that you should give to the password field of your
299+
login form. When you submit the form to ``check_path``, the security system
300+
will look for a POST parameter with this name.
301+
302+
post_only
303+
.........
304+
305+
**type**: ``Boolean`` **default**: ``true``
306+
307+
By default, you must submit your login form to the ``check_path`` URL as
308+
a POST request. By setting this option to ``false``, you can send a GET request
309+
to the ``check_path`` URL.
286310

287311
Redirecting after Login
288312
~~~~~~~~~~~~~~~~~~~~~~~

reference/configuration/swiftmailer.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -130,15 +130,15 @@ antiflood
130130
threshold
131131
.........
132132

133-
**type**: ``string`` **default**: ``99``
133+
**type**: ``integer`` **default**: ``99``
134134

135135
Used with ``Swift_Plugins_AntiFloodPlugin``. This is the number of emails
136136
to send before restarting the transport.
137137

138138
sleep
139139
.....
140140

141-
**type**: ``string`` **default**: ``0``
141+
**type**: ``integer`` **default**: ``0``
142142

143143
Used with ``Swift_Plugins_AntiFloodPlugin``. This is the number of seconds
144144
to sleep for during a transport restart.

0 commit comments

Comments
 (0)