]> git.immae.eu Git - github/wallabag/wallabag.git/blame - src/Wallabag/CoreBundle/Controller/WallabagRestController.php
we can now set a title to the article when we use POST /api/entries
[github/wallabag/wallabag.git] / src / Wallabag / CoreBundle / Controller / WallabagRestController.php
CommitLineData
f8bf8952
NL
1<?php
2
3namespace Wallabag\CoreBundle\Controller;
4
5use Nelmio\ApiDocBundle\Annotation\ApiDoc;
f8bf8952 6use Symfony\Bundle\FrameworkBundle\Controller\Controller;
27f15aa4 7use Symfony\Component\HttpFoundation\Request;
42a90646 8use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
f8bf8952
NL
9use Wallabag\CoreBundle\Entity\Entries;
10use Wallabag\CoreBundle\Entity\Tags;
843dbe51 11use Wallabag\CoreBundle\Service\Extractor;
f8bf8952 12
a8c90c5c 13class WallabagRestController extends Controller
f8bf8952 14{
f8bf8952 15 /**
a8c90c5c 16 * Retrieve all entries. It could be filtered by many options.
f8bf8952
NL
17 *
18 * @ApiDoc(
a8c90c5c 19 * parameters={
6079aaa3
NL
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."},
a8c90c5c
NL
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 * }
f8bf8952
NL
29 * )
30 * @return Entries
31 */
27f15aa4 32 public function getEntriesAction(Request $request)
f8bf8952 33 {
6e334aba
NL
34 $isArchived = $request->query->get('archive');
35 $isStarred = $request->query->get('star');
6079aaa3 36 $isDeleted = $request->query->get('delete', 0);
a8c90c5c
NL
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')
6e334aba 46 ->findEntries(1, $isArchived, $isStarred, $isDeleted, $sort, $order);
a8c90c5c 47
7df80cb3 48 if (!is_array($entries)) {
a8c90c5c
NL
49 throw $this->createNotFoundException();
50 }
51
52 return $entries;
f8bf8952
NL
53 }
54
55 /**
a8c90c5c 56 * Retrieve a single entry
f8bf8952
NL
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 /**
a8c90c5c 71 * Create an entry
f8bf8952
NL
72 *
73 * @ApiDoc(
a8c90c5c
NL
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 * }
f8bf8952
NL
79 * )
80 */
843dbe51 81 public function postEntriesAction(Request $request)
f8bf8952 82 {
843dbe51 83 //TODO gérer si on passe les tags
c3235553
NL
84 $url = $request->request->get('url');
85
86 $content = Extractor::extract($url);
843dbe51
NL
87 $entry = new Entries();
88 $entry->setUserId(1);
c3235553 89 $entry->setUrl($url);
77bb7b92 90 $entry->setTitle(!is_null($request->request->get('title')) ? $request->request->get('title') : $content->getTitle());
843dbe51 91 $entry->setContent($content->getBody());
843dbe51
NL
92 $em = $this->getDoctrine()->getManager();
93 $em->persist($entry);
94 $em->flush();
95
96 return $entry;
f8bf8952
NL
97 }
98
99 /**
a8c90c5c 100 * Change several properties of an entry
f8bf8952
NL
101 *
102 * @ApiDoc(
103 * requirements={
104 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
a8c90c5c
NL
105 * },
106 * parameters={
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.."},
112 * }
f8bf8952
NL
113 * )
114 */
115 public function patchEntriesAction(Entries $entry)
116 {
f8bf8952
NL
117 }
118
119 /**
a8c90c5c 120 * Delete **permanently** an entry
f8bf8952
NL
121 *
122 * @ApiDoc(
a8c90c5c
NL
123 * requirements={
124 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
125 * }
f8bf8952
NL
126 * )
127 */
a8c90c5c 128 public function deleteEntriesAction(Entries $entry)
f8bf8952 129 {
42a90646
NL
130 if ($entry->isDeleted()) {
131 throw new NotFoundHttpException('This entry is already deleted');
132 }
133
134 $em = $this->getDoctrine()->getManager();
135 $entry->setDeleted(1);
136 $em->persist($entry);
137 $em->flush();
138
139 return $entry;
f8bf8952
NL
140 }
141
142 /**
a8c90c5c 143 * Retrieve all tags for an entry
f8bf8952
NL
144 *
145 * @ApiDoc(
146 * requirements={
147 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
148 * }
149 * )
150 */
7df80cb3
J
151 public function getEntriesTagsAction(Entries $entry)
152 {
f8bf8952
NL
153 }
154
155 /**
a8c90c5c 156 * Add one or more tags to an entry
f8bf8952
NL
157 *
158 * @ApiDoc(
159 * requirements={
160 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
a8c90c5c
NL
161 * },
162 * parameters={
163 * {"name"="tags", "dataType"="string", "required"=false, "format"="tag1,tag2,tag3", "description"="a comma-separated list of tags."},
164 * }
f8bf8952
NL
165 * )
166 */
7df80cb3
J
167 public function postEntriesTagsAction(Entries $entry)
168 {
f8bf8952
NL
169 }
170
171 /**
a8c90c5c 172 * Permanently remove one tag for an entry
f8bf8952
NL
173 *
174 * @ApiDoc(
175 * requirements={
176 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"},
177 * {"name"="entry", "dataType"="integer", "requirement"="\w+", "description"="The entry ID"}
178 * }
179 * )
180 */
181 public function deleteEntriesTagsAction(Entries $entry, Tags $tag)
182 {
f8bf8952
NL
183 }
184
185 /**
a8c90c5c 186 * Retrieve all tags
f8bf8952
NL
187 *
188 * @ApiDoc(
189 * )
190 */
7df80cb3
J
191 public function getTagsAction()
192 {
f8bf8952
NL
193 }
194
195 /**
a8c90c5c 196 * Retrieve a single tag
f8bf8952
NL
197 *
198 * @ApiDoc(
a8c90c5c 199 * requirements={
f8bf8952 200 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
a8c90c5c 201 * }
f8bf8952
NL
202 * )
203 */
7df80cb3
J
204 public function getTagAction(Tags $tag)
205 {
f8bf8952
NL
206 }
207
208 /**
a8c90c5c 209 * Permanently remove one tag from **every** entry
f8bf8952
NL
210 *
211 * @ApiDoc(
212 * requirements={
213 * {"name"="tag", "dataType"="string", "requirement"="\w+", "description"="The tag"}
214 * }
215 * )
216 */
217 public function deleteTagAction(Tags $tag)
218 {
f8bf8952 219 }
7df80cb3 220}