Skip to content

Commit 00d696f

Browse files
committed
Merge branch '3.3' into 3.4
* 3.3: doc(http_foundation.rst): Fix code error which used create() instead of constructor method. Follow the same code style in docblock annotations
2 parents 1fd33a1 + 2f195e8 commit 00d696f

15 files changed

+25
-25
lines changed

best_practices/business-logic.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ looking for mapping information:
283283
* mappedBy="post",
284284
* orphanRemoval=true
285285
* )
286-
* @ORM\OrderBy({"publishedAt" = "ASC"})
286+
* @ORM\OrderBy({"publishedAt"="ASC"})
287287
*/
288288
private $comments;
289289

best_practices/controllers.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ manually. In our application, we have this situation in ``CommentController``:
182182
.. code-block:: php
183183
184184
/**
185-
* @Route("/comment/{postSlug}/new", name = "comment_new")
185+
* @Route("/comment/{postSlug}/new", name="comment_new")
186186
*/
187187
public function newAction(Request $request, $postSlug)
188188
{
@@ -208,8 +208,8 @@ flexible:
208208
use Symfony\Component\Routing\Annotation\Route;
209209
210210
/**
211-
* @Route("/comment/{postSlug}/new", name = "comment_new")
212-
* @ParamConverter("post", options={"mapping": {"postSlug": "slug"}})
211+
* @Route("/comment/{postSlug}/new", name="comment_new")
212+
* @ParamConverter("post", options={"mapping"={"postSlug"="slug"}})
213213
*/
214214
public function newAction(Request $request, Post $post)
215215
{

components/http_foundation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ PHP callable that is able to create an instance of your ``Request`` class::
297297
array $server = array(),
298298
$content = null
299299
) {
300-
return SpecialRequest::create(
300+
return new SpecialRequest(
301301
$query,
302302
$request,
303303
$attributes,

reference/constraints/All.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ entry in that array:
3535
/**
3636
* @Assert\All({
3737
* @Assert\NotBlank,
38-
* @Assert\Length(min = 5)
38+
* @Assert\Length(min=5)
3939
* })
4040
*/
4141
protected $favoriteColors = array();

reference/constraints/Choice.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ If your valid choice list is simple, you can pass them in directly via the
5252
protected $city;
5353
5454
/**
55-
* @Assert\Choice(choices = {"fiction", "non-fiction"}, message = "Choose a valid genre.")
55+
* @Assert\Choice(choices={"fiction", "non-fiction"}, message="Choose a valid genre.")
5656
*/
5757
protected $genre;
5858
}
@@ -162,7 +162,7 @@ constraint.
162162
class Author
163163
{
164164
/**
165-
* @Assert\Choice(callback = "getGenres")
165+
* @Assert\Choice(callback="getGenres")
166166
*/
167167
protected $genre;
168168
}
@@ -227,7 +227,7 @@ you can pass the class name and the method as an array.
227227
class Author
228228
{
229229
/**
230-
* @Assert\Choice(callback = {"Util", "getGenres"})
230+
* @Assert\Choice(callback={"Util", "getGenres"})
231231
*/
232232
protected $genre;
233233
}

reference/constraints/IsTrue.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Then you can constrain this method with ``IsTrue``.
5555
protected $token;
5656
5757
/**
58-
* @Assert\IsTrue(message = "The token is invalid")
58+
* @Assert\IsTrue(message="The token is invalid")
5959
*/
6060
public function isTokenValid()
6161
{

reference/constraints/Luhn.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ will contain a credit card number.
3434
class Transaction
3535
{
3636
/**
37-
* @Assert\Luhn(message = "Please check your credit card number.")
37+
* @Assert\Luhn(message="Please check your credit card number.")
3838
*/
3939
protected $cardNumber;
4040
}

reference/constraints/Valid.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ stores an ``Address`` instance in the ``$address`` property.
6464
6565
/**
6666
* @Assert\NotBlank
67-
* @Assert\Length(max = 5)
67+
* @Assert\Length(max=5)
6868
*/
6969
protected $zipCode;
7070
}
@@ -78,7 +78,7 @@ stores an ``Address`` instance in the ``$address`` property.
7878
{
7979
/**
8080
* @Assert\NotBlank
81-
* @Assert\Length(min = 4)
81+
* @Assert\Length(min=4)
8282
*/
8383
protected $firstName;
8484

routing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ To fix this, add a *requirement* that the ``{page}`` wildcard can *only* match n
179179
class BlogController extends Controller
180180
{
181181
/**
182-
* @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
182+
* @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
183183
*/
184184
public function listAction($page)
185185
{
@@ -277,7 +277,7 @@ So how can you make ``blog_list`` once again match when the user visits
277277
class BlogController extends Controller
278278
{
279279
/**
280-
* @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
280+
* @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
281281
*/
282282
public function listAction($page = 1)
283283
{

routing/optional_placeholders.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ This is done by including it in the ``defaults`` collection:
135135
// ...
136136
137137
/**
138-
* @Route("/blog/{page}", defaults={"page" = 1})
138+
* @Route("/blog/{page}", defaults={"page"=1})
139139
*/
140140
public function indexAction($page)
141141
{

routing/requirements.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ a routing ``{wildcard}`` to only match some regular expression:
2121
class BlogController extends Controller
2222
{
2323
/**
24-
* @Route("/blog/{page}", name="blog_list", requirements={"page": "\d+"})
24+
* @Route("/blog/{page}", name="blog_list", requirements={"page"="\d+"})
2525
*/
2626
public function listAction($page)
2727
{
@@ -97,8 +97,8 @@ URL:
9797
class MainController extends Controller
9898
{
9999
/**
100-
* @Route("/{_locale}", defaults={"_locale": "en"}, requirements={
101-
* "_locale": "en|fr"
100+
* @Route("/{_locale}", defaults={"_locale"="en"}, requirements={
101+
* "_locale"="en|fr"
102102
* })
103103
*/
104104
public function homepageAction($_locale)

templating/formats.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ be configured so that ``/about-us`` sets the request format to ``html`` while
5151
special ``_format`` placeholder in your route definition::
5252

5353
/**
54-
* @Route("/{slug}.{_format}", defaults={"_format": "html"})
54+
* @Route("/{slug}.{_format}", defaults={"_format"="html"})
5555
*/
5656
public function showAction(Request $request, $slug)
5757
{

validation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ this method must return ``true``:
637637
class Author
638638
{
639639
/**
640-
* @Assert\IsTrue(message = "The password cannot match your first name")
640+
* @Assert\IsTrue(message="The password cannot match your first name")
641641
*/
642642
public function isPasswordLegal()
643643
{

validation/severity.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,17 @@ Use the ``payload`` option to configure the error level for each constraint:
3535
class User
3636
{
3737
/**
38-
* @Assert\NotBlank(payload = {"severity" = "error"})
38+
* @Assert\NotBlank(payload={"severity"="error"})
3939
*/
4040
protected $username;
4141
4242
/**
43-
* @Assert\NotBlank(payload = {"severity" = "error"})
43+
* @Assert\NotBlank(payload={"severity"="error"})
4444
*/
4545
protected $password;
4646
4747
/**
48-
* @Assert\Iban(payload = {"severity" = "warning"})
48+
* @Assert\Iban(payload={"severity"="warning"})
4949
*/
5050
protected $bankAccountNumber;
5151
}

validation/translations.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ property is not empty, add the following:
3333
class Author
3434
{
3535
/**
36-
* @Assert\NotBlank(message = "author.name.not_blank")
36+
* @Assert\NotBlank(message="author.name.not_blank")
3737
*/
3838
public $name;
3939
}

0 commit comments

Comments
 (0)