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\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:Entry')
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(Entry
$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."},
82 public function postEntriesAction(Request
$request)
84 //TODO gérer si on passe les tags
85 $url = $request->request
->get('url');
87 $content = Extractor
::extract($url);
91 $entry->setTitle($request->request
->get('title') ?: $content->getTitle());
92 $entry->setContent($content->getBody());
93 $em = $this->getDoctrine()->getManager();
101 * Change several properties of an entry
105 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
108 * {"name"="title", "dataType"="string", "required"=false},
109 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
110 * {"name"="archive", "dataType"="boolean", "required"=false, "format"="true or false", "description"="archived the entry."},
111 * {"name"="star", "dataType"="boolean", "required"=false, "format"="true or false", "description"="starred the entry."},
112 * {"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.."},
117 public function patchEntriesAction(Entry
$entry, Request
$request)
119 $title = $request->request
->get("title");
120 $tags = $request->request
->get("tags", array());
121 $isArchived = $request->request
->get("archive");
122 $isDeleted = $request->request
->get("delete");
123 $isStarred = $request->request
->get("star");
125 if (!is_null($title)) {
126 $entry->setTitle($title);
129 if (!is_null($isArchived)) {
130 $entry->setArchived($isArchived);
133 if (!is_null($isDeleted)) {
134 $entry->setDeleted($isDeleted);
137 if (!is_null($isStarred)) {
138 $entry->setStarred($isStarred);
141 $em = $this->getDoctrine()->getManager();
148 * Delete **permanently** an entry
152 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
157 public function deleteEntriesAction(Entry
$entry)
159 if ($entry->isDeleted()) {
160 throw new NotFoundHttpException('This entry is already deleted');
163 $em = $this->getDoctrine()->getManager();
164 $entry->setDeleted(1);
171 * Retrieve all tags for an entry
175 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
179 public function getEntriesTagsAction(Entry
$entry)
184 * Add one or more tags to an entry
188 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
191 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
195 public function postEntriesTagsAction(Entry
$entry)
200 * Permanently remove one tag for an entry
204 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
205 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
209 public function deleteEntriesTagsAction(Entry
$entry, Tags
$tag)
219 public function getTagsAction()
224 * Retrieve a single tag
228 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
232 public function getTagAction(Tags
$tag)
237 * Permanently remove one tag from **every** entry
241 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
245 public function deleteTagAction(Tags
$tag)