8000 [Reference] update the configuration reference · symfony/symfony-docs@5dab0ea · GitHub
[go: up one dir, main page]
Skip to content

Commit 5dab0ea

Browse files
xabbuhxabbuh
committed
[Reference] update the configuration reference
Move some `versionadded` directive to right position and add missing type information.
1 parent 9b4d747 commit 5dab0ea

File tree

4 files changed

+62
-46
lines changed

4 files changed

+62
-46
lines changed

‎reference/configuration/doctrine.rst

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

343347
.. index::
344348
single: Configuration; Doctrine DBAL

‎reference/configuration/framework.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -464,30 +464,30 @@ would be ``/images/logo.png?version=5``.
464464
profiler
465465
~~~~~~~~
466466

467-
.. versionadded:: 2.2
468-
The ``enabled`` option was introduced in Symfony 2.2. Previously, the profiler
469-
could only be disabled by omitting the ``framework.profiler`` configuration
470-
entirely.
471-
472467
.. _profiler.enabled:
473468

474469
enabled
475470
.......
476471

477-
**default**: ``true`` in the ``dev`` and ``test`` environments
472+
.. versionadded:: 2.2
473+
The ``enabled`` option was introduced in Symfony 2.2. Previously, the profiler
474+
could only be disabled by omitting the ``framework.profiler`` configuration
475+
entirely.
476+
477+
**type**: ``boolean`` **default**: ``true`` in the ``dev`` and ``test`` environments
478478

479479
The profiler can be disabled by setting this key to ``false``.
480480

481+
collect
482+
.......
483+
481484
.. versionadded:: 2.3
482485
The ``collect`` option was introduced in Symfony 2.3. Previously, when
483486
``profiler.enabled`` was ``false``, the profiler *was* actually enabled,
484487
but the collectors were disabled. Now, the profiler and the collectors
485488
can be controlled independently.
486489

487-
collect
488-
.......
489-
490-
**default**: ``true``
490+
**type**: ``boolean`` **default**: ``true``
491491

492492
This option configures the way the profiler behaves when it is enabled. If set
493493
to ``true``, the profiler collects data for all requests. If you want to only
@@ -511,7 +511,7 @@ Whether or not to enable the ``translator`` service in the service container.
511511
fallback
512512
........
513513

514-
**default**: ``en``
514+
**type**: ``string`` **default**: ``en``
515515

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

‎reference/configuration/security.rst

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -248,38 +248,50 @@ 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``)
251+
``login_path``
252+
**type**: ``string`` **default**: ``/login``
253+
252254
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+
``use_forward`` is set to ``true``) when they try to access a protected
256+
resource but isn't fully authenticated.
255257

256258
This path **must** be accessible by a normal, un-authenticated user,
257259
else you may create a redirect loop. For details, see
258260
":ref:`Avoid Common Pitfalls <book-security-common-pitfalls>`".
259261

260-
* ``check_path`` (type: ``string``, default: ``/login_check``)
262+
``check_path``
263+
**type**: ``string`` **default**: ``/login_check``
264+
261265
This is the route or path that your login form must submit to. The
262266
firewall will intercept any requests (``POST`` requests only, by default)
263267 to this URL and process the submitted login credentials.
264268

265269
Be sure that this URL is covered by your main firewall (i.e. don't create
266270
a separate firewall just for ``check_path`` URL).
267271

268-
* ``use_forward`` (type: ``Boolean``, default: ``false``)
272+
``use_forward``
273+
**type**: ``Boolean`` **default**: ``false``
274+
269275
If you'd like the user to be forwarded to the login form instead of
270276
being redirected, set this option to ``true``.
271277

272-
* ``username_parameter`` (type: ``string``, default: ``_username``)
278+
``username_parameter``
279+
**type**: ``string`` **default**: ``_username``
280+
273281
This is the field name that you should give to the username field of
274282
your login form. When you submit the form to ``check_path``, the security
275283
system will look for a POST parameter with this name.
276284

277-
* ``password_parameter`` (type: ``string``, default: ``_password``)
285+
``password_parameter``
286+
**type**: ``string`` **default**: ``_password``
287+
278288
This is the field name that you should give to the password field of
279289
your login form. When you submit the form to ``check_path``, the security
280290
system will look for a POST parameter with this name.
281291

282-
* ``post_only`` (type: ``Boolean``, default: ``true``)
292+
``post_only``
293+
**type**: ``Boolean`` **default**: ``true``
294+
283295
By default, you must submit your login form to the ``check_path`` URL
284296
as a POST request. By setting this option to ``false``, you can send a
285297
GET request to the ``check_path`` URL.

‎reference/configuration/swiftmailer.rst

Lines changed: 2 additions & 2 deletions
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)
0