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\Entries
;
10 use Wallabag\CoreBundle\Entity\Tags
;
11 use Wallabag\CoreBundle\Service\Extractor
;
13 class WallabagRestController
extends Controller
16 * Retrieve all entries. It could be filtered by many options.
20 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by archived status."},
21 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false, all entries by default", "description"="filter by starred status."},
22 * {"name"="delete", "dataType"="boolean", "required"=false, "format"="true or false, 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."},
32 public function getEntriesAction(Request
$request)
34 $isArchived = $request->query
->get('archive');
35 $isStarred = $request->query
->get('star');
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());
45 ->getRepository('WallabagCoreBundle:Entries')
46 ->findEntries(1, $isArchived, $isStarred, $isDeleted, $sort, $order);
48 if (!is_array($entries)) {
49 throw $this->createNotFoundException();
56 * Retrieve a single entry
60 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
65 public function getEntryAction(Entries
$entry)
75 * {"name"="url", "dataType"="string", "required"=true, "format"="http://www.test.com/article.html", "description"="Url for the entry."},
76 * {"name"="title", "dataType"="string", "required"=false, "description"="Optional, we'll get the title from the page."},
77 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
81 public function postEntriesAction(Request
$request)
83 //TODO gérer si on passe les tags
84 $url = $request->request
->get('url');
86 $content = Extractor
::extract($url);
87 $entry = new Entries();
90 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
91 $entry->setContent($content->getBody());
92 $em = $this->getDoctrine()->getManager();
100 * Change several properties of an entry
104 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
107 * {"name"="title", "dataType"="string", "required"=false},
108 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
109 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
110 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
111 * {"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.."},
115 public function patchEntriesAction(Entries
$entry, Request
$request)
117 $title = $request->request
->get("title");
118 $tags = $request->request
->get("tags", array());
119 $isArchived = $request->request
->get("archive");
120 $isDeleted = $request->request
->get("delete");
121 $isStarred = $request->request
->get("star");
123 if (!is_null($title)) {
124 $entry->setTitle($title);
127 if (!is_null($isArchived)) {
128 $entry->setArchived($isArchived);
131 if (!is_null($isDeleted)) {
132 $entry->setDeleted($isDeleted);
135 if (!is_null($isStarred)) {
136 $entry->setStarred($isStarred);
139 $em = $this->getDoctrine()->getManager();
146 * Delete **permanently** an entry
150 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
154 public function deleteEntriesAction(Entries
$entry)
156 if ($entry->isDeleted()) {
157 throw new NotFoundHttpException('This entry is already deleted');
160 $em = $this->getDoctrine()->getManager();
161 $entry->setDeleted(1);
168 * Retrieve all tags for an entry
172 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
176 public function getEntriesTagsAction(Entries
$entry)
181 * Add one or more tags to an entry
185 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
188 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
192 public function postEntriesTagsAction(Entries
$entry)
197 * Permanently remove one tag for an entry
201 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
202 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
206 public function deleteEntriesTagsAction(Entries
$entry, Tags
$tag)
216 public function getTagsAction()
221 * Retrieve a single tag
225 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
229 public function getTagAction(Tags
$tag)
234 * Permanently remove one tag from **every** entry
238 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
242 public function deleteTagAction(Tags
$tag)