Skip to content

Commit 2dae187

Browse files
isleshocky77isleshocky77
committed
Update all docs to not recommend invalid YAML.
Updated the docs to make sure we don't have any instances of ```yaml key: %value% ``` This invalid yaml mark up. See: #1770 #1770 See: symfony/symfony-standard#427
1 parent 95d25d8 commit 2dae187

File tree

15 files changed

+47
-47
lines changed

15 files changed

+47
-47
lines changed

‎book/doctrine.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ information. By convention, this information is usually configured in an
6767
# app/config/config.yml
6868
doctrine:
6969
dbal:
70-
driver: %database_driver%
71-
host: %database_host%
72-
dbname: %database_name%
73-
user: %database_user%
74-
password: %database_password%
70+
driver: "%database_driver%"
71+
host: "%database_host%"
72+
dbname: "%database_name%"
73+
user: "%database_user%"
74+
password: "%database_password%"
7575
7676
By separating the database information into a separate file, you can
7777
easily keep different versions of the file on each server. You can also

‎book/propel.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ information. By convention, this information is usually configured in an
5252
5353
propel:
5454
dbal:
55-
driver: %database_driver%
56-
user: %database_user%
57-
password: %database_password%
58-
dsn: %database_driver%:host=%database_host%;dbname=%database_name%;charset=%database_charset%
55+
driver: "%database_driver%"
56+
user: "%database_user%"
57+
password: "%database_password%"
58+
dsn: "%database_driver%:host=%database_host%;dbname=%database_name%;charset=%database_charset%"
5959
6060
Now that Propel knows about your database, Symfony2 can create the database for
6161
you:

‎book/service_container.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ straightforward. Parameters make defining services more organized and flexible:
186186
187187
services:
188188
my_mailer:
189-
class: %my_mailer.class%
189+
class: "%my_mailer.class%"
190190
arguments: [%my_mailer.transport%]
191191
192192
.. code-block:: xml
@@ -358,7 +358,7 @@ directories don't exist, create them.
358358
359359
services:
360360
my_mailer:
361-
class: %my_mailer.class%
361+
class: "%my_mailer.class%"
362362
arguments: [%my_mailer.transport%]
363363
364364
.. code-block:: xml
@@ -594,7 +594,7 @@ the service container gives us a much more appealing option:
594594
my_mailer:
595595
# ...
596596
newsletter_manager:
597-
class: %newsletter_manager.class%
597+
class: "%newsletter_manager.class%"
598598
arguments: [@my_mailer]
599599
600600
.. code-block:: xml
@@ -681,7 +681,7 @@ Injecting the dependency by the setter method just needs a change of syntax:
681681
my_mailer:
682682
# ...
683683
newsletter_manager:
684-
class: %newsletter_manager.class%
684+
class: "%newsletter_manager.class%"
685685
calls:
686686
- [ setMailer, [ @my_mailer ] ]
687687
@@ -746,7 +746,7 @@ it exists and do nothing if it doesn't:
746746
747747
services:
748748
newsletter_manager:
749-
class: %newsletter_manager.class%
749+
class: "%newsletter_manager.class%"
750750
arguments: [@?my_mailer]
751751
752752
.. code-block:: xml
@@ -845,7 +845,7 @@ Configuring the service container is easy:
845845
846846
services:
847847
newsletter_manager:
848-
class: %newsletter_manager.class%
848+
class: "%newsletter_manager.class%"
849849
arguments: [@mailer, @templating]
850850
851851
.. code-block:: xml

‎components/dependency_injection/advanced.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ the service itself gets loaded. To do so, you can use the ``file`` directive.
107107
services:
108108
foo:
109109
class: Example\Foo\Bar
110-
file: %kernel.root_dir%/src/path/to/file/foo.php
110+
file: "%kernel.root_dir%/src/path/to/file/foo.php"
111111
112112
.. code-block:: xml
113113

‎components/dependency_injection/factories.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ class:
4141
newsletter_factory.class: NewsletterFactory
4242
services:
4343
newsletter_manager:
44-
class: %newsletter_manager.class%
45-
factory_class: %newsletter_factory.class%
44+
class: "%newsletter_manager.class%"
45+
factory_class: "%newsletter_factory.class%"
4646
factory_method: get
4747
4848
.. code-block:: xml
@@ -92,9 +92,9 @@ factory itself as a service:
9292
newsletter_factory.class: NewsletterFactory
9393
services:
9494
newsletter_factory:
95-
class: %newsletter_factory.class%
95+
class: "%newsletter_factory.class%"
9696
newsletter_manager:
97-
class: %newsletter_manager.class%
97+
class: "%newsletter_manager.class%"
9898
factory_service: newsletter_factory
9999
factory_method: get
100100
@@ -156,9 +156,9 @@ in the previous example takes the ``templating`` service as an argument:
156156
newsletter_factory.class: NewsletterFactory
157157
services:
158158
newsletter_factory:
159-
class: %newsletter_factory.class%
159+
class: "%newsletter_factory.class%"
160160
newsletter_manager:
161-
class: %newsletter_manager.class%
161+
class: "%newsletter_manager.class%"
162162
factory_service: newsletter_factory
163163
factory_method: get
164164
arguments:
@@ -201,4 +201,4 @@ in the previous example takes the ``templating`` service as an argument:
201201
'newsletter_factory'
202202
)->setFactoryMethod(
203203
'get'
204-
);
204+
);

‎components/dependency_injection/parentservices.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ The service config for these classes would look something like this:
6262
my_email_formatter:
6363
# ...
6464
newsletter_manager:
65-
class: %newsletter_manager.class%
65+
class: "%newsletter_manager.class%"
6666
calls:
6767
- [ setMailer, [ @my_mailer ] ]
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] ]
@@ -191,18 +191,18 @@ a parent for a service.
191191
my_email_formatter:
192192
# ...
193193
mail_manager:
194-
class: %mail_manager.class%
194+
class: "%mail_manager.class%"
195195
abstract: true
196196
calls:
197197
- [ setMailer, [ @my_mailer ] ]
198198
- [ setEmailFormatter, [ @my_email_formatter] ]
199199
200200
newsletter_manager:
201-
class: %newsletter_manager.class%
201+
class: "%newsletter_manager.class%"
202202
parent: mail_manager
203203
204204
greeting_card_manager:
205-
class: %greeting_card_manager.class%
205+
class: "%greeting_card_manager.class%"
206206
parent: mail_manager
207207
208208
.. code-block:: xml
@@ -317,20 +317,20 @@ to the ``NewsletterManager`` class, the config would look like this:
317317
my_email_formatter:
318318
# ...
319319
mail_manager:
320-
class: %mail_manager.class%
320+
class: "%mail_manager.class%"
321321
abstract: true
322322
calls:
323323
- [ setMailer, [ @my_mailer ] ]
324324
- [ setEmailFormatter, [ @my_email_formatter] ]
325325
326326
newsletter_manager:
327-
class: %newsletter_manager.class%
327+
class: "%newsletter_manager.class%"
328328
parent: mail_manager
329329
calls:
330330
- [ setMailer, [ @my_alternative_mailer ] ]
331331
332332
greeting_card_manager:
333-
class: %greeting_card_manager.class%
333+
class: "%greeting_card_manager.class%"
334334
parent: mail_manager
335335
336336
.. code-block:: xml
@@ -449,13 +449,13 @@ If you had the following config:
449449
another_filter:
450450
# ...
451451
mail_manager:
452-
class: %mail_manager.class%
452+
class: "%mail_manager.class%"
453453
abstract: true
454454
calls:
455455
- [ setFilter, [ @my_filter ] ]
456456
457457
newsletter_manager:
458-
class: %newsletter_manager.class%
458+
class: "%newsletter_manager.class%"
459459
parent: mail_manager
460460
calls:
461461
- [ setFilter, [ @another_filter ] ]

‎components/dependency_injection/tags.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Then, define the chain as a service:
4444
4545
services:
4646
acme_mailer.transport_chain:
47-
class: %acme_mailer.transport_chain.class%
47+
class: "%acme_mailer.transport_chain.class%"
4848
4949
.. code-block:: xml
5050

‎cookbook/configuration/external_parameters.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ You can now reference these parameters wherever you need them.
6666
dbal:
6767
driver pdo_mysql
6868
dbname: symfony2_project
69-
user: %database.user%
70-
password: %database.password%
69+
user: "%database.user%"
70+
password: "%database.password%"
7171
7272
.. code-block:: xml
7373

‎cookbook/configuration/override_dir_structure.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ may need to modify the paths inside these files::
108108
# ...
109109
assetic:
110110
# ...
111-
read_from: %kernel.root_dir%/../../public_html
111+
read_from: "%kernel.root_dir%/../../public_html"
112112
113113
Now you just need to dump the assets again and your application should
114114
work:

‎cookbook/security/custom_provider.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Now we make the user provider available as a service.
170170
171171
services:
172172
webservice_user_provider:
173-
class: %webservice_user_provider.class%
173+
class: "%webservice_user_provider.class%"
174174
175175
.. code-block:: xml
176176

‎cookbook/security/securing_services.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Then in your service configuration, you can inject the service:
7979
8080
services:
8181
newsletter_manager:
82-
class: %newsletter_manager.class%
82+
class: "%newsletter_manager.class%"
8383
arguments: [@security.context]
8484
8585
.. code-block:: xml

‎cookbook/service_container/scopes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ The service config for this class would look something like this:
159159
my_mailer.class: Acme\HelloBundle\Mail\Mailer
160160
services:
161161
my_mailer:
162-
class: %my_mailer.class%
162+
class: "%my_mailer.class%"
163163
arguments:
164164
- "@service_container"
165165
# scope: container can be omitted as it is the default

‎cookbook/templating/global_variables.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ system, which lets you isolate or reuse the value:
3535
# app/config/config.yml
3636
twig:
3737
globals:
38-
ga_tracking: %ga_tracking%
38+
ga_tracking: "%ga_tracking%"
3939
4040
The same variable is available exactly as before.
4141

‎reference/configuration/assetic.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Full Default Configuration
1414
assetic:
1515
debug: true
1616
use_controller: true
17-
read_from: %kernel.root_dir%/../web
18-
write_to: %assetic.read_from%
17+
read_from: "%kernel.root_dir%/../web"
18+
write_to: "%assetic.read_from%"
1919
java: /usr/bin/java
2020
node: /usr/bin/node
2121
sass: /usr/bin/sass

‎reference/configuration/doctrine.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ the ORM resolves to:
140140
# the standard distribution overrides this to be true in debug, false otherwise
141141
auto_generate_proxy_classes: false
142142
proxy_namespace: Proxies
143-
proxy_dir: %kernel.cache_dir%/doctrine/orm/Proxies
143+
proxy_dir: "%kernel.cache_dir%/doctrine/orm/Proxies"
144144
default_entity_manager: default
145145
metadata_cache_driver: array
146146
query_cache_driver: array
@@ -236,12 +236,12 @@ can configure. The following block shows all possible configuration keys:
236236
driver_class: MyNamespace\MyDriverImpl
237237
options:
238238
foo: bar
239-
path: %kernel.data_dir%/data.sqlite
239+
path: "%kernel.data_dir%/data.sqlite"
240240
memory: true
241241
unix_socket: /tmp/mysql.sock
242242
wrapper_class: MyDoctrineDbalConnectionWrapper
243243
charset: UTF8
244-
logging: %kernel.debug%
244+
logging: "%kernel.debug%"
245245
platform_service: MyOwnDatabasePlatformService
246246
mapping_types:
247247
enum: string
@@ -304,4 +304,4 @@ which is the first one defined or the one configured via the
304304
Each connection is also accessible via the ``doctrine.dbal.[name]_connection``
305305
service where ``[name]`` if the name of the connection.
306306
307-
.. _DBAL documentation: http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/index.html
307+
.. _DBAL documentation: http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/index.html

0 commit comments

Comments
 (0)