Skip to content

Commit 4c5b0c4

Browse files
committed
Merge branch '2.2'
Conflicts: reference/forms/types/birthday.rst reference/forms/types/choice.rst reference/forms/types/date.rst reference/forms/types/datetime.rst reference/forms/types/file.rst reference/forms/types/time.rst
2 parents dbe0e62 + b57f2ab commit 4c5b0c4

38 files changed

+497
-148
lines changed

book/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -807,7 +807,7 @@ Take the following ``access_control`` entries as an example:
807807
array('path' => '^/admin', 'role' => 'ROLE_USER'),
808808
),
809809
810-
For each incoming request, Symfony will decided which ``access_control``
810+
For each incoming request, Symfony will decide which ``access_control``
811811
to use based on the URI, the client's IP address, the incoming host name,
812812
and the request method. Remember, the first rule that matches is used, and
813813
if ``ip``, ``host`` or ``method`` are not specified for an entry, that ``access_control``

components/http_foundation/introduction.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -499,10 +499,11 @@ to ``application/json``.
499499

500500
.. caution::
501501

502-
To avoid `JSON Hijacking`_, you should pass an associative array as the
503-
outer-most array to ``JsonResponse`` and not an indexed array so that
504-
the final result is an object (e.g. ``{"object": "not inside an array"}``)
505-
instead of an array (e.g. ``[{"object": "inside an array"}]``).
502+
To avoid XSSI `JSON Hijacking`_, you should pass an associative array
503+
as the outer-most array to ``JsonResponse`` and not an indexed array so
504+
that the final result is an object (e.g. ``{"object": "not inside an array"}``)
505+
instead of an array (e.g. ``[{"object": "inside an array"}]``). Read
506+
the `OWASP guidelines`_ for more information.
506507

507508
JSONP Callback
508509
~~~~~~~~~~~~~~
@@ -528,3 +529,4 @@ The session information is in its own document: :doc:`/components/http_foundatio
528529
.. _Nginx: http://wiki.nginx.org/XSendfile
529530
.. _Apache: https://tn123.org/mod_xsendfile/
530531
.. _`JSON Hijacking`: http://haacked.com/archive/2009/06/25/json-hijacking.aspx
532+
.. _OWASP guidelines: https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside

contributing/documentation/format.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ the highlighted pseudo-language:
5252

5353
A list of supported languages is available on the `Pygments website`_.
5454

55+
.. _docs-configuration-blocks:
56+
5557
Configuration Blocks
5658
~~~~~~~~~~~~~~~~~~~~
5759

contributing/documentation/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ Contributing Documentation
66

77
overview
88
format
9+
standards
910
translations
1011
license

contributing/documentation/overview.rst

Lines changed: 2 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -161,55 +161,8 @@ tags would be removed from the new 2.5 branch.
161161
Standards
162162
---------
163163

164-
In order to help the reader as much as possible and to create code examples that
165-
look and feel familiar, you should follow these rules:
166-
167-
* The code follows the :doc:`Symfony Coding Standards</contributing/code/standards>`
168-
as well as the `Twig Coding Standards`_;
169-
* Each line should break approximately after the first word that crosses the
170-
72nd character (so most lines end up being 72-78 characters);
171-
* To avoid horizontal scrolling on code blocks, we prefer to break a line
172-
correctly if it crosses the 85th character;
173-
* When you fold one or more lines of code, place ``...`` in a comment at the point
174-
of the fold. These comments are: ``// ...`` (php), ``# ...`` (yaml/bash), ``{# ... #}``
175-
(twig), ``<!-- ... -->`` (xml/html), ``; ...`` (ini), ``...`` (text);
176-
* When you fold a part of a line, e.g. a variable value, put ``...`` (without comment)
177-
at the place of the fold;
178-
* Description of the folded code: (optional)
179-
If you fold several lines: the description of the fold can be placed after the ``...``
180-
If you fold only part of a line: the description can be placed before the line;
181-
* If useful, a ``codeblock`` should begin with a comment containing the filename
182-
of the file in the code block. Don't place a blank line after this comment,
183-
unless the next line is also a comment;
184-
* You should put a ``$`` in front of every bash line;
185-
* The ``::`` shorthand is preferred over ``.. code-block:: php`` to begin a PHP
186-
code block;
187-
* You should use a form of *you* instead of *we*.
188-
189-
An example::
190-
191-
// src/Foo/Bar.php
192-
193-
// ...
194-
class Bar
195-
{
196-
// ...
197-
198-
public function foo($bar)
199-
{
200-
// set foo with a value of bar
201-
$foo = ...;
202-
203-
// ... check if $bar has the correct value
204-
205-
return $foo->baz($bar, ...);
206-
}
207-
}
208-
209-
.. caution::
210-
211-
In Yaml you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
212-
but this should not be done in Twig (e.g. ``{'hello' : 'value'}``).
164+
All documentation in the Symfony Documentation should follow
165+
:doc:`the documentation standards <standards>`.
213166

214167
Reporting an Issue
215168
------------------
@@ -231,4 +184,3 @@ Read the dedicated :doc:`document <translations>`.
231184
.. _`fork`: https://help.github.com/articles/fork-a-repo
232185
.. _`pull requests`: https://help.github.com/articles/using-pull-requests
233186
.. _`Documentation Build Errors`: http://symfony.com/doc/build_errors
234-
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
Documentation Standards
2+
=======================
3+
4+
In order to help the reader as much as possible and to create code examples that
5+
look and feel familiar, you should follow these standards.
6+
7+
Sphinx
8+
------
9+
10+
* The following characters are choosen for different heading levels: level 1
11+
is ``=``, level 2 ``-``, level 3 ``~``, level 4 ``.`` and level 5 ``"``;
12+
* Each line should break approximately after the first word that crosses the
13+
72nd character (so most lines end up being 72-78 characters);
14+
* The ``::`` shorthand is *preferred* over ``.. code-block:: php`` to begin a PHP
15+
code block (read `the Sphinx documentation`_ to see when you should use the
16+
shorthand);
17+
* Inline hyperlinks are **not** used. Seperate the link and their target
18+
definition, which you add on the bottom of the page;
19+
* You should use a form of *you* instead of *we*.
20+
21+
Example
22+
~~~~~~~
23+
24+
.. code-block:: text
25+
26+
Example
27+
=======
28+
29+
When you are working on the docs, you should follow the `Symfony Docs`_
30+
standards.
31+
32+
Level 2
33+
-------
34+
35+
A PHP example would be::
36+
37+
echo 'Hello World';
38+
39+
Level 3
40+
~~~~~~~
41+
42+
.. code-block:: php
43+
44+
echo 'You cannot use the :: shortcut here';
45+
46+
.. _`Symfony Docs`: http://symfony.com/doc/current/contributing/documentation/standards.html
47+
48+
Code Examples
49+
-------------
50+
51+
* The code follows the :doc:`Symfony Coding Standards</contributing/code/standards>`
52+
as well as the `Twig Coding Standards`_;
53+
* To avoid horizontal scrolling on code blocks, we prefer to break a line
54+
correctly if it crosses the 85th character;
55+
* When you fold one or more lines of code, place ``...`` in a comment at the point
56+
of the fold. These comments are: ``// ...`` (php), ``# ...`` (yaml/bash), ``{# ... #}``
57+
(twig), ``<!-- ... -->`` (xml/html), ``; ...`` (ini), ``...`` (text);
58+
* When you fold a part of a line, e.g. a variable value, put ``...`` (without comment)
59+
at the place of the fold;
60+
* Description of the folded code: (optional)
61+
If you fold several lines: the description of the fold can be placed after the ``...``
62+
If you fold only part of a line: the description can be placed before the line;
63+
* If useful, a ``codeblock`` should begin with a comment containing the filename
64+
of the file in the code block. Don't place a blank line after this comment,
65+
unless the next line is also a comment;
66+
* You should put a ``$`` in front of every bash line.
67+
68+
Formats
69+
~~~~~~~
70+
71+
Configuration examples should show all supported formats using
72+
:ref:`configuration blocks <docs-configuration-blocks>`. The supported formats
73+
(and their orders) are:
74+
75+
* **Configuration** (including services and routing): Yaml, Xml, Php
76+
* **Validation**: Yaml, Annotations, Xml, Php
77+
* **Doctrine Mapping**: Annotations, Yaml, Xml, Php
78+
79+
Example
80+
~~~~~~~
81+
82+
.. code-block:: php
83+
84+
// src/Foo/Bar.php
85+
86+
// ...
87+
class Bar
88+
{
89+
// ...
90+
91+
public function foo($bar)
92+
{
93+
// set foo with a value of bar
94+
$foo = ...;
95+
96+
// ... check if $bar has the correct value
97+
98+
return $foo->baz($bar, ...);
99+
}
100+
}
101+
102+
.. caution::
103+
104+
In Yaml you should put a space after ``{`` and before ``}`` (e.g. ``{ _controller: ... }``),
105+
but this should not be done in Twig (e.g. ``{'hello' : 'value'}``).
106+
107+
.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
108+
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html

contributing/map.rst.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
* :doc:`Overview </contributing/documentation/overview>`
1515
* :doc:`Format </contributing/documentation/format>`
16+
* :doc:`Documentation Standards </contributing/documentation/standards>`
1617
* :doc:`Translations </contributing/documentation/translations>`
1718
* :doc:`License </contributing/documentation/license>`
1819

cookbook/form/data_transformers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ when creating your form. Later, you'll learn how you could create a custom
152152
``issue`` field type to avoid needing to do this in your controller::
153153

154154
$taskForm = $this->createForm(new TaskType(), $task, array(
155-
'em' => $this->getDoctrine()->getEntityManager(),
155+
'em' => $this->getDoctrine()->getManager(),
156156
));
157157

158158
Cool, you're done! Your user will be able to enter an issue number into the

0 commit comments

Comments
 (0)