Skip to content

Commit 12a05fb

Browse files
wbloszykwbloszyk
committed
Allow "friendsofsymfony/rest-bundle:^3.0"
1 parent 2519ef3 commit 12a05fb

12 files changed

+181
-101
lines changed

‎composer.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@
5656
"twig/twig": "^2.12.1"
5757
},
5858
"conflict": {
59-
"friendsofsymfony/rest-bundle": "<2.1 || >=3.0",
59+
"friendsofsymfony/rest-bundle": "<2.1",
6060
"jms/serializer": "<0.13",
6161
"sonata-project/core-bundle": "<3.20"
6262
},
6363
"require-dev": {
6464
"doctrine/annotations": "1.10.3",
65-
"friendsofsymfony/rest-bundle": "^2.1",
65+
"friendsofsymfony/rest-bundle": "^2.6 || ^3.0",
6666
"jms/serializer-bundle": "^2.0 || ^3.0",
6767
"matthiasnoback/symfony-dependency-injection-test": "^4.1.1",
6868
"nelmio/api-doc-bundle": "^2.4",

‎src/Controller/Api/BlockController.php

+12-11
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313

1414
namespace Sonata\PageBundle\Controller\Api;
1515

16-
use FOS\RestBundle\Controller\Annotations\View;
16+
use FOS\RestBundle\Controller\Annotations as Rest;
17+
use FOS\RestBundle\View\View;
1718
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
1819
use Sonata\BlockBundle\Model\BlockInterface;
1920
use Sonata\BlockBundle\Model\BlockManagerInterface;
@@ -48,7 +49,7 @@ public function __construct(BlockManagerInterface $blockManager, FormFactoryInte
4849
* @ApiDoc(
4950
* resource=true,
5051
* requirements={
51-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="block id"}
52+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Block identifier"}
5253
* },
5354
* output={"class"="Sonata\PageBundle\Model\BlockInterface", "groups"={"sonata_api_read"}},
5455
* statusCodes={
@@ -57,9 +58,9 @@ public function __construct(BlockManagerInterface $blockManager, FormFactoryInte
5758
* }
5859
* )
5960
*
60-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
61+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
6162
*
62-
* @param $id
63+
* @param int $id Block identifier
6364
*
6465
* @return BlockInterface
6566
*/
@@ -73,7 +74,7 @@ public function getBlockAction($id)
7374
*
7475
* @ApiDoc(
7576
* requirements={
76-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="block identifier"},
77+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Block identifier"},
7778
* },
7879
* input={"class"="sonata_page_api_form_block", "name"="", "groups"={"sonata_api_write"}},
7980
* output={"class"="Sonata\PageBundle\Model\Block", "groups"={"sonata_api_read"}},
@@ -84,10 +85,10 @@ public function getBlockAction($id)
8485
* }
8586
* )
8687
*
87-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
88+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
8889
*
89-
* @param int $id A Block identifier
90-
* @param Request $request A Symfony request
90+
* @param int $id Block identifier
91+
* @param Request $request Symfony request
9192
*
9293
* @throws NotFoundHttpException
9394
*
@@ -119,7 +120,7 @@ public function putBlockAction($id, Request $request)
119120
*
120121
* @ApiDoc(
121122
* requirements={
122-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="block identifier"}
123+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Block identifier"}
123124
* },
124125
* statusCodes={
125126
* 200="Returned when block is successfully deleted",
@@ -128,11 +129,11 @@ public function putBlockAction($id, Request $request)
128129
* }
129130
* )
130131
*
131-
* @param int $id A Block identifier
132+
* @param int $id Block identifier
132133
*
133134
* @throws NotFoundHttpException
134135
*
135-
* @return \FOS\RestBundle\View\View
136+
* @return View
136137
*/
137138
public function deleteBlockAction($id)
138139
{

‎src/Controller/Api/FOSRestController.php

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
use FOS\RestBundle\Context\Context;
1717
use FOS\RestBundle\Controller\Annotations\QueryParam;
1818
use FOS\RestBundle\Request\ParamFetcherInterface;
19-
use FOS\RestBundle\View\View as FOSRestView;
19+
use FOS\RestBundle\View\View;
2020

2121
/**
2222
* @author Duchkina Anastasiya <duchkina.nast@gmail.com>
@@ -40,15 +40,15 @@ final protected function setMapForOrderByParam(ParamFetcherInterface $paramFetch
4040
/**
4141
* @param $entity
4242
*
43-
* @return FOSRestView
43+
* @return View
4444
*/
4545
final protected function serializeContext($entity, array $groups)
4646
{
4747
$context = new Context();
4848
$context->setGroups($groups);
4949
$context->enableMaxDepth();
5050

51-
$view = FOSRestView::create($entity);
51+
$view = View::create($entity);
5252
$view->setContext($context);
5353

5454
return $view;

‎src/Controller/Api/PageController.php

+41-39
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313

1414
namespace Sonata\PageBundle\Controller\Api;
1515

16-
use FOS\RestBundle\Controller\Annotations\QueryParam;
17-
use FOS\RestBundle\Controller\Annotations\View;
16+
use FOS\RestBundle\Controller\Annotations as Rest;
1817
use FOS\RestBundle\Request\ParamFetcherInterface;
18+
use FOS\RestBundle\View\View;
1919
use Nelmio\ApiDocBundle\Annotation\ApiDoc;
2020
use Sonata\BlockBundle\Model\BlockInterface;
2121
use Sonata\BlockBundle\Model\BlockManagerInterface;
@@ -76,17 +76,17 @@ public function __construct(SiteManagerInterface $siteManager, PageManagerInterf
7676
* output={"class"="Sonata\DatagridBundle\Pager\PagerInterface", "groups"={"sonata_api_read"}}
7777
* )
7878
*
79-
* @QueryParam(name="page", requirements="\d+", default="1", description="Page for 'page' list pagination")
80-
* @QueryParam(name="count", requirements="\d+", default="10", description="Number of pages by page")
81-
* @QueryParam(name="enabled", requirements="0|1", nullable=true, strict=true, description="Enabled/Disabled pages filter")
82-
* @QueryParam(name="edited", requirements="0|1", nullable=true, strict=true, description="Edited/Up to date pages filter")
83-
* @QueryParam(name="internal", requirements="0|1", nullable=true, strict=true, description="Internal/Exposed pages filter")
84-
* @QueryParam(name="root", requirements="0|1", nullable=true, strict=true, description="Filter pages having no parent id")
85-
* @QueryParam(name="site", requirements="\d+", nullable=true, strict=true, description="Filter pages for a specific site's id")
86-
* @QueryParam(name="parent", requirements="\d+", nullable=true, strict=true, description="Get pages being child of given page id")
87-
* @QueryParam(name="orderBy", map=true, requirements="ASC|DESC", nullable=true, strict=true, description="Order by array (key is field, value is direction)")
79+
* @Rest\QueryParam(name="page", requirements="\d+", default="1", description="Page for 'page' list pagination")
80+
* @Rest\QueryParam(name="count", requirements="\d+", default="10", description="Number of pages by page")
81+
* @Rest\QueryParam(name="enabled", requirements="0|1", nullable=true, strict=true, description="Enabled/Disabled pages filter")
82+
* @Rest\QueryParam(name="edited", requirements="0|1", nullable=true, strict=true, description="Edited/Up to date pages filter")
83+
* @Rest\QueryParam(name="internal", requirements="0|1", nullable=true, strict=true, description="Internal/Exposed pages filter")
84+
* @Rest\QueryParam(name="root", requirements="0|1", nullable=true, strict=true, description="Filter pages having no parent id")
85+
* @Rest\QueryParam(name="site", requirements="\d+", nullable=true, strict=true, description="Filter pages for a specific site's id")
86+
* @Rest\QueryParam(name="parent", requirements="\d+", nullable=true, strict=true, description="Get pages being child of given page id")
87+
* @Rest\QueryParam(name="orderBy", map=true, requirements="ASC|DESC", nullable=true, strict=true, description="Order by array (key is field, value is direction)")
8888
*
89-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
89+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
9090
*
9191
* @return PagerInterface
9292
*/
@@ -128,7 +128,7 @@ public function getPagesAction(ParamFetcherInterface $paramFetcher)
128128
*
129129
* @ApiDoc(
130130
* requirements={
131-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page id"}
131+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
132132
* },
133133
* output={"class"="Sonata\PageBundle\Model\PageInterface", "groups"={"sonata_api_read"}},
134134
* statusCodes={
@@ -137,9 +137,9 @@ public function getPagesAction(ParamFetcherInterface $paramFetcher)
137137
* }
138138
* )
139139
*
140-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
140+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
141141
*
142-
* @param $id
142+
* @param int $id Page identifier
143143
*
144144
* @return PageInterface
145145
*/
@@ -153,7 +153,7 @@ public function getPageAction($id)
153153
*
154154
* @ApiDoc(
155155
* requirements={
156-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page id"}
156+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
157157
* },
158158
* output={"class"="Sonata\BlockBundle\Model\BlockInterface", "groups"={"sonata_api_read"}},
159159
* statusCodes={
@@ -162,9 +162,9 @@ public function getPageAction($id)
162162
* }
163163
* )
164164
*
165-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
165+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
166166
*
167-
* @param $id
167+
* @param int $id Page identifier
168168
*
169169
* @return BlockInterface[]
170170
*/
@@ -178,7 +178,7 @@ public function getPageBlocksAction($id)
178178
*
179179
* @ApiDoc(
180180
* requirements={
181-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page id"}
181+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
182182
* },
183183
* output={"class"="Sonata\BlockBundle\Model\BlockInterface", "groups"={"sonata_api_read"}},
184184
* statusCodes={
@@ -187,9 +187,9 @@ public function getPageBlocksAction($id)
187187
* }
188188
* )
189189
*
190-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
190+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
191191
*
192-
* @param $id
192+
* @param int $id Page identifier
193193
*
194194
* @return PageInterface[]
195195
*/
@@ -205,7 +205,7 @@ public function getPagePagesAction($id)
205205
*
206206
* @ApiDoc(
207207
* requirements={
208-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page identifier"}
208+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
209209
* },
210210
* input={"class"="sonata_page_api_form_block", "name"="", "groups"={"sonata_api_write"}},
211211
* output={"class"="Sonata\PageBundle\Model\Block", "groups"={"sonata_api_read"}},
@@ -216,10 +216,10 @@ public function getPagePagesAction($id)
216216
* }
217217
* )
218218
*
219-
* @View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
219+
* @Rest\View(serializerGroups={"sonata_api_read"}, serializerEnableMaxDepthChecks=true)
220220
*
221-
* @param int $id A Page identifier
222-
* @param Request $request A Symfony request
221+
* @param int $id Page identifier
222+
* @param Request $request Symfony request
223223
*
224224
* @throws NotFoundHttpException
225225
*
@@ -260,7 +260,7 @@ public function postPageBlockAction($id, Request $request)
260260
* }
261261
* )
262262
*
263-
* @param Request $request A Symfony request
263+
* @param Request $request Symfony request
264264
*
265265
* @throws NotFoundHttpException
266266
*
@@ -276,7 +276,7 @@ public function postPageAction(Request $request)
276276
*
277277
* @ApiDoc(
278278
* requirements={
279-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page identifier"}
279+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
280280
* },
281281
* input={"class"="sonata_page_api_form_page", "name"="", "groups"={"sonata_api_write"}},
282282
* output={"class"="Sonata\PageBundle\Model\Page", "groups"={"sonata_api_read"}},
@@ -287,8 +287,10 @@ public function postPageAction(Request $request)
287287
* }
288288
* )
289289
*
290-
* @param int $id A Page identifier
291-
* @param Request $request A Symfony request
290+
* @Rest\Put("", name="")
291+
*
292+
* @param int $id Page identifier
293+
* @param Request $request Symfony request
292294
*
293295
* @throws NotFoundHttpException
294296
*
@@ -304,7 +306,7 @@ public function putPageAction($id, Request $request)
304306
*
305307
* @ApiDoc(
306308
* requirements={
307-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page identifier"}
309+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
308310
* },
309311
* statusCodes={
310312
* 200="Returned when page is successfully deleted",
@@ -313,11 +315,11 @@ public function putPageAction($id, Request $request)
313315
* }
314316
* )
315317
*
316-
* @param int $id A Page identifier
318+
* @param int $id Page identifier
317319
*
318320
* @throws NotFoundHttpException
319321
*
320-
* @return \FOS\RestBundle\View\View
322+
* @return View
321323
*/
322324
public function deletePageAction($id)
323325
{
@@ -333,7 +335,7 @@ public function deletePageAction($id)
333335
*
334336
* @ApiDoc(
335337
* requirements={
336-
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="page identifier"}
338+
* {"name"="id", "dataType"="integer", "requirement"="\d+", "description"="Page identifier"}
337339
* },
338340
* statusCodes={
339341
* 200="Returned when snapshots are successfully queued for creation",
@@ -342,11 +344,11 @@ public function deletePageAction($id)
342344
* }
343345
* )
344346
*
345-
* @param int $id A Page identifier
347+
* @param int $id Page identifier
346348
*
347349
* @throws NotFoundHttpException
348350
*
349-
* @return \FOS\RestBundle\View\View
351+
* @return View
350352
*/
351353
public function postPageSnapshotAction($id)
352354
{
@@ -371,7 +373,7 @@ public function postPageSnapshotAction($id)
371373
*
372374
* @throws NotFoundHttpException
373375
*
374-
* @return \FOS\RestBundle\View\View
376+
* @return View
375377
*/
376378
public function postPagesSnapshotsAction()
377379
{
@@ -389,7 +391,7 @@ public function postPagesSnapshotsAction()
389391
/**
390392
* Retrieves page with id $id or throws an exception if it doesn't exist.
391393
*
392-
* @param $id
394+
* @param mixed $id Page identifier
393395
*
394396
* @throws NotFoundHttpException
395397
*
@@ -409,7 +411,7 @@ protected function getPage($id)
409411
/**
410412
* Retrieves Block with id $id or throws an exception if it doesn't exist.
411413
*
412-
* @param $id
414+
* @param mixed $id Block identifier
413415
*
414416
* @throws NotFoundHttpException
415417
*
@@ -430,7 +432,7 @@ protected function getBlock($id)
430432
* Write a page, this method is used by both POST and PUT action methods.
431433
*
432434
* @param Request $request Symfony request
433-
* @param int|null $id A page identifier
435+
* @param int|null $id Page identifier
434436
*
435437
* @return FormInterface
436438
*/

0 commit comments

Comments
 (0)