Skip to content

Commit 31cefc6

Browse files
committed
made some small tweaks
1 parent 84ca34b commit 31cefc6

File tree

5 files changed

+30
-34
lines changed

5 files changed

+30
-34
lines changed

UPGRADE-2.3.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,3 @@ DomCrawler
184184
return $crawler->text();
185185
});
186186
```
187-
188-
BrowserKit
189-
----------
190-
191-
* The `Symfony\Component\BrowserKit\Client::getResponse()/getRequest()`
192-
methods now **always** return the request/response instance from the code
193-
that handles the request. To get the BrowserKit request/response instances,
194-
use the new `getInternalResponse()/getInternalRequest()` methods.

src/Symfony/Bundle/FrameworkBundle/Client.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ public function enableProfiler()
8585
}
8686

8787
/**
88-
* Makes a request.
88+
* {@inheritdoc}
8989
*
9090
* @param Request $request A Request instance
9191
*
@@ -113,6 +113,10 @@ protected function doRequest($request)
113113

114114
/**
115115
* {@inheritdoc}
116+
*
117+
* @param Request $request A Request instance
118+
*
119+
* @return Response A Response instance
116120
*/
117121
protected function doRequestInProcess($request)
118122
{

src/Symfony/Component/BrowserKit/CHANGELOG.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ CHANGELOG
66

77
* added `Client::getInternalRequest()` and `Client::getInternalResponse()` to
88
have access to the BrowserKit internal request and response objects
9-
* [BC BREAK] The `Symfony\Component\HttpKernel\Client::getRequest()` method now
10-
returns the request instance created by the client
11-
* [BC BREAK] The `Symfony\Component\HttpKernel\Client::request()` method now
12-
always returns the response instance created by the client
139

1410
2.1.0
1511
-----

src/Symfony/Component/BrowserKit/Client.php

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ public function getCookieJar()
158158
/**
159159
* Returns the current Crawler instance.
160160
*
161-
* @return Crawler A Crawler instance
161+
* @return Crawler|null A Crawler instance
162162
*
163163
* @api
164164
*/
@@ -168,9 +168,9 @@ public function getCrawler()
168168
}
169169

170170
/**
171-
* Returns the current Response instance.
171+
* Returns the current BrowserKit Response instance.
172172
*
173-
* @return Response A Response instance
173+
* @return Response|null A BrowserKit Response instance
174174
*
175175
* @api
176176
*/
@@ -180,12 +180,14 @@ public function getInternalResponse()
180180
}
181181

182182
/**
183-
* Returns the origin response instance.
183+
* Returns the current origin response instance.
184184
*
185185
* The origin response is the response instance that is returned
186186
* by the code that handles requests.
187187
*
188-
* @return object A response instance
188+
* @return object|null A response instance
189+
*
190+
* @see doRequest
189191
*
190192
* @api
191193
*/
@@ -195,9 +197,9 @@ public function getResponse()
195197
}
196198

197199
/**
198-
* Returns the current Request instance.
200+
* Returns the current BrowserKit Request instance.
199201
*
200-
* @return Request A Request instance
202+
* @return Request|null A BrowserKit Request instance
201203
*
202204
* @api
203205
*/
@@ -207,14 +209,16 @@ public function getInternalRequest()
207209
}
208210

209211
/**
210-
* Returns the origin Request instance.
212+
* Returns the current origin Request instance.
211213
*
212214
* The origin request is the request instance that is sent
213215
* to the code that handles requests.
214216
*
215-
* @api
217+
* @return object|null A Request instance
218+
*
219+
* @see doRequest
216220
*
217-
* @return object A Request instance
221+
* @api
218222
*/
219223
public function getRequest()
220224
{
@@ -343,7 +347,7 @@ abstract protected function doRequest($request);
343347
/**
344348
* Returns the script to execute when the request must be insulated.
345349
*
346-
* @param Request $request A Request instance
350+
* @param object $request An origin request instance
347351
*
348352
* @throws \LogicException When this abstract class is not implemented
349353
*/
@@ -355,23 +359,23 @@ protected function getScript($request)
355359
}
356360

357361
/**
358-
* Filters the request.
362+
* Filters the BrowserKit request to the origin one.
359363
*
360-
* @param Request $request The request to filter
364+
* @param Request $request The BrowserKit Request to filter
361365
*
362-
* @return Request
366+
* @return object An origin request instance
363367
*/
364368
protected function filterRequest(Request $request)
365369
{
366370
return $request;
367371
}
368372

369373
/**
370-
* Filters the Response.
374+
* Filters the origin response to the BrowserKit one.
371375
*
372-
* @param Response $response The Response to filter
376+
* @param object $response The origin response to filter
373377
*
374-
* @return Response
378+
* @return Response An BrowserKit Response instance
375379
*/
376380
protected function filterResponse($response)
377381
{

src/Symfony/Component/HttpKernel/Client.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public function __construct(HttpKernelInterface $kernel, array $server = array()
5353
/**
5454
* {@inheritdoc}
5555
*
56-
* @return Request A Request instance
56+
* @return Request|null A Request instance
5757
*/
5858
public function getRequest()
5959
{
@@ -63,7 +63,7 @@ public function getRequest()
6363
/**
6464
* {@inheritdoc}
6565
*
66-
* @return Response A Response instance
66+
* @return Response|null A Response instance
6767
*/
6868
public function getResponse()
6969
{
@@ -121,7 +121,7 @@ protected function getScript($request)
121121
/**
122122
* Converts the BrowserKit request to a HttpKernel request.
123123
*
124-
* @param DomRequest $request A Request instance
124+
* @param DomRequest $request A DomRequest instance
125125
*
126126
* @return Request A Request instance
127127
*/
@@ -188,7 +188,7 @@ protected function filterFiles(array $files)
188188
*
189189
* @param Response $response A Response instance
190190
*
191-
* @return Response A Response instance
191+
* @return DomResponse A DomResponse instance
192192
*/
193193
protected function filterResponse($response)
194194
{

0 commit comments

Comments
 (0)