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 Wallabag\CoreBundle\Entity\Entry
;
10 use Wallabag\CoreBundle\Entity\Tag
;
11 use Wallabag\CoreBundle\Service\Extractor
;
13 class WallabagRestController
extends Controller
16 * Retrieve salt for a giver user.
20 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
25 public function getSaltAction($username)
29 ->getRepository('WallabagCoreBundle:User')
30 ->findOneByUsername($username);
33 throw $this->createNotFoundException();
36 return array($user->getSalt() ?: null);
39 * Retrieve all entries. It could be filtered by many options.
43 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
44 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
45 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
46 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
47 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
48 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
49 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
54 public function getEntriesAction(Request
$request)
56 $isArchived = $request->query
->get('archive');
57 $isStarred = $request->query
->get('star');
58 $sort = $request->query
->get('sort', 'created');
59 $order = $request->query
->get('order', 'desc');
60 $page = $request->query
->get('page', 1);
61 $perPage = $request->query
->get('perPage', 30);
62 $tags = $request->query
->get('tags', array());
66 ->getRepository('WallabagCoreBundle:Entry')
67 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $sort, $order);
70 throw $this->createNotFoundException();
73 $json = $this->get('serializer')->serialize($entries, 'json');
75 return new Response($json, 200, array('application/json'));
79 * Retrieve a single entry
83 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
88 public function getEntryAction(Entry
$entry)
90 $json = $this->get('serializer')->serialize($entry, 'json');
92 return new Response($json, 200, array('application/json'));
100 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
101 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
102 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
107 public function postEntriesAction(Request
$request)
109 //TODO gérer si on passe les tags
110 $url = $request->request
->get('url');
112 $content = Extractor
::extract($url);
113 $entry = new Entry($this->getUser());
114 $entry->setUrl($url);
115 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
116 $entry->setContent($content->getBody());
117 $em = $this->getDoctrine()->getManager();
118 $em->persist($entry);
121 $json = $this->get('serializer')->serialize($entry, 'json');
123 return new Response($json, 200, array('application/json'));
127 * Change several properties of an entry
131 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
134 * {"name"="title", "dataType"="string", "required"=false},
135 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
136 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
137 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
142 public function patchEntriesAction(Entry
$entry, Request
$request)
144 $title = $request->request
->get("title");
145 $tags = $request->request
->get("tags", array());
146 $isArchived = $request->request
->get("archive");
147 $isStarred = $request->request
->get("star");
149 if (!is_null($title)) {
150 $entry->setTitle($title);
153 if (!is_null($isArchived)) {
154 $entry->setArchived($isArchived);
157 if (!is_null($isStarred)) {
158 $entry->setStarred($isStarred);
161 $em = $this->getDoctrine()->getManager();
168 * Delete **permanently** an entry
172 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
177 public function deleteEntriesAction(Entry
$entry)
179 $em = $this->getDoctrine()->getManager();
183 $json = $this->get('serializer')->serialize($entry, 'json');
185 return new Response($json, 200, array('application/json'));
189 * Retrieve all tags for an entry
193 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
197 public function getEntriesTagsAction(Entry
$entry)
199 $json = $this->get('serializer')->serialize($entry->getTags(), 'json');
201 return new Response($json, 200, array('application/json'));
205 * Add one or more tags to an entry
209 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
212 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
216 public function postEntriesTagsAction(Entry
$entry)
221 * Permanently remove one tag for an entry
225 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
226 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
230 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
238 * {"name"="user", "dataType"="integer", "requirement"="\w+", "description"="The user ID"}
241 public function getTagsUserAction()
246 * Permanently remove one tag from **every** entry
250 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
254 public function deleteTagAction(Tag
$tag)