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\HttpKernel\Exception\NotFoundHttpException
;
9 use Wallabag\CoreBundle\Entity\Entry
;
10 use Wallabag\CoreBundle\Entity\Tags
;
11 use Wallabag\CoreBundle\Entity\User
;
12 use Wallabag\CoreBundle\Service\Extractor
;
14 class WallabagRestController
extends Controller
17 * Retrieve salt for a giver user.
21 * {"name"="username", "dataType"="string", "required"=true, "description"="username"}
26 public function getSaltAction($username)
30 ->getRepository('WallabagCoreBundle:User')
31 ->findOneByUsername($username);
34 throw $this->createNotFoundException();
37 return $user->getSalt();
40 * Retrieve all entries. It could be filtered by many options.
44 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
45 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
46 * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted status."},
47 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
48 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
49 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
50 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
51 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
56 public function getEntriesAction(Request
$request)
58 $isArchived = $request->query
->get('archive');
59 $isStarred = $request->query
->get('star');
60 $isDeleted = $request->query
->get('delete', 0);
61 $sort = $request->query
->get('sort', 'created');
62 $order = $request->query
->get('order', 'desc');
63 $page = $request->query
->get('page', 1);
64 $perPage = $request->query
->get('perPage', 30);
65 $tags = $request->query
->get('tags', array());
69 ->getRepository('WallabagCoreBundle:Entry')
70 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order);
72 if (!is_array($entries)) {
73 throw $this->createNotFoundException();
80 * Retrieve a single entry
84 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
89 public function getEntryAction(Entry
$entry)
99 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
100 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
101 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
106 public function postEntriesAction(Request
$request)
108 //TODO gérer si on passe les tags
109 $url = $request->request
->get('url');
111 $content = Extractor
::extract($url);
112 $entry = new Entry($this->getUser()->getId());
113 $entry->setUrl($url);
114 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
115 $entry->setContent($content->getBody());
116 $em = $this->getDoctrine()->getManager();
117 $em->persist($entry);
124 * Change several properties of an entry
128 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
131 * {"name"="title", "dataType"="string", "required"=false},
132 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
133 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
134 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
135 * {"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.."},
140 public function patchEntriesAction(Entry
$entry, Request
$request)
142 $title = $request->request
->get("title");
143 $tags = $request->request
->get("tags", array());
144 $isArchived = $request->request
->get("archive");
145 $isDeleted = $request->request
->get("delete");
146 $isStarred = $request->request
->get("star");
148 if (!is_null($title)) {
149 $entry->setTitle($title);
152 if (!is_null($isArchived)) {
153 $entry->setArchived($isArchived);
156 if (!is_null($isDeleted)) {
157 $entry->setDeleted($isDeleted);
160 if (!is_null($isStarred)) {
161 $entry->setStarred($isStarred);
164 $em = $this->getDoctrine()->getManager();
171 * Delete **permanently** an entry
175 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
180 public function deleteEntriesAction(Entry
$entry)
182 if ($entry->isDeleted()) {
183 throw new NotFoundHttpException('This entry is already deleted');
186 $em = $this->getDoctrine()->getManager();
187 $entry->setDeleted(1);
194 * Retrieve all tags for an entry
198 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
202 public function getEntriesTagsAction(Entry
$entry)
207 * Add one or more tags to an entry
211 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
214 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
218 public function postEntriesTagsAction(Entry
$entry)
223 * Permanently remove one tag for an entry
227 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
228 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
232 public function deleteEntriesTagsAction(Entry
$entry, Tags
$tag)
242 public function getTagsAction()
247 * Retrieve a single tag
251 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
255 public function getTagAction(Tags
$tag)
260 * Permanently remove one tag from **every** entry
264 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
268 public function deleteTagAction(Tags
$tag)