src/Wallabag/CoreBundle/Controller/WallabagRestController.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Controller;
   4
   5 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
   6 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
   7 use Symfony\Component\HttpFoundation\Request;
   8 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
   9 use Wallabag\CoreBundle\Entity\Entries;
  10 use Wallabag\CoreBundle\Entity\Tags;
  11 use Wallabag\CoreBundle\Service\Extractor;
  12
  13 class WallabagRestController extends Controller
  14 {
  15     /**
  16      * Retrieve all entries. It could be filtered by many options.
  17      *
  18      * @ApiDoc(
  19      *       parameters={
  20      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="filter by archived status."},
  21      *          {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="filter by starred status."},
  22      *          {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="filter by deleted status."},
  23      *          {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
  24      *          {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
  25      *          {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
  26      *          {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
  27      *          {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
  28      *       }
  29      * )
  30      * @return Entries
  31      */
  32     public function getEntriesAction(Request $request)
  33     {
  34         // TODO isArchived, isStarred et isDeleted ne doivent pas avoir de valeur par défaut
  35         // TODO Si on ne passe rien, on ne filtre pas sur le statut.
  36         $isArchived = $request->query->get('archive');
  37         $isStarred  = $request->query->get('star');
  38         $isDeleted  = $request->query->get('delete');
  39         $sort       = $request->query->get('sort', 'created');
  40         $order      = $request->query->get('order', 'desc');
  41         $page       = $request->query->get('page', 1);
  42         $perPage    = $request->query->get('perPage', 30);
  43         $tags       = $request->query->get('tags', array());
  44
  45         $entries = $this
  46             ->getDoctrine()
  47             ->getRepository('WallabagCoreBundle:Entries')
  48             ->findEntries(1, $isArchived, $isStarred, $isDeleted, $sort, $order);
  49
  50         if (!is_array($entries)) {
  51             throw $this->createNotFoundException();
  52         }
  53
  54         return $entries;
  55     }
  56
  57     /**
  58      * Retrieve a single entry
  59      *
  60      * @ApiDoc(
  61      *      requirements={
  62      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
  63      *      }
  64      * )
  65      * @return Entries
  66      */
  67     public function getEntryAction(Entries $entry)
  68     {
  69         return $entry;
  70     }
  71
  72     /**
  73      * Create an entry
  74      *
  75      * @ApiDoc(
  76      *       parameters={
  77      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
  78      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
  79      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
  80      *       }
  81      * )
  82      */
  83     public function postEntriesAction(Request $request)
  84     {
  85         //TODO la récup ne marche pas
  86         //TODO gérer si on passe le titre
  87         //TODO gérer si on passe les tags
  88         //TODO ne pas avoir du code comme ça qui doit se trouver dans le Repository
  89         $url = $request->request->get('url');
  90
  91         $content = Extractor::extract($url);
  92         $entry = new Entries();
  93         $entry->setUserId(1);
  94         $entry->setUrl($url);
  95         $entry->setTitle($content->getTitle());
  96         $entry->setContent($content->getBody());
  97         $em = $this->getDoctrine()->getManager();
  98         $em->persist($entry);
  99         $em->flush();
 100
 101         return $entry;
 102     }
 103
 104     /**
 105      * Change several properties of an entry
 106      *
 107      * @ApiDoc(
 108      *      requirements={
 109      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 110      *      },
 111      *      parameters={
 112      *          {"name"="title", "dataType"="string", "required"=false},
 113      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 114      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="archived the entry."},
 115      *          {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="starred the entry."},
 116      *          {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
 117      *       }
 118      * )
 119      */
 120     public function patchEntriesAction(Entries $entry)
 121     {
 122     }
 123
 124     /**
 125      * Delete **permanently** an entry
 126      *
 127      * @ApiDoc(
 128      *      requirements={
 129      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 130      *      }
 131      * )
 132      */
 133     public function deleteEntriesAction(Entries $entry)
 134     {
 135         if ($entry->isDeleted()) {
 136             throw new NotFoundHttpException('This entry is already deleted');
 137         }
 138
 139         $em = $this->getDoctrine()->getManager();
 140         $entry->setDeleted(1);
 141         $em->persist($entry);
 142         $em->flush();
 143
 144         return $entry;
 145     }
 146
 147     /**
 148      * Retrieve all tags for an entry
 149      *
 150      * @ApiDoc(
 151      *      requirements={
 152      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 153      *      }
 154      * )
 155      */
 156     public function getEntriesTagsAction(Entries $entry)
 157     {
 158     }
 159
 160     /**
 161      * Add one or more tags to an entry
 162      *
 163      * @ApiDoc(
 164      *      requirements={
 165      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 166      *      },
 167      *      parameters={
 168      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 169      *       }
 170      * )
 171      */
 172     public function postEntriesTagsAction(Entries $entry)
 173     {
 174     }
 175
 176     /**
 177      * Permanently remove one tag for an entry
 178      *
 179      * @ApiDoc(
 180      *      requirements={
 181      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 182      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 183      *      }
 184      * )
 185      */
 186     public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
 187     {
 188     }
 189
 190     /**
 191      * Retrieve all tags
 192      *
 193      * @ApiDoc(
 194      * )
 195      */
 196     public function getTagsAction()
 197     {
 198     }
 199
 200     /**
 201      * Retrieve a single tag
 202      *
 203      * @ApiDoc(
 204      *       requirements={
 205      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 206      *       }
 207      * )
 208      */
 209     public function getTagAction(Tags $tag)
 210     {
 211     }
 212
 213     /**
 214      * Permanently remove one tag from **every** entry
 215      *
 216      * @ApiDoc(
 217      *      requirements={
 218      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 219      *      }
 220      * )
 221      */
 222     public function deleteTagAction(Tags $tag)
 223     {
 224     }
 225 }