3 namespace Wallabag\CoreBundle\Controller
;
5 use Nelmio\ApiDocBundle\Annotation\ApiDoc
;
6 use Symfony\Bundle\FrameworkBundle\Controller\Controller
;
7 use Symfony\Component\HttpFoundation\Request
;
8 use Symfony\Component\HttpFoundation\Response
;
9 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException
;
10 use Wallabag\CoreBundle\Entity\Entry
;
11 use Wallabag\CoreBundle\Entity\Tag
;
12 use Wallabag\CoreBundle\Service\Extractor
;
13 use Hateoas\HateoasBuilder
;
15 class WallabagRestController
extends Controller
18 * Retrieve salt for a giver user.
22 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
27 public function getSaltAction($username)
31 ->getRepository('WallabagCoreBundle:User')
32 ->findOneByUsername($username);
35 throw $this->createNotFoundException();
38 return array($user->getSalt() ?: null);
41 * Retrieve all entries. It could be filtered by many options.
45 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
46 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
47 * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted status."},
48 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
49 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
50 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
51 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
52 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
57 public function getEntriesAction(Request
$request)
59 $isArchived = $request->query
->get('archive');
60 $isStarred = $request->query
->get('star');
61 $isDeleted = $request->query
->get('delete', 0);
62 $sort = $request->query
->get('sort', 'created');
63 $order = $request->query
->get('order', 'desc');
64 $page = $request->query
->get('page', 1);
65 $perPage = $request->query
->get('perPage', 30);
66 $tags = $request->query
->get('tags', array());
70 ->getRepository('WallabagCoreBundle:Entry')
71 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order);
74 throw $this->createNotFoundException();
77 $hateoas = HateoasBuilder
::create()->build();
78 $json = $hateoas->serialize($entries, 'json');
80 return new Response($json, 200, array('application/json'));
84 * Retrieve a single entry
88 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
93 public function getEntryAction(Entry
$entry)
95 $hateoas = HateoasBuilder
::create()->build();
96 $json = $hateoas->serialize($entry, 'json');
98 return new Response($json, 200, array('application/json'));
106 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
107 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
108 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
113 public function postEntriesAction(Request
$request)
115 //TODO gérer si on passe les tags
116 $url = $request->request
->get('url');
118 $content = Extractor
::extract($url);
119 $entry = new Entry($this->getUser());
120 $entry->setUrl($url);
121 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
122 $entry->setContent($content->getBody());
123 $em = $this->getDoctrine()->getManager();
124 $em->persist($entry);
131 * Change several properties of an entry
135 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
138 * {"name"="title", "dataType"="string", "required"=false},
139 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
140 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
141 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
142 * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
147 public function patchEntriesAction(Entry
$entry, Request
$request)
149 $title = $request->request
->get("title");
150 $tags = $request->request
->get("tags", array());
151 $isArchived = $request->request
->get("archive");
152 $isDeleted = $request->request
->get("delete");
153 $isStarred = $request->request
->get("star");
155 if (!is_null($title)) {
156 $entry->setTitle($title);
159 if (!is_null($isArchived)) {
160 $entry->setArchived($isArchived);
163 if (!is_null($isDeleted)) {
164 $entry->setDeleted($isDeleted);
167 if (!is_null($isStarred)) {
168 $entry->setStarred($isStarred);
171 $em = $this->getDoctrine()->getManager();
178 * Delete **permanently** an entry
182 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
187 public function deleteEntriesAction(Entry
$entry)
189 if ($entry->isDeleted()) {
190 throw new NotFoundHttpException('This entry is already deleted');
193 $em = $this->getDoctrine()->getManager();
194 $entry->setDeleted(1);
201 * Retrieve all tags for an entry
205 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
209 public function getEntriesTagsAction(Entry
$entry)
214 * Add one or more tags to an entry
218 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
221 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
225 public function postEntriesTagsAction(Entry
$entry)
230 * Permanently remove one tag for an entry
234 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
235 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
239 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
249 public function getTagsAction()
254 * Retrieve a single tag
258 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
262 public function getTagAction(Tag
$tag)
267 * Permanently remove one tag from **every** entry
271 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
275 public function deleteTagAction(Tag
$tag)