]> git.immae.eu Git - github/wallabag/wallabag.git/blob - src/Wallabag/CoreBundle/Controller/WallabagRestController.php
change delete status for GET /api/entries method
[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Controller / WallabagRestController.php
1 <?php
2
3 namespace Wallabag\CoreBundle\Controller;
4
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;
12
13 class WallabagRestController extends Controller
14 {
15 /**
16 * Retrieve all entries. It could be filtered by many options.
17 *
18 * @ApiDoc(
19 * parameters={
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."},
28 * }
29 * )
30 * @return Entries
31 */
32 public function getEntriesAction(Request $request)
33 {
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());
42
43 $entries = $this
44 ->getDoctrine()
45 ->getRepository('WallabagCoreBundle:Entries')
46 ->findEntries(1, $isArchived, $isStarred, $isDeleted, $sort, $order);
47
48 if (!is_array($entries)) {
49 throw $this->createNotFoundException();
50 }
51
52 return $entries;
53 }
54
55 /**
56 * Retrieve a single entry
57 *
58 * @ApiDoc(
59 * requirements={
60 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
61 * }
62 * )
63 * @return Entries
64 */
65 public function getEntryAction(Entries $entry)
66 {
67 return $entry;
68 }
69
70 /**
71 * Create an entry
72 *
73 * @ApiDoc(
74 * parameters={
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."},
78 * }
79 * )
80 */
81 public function postEntriesAction(Request $request)
82 {
83 //TODO la récup ne marche pas
84 //TODO gérer si on passe le titre
85 //TODO gérer si on passe les tags
86 //TODO ne pas avoir du code comme ça qui doit se trouver dans le Repository
87 $url = $request->request->get('url');
88
89 $content = Extractor::extract($url);
90 $entry = new Entries();
91 $entry->setUserId(1);
92 $entry->setUrl($url);
93 $entry->setTitle($content->getTitle());
94 $entry->setContent($content->getBody());
95 $em = $this->getDoctrine()->getManager();
96 $em->persist($entry);
97 $em->flush();
98
99 return $entry;
100 }
101
102 /**
103 * Change several properties of an entry
104 *
105 * @ApiDoc(
106 * requirements={
107 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
108 * },
109 * parameters={
110 * {"name"="title", "dataType"="string", "required"=false},
111 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
112 * {"name"="archive", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="archived the entry."},
113 * {"name"="star", "dataType"="integer", "required"=false, "format"="'0' or '1', default '0'", "description"="starred the entry."},
114 * {"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 * }
116 * )
117 */
118 public function patchEntriesAction(Entries $entry)
119 {
120 }
121
122 /**
123 * Delete **permanently** an entry
124 *
125 * @ApiDoc(
126 * requirements={
127 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
128 * }
129 * )
130 */
131 public function deleteEntriesAction(Entries $entry)
132 {
133 if ($entry->isDeleted()) {
134 throw new NotFoundHttpException('This entry is already deleted');
135 }
136
137 $em = $this->getDoctrine()->getManager();
138 $entry->setDeleted(1);
139 $em->persist($entry);
140 $em->flush();
141
142 return $entry;
143 }
144
145 /**
146 * Retrieve all tags for an entry
147 *
148 * @ApiDoc(
149 * requirements={
150 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
151 * }
152 * )
153 */
154 public function getEntriesTagsAction(Entries $entry)
155 {
156 }
157
158 /**
159 * Add one or more tags to an entry
160 *
161 * @ApiDoc(
162 * requirements={
163 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
164 * },
165 * parameters={
166 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
167 * }
168 * )
169 */
170 public function postEntriesTagsAction(Entries $entry)
171 {
172 }
173
174 /**
175 * Permanently remove one tag for an entry
176 *
177 * @ApiDoc(
178 * requirements={
179 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
180 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
181 * }
182 * )
183 */
184 public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
185 {
186 }
187
188 /**
189 * Retrieve all tags
190 *
191 * @ApiDoc(
192 * )
193 */
194 public function getTagsAction()
195 {
196 }
197
198 /**
199 * Retrieve a single tag
200 *
201 * @ApiDoc(
202 * requirements={
203 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
204 * }
205 * )
206 */
207 public function getTagAction(Tags $tag)
208 {
209 }
210
211 /**
212 * Permanently remove one tag from **every** entry
213 *
214 * @ApiDoc(
215 * requirements={
216 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
217 * }
218 * )
219 */
220 public function deleteTagAction(Tags $tag)
221 {
222 }
223 }