backport RFC-2518 annotations

Author: xabbuh

Controller/Annotations/Copy.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * COPY Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class Copy extends Route
+{
+    public function getMethod()
+    {
+        return 'COPY';
+    }
+}

Controller/Annotations/Lock.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * LOCK Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class Lock extends Route
+{
+    public function getMethod()
+    {
+        return 'LOCK';
+    }
+}

Controller/Annotations/Mkcol.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * MKCOL Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class Mkcol extends Route
+{
+    public function getMethod()
+    {
+        return 'MKCOL';
+    }
+}

Controller/Annotations/Move.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * MOVE Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class Move extends Route
+{
+    public function getMethod()
+    {
+        return 'MOVE';
+    }
+}

Controller/Annotations/PropFind.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * PROPFIND Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class PropFind extends Route
+{
+    public function getMethod()
+    {
+        return 'PROPFIND';
+    }
+}

Controller/Annotations/PropPatch.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * PROPPATCH Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class PropPatch extends Route
+{
+    public function getMethod()
+    {
+        return 'PROPPATCH';
+    }
+}

Controller/Annotations/Unlock.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the FOSRestBundle package.
+ *
+ * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace FOS\RestBundle\Controller\Annotations;
+
+/**
+ * UNLOCK Route annotation class.
+ *
+ * @Annotation
+ * @Target("METHOD")
+ *
+ * @author Maximilian Bosch <[email protected]>
+ */
+class Unlock extends Route
+{
+    public function getMethod()
+    {
+        return 'UNLOCK';
+    }
+}

Resources/doc/5-automatic-route-generation_single-restful-controller.rst

@@ -45,44 +45,62 @@ Define resource actions
     <?php
     class UsersController
     {
+        public function copyUserAction($id) // RFC-2518
+        {} // "copy_user"            [PATCH] /users/{id}/copy
+
+        public function propfindUserPropsAction($id, $property) // RFC-2518
+        {} // "propfind_user_props"  [PATCH] /users/{id}/props/{property}/propfind
+
+        public function proppatchUserPropsAction($id, $property) // RFC-2518
+        {} // "proppatch_user_props" [PATCH] /users/{id}/props/{property}/proppatch
+
+        public function moveUserAction($id) // RFC-2518
+        {} // "move_user"            [PATCH] /users/{id}/move
+
+        public function mkcolUsersAction() // RFC-2518
+        {} // "mkcol_users"          [GET] /users/mkcol
+
         public function optionsUsersAction()
-        {} // "options_users" [OPTIONS] /users
+        {} // "options_users"        [OPTIONS] /users
 
         public function getUsersAction()
-        {} // "get_users"     [GET] /users
+        {} // "get_users"            [GET] /users
 
         public function newUsersAction()
-        {} // "new_users"     [GET] /users/new
+        {} // "new_users"            [GET] /users/new
 
         public function postUsersAction()
-        {} // "post_users"    [POST] /users
+        {} // "post_users"           [POST] /users
 
         public function patchUsersAction()
-        {} // "patch_users"   [PATCH] /users
+        {} // "patch_users"          [PATCH] /users
 
         public function getUserAction($slug)
-        {} // "get_user"      [GET] /users/{slug}
+        {} // "get_user"             [GET] /users/{slug}
 
         public function editUserAction($slug)
-        {} // "edit_user"     [GET] /users/{slug}/edit
+        {} // "edit_user"            [GET] /users/{slug}/edit
 
         public function putUserAction($slug)
-        {} // "put_user"      [PUT] /users/{slug}
+        {} // "put_user"             [PUT] /users/{slug}
 
         public function patchUserAction($slug)
-        {} // "patch_user"    [PATCH] /users/{slug}
+        {} // "patch_user"           [PATCH] /users/{slug}
 
         public function lockUserAction($slug)
-        {} // "lock_user"     [PATCH] /users/{slug}/lock
+        {} // "lock_user"            [PATCH] /users/{slug}/lock
+
+        public function unlockUserAction($slug)
+        {} // "unlock_user"          [PATCH] /users/{slug}/unlock
 
         public function banUserAction($slug)
-        {} // "ban_user"      [PATCH] /users/{slug}/ban
+        {} // "ban_user"             [PATCH] /users/{slug}/ban
 
         public function removeUserAction($slug)
-        {} // "remove_user"   [GET] /users/{slug}/remove
+        {} // "remove_user"          [GET] /users/{slug}/remove
 
         public function deleteUserAction($slug)
-        {} // "delete_user"   [DELETE] /users/{slug}
+        {} // "delete_user"          [DELETE] /users/{slug}
 
         public function getUserCommentsAction($slug)
         {} // "get_user_comments"    [GET] /users/{slug}/comments

Resources/doc/annotations-reference.rst

@@ -92,7 +92,7 @@ Route
 
 RestBundle extends the `@Route Symfony annotation`_ from Symfony.
 
-@Delete @Get @Head @Link @Patch @Post @Put @Unlink have the same options as @Route.
+@Delete @Get @Head @Link @Patch @Post @Put @Unlink @Lock @Unlock @PropFind @PropPatch @Move @Mkcol @Copy have the same options as @Route.
 
 When using ``symfony/routing:>=2.4`` (or the full framework) you have access to
 the expression language component and can add conditions to your routing

Routing/Loader/Reader/RestActionReader.php

@@ -12,11 +12,11 @@
 namespace FOS\RestBundle\Routing\Loader\Reader;
 
 use Doctrine\Common\Annotations\Reader;
-use Symfony\Component\Routing\Route;
 use FOS\RestBundle\Controller\Annotations\Route as RouteAnnotation;
-use FOS\RestBundle\Util\Inflector\InflectorInterface;
+use FOS\RestBundle\Inflector\InflectorInterface;
 use FOS\RestBundle\Routing\RestRouteCollection;
 use FOS\RestBundle\Request\ParamReader;
+use Symfony\Component\Routing\Route;
 
 /**
  * REST controller actions reader.
@@ -203,6 +203,14 @@ public function read(RestRouteCollection $collection, \ReflectionMethod $method,
 
                 if (!empty($annoMethods)) {
                     $methods = $annoMethods;
+
+                    // workaround for new method annotations that are not supported in method
+                    // names until FOSRestBundle 2.0 for BC reasons (if this check wasn't added
+                    // the method name would have been appended to the generated path)
+                    if (!in_array(strtolower($annotation->getMethod()), $this->availableHTTPMethods)) {
+                        array_pop($urlParts);
+                        $path = implode('/', $urlParts);
+                    }
                 }
 
                 $path = $annotation->getPath() !== null ? $this->routePrefix.$annotation->getPath() : $path;