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"="integer", "required"=false, "format"="'0' or '1', all entries by default", "description"="filter by archived status."},
21 * {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', all entries by default", "description"="filter by starred status."},
22 * {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', 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(!is_null($request->request
->get('title')) ? $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"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="archived the entry."},
110 * {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="starred the entry."},
111 * {"name"="delete", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="flag as deleted. Default false. In case that you don't want to *really* remove it.."},
115 public function patchEntriesAction(Entries
$entry)
120 * Delete **permanently** an entry
124 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
128 public function deleteEntriesAction(Entries
$entry)
130 if ($entry->isDeleted()) {
131 throw new NotFoundHttpException('This entry is already deleted');
134 $em = $this->getDoctrine()->getManager();
135 $entry->setDeleted(1);
136 $em->persist($entry);
143 * Retrieve all tags for an entry
147 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
151 public function getEntriesTagsAction(Entries
$entry)
156 * Add one or more tags to an entry
160 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
163 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
167 public function postEntriesTagsAction(Entries
$entry)
172 * Permanently remove one tag for an entry
176 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
177 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
181 public function deleteEntriesTagsAction(Entries
$entry, Tags
$tag)
191 public function getTagsAction()
196 * Retrieve a single tag
200 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
204 public function getTagAction(Tags
$tag)
209 * Permanently remove one tag from **every** entry
213 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
217 public function deleteTagAction(Tags
$tag)