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\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());
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"="delete", "dataType"="boolean", "required"=false, "format"="true or false, default '0'", "description"="filter by deleted status."},
46 * {"name"="sort", "dataType"="string", "required"=false, "format"="'created' or 'updated', default 'created'", "description"="sort entries by date."},
47 * {"name"="order", "dataType"="string", "required"=false, "format"="'asc' or 'desc', default 'desc'", "description"="order of sort."},
48 * {"name"="page", "dataType"="integer", "required"=false, "format"="default '1'", "description"="what page you want."},
49 * {"name"="perPage", "dataType"="integer", "required"=false, "format"="default'30'", "description"="results per page."},
50 * {"name"="tags", "dataType"="string", "required"=false, "format"="api%2Crest", "description"="a list of tags url encoded. Will returns entries that matches ALL tags."},
55 public function getEntriesAction(Request
$request)
57 $isArchived = $request->query
->get('archive');
58 $isStarred = $request->query
->get('star');
59 $isDeleted = $request->query
->get('delete', 0);
60 $sort = $request->query
->get('sort', 'created');
61 $order = $request->query
->get('order', 'desc');
62 $page = $request->query
->get('page', 1);
63 $perPage = $request->query
->get('perPage', 30);
64 $tags = $request->query
->get('tags', array());
68 ->getRepository('WallabagCoreBundle:Entry')
69 ->findEntries($this->getUser()->getId(), $isArchived, $isStarred, $isDeleted, $sort, $order);
72 throw $this->createNotFoundException();
79 * Retrieve a single entry
83 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
88 public function getEntryAction(Entry
$entry)
98 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
99 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
100 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
105 public function postEntriesAction(Request
$request)
107 //TODO gérer si on passe les tags
108 $url = $request->request
->get('url');
110 $content = Extractor
::extract($url);
111 $entry = new Entry($this->getUser());
112 $entry->setUrl($url);
113 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
114 $entry->setContent($content->getBody());
115 $em = $this->getDoctrine()->getManager();
116 $em->persist($entry);
123 * Change several properties of an entry
127 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
130 * {"name"="title", "dataType"="string", "required"=false},
131 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
132 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
133 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
134 * {"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.."},
139 public function patchEntriesAction(Entry
$entry, Request
$request)
141 $title = $request->request
->get("title");
142 $tags = $request->request
->get("tags", array());
143 $isArchived = $request->request
->get("archive");
144 $isDeleted = $request->request
->get("delete");
145 $isStarred = $request->request
->get("star");
147 if (!is_null($title)) {
148 $entry->setTitle($title);
151 if (!is_null($isArchived)) {
152 $entry->setArchived($isArchived);
155 if (!is_null($isDeleted)) {
156 $entry->setDeleted($isDeleted);
159 if (!is_null($isStarred)) {
160 $entry->setStarred($isStarred);
163 $em = $this->getDoctrine()->getManager();
170 * Delete **permanently** an entry
174 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
179 public function deleteEntriesAction(Entry
$entry)
181 if ($entry->isDeleted()) {
182 throw new NotFoundHttpException('This entry is already deleted');
185 $em = $this->getDoctrine()->getManager();
186 $entry->setDeleted(1);
193 * Retrieve all tags for an entry
197 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
201 public function getEntriesTagsAction(Entry
$entry)
206 * Add one or more tags to an entry
210 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
213 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
217 public function postEntriesTagsAction(Entry
$entry)
222 * Permanently remove one tag for an entry
226 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
227 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
231 public function deleteEntriesTagsAction(Entry
$entry, Tag
$tag)
241 public function getTagsAction()
246 * Retrieve a single tag
250 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
254 public function getTagAction(Tag
$tag)
259 * Permanently remove one tag from **every** entry
263 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
267 public function deleteTagAction(Tag
$tag)