Skip to content

Commit a0b06ae

Browse files
weaverryanweaverryan
committed
Merge remote-tracking branch 'origin/master'
* origin/master: (93 commits) [#5623] don't configure default constraint message [Validator] added BIC validator Update links Added September changelog Added September changelog Misspelling [#5689] Some minor syntax fixes [DI] Add some documentation for the deprecation feature Info about implicit session start Revert "[#5771] remove another Response constant" Revert "Remove not existing response constant" [#5771] remove another Response constant [#5761] add versionadded directive Fixed two typos Remember me, Renamed key to secret translations have been removed from symfony.com Remove not existing response constant Update HttpFoundation note after recent changes in routing component [#5584] language tweak and XML config fix Add DebugBundle config reference ...
2 parents 9f8d766 + b13593e commit a0b06ae

File tree

111 files changed

+1439
-1070
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+1439
-1070
lines changed

‎_theme/_templates/layout.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
<div id="sidebar" class="col-sm-3">
4545
<div id="sidebar-content">
4646
<div id="demo-warning">
47-
<h4>This is a demo</h4>
48-
<p>This is a demo provided by platform.sh.<br>
49-
<a href="http://symfony.com/doc/current/{{ pagename }}">Visit on symfony.com</a>.</p>
47+
<h4>Pull request build</h4>
48+
<p>Each pull request of the Symfony Documentation is automatically deployed and hosted on <a href="https://platform.sh">Platform.sh</a>.<br>
49+
View this page on <a href="https://symfony.com/doc/current/{{ pagename }}">symfony.com</a>.</p>
5050
</div>
5151

5252
{%- include "globaltoc.html" %}

‎book/controller.rst‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -619,8 +619,8 @@ session.
619619
Flash Messages
620620
~~~~~~~~~~~~~~
621621

622-
You can also store small messages that will be stored on the user's session
623-
for exactly one additional request. This is useful when processing a form:
622+
You can also store small messages that will be stored on the user's session.
623+
This is useful when processing a form:
624624
you want to redirect and have a special message shown on the *next* page.
625625
These types of messages are called "flash" messages.
626626

@@ -675,9 +675,17 @@ the ``notice`` message:
675675
</div>
676676
<?php endforeach ?>
677677

678-
By design, flash messages are meant to live for exactly one request (they're
679-
"gone in a flash"). They're designed to be used across redirects exactly as
680-
you've done in this example.
678+
.. note::
679+
680+
By design, flash messages are meant to be processed exactly once. This means
681+
that they vanish from the session automatically when they are retrieved from
682+
the flash bag by calling the ``get()`` method.
683+
684+
.. tip::
685+
686+
You can use the
687+
:method:`Symfony\\Component\\HttpFoundation\\Session\\Flash\\FlashBagInterface::peek`
688+
method instead to retrieve the message while keeping it in the bag.
681689

682690
.. index::
683691
single: Controller; Response object

‎book/forms.rst‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -232,13 +232,21 @@ controller::
232232
$form->handleRequest($request);
233233

234234
if ($form->isValid()) {
235-
// perform some action, such as saving the task to the database
235+
// ... perform some action, such as saving the task to the database
236236

237237
return $this->redirectToRoute('task_success');
238238
}
239239

240-
// ...
240+
return $this->render('default/new.html.twig', array(
241+
'form' => $form->createView(),
242+
));
241243
}
244+
245+
.. caution::
246+
247+
Be aware that the ``createView()`` method should be called *after* ``handleRequest``
248+
is called. Otherwise, changes done in the ``*_SUBMIT`` events aren't applied to the
249+
view (like validation errors).
242250

243251
.. versionadded:: 2.3
244252
The :method:`Symfony\\Component\\Form\\FormInterface::handleRequest` method
@@ -1774,6 +1782,11 @@ The ``_token`` field is a hidden field and will be automatically rendered
17741782
if you include the ``form_end()`` function in your template, which ensures
17751783
that all un-rendered fields are output.
17761784

1785+
.. caution::
1786+
1787+
Since the token is stored in the session, a session is started automatically
1788+
as soon as you render a form with CSRF protection.
1789+
17771790
The CSRF token can be customized on a form-by-form basis. For example::
17781791

17791792
use Symfony\Component\OptionsResolver\OptionsResolver;
@@ -1953,7 +1966,7 @@ Learn more from the Cookbook
19531966
* :doc:`/cookbook/security/csrf_in_login_form`
19541967
* :doc:`/cookbook/cache/form_csrf_caching`
19551968

1956-
.. _`Symfony Form component`: https://github.com/symfony/Form
1969+
.. _`Symfony Form component`: https://github.com/symfony/form
19571970
.. _`DateTime`: http://php.net/manual/en/class.datetime.php
19581971
.. _`Twig Bridge`: https://github.com/symfony/symfony/tree/master/src/Symfony/Bridge/Twig
19591972
.. _`form_div_layout.html.twig`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig

‎book/from_flat_php_to_symfony2.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -757,8 +757,8 @@ Learn more from the Cookbook
757757

758758
.. _`Doctrine`: http://www.doctrine-project.org
759759
.. _`download Composer`: https://getcomposer.org/download/
760-
.. _`Routing`: https://github.com/symfony/Routing
761-
.. _`Templating`: https://github.com/symfony/Templating
760+
.. _`Routing`: https://github.com/symfony/routing
761+
.. _`Templating`: https://github.com/symfony/templating
762762
.. _`KnpBundles.com`: http://knpbundles.com/
763763
.. _`Twig`: http://twig.sensiolabs.org
764764
.. _`Varnish`: https://www.varnish-cache.org/

‎book/http_cache.rst‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ Here is a list of the main options:
230230
``allow_revalidate``
231231
Specifies whether the client can force a cache revalidate by including a
232232
``Cache-Control`` "max-age=0" directive in the request. Set it to ``true`` for
233-
compliance with RFC 2616 (default: false).
233+
compliance with RFC 2616 (default: ``false``).
234234

235235
``stale_while_revalidate``
236236
Specifies the default number of seconds (the granularity is the second as the
@@ -651,6 +651,7 @@ header value::
651651
namespace AppBundle\Controller;
652652

653653
// ...
654+
use Symfony\Component\HttpFoundation\Response;
654655
use Symfony\Component\HttpFoundation\Request;
655656
use AppBundle\Entity\Article;
656657

@@ -665,6 +666,7 @@ header value::
665666

666667
$date = $authorDate > $articleDate ? $authorDate : $articleDate;
667668

669+
$response = new Response();
668670
$response->setLastModified($date);
669671
// Set response as public. Otherwise it will be private by default.
670672
$response->setPublic();
@@ -880,8 +882,8 @@ that data from its cache.
880882

881883
If you want to use cache invalidation, have a look at the
882884
`FOSHttpCacheBundle`_. This bundle provides services to help with various
883-
cache invalidation concepts, and also documents the configuration for the
884-
a couple of common caching proxies.
885+
cache invalidation concepts and also documents the configuration for a
886+
couple of common caching proxies.
885887

886888
If one content corresponds to one URL, the ``PURGE`` model works well.
887889
You send a request to the cache proxy with the HTTP method ``PURGE`` (using

‎book/http_fundamentals.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -579,5 +579,5 @@ sensible defaults. For more advanced users, the sky is the limit.
579579
.. _`List of HTTP status codes`: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
580580
.. _`List of HTTP header fields`: https://en.wikipedia.org/wiki/List_of_HTTP_header_fields
581581
.. _`List of common media types`: https://www.iana.org/assignments/media-types/media-types.xhtml
582-
.. _`Validator`: https://github.com/symfony/Validator
582+
.. _`Validator`: https://github.com/symfony/validator
583583
.. _`Swift Mailer`: http://swiftmailer.org/

‎book/installation.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ If there are any issues, correct them now before moving on.
239239
$ rm -rf app/cache/*
240240
$ rm -rf app/logs/*
241241
242-
$ HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1`
242+
$ HTTPDUSER=`ps axo user,comm | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1`
243243
$ sudo chmod +a "$HTTPDUSER allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
244244
$ sudo chmod +a "`whoami` allow delete,write,append,file_inherit,directory_inherit" app/cache app/logs
245245
@@ -254,7 +254,7 @@ If there are any issues, correct them now before moving on.
254254

255255
.. code-block:: bash
256256
257-
$ HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1`
257+
$ HTTPDUSER=`ps axo user,comm | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1`
258258
$ sudo setfacl -R -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX app/cache app/logs
259259
$ sudo setfacl -dR -m u:"$HTTPDUSER":rwX -m u:`whoami`:rwX app/cache app/logs
260260

‎book/security.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ else, you'll want to encode their passwords. The best algorithm to use is
512512
513513
.. include:: /cookbook/security/_ircmaxwell_password-compat.rst.inc
514514

515-
Of course, your user's passwords now need to be encoded with this exact algorithm.
515+
Of course, your users' passwords now need to be encoded with this exact algorithm.
516516
For hardcoded users, you can use an `online tool`_, which will give you something
517517
like this:
518518

‎book/translation.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -593,7 +593,7 @@ use somewhere in your application::
593593
public $name;
594594
}
595595

596-
Add constraints though any of the supported methods. Set the message option to the
596+
Add constraints through any of the supported methods. Set the message option to the
597597
translation source text. For example, to guarantee that the ``$name`` property is
598598
not empty, add the following:
599599

‎book/validation.rst‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -734,19 +734,19 @@ user registers and when a user updates their contact information later:
734734
class User implements UserInterface
735735
{
736736
/**
737-
* @Assert\Email(groups={"registration"})
738-
*/
737+
* @Assert\Email(groups={"registration"})
738+
*/
739739
private $email;
740740
741741
/**
742-
* @Assert\NotBlank(groups={"registration"})
743-
* @Assert\Length(min=7, groups={"registration"})
744-
*/
742+
* @Assert\NotBlank(groups={"registration"})
743+
* @Assert\Length(min=7, groups={"registration"})
744+
*/
745745
private $password;
746746
747747
/**
748-
* @Assert\Length(min=2)
749-
*/
748+
* @Assert\Length(min=2)
749+
*/
750750
private $city;
751751
}
752752
@@ -927,13 +927,13 @@ username and the password are different only if all other validation passes
927927
class User implements UserInterface
928928
{
929929
/**
930-
* @Assert\NotBlank
931-
*/
930+
* @Assert\NotBlank
931+
*/
932932
private $username;
933933
934934
/**
935-
* @Assert\NotBlank
936-
*/
935+
* @Assert\NotBlank
936+
*/
937937
private $password;
938938
939939
/**
@@ -1300,5 +1300,5 @@ Learn more from the Cookbook
13001300

13011301
* :doc:`/cookbook/validation/custom_constraint`
13021302

1303-
.. _Validator: https://github.com/symfony/Validator
1303+
.. _Validator: https://github.com/symfony/validator
13041304
.. _JSR303 Bean Validation specification: http://jcp.org/en/jsr/detail?id=303

0 commit comments

Comments
 (0)