8000 Merge branch '3.0' · symfony/symfony-docs@3dae7e3 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3dae7e3

Browse files
weaverryanweaverryan
committed
Merge branch '3.0'
* 3.0: fix status code in snippet Fixing bad conflict fix [#6449] Removing choices_as_values on merge Fix form/validation directory path Use different placeholders in mailer config Fixed an array notation in comment (serializer.rst) Fixed array and trailing spaces [Form] fixed ChoiceType example in CollectionType [Form] fixed CollectionType needless option updated the core team Fixed a path Added a caution note about REMOTE_USER and user impersonation Fixed grammatical error Comment updates Updated Heroku instructions
2 parents bdacf53 + ffb40b9 commit 3dae7e3

File tree

9 files changed

+53
-48
lines changed

9 files changed

+53
-48
lines changed

‎book/http_cache.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -917,7 +917,7 @@ Here is how you can configure the Symfony reverse proxy to support the
917917
if ($this->getStore()->purge($request->getUri())) {
918918
$response->setStatusCode(200, 'Purged');
919919
} else {
920-
$response->setStatusCode(200, 'Not found');
920+
$response->setStatusCode(404, 'Not found');
921921
}
922922

923923
return $response;

‎components/form/introduction.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -315,9 +315,8 @@ Your integration with the Validation component will look something like this::
315315
use Symfony\Component\Validator\Validation;
316316

317317
$vendorDir = realpath(__DIR__.'/../vendor');
318-
$vendorFormDir = $vendorDir.'/symfony/form/Symfony/Component/Form';
319-
$vendorValidatorDir =
320-
$vendorDir.'/symfony/validator/Symfony/Component/Validator';
318+
$vendorFormDir = $vendorDir.'/symfony/form';
319+
$vendorValidatorDir = $vendorDir.'/symfony/validator';
321320

322321
// create the validator - details will vary
323322
$validator = Validation::createValidator();

‎components/serializer.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ You are now able to serialize only attributes in the groups you want::
296296
$serializer = new Serializer(array($normalizer));
297297

298298
$data = $serializer->normalize($obj, null, array('groups' => array('group1')));
299-
// $data = ['foo' => 'foo'];
299+
// $data = array('foo' => 'foo');
300300

301301
$obj2 = $serializer->denormalize(
302302
array('foo' => 'foo', 'bar' => 'bar'),

‎contributing/code/core_team.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,9 @@ Active Core Members
5151
* **Romain Neutron** (`romainneutron`_) can merge into the
5252
Process_ component;
5353

54-
* **Nicolas Grekas** (`nicolas-grekas`_) can merge into the Debug_
55-
component, the VarDumper_ component and the DebugBundle_;
54+
* **Nicolas Grekas** (`nicolas-grekas`_) can merge into the Cache_, Debug_,
55+
Process_, PropertyAccess_, VarDumper_ components, PhpUnitBridge_ and
56+
the DebugBundle_;
5657

5758
* **Christophe Coevoet** (`stof`_) can merge into the BrowserKit_,
5859
Config_, Console_, DependencyInjection_, DomCrawler_, EventDispatcher_,

‎cookbook/deployment/fortrabbit.rst

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Before getting started, you should have done a few things on the fortrabbit side
2020
Preparing your Application
2121
--------------------------
2222

23-
You don't need to change any code to deploy a Symfony application to fortrabbit.
23+
You don't need to change any code to deploy a Symfony application to fortrabbit.
2424
But it requires some minor tweaks to its configuration.
2525

2626
Configure Logging
2727
~~~~~~~~~~~~~~~~~
2828

29-
Per default Symfony logs to a file. Modify the ``app/config/config_prod.yml`` file
29+
Per default Symfony logs to a file. Modify the ``app/config/config_prod.yml`` file
3030
to redirect it to :phpfunction:`error_log`:
3131

3232
.. configuration-block::
@@ -73,7 +73,7 @@ to redirect it to :phpfunction:`error_log`:
7373
Configuring Database Access & Session Handler
7474
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7575

76-
You can use the fortrabbit App Secrets to attain your database credentials.
76+
You can use the fortrabbit App Secrets to attain your database credentials.
7777
Create the file ``app/config/config_prod_secrets.php`` with the following
7878
contents::
7979

@@ -98,7 +98,7 @@ contents::
9898
// check if the Memcache component is present
9999
if (isset($secrets['MEMCACHE'])) {
100100
$memcache = $secrets['MEMCACHE'];
101-
$handlers = [];
101+
$handlers = array();
102102

103103
foreach (range(1, $memcache['COUNT']) as $num) {
104104
$handlers[] = $memcache['HOST'.$num].':'.$memcache['PORT'.$num];
@@ -175,19 +175,19 @@ Configuring the Environment in the Dashboard
175175
PHP Settings
176176
~~~~~~~~~~~~
177177

178-
The PHP version and enabled extensions are configuable under the PHP settings
178+
The PHP version and enabled extensions are configuable under the PHP settings
179179
of your App within the fortrabbit Dashboard.
180180

181181
Environment Variables
182182
~~~~~~~~~~~~~~~~~~~~~
183183

184-
Set the ``SYMFONY_ENV`` environment variable to ``prod`` to make sure the right
184+
Set the ``SYMFONY_ENV`` environment variable to ``prod`` to make sure the right
185185
config files get loaded. ENV vars are configuable in fortrabbit Dashboard as well.
186186

187187
Document Root
188188
~~~~~~~~~~~~~
189189

190-
The document root is configuable for every custom domain you setup for your App.
190+
The document root is configuable for every custom domain you setup for your App.
191191
The default is ``/htdocs``, but for Symfony you probably want to change it to
192192
``/htdocs/web``. You also do so in the fortrabbit Dashboard under ``Domain`` settings.
193193

@@ -197,8 +197,8 @@ Deploying to fortrabbit
197197
It is assumed that your codebase is under version-control with Git and dependencies
198198
are managed with Composer (locally).
199199

200-
Every time you push to fortrabbit composer install runs before your code gets
201-
deployed. To finetune the deployment behavior put a `fortrabbit.yml`_. deployment
200+
Every time you push to fortrabbit composer install runs before your code gets
201+
deployed. To finetune the deployment behavior put a `fortrabbit.yml`_. deployment
202202
file (optional) in the project root.
203203

204204
Add fortrabbit as a (additional) Git remote and add your configuration changes:
@@ -221,11 +221,11 @@ Commit and push
221221
Replace ``<your-app>`` with the name of your fortrabbit App.
222222

223223
.. code-block:: bash
224-
224+
225225
Commit received, starting build of branch master
226226
227227
––––––––––––––––––––––– ∙ƒ –––––––––––––––––––––––
228-
228+
229229
B U I L D
230230
231231
Checksum:
@@ -244,7 +244,7 @@ Commit and push
244244
Installing dependencies (including require-dev) from lock file
245245
Nothing to install or update
246246
Generating autoload files
247-
247+
248248
- - -
249249
172ms
250250
@@ -271,11 +271,11 @@ Commit and push
271271
272272
.. note::
273273

274-
The first ``git push`` takes much longer as all composer dependencies get
275-
downloaded. All subsequent deploys are done within seconds.
274+
The first ``git push`` takes much longer as all composer dependencies get
275+
downloaded. All subsequent deploys are done within seconds.
276276

277-
That's it! Your application is being deployed on fortrabbit. More information
278-
about `database migrations and tunneling`_ can be found in the fortrabbit
277+
That's it! Your application is being deployed on fortrabbit. More information
278+
about `database migrations and tunneling`_ can be found in the fortrabbit
279279
documentation.
280280

281281
.. _`fortrabbit`: https://www.fortrabbit.com

‎cookbook/deployment/heroku.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -305,20 +305,20 @@ This is also very useful to build assets on the production system, e.g. with Ass
305305
306306
With the next deploy, Heroku compiles your app using the Node.js buildpack and
307307
your npm packages become installed. On the other hand, your ``composer.json`` is
308-
now ignored. To compile your app with both buildpacks, Node.js *and* PHP, you can
309-
use a special `multiple buildpack`_. To override buildpack auto-detection, you
310-
need to explicitly set the buildpack URL:
308+
now ignored. To compile your app with both buildpacks, Node.js *and* PHP, you need
309+
to use both buildpacks. To override buildpack auto-detection, you
310+
need to explicitly set the buildpack:
311311

312312
.. code-block:: bash
313313
314-
$ heroku buildpacks:set https://github.com/ddollar/heroku-buildpack-multi.git
315-
316-
Next, add a ``.buildpacks`` file to your project, listing the buildpacks you need:
317-
318-
.. code-block:: text
319-
320-
https://github.com/heroku/heroku-buildpack-nodejs.git
321-
https://github.com/heroku/heroku-buildpack-php.git
314+
$ heroku buildpacks:set heroku/nodejs
315+
Buildpack set. Next release on your-application will use heroku/nodejs.
316+
Run git push heroku master to create a new release using this buildpack.
317+
$ heroku buildpacks:set heroku/php --index 2
318+
Buildpack set. Next release on your-application will use:
319+
1. heroku/nodejs
320+
2. heroku/php
321+
Run git push heroku master to create a new release using these buildpacks.
322322
323323
With the next deploy, you can benefit from both buildpacks. This setup also enables
324324
your Heroku environment to make use of node based automatic build tools like
@@ -336,7 +336,6 @@ This is also very useful to build assets on the production system, e.g. with Ass
336336
.. _`custom compile steps`: https://devcenter.heroku.com/articles/php-support#custom-compile-step
337337
.. _`custom Composer command`: https://getcomposer.org/doc/articles/scripts.md#writing-custom-commands
338338
.. _`Heroku buildpacks`: https://devcenter.heroku.com/articles/buildpacks
339-
.. _`multiple buildpack`: https://github.com/ddollar/heroku-buildpack-multi
340339
.. _`Grunt`: http://gruntjs.com
341340
.. _`gulp`: http://gulpjs.com
342341
.. _`Heroku documentation`: https://devcenter.heroku.com/articles/custom-php-settings#nginx

‎cookbook/email/cloud.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ and complete the configuration with the provided ``username`` and ``password``:
3636
host: email-smtp.us-east-1.amazonaws.com
3737
port: 465 # different ports are available, see SES console
3838
encryption: tls # TLS encryption is required
39-
username: AWS_ACCESS_KEY # to be created in the SES console
40-
password: AWS_SECRET_KEY # to be created in the SES console
39+
username: AWS_SES_SMTP_USERNAME # to be created in the SES console
40+
password: AWS_SES_SMTP_PASSWORD # to be created in the SES console
4141
4242
.. code-block:: xml
4343
@@ -57,8 +57,8 @@ and complete the configuration with the provided ``username`` and ``password``:
5757
host="email-smtp.us-east-1.amazonaws.com"
5858
port="465"
5959
encryption="tls"
60-
username="AWS_ACCESS_KEY"
61-
password="AWS_SECRET_KEY"
60+
username="AWS_SES_SMTP_USERNAME"
61+
password="AWS_SES_SMTP_PASSWORD"
6262
/>
6363
</container>
6464
@@ -70,8 +70,8 @@ and complete the configuration with the provided ``username`` and ``password``:
7070
'host' => 'email-smtp.us-east-1.amazonaws.com',
7171
'port' => 465,
7272
'encryption' => 'tls',
73-
'username' => 'AWS_ACCESS_KEY',
74-
'password' => 'AWS_SECRET_KEY',
73+
'username' => 'AWS_SES_SMTP_USERNAME',
74+
'password' => 'AWS_SES_SMTP_PASSWORD',
7575
));
7676
7777
The ``port`` and ``encryption`` keys are not present in the Symfony Standard
@@ -96,8 +96,8 @@ And that's it, you're ready to start sending emails through the cloud!
9696
mailer_host: email-smtp.us-east-1.amazonaws.com
9797
mailer_port: 465 # different ports are available, see SES console
9898
mailer_encryption: tls # TLS encryption is required
99-
mailer_user: AWS_ACCESS_KEY # to be created in the SES console
100-
mailer_password: AWS_SECRET_KEY # to be created in the SES console
99+
mailer_user: AWS_SES_SMTP_USERNAME # to be created in the SES console
100+
mailer_password: AWS_SES_SMTP_PASSWORD # to be created in the SES console
101101
102102
.. note::
103103

‎cookbook/security/pre_authenticated.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,3 +148,10 @@ key in the ``remote_user`` firewall configuration.
148148
Just like for X509 authentication, you will need to configure a "user provider".
149149
See :ref:`the previous note <cookbook-security-pre-authenticated-user-provider-note>`
150150
for more information.
151+
152+
.. caution::
153+
154+
:doc:`User impersonation </cookbook/security/impersonating_user>` is not
155+
compatible with ``REMOTE_USER`` based authentication. The reason is that
156+
impersonation requires the authentication state to be maintained server-side
157+
but ``REMOTE_USER`` information is sent by the browser in each request.

‎reference/forms/types/collection.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ address as its own input text box::
6161
'entry_type' => EmailType::class,
6262
// these options are passed to each "email" type
6363
'entry_options' => array(
64-
'required' => false,
6564
'attr' => array('class' => 'email-box')
6665
),
6766
));
@@ -296,10 +295,10 @@ type::
296295
'entry_type' => ChoiceType::class,
297296
'entry_options' => array(
298297
'choices' => array(
299-
'nashville' => 'Nashville',
300-
'paris' => 'Paris',
301-
'berlin' => 'Berlin',
302-
'london' => 'London',
298+
'Nashville' => 'nashville',
299+
'Paris' => 'paris',
300+
'Berlin' => 'berlin',
301+
'London' => 'london',
303302
),
304303
),
305304
));

0 commit comments

Comments
 (0)
0