]> git.immae.eu Git - github/wallabag/wallabag.git/commitdiff
bring annotations to API
authorThomas Citharel <tcit@tcit.fr>
Fri, 18 Mar 2016 15:41:23 +0000 (16:41 +0100)
committerJeremy Benoist <jeremy.benoist@gmail.com>
Sat, 22 Oct 2016 07:06:07 +0000 (09:06 +0200)
src/Wallabag/AnnotationBundle/Controller/WallabagAnnotationController.php
src/Wallabag/ApiBundle/Controller/WallabagRestController.php

index ad083e31c6fa2a29d6852cc6f001b2961e68f815..80ac0035580ab2884aabf9688b4f21acf90d6753 100644 (file)
@@ -15,11 +15,9 @@ class WallabagAnnotationController extends FOSRestController
     /**
      * Retrieve annotations for an entry.
      *
-     * @ApiDoc(
-     *      requirements={
-     *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
-     *      }
-     * )
+     * @param Entry $entry
+     *
+     * @see Wallabag\ApiBundle\Controller\WallabagRestController
      *
      * @return Response
      */
@@ -42,13 +40,7 @@ class WallabagAnnotationController extends FOSRestController
      *
      * @param Entry $entry
      *
-     * @ApiDoc(
-     *      requirements={
-     *          {"name"="ranges", "dataType"="array", "requirement"="\w+", "description"="The range array for the annotation"},
-     *          {"name"="quote", "dataType"="string", "required"=false, "description"="Optional, quote for the annotation"},
-     *          {"name"="text", "dataType"="string", "required"=true, "description"=""},
-     *      }
-     * )
+     * @see Wallabag\ApiBundle\Controller\WallabagRestController
      *
      * @return Response
      */
@@ -81,11 +73,7 @@ class WallabagAnnotationController extends FOSRestController
     /**
      * Updates an annotation.
      *
-     * @ApiDoc(
-     *      requirements={
-     *          {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
-     *      }
-     * )
+     * @see Wallabag\ApiBundle\Controller\WallabagRestController
      *
      * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
      *
@@ -110,11 +98,7 @@ class WallabagAnnotationController extends FOSRestController
     /**
      * Removes an annotation.
      *
-     * @ApiDoc(
-     *      requirements={
-     *          {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
-     *      }
-     * )
+     * @see Wallabag\ApiBundle\Controller\WallabagRestController
      *
      * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
      *
index 3437bb9b96d937d836d3268e5eabcff2c894ad17..6275afa0afc006c4d7b65c17c982d029f56eff34 100644 (file)
@@ -6,12 +6,14 @@ use FOS\RestBundle\Controller\FOSRestController;
 use Hateoas\Configuration\Route as HateoasRoute;
 use Hateoas\Representation\Factory\PagerfantaFactory;
 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use Wallabag\CoreBundle\Entity\Entry;
 use Wallabag\CoreBundle\Entity\Tag;
+use Wallabag\AnnotationBundle\Entity\Annotation;
 
 class WallabagRestController extends FOSRestController
 {
@@ -517,6 +519,136 @@ class WallabagRestController extends FOSRestController
         return (new JsonResponse())->setJson($json);
     }
 
+    /**
+     * Retrieve annotations for an entry.
+     *
+     * @ApiDoc(
+     *      requirements={
+     *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
+     *      }
+     * )
+     *
+     * @return Response
+     */
+    public function getAnnotationsAction(Entry $entry)
+    {
+
+        $this->validateAuthentication();
+
+        $annotationRows = $this
+                ->getDoctrine()
+                ->getRepository('WallabagAnnotationBundle:Annotation')
+                ->findAnnotationsByPageId($entry->getId(), $this->getUser()->getId());
+        $total = count($annotationRows);
+        $annotations = array('total' => $total, 'rows' => $annotationRows);
+
+        $json = $this->get('serializer')->serialize($annotations, 'json');
+
+        return $this->renderJsonResponse($json);
+    }
+
+    /**
+     * Creates a new annotation.
+     *
+     * @param Entry $entry
+     *
+     * @ApiDoc(
+     *      requirements={
+     *          {"name"="ranges", "dataType"="array", "requirement"="\w+", "description"="The range array for the annotation"},
+     *          {"name"="quote", "dataType"="string", "required"=false, "description"="Optional, quote for the annotation"},
+     *          {"name"="text", "dataType"="string", "required"=true, "description"=""},
+     *      }
+     * )
+     *
+     * @return Response
+     */
+    public function postAnnotationAction(Request $request, Entry $entry)
+    {
+        $this->validateAuthentication();
+
+        $data = json_decode($request->getContent(), true);
+
+        $em = $this->getDoctrine()->getManager();
+
+        $annotation = new Annotation($this->getUser());
+
+        $annotation->setText($data['text']);
+        if (array_key_exists('quote', $data)) {
+            $annotation->setQuote($data['quote']);
+        }
+        if (array_key_exists('ranges', $data)) {
+            $annotation->setRanges($data['ranges']);
+        }
+
+        $annotation->setEntry($entry);
+
+        $em->persist($annotation);
+        $em->flush();
+
+        $json = $this->get('serializer')->serialize($annotation, 'json');
+
+        return $this->renderJsonResponse($json);
+    }
+
+    /**
+     * Updates an annotation.
+     *
+     * @ApiDoc(
+     *      requirements={
+     *          {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
+     *      }
+     * )
+     *
+     * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
+     *
+     * @return Response
+     */
+    public function putAnnotationAction(Annotation $annotation, Request $request)
+    {
+
+        $this->validateAuthentication();
+
+        $data = json_decode($request->getContent(), true);
+
+        if (!is_null($data['text'])) {
+            $annotation->setText($data['text']);
+        }
+
+        $em = $this->getDoctrine()->getManager();
+        $em->flush();
+
+        $json = $this->get('serializer')->serialize($annotation, 'json');
+
+        return $this->renderJsonResponse($json);
+    }
+
+    /**
+     * Removes an annotation.
+     *
+     * @ApiDoc(
+     *      requirements={
+     *          {"name"="annotation", "dataType"="string", "requirement"="\w+", "description"="The annotation ID"}
+     *      }
+     * )
+     *
+     * @ParamConverter("annotation", class="WallabagAnnotationBundle:Annotation")
+     *
+     * @return Response
+     */
+    public function deleteAnnotationAction(Annotation $annotation)
+    {
+
+        $this->validateAuthentication();
+
+        $em = $this->getDoctrine()->getManager();
+        $em->remove($annotation);
+        $em->flush();
+
+        $json = $this->get('serializer')->serialize($annotation, 'json');
+
+        return $this->renderJsonResponse($json);
+    }
+
     /**
      * Retrieve version number.
      *