10000 Fixes of all kind · symfony/symfony-docs@8d4f444 · GitHub
[go: up one dir, main page]
Skip to content

Commit 8d4f444

Browse files
bicpibicpi
committed
Fixes of all kind
1 parent e96e12d commit 8d4f444

34 files changed

+103
-69
lines changed

‎book/controller.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -470,7 +470,7 @@ object that's returned from that controller::
470470
return $response;
471471
}
472472

473-
Notice that the `forward()` method uses the same string representation of
473+
Notice that the ``forward()`` method uses the same string representation of
474474
the controller used in the routing configuration. In this case, the target
475475
controller class will be ``HelloController`` inside some ``AcmeHelloBundle``.
476476
The array passed to the method becomes the arguments on the resulting controller.
@@ -786,7 +786,7 @@ The Request Object
786786
Besides the values of the routing placeholders, the controller also has access
787787
to the ``Request`` object. The framework injects the ``Request`` object in the
788788
controller if a variable is type-hinted with
789-
`Symfony\Component\HttpFoundation\Request`::
789+
:class:`Symfony\\Component\\HttpFoundation\\Request`::
790790

791791
use Symfony\Component\HttpFoundation\Request;
792792

‎book/forms.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -495,7 +495,7 @@ these cases you can set the ``validation_groups`` option to ``false``::
495495
Note that when you do that, the form will still run basic integrity checks,
496496
for example whether an uploaded file was too large or whether non-existing
497497
fields were submitted. If you want to suppress validation, you can use the
498-
:ref:`POST_SUBMIT event <cookbook-dynamic-form-modification-suppressing-form-validation>`
498+
:ref:`POST_SUBMIT event <cookbook-dynamic-form-modification-suppressing-form-validation>`.
499499

500500
.. index::
501501
single: Forms; Validation groups based on submitted data
@@ -1811,7 +1811,7 @@ an array.
18111811
18121812
$this->get('request')->request->get('name');
18131813
1814-
Be advised, however, that in most cases using the getData() method is
1814+
Be advised, however, that in most cases using the ``getData()`` method is
18151815
a better choice, since it returns the data (usually an object) after
18161816
it's been transformed by the form framework.
18171817
@@ -1858,7 +1858,7 @@ but here's a short example:
18581858
18591859
.. tip::
18601860
1861-
If you are using Validation Groups, you need to either reference the
1861+
If you are using validation groups, you need to either reference the
18621862
``Default`` group when creating the form, or set the correct group on
18631863
the constraint you are adding.
18641864
@@ -1896,7 +1896,7 @@ Learn more from the Cookbook
18961896
18971897
.. _`Symfony2 Form component`: https://github.com/symfony/Form
18981898
.. _`DateTime`: http://php.net/manual/en/class.datetime.php
1899-
.. _`Twig Bridge`: https://github.com/symfony/symfony/tree/2.2/src/Symfony/Bridge/Twig
1900-
.. _`form_div_layout.html.twig`: https://github.com/symfony/symfony/blob/2.2/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
1899+
.. _`Twig Bridge`: https://github.com/symfony/symfony/tree/2.3/src/Symfony/Bridge/Twig
1900+
.. _`form_div_layout.html.twig`: https://github.com/symfony/symfony/blob/2.3/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
19011901
.. _`Cross-site request forgery`: http://en.wikipedia.org/wiki/Cross-site_request_forgery
1902-
.. _`view on GitHub`: https://github.com/symfony/symfony/tree/2.2/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form
1902+
.. _`view on GitHub`: https://github.com/symfony/symfony/tree/2.3/src/Symfony/Bundle/FrameworkBundle/Resources/views/Form

‎book/security.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Basic Example: HTTP Authentication
3434
The Security component can be configured via your application configuration.
3535
In fact, most standard security setups are just a matter of using the right
3636
configuration. The following configuration tells Symfony to secure any URL
37-
matching ``/admin/*`` and to ask the user for credentials using basic HTTP
37+
matching ``/admin*`` and to ask the user for credentials using basic HTTP
3838
authentication (i.e. the old-school username/password box):
3939

4040
.. configuration-block::
@@ -143,9 +143,9 @@ that looks like the following:
143143

144144
* There are two users in the system (``ryan`` and ``admin``);
145145
* Users authenticate themselves via the basic HTTP authentication prompt;
146-
* Any URL matching ``/admin/*`` is secured, and only the ``admin`` user
146+
* Any URL matching ``/admin*`` is secured, and only the ``admin`` user
147147
can access it;
148-
* All URLs *not* matching ``/admin/*`` are accessible by all users (and the
148+
* All URLs *not* matching ``/admin*`` are accessible by all users (and the
149149
user is never prompted to log in).
150150

151151
Read this short summary about how security works and how each part of the
@@ -193,7 +193,7 @@ Access Controls (Authorization)
193193
If a user requests ``/admin/foo``, however, the process behaves differently.
194194
This is because of the ``access_control`` configuration section that says
195195
that any URL matching the regular expression pattern ``^/admin`` (i.e. ``/admin``
196-
or anything matching ``/admin/*``) requires the ``ROLE_ADMIN`` role. Roles
196+
or anything matching ``/admin*``) requires the ``ROLE_ADMIN`` role. Roles
197197
are the basis for most authorization: a user can access ``/admin/foo`` only
198198
if it has the ``ROLE_ADMIN`` role.
199199

‎book/service_container.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -980,12 +980,10 @@ with ``twig.extension`` and automatically registers them as extensions.
980980
Tags, then, are a way to tell Symfony2 or other third-party bundles that
981981
your service should be registered or used in some special way by the bundle.
982982

983-
The following is a list of tags available with the core Symfony2 bundles.
984-
Each of these has a different effect on your service and many tags require
985-
additional arguments (beyond just the ``name`` parameter).
986-
987983
For a list of all the tags available in the core Symfony Framework, check
988-
out :doc:`/reference/dic_tags`.
984+
out :doc:`/reference/dic_tags`. Each of these has a different effect on your
985+
service and many tags require additional arguments (beyond just the ``name``
986+
parameter).
989987

990988
Debugging Services
991989
------------------

‎book/templating.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1039,14 +1039,14 @@ stylesheets and JavaScripts that you'll need throughout your site:
10391039
{# ... #}
10401040

10411041
{% block stylesheets %}
1042-
<link href="{{ asset('/css/main.css') }}" rel="stylesheet" />
1042+
<link href="{{ asset('css/main.css') }}" rel="stylesheet" />
10431043
{% endblock %}
10441044
</head>
10451045
<body>
10461046
{# ... #}
10471047

10481048
{% block javascripts %}
1049-
<script src="{{ asset('/js/main.js') }}"></script>
1049+
<script src="{{ asset('js/main.js') }}"></script>
10501050
{% endblock %}
10511051
</body>
10521052
</html>
@@ -1064,7 +1064,7 @@ page. From inside that contact page's template, do the following:
10641064
{% block stylesheets %}
10651065
{{ parent() }}
10661066

1067-
<link href="{{ asset('/css/contact.css') }}" rel="stylesheet" />
1067+
<link href="{{ asset('css/contact.css') }}" rel="stylesheet" />
10681068
{% endblock %}
10691069

10701070
{# ... #}
@@ -1329,7 +1329,7 @@ covered:
13291329
{% endfor %}
13301330
{% endblock %}
13311331

1332-
Notice that this template extends the section template -(``AcmeBlogBundle::layout.html.twig``)
1332+
Notice that this template extends the section template (``AcmeBlogBundle::layout.html.twig``)
13331333
which in-turn extends the base application layout (``::base.html.twig``).
13341334
This is the common three-level inheritance model.
13351335

‎book/translation.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -554,8 +554,8 @@ use somewhere in your application::
554554
}
555555

556556
Add constraints though any of the supported methods. Set the message option to the
557-
translation source text. For example, to guarantee that the $name property is not
558-
empty, add the following:
557+
translation source text. For example, to guarantee that the ``$name`` property is
558+
not empty, add the following:
559559

560560
.. configuration-block::
561561

@@ -654,8 +654,8 @@ Translating Database Content
654654
----------------------------
655655

656656
The translation of database content should be handled by Doctrine through
657-
the `Translatable Extension`_. For more information, see the documentation
658-
for that library.
657+
the `Translatable Extension`_ or the `Translatable Bahavior`_ (PHP 5.4+).
658+
For more information, see the documentation for thes libraries.
659659

660660
Summary
661661
-------
@@ -680,3 +680,4 @@ steps:
680680
.. _`ISO 3166-1 alpha-2`: http://en.wikipedia.org/wiki/ISO_3166-1#Current_codes
681681
.. _`ISO 639-1`: http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
682682
.. _`Translatable Extension`: https://github.com/l3pp4rd/DoctrineExtensions
683+
.. _`Translatable Bahavior`: https://github.com/KnpLabs/DoctrineBehaviors

‎book/validation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -985,9 +985,9 @@ entity and a new constraint group called ``Premium``:
985985
Acme\DemoBundle\Entity\User:
986986
properties:
987987
name:
988-
- NotBlank
988+
- NotBlank: ~
989989
creditCard:
990-
- CardScheme
990+
- CardScheme:
991991
schemes: [VISA]
992992
groups: [Premium]
993993

‎components/console/helpers/dialoghelper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ from the command line, you need to overwrite the HelperSet used by the command::
277277
return $stream;
278278
}
279279

280-
By setting the inputStream of the ``DialogHelper``, you imitate what the
280+
By setting the input stream of the ``DialogHelper``, you imitate what the
281281
console would do internally with all user input through the cli. This way
282282
you can test any user interaction (even complex ones) by passing an appropriate
283283
input stream.

‎components/console/helpers/tablehelper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ When building a console application it may be useful to display tabular data:
1111

1212
.. image:: /images/components/console/table.png
1313

14-
To display table, use the :class:`Symfony\\Component\\Console\\Helper\\TableHelper`,
14+
To display a table, use the :class:`Symfony\\Component\\Console\\Helper\\TableHelper`,
1515
set headers, rows and render::
1616

1717
$table = $app->getHelperSet()->get('table');

‎components/console/introduction.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,8 @@ level. For example::
197197
}
198198

199199
When the quiet level is used, all output is suppressed as the default
200-
:method:`Symfony\Component\Console\Output::write <Symfony\\Component\\Console\\Output\\Output::write>`
201-
method returns without actually printing.
200+
:method:`Symfony\\Component\\Console\\Output\\Output::write` method returns
201+
without actually printing.
202202

203203
Using Command Arguments
204204
-----------------------
@@ -286,13 +286,13 @@ Unlike arguments, options are not ordered (meaning you can specify them in any
286286
order) and are specified with two dashes (e.g. ``--yell`` - you can also
287287
declare a one-letter shortcut that you can call with a single dash like
288288
``-y``). Options are *always* optional, and can be setup to accept a value
289-
(e.g. ``dir=src``) or simply as a boolean flag without a value (e.g.
290-
``yell``).
289+
(e.g. ``--dir=src``) or simply as a boolean flag without a value (e.g.
290+
``--yell``).
291291

292292
.. tip::
293293

294294
It is also possible to make an option *optionally* accept a value (so that
295-
``--yell`` or ``yell=loud`` work). Options can also be configured to
295+
``--yell`` or ``--yell=loud`` work). Options can also be configured to
296296
accept an array of values.
297297

298298
For example, add a new option to the command that can be used to specify
@@ -344,7 +344,7 @@ Option Value
344344
InputOption::VALUE_IS_ARRAY This option accepts multiple values (e.g. ``--dir=/foo --dir=/bar``)
345345
InputOption::VALUE_NONE Do not accept input for this option (e.g. ``--yell``)
346346
InputOption::VALUE_REQUIRED This value is required (e.g. ``--iterations=5``), the option itself is still optional
347-
InputOption::VALUE_OPTIONAL This option may or may not have a value (e.g. ``yell`` or ``yell=loud``)
347+
InputOption::VALUE_OPTIONAL This option may or may not have a value (e.g. ``--yell`` or ``--yell=loud``)
348348
=========================== =====================================================================================
349349

350350
You can combine ``VALUE_IS_ARRAY`` with ``VALUE_REQUIRED`` or ``VALUE_OPTIONAL`` like this:

‎components/dependency_injection/advanced.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,18 @@ service by asking for the ``bar`` service like this::
142142

143143
$container->get('bar'); // Would return the foo service
144144

145+
.. note::
146+
147+
In YAML, you can also use a shortcut to alias a service:
148+
149+
.. code-block:: yaml
150+
151+
services:
152+
foo:
153+
class: Example\Foo
154+
bar: "@foo"
155+
156+
145157
Requiring files
146158
---------------
147159

@@ -169,5 +181,5 @@ the service itself gets loaded. To do so, you can use the ``file`` directive.
169181
$definition->setFile('%kernel.root_dir%/src/path/to/file/foo.php');
170182
$container->setDefinition('foo', $definition);
171183
172-
Notice that Symfony will internally call the PHP function require_once
184+
Notice that Symfony will internally call the PHP statement ``require_once``
173185
which means that your file will be included only once per request.

‎components/dependency_injection/definitions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Add a method call with::
104104

105105
$definition->addMethodCall($method, $arguments);
106106

107-
Where ``$method`` is the method name and $arguments is an array of the arguments
107+
Where ``$method`` is the method name and ``$arguments`` is an array of the arguments
108108
to call the method with. The arguments can be strings, arrays, parameters or
109109
service ids as with the constructor arguments.
110110

‎components/dependency_injection/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The DependencyInjection Component
99
the way objects are constructed in your application.
1010

1111
For an introduction to Dependency Injection and service containers see
12-
:doc:`/book/service_container`
12+
:doc:`/book/service_container`.
1313

1414
Installation
1515
------------
@@ -181,7 +181,7 @@ Setting Up the Container with Configuration Files
181181
As well as setting up the services using PHP as above you can also use
182182
configuration files. This allows you to use XML or YAML to write the definitions
183183
for the services rather than using PHP to define the services as in the above
184-
examples. In anything but the smallest applications it make sense to organize
184+
examples. In anything but the smallest applications it makes sense to organize
185185
the service definitions by moving them into one or more configuration files.
186186
To do this you also need to install
187187
:doc:`the Config component </components/config/introduction>`.

‎components/dependency_injection/parentservices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The service config for these classes would look something like this:
6868
- [setEmailFormatter, ["@my_email_formatter"]]
6969
7070
greeting_card_manager:
71-
class: "%greeting_card_manager.class%"
71+
class: "%greeting_card_manager.class%"
7272
calls:
7373
- [setMailer, ["@my_mailer"]]
7474
- [setEmailFormatter, ["@my_email_formatter"]]

‎components/dependency_injection/tags.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,18 @@ To answer this, change the service declaration:
235235
<tag name="acme_mailer.transport" alias="bar" />
236236
</service>
237237
238+
.. code-block:: php
239+
240+
use Symfony\Component\DependencyInjection\Definition;
241+
242+
$definitionSmtp = new Definition('\Swift_SmtpTransport', array('%mailer_host%'));
243+
$definitionSmtp->addTag('acme_mailer.transport', array('alias' => 'foo'));
244+
$container->setDefinition('acme_mailer.transport.smtp', $definitionSmtp);
245+
246+
$definitionSendmail = new Definition('\Swift_SendmailTransport');
247+
$definitionSendmail->addTag('acme_mailer.transport', array('alias' => 'bar'));
248+
$container->setDefinition('acme_mailer.transport.sendmail', $definitionSendmail);
249+
238250
Notice that you've added a generic ``alias`` key to the tag. To actually
239251
use this, update the compiler::
240252

‎components/http_foundation/introduction.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ If you need to get full access to parsed data from ``Accept``, ``Accept-Language
258258
$quality = $item->getQuality();
259259
}
260260

261-
// accepts items are sorted by descending quality
261+
// Accept header items are sorted by descending quality
262262
$accepts = AcceptHeader::fromString($request->headers->get('Accept'))
263263
->all();
264264

@@ -378,7 +378,7 @@ method::
378378
$response->send();
379379
}
380380

381-
If the Response is not modified, it sets the status code to 304 and remove the
381+
If the Response is not modified, it sets the status code to 304 and removes the
382382
actual response content.
383383

384384
Redirecting the User

‎components/property_access/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ You can also mix objects and arrays::
322322

323323
public function setChildren($children)
324324
{
325-
return $this->children;
325+
$this->children = $children;
326326
}
327327

328328
public function getChildren()

‎components/routing/introduction.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,17 +73,17 @@ Defining routes
7373
A full route definition can contain up to seven parts:
7474

7575
1. The URL path route. This is matched against the URL passed to the `RequestContext`,
76-
and can contain named wildcard placeholders (e.g. ``{placeholders}``)
77-
to match dynamic parts in the URL.
76+
and can contain named wildcard placeholders (e.g. ``{placeholders}``)
77+
to match dynamic parts in the URL.
7878

7979
2. An array of default values. This contains an array of arbitrary values
80-
that will be returned when the request matches the route.
80+
that will be returned when the request matches the route.
8181

8282
3. An array of requirements. These define constraints for the values of the
83-
placeholders as regular expressions.
83+
placeholders as regular expressions.
8484

8585
4. An array of options. These contain internal settings for the route and
86-
are the least commonly needed.
86+
are the least commonly needed.
8787

8888
5. A host. This is matched against the host of the request. See
8989
:doc:`/components/routing/hostname_pattern` for more details.

‎components/translation/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ The second step is done by creating message catalogs that define the translation
9595
for any number of different locales.
9696

9797
Creating Translations
98-
=====================
98+
---------------------
9999

100100
The act of creating translation files is an important part of "localization"
101101
(often abbreviated `L10n`_). Translation files consist of a series of

‎cookbook/bundles/inheritance.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ things like controllers, templates, and other files in a bundle's
1212

1313
For example, suppose that you're installing the `FOSUserBundle`_, but you
1414
want to override its base ``layout.html.twig`` template, as well as one of
15-
its controllers. Suppose also that you have your own ``AcmeUserBundle``
15+
its controllers. Suppose also that you have your own AcmeUserBundle
1616
where you want the overridden files to live. Start by registering the FOSUserBundle
1717
as the "parent" of your bundle::
1818

‎cookbook/bundles/override.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ can override the translations from any translation file, as long as it is in
181181

182182
.. caution::
183183

184-
The last translation file always wins. That mean that you need to make
184+
The last translation file always wins. That means that you need to make
185185
sure that the bundle containing *your* translations is loaded after any
186186
bundle whose translations you're overriding. This is done in ``AppKernel``.
187187

0 commit comments

Comments
 (0)
0