src/Wallabag/CoreBundle/Controller/WallabagRestController.php

   1 <?php
   2
   3 namespace Wallabag\CoreBundle\Controller;
   4
   5 use Nelmio\ApiDocBundle\Annotation\ApiDoc;
   6 use FOS\RestBundle\Controller\Annotations\View;
   7 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
   8 use Symfony\Component\HttpFoundation\Request;
   9 use Wallabag\CoreBundle\Entity\Entries;
  10 use Wallabag\CoreBundle\Entity\Tags;
  11
  12 class WallabagRestController extends Controller
  13 {
  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         $isArchived = $request->query->get('archive', 0);
  35         $isStarred  = $request->query->get('star', 0);
  36         $isDeleted  = $request->query->get('delete', 0);
  37         $sort       = $request->query->get('sort', 'created');
  38         $order      = $request->query->get('order', 'desc');
  39         $page       = $request->query->get('page', 1);
  40         $perPage    = $request->query->get('perPage', 30);
  41         $tags       = $request->query->get('tags', array());
  42
  43         $entries = $this
  44             ->getDoctrine()
  45             ->getRepository('WallabagCoreBundle:Entries')
  46             ->findEntries(1, (int)$isArchived, (int)$isStarred, (int)$isDeleted, $sort, $order);
  47
  48         if(!is_array($entries)) {
  49             throw $this->createNotFoundException();
  50         }
  51
  52         return $entries;
  53
  54     }
  55
  56     /**
  57      * Retrieve a single entry
  58      *
  59      * @ApiDoc(
  60      *      requirements={
  61      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
  62      *      }
  63      * )
  64      * @return Entries
  65      */
  66     public function getEntryAction(Entries $entry)
  67     {
  68         return $entry;
  69     }
  70
  71     /**
  72      * Create an entry
  73      *
  74      * @ApiDoc(
  75      *       parameters={
  76      *          {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
  77      *          {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
  78      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
  79      *       }
  80      * )
  81      */
  82     public function postEntriesAction()
  83     {
  84
  85     }
  86
  87     /**
  88      * Change several properties of an entry
  89      *
  90      * @ApiDoc(
  91      *      requirements={
  92      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
  93      *      },
  94      *      parameters={
  95      *          {"name"="title", "dataType"="string", "required"=false},
  96      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
  97      *          {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="archived the entry."},
  98      *          {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="starred the entry."},
  99      *          {"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.."},
 100      *       }
 101      * )
 102      */
 103     public function patchEntriesAction(Entries $entry)
 104     {
 105
 106     }
 107
 108     /**
 109      * Delete **permanently** an entry
 110      *
 111      * @ApiDoc(
 112      *      requirements={
 113      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 114      *      }
 115      * )
 116      */
 117     public function deleteEntriesAction(Entries $entry)
 118     {
 119
 120     }
 121
 122
 123     /**
 124      * Retrieve all tags for an entry
 125      *
 126      * @ApiDoc(
 127      *      requirements={
 128      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 129      *      }
 130      * )
 131      */
 132     public function getEntriesTagsAction(Entries $entry) {
 133
 134     }
 135
 136     /**
 137      * Add one or more tags to an entry
 138      *
 139      * @ApiDoc(
 140      *      requirements={
 141      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 142      *      },
 143      *      parameters={
 144      *          {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
 145      *       }
 146      * )
 147      */
 148     public function postEntriesTagsAction(Entries $entry) {
 149
 150     }
 151
 152     /**
 153      * Permanently remove one tag for an entry
 154      *
 155      * @ApiDoc(
 156      *      requirements={
 157      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
 158      *          {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
 159      *      }
 160      * )
 161      */
 162     public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
 163     {
 164
 165     }
 166
 167     /**
 168      * Retrieve all tags
 169      *
 170      * @ApiDoc(
 171      * )
 172      */
 173     public function getTagsAction() {
 174
 175     }
 176
 177     /**
 178      * Retrieve a single tag
 179      *
 180      * @ApiDoc(
 181      *       requirements={
 182      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 183      *       }
 184      * )
 185      */
 186     public function getTagAction(Tags $tag) {
 187
 188     }
 189
 190     /**
 191      * Permanently remove one tag from **every** entry
 192      *
 193      * @ApiDoc(
 194      *      requirements={
 195      *          {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
 196      *      }
 197      * )
 198      */
 199     public function deleteTagAction(Tags $tag)
 200     {
 201
 202     }
 203 }