Skip to content

Commit 0504675

Browse files
weaverryanweaverryan
committed
Trying to make some of the reference "prototype" a bit more clear, though I think that most of them are still quite obtuse and will need more research and explanation - see #1303 
1 parent 4379241 commit 0504675

File tree

6 files changed

+53
-56
lines changed

6 files changed

+53
-56
lines changed

‎reference/configuration/assetic.rst

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,9 @@ Full Default Configuration
2222
node: /usr/bin/node
2323
ruby: /usr/bin/ruby
2424
sass: /usr/bin/sass
25+
# An key-value pair of any number of named elements
2526
variables:
26-
27-
# Prototype
28-
name: []
27+
some_name: []
2928
bundles:
3029
3130
# Defaults (all currently registered bundles):
@@ -38,21 +37,18 @@ Full Default Configuration
3837
- AsseticBundle
3938
- ...
4039
assets:
41-
42-
# Prototype
43-
name:
40+
# An array of named assets (e.g. some_asset, some_other_asset)
41+
some_asset:
4442
inputs: []
4543
filters: []
4644
options:
47-
48-
# Prototype
49-
name: []
45+
# A key-value array of options and values
46+
some_option_name: []
5047
filters:
5148
52-
# Prototype
53-
name: []
49+
# An array of named filters (e.g. some_filter, some_other_filter)
50+
some_filter: []
5451
twig:
5552
functions:
56-
57-
# Prototype
58-
name: []
53+
# An array of named functions (e.g. some_function, some_other_function)
54+
some_function: []

‎reference/configuration/doctrine.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,18 @@ Configuration Reference
1313
dbal:
1414
default_connection: default
1515
types:
16-
# Prototype
17-
name:
18-
class: ~ # Required
16+
# A collection of custom types
17+
# Example
18+
some_custom_type:
19+
class: Acme\HelloBundle\MyCustomType
1920
commented: true
2021
2122
connections:
2223
default:
2324
dbname: database
2425
25-
# Prototype
26-
name:
26+
# A collection of different named connections (e.g. default, conn2, etc)
27+
default:
2728
dbname: ~
2829
host: localhost
2930
port: ~
@@ -60,16 +61,15 @@ Configuration Reference
6061
driver_class: ~
6162
wrapper_class: ~
6263
options:
63-
# Prototype
64+
# an array of options
6465
key: []
6566
mapping_types:
66-
67-
# Prototype
67+
# an array of mapping types
6868
name: []
6969
slaves:
7070
71-
# Prototype
72-
name:
71+
# a collection of named slave connections (e.g. slave1, slave2)
72+
slave1:
7373
dbname: ~
7474
host: localhost
7575
port: ~
@@ -106,8 +106,8 @@ Configuration Reference
106106
proxy_dir: %kernel.cache_dir%/doctrine/orm/Proxies
107107
proxy_namespace: Proxies
108108
entity_managers:
109-
# Prototype
110-
name:
109+
# A collection of different named entity managers (e.g. some_em, another_em)
110+
some_em:
111111
query_cache_driver:
112112
type: array # Required
113113
host: ~
@@ -132,37 +132,37 @@ Configuration Reference
132132
auto_mapping: false
133133
hydrators:
134134
135-
# Prototype
136-
name: []
135+
# An array of hydrator names
136+
hydrator_name: []
137137
mappings:
138-
139-
# Prototype
140-
name:
138+
# An array of mappings, which may be a bundle name or something else
139+
mapping_name:
141140
mapping: true
142141
type: ~
143142
dir: ~
144143
alias: ~
145144
prefix: ~
146145
is_bundle: ~
147146
dql:
147+
# a collection of string functions
148148
string_functions:
149+
# example
150+
# test_string: Acme\HelloBundle\DQL\StringFunction
149151
150-
# Prototype
151-
name: []
152+
# a collection of numeric functions
152153
numeric_functions:
154+
# example
155+
# test_numeric: Acme\HelloBundle\DQL\NumericFunction
153156
154-
# Prototype
155-
name: []
157+
# a collection of datetime functions
156158
datetime_functions:
157-
158-
# Prototype
159-
name: []
159+
# example
160+
# test_datetime: Acme\HelloBundle\DQL\DatetimeFunction
160161
161162
# Register SQL Filters in the entity manager
162163
filters:
163-
164-
# Prototype
165-
name:
164+
# An array of filters
165+
some_filter:
166166
class: ~ # Required
167167
enabled: false
168168

‎reference/configuration/framework.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,8 +337,8 @@ Full Default Configuration
337337
loaders: []
338338
packages:
339339
340-
# Prototype
341-
name:
340+
# A collection of named packages
341+
some_package_name:
342342
version: ~
343343
version_format: %%s?%%s
344344
base_urls:

‎reference/configuration/monolog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Configuration Reference
2929
type: service
3030
id: my_handler
3131
32-
# Prototype
33-
name:
32+
# Default options and values for some "my_custom_handler"
33+
my_custom_handler:
3434
type: ~ # Required
3535
id: ~
3636
priority: 0

‎reference/configuration/security.rst

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ Each part will be explained in the next section.
5555
encode_as_base64: true
5656
iterations: 5000
5757
58-
# Prototype
59-
class:
58+
# Example options/values for what a custom encoder might look like
59+
Acme\Your\Class\Name:
6060
algorithm: ~
6161
ignore_case: false
6262
encode_as_base64: true
@@ -79,8 +79,8 @@ Each part will be explained in the next section.
7979
class: SecurityBundle:User
8080
property: username
8181
82-
# Prototype
83-
name:
82+
# Example custom provider
83+
some_custom_provider:
8484
id: ~
8585
chain:
8686
providers: []
@@ -143,8 +143,8 @@ Each part will be explained in the next section.
143143
success_handler: some.service.id
144144
anonymous: ~
145145
146-
# Prototype
147-
name:
146+
# Default values and options for any firewall
147+
some_firewall_listener:
148148
pattern: ~
149149
security: true
150150
request_matcher: ~
@@ -186,9 +186,8 @@ Each part will be explained in the next section.
186186
methods: []
187187
roles: []
188188
role_hierarchy:
189-
190-
# Prototype
191-
id: []
189+
ROLE_ADMIN: [ROLE_ORGANIZER, ROLE_USER]
190+
ROLE_SUPERADMIN: [ROLE_ADMIN]
192191
193192
.. _reference-security-firewall-form-login:
194193

‎reference/configuration/twig.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,11 @@ TwigBundle Configuration Reference
2424
foo: "@bar"
2525
pi: 3.14
2626
27-
# Prototype
28-
key:
27+
# Example options, but the easiest use is as seen above
28+
some_variable_name:
29+
# a service id that should be the value
2930
id: ~
31+
# set to service or leave blank
3032
type: ~
3133
value: ~
3234
autoescape: ~

0 commit comments

Comments
 (0)