2015-01-29 15:56:58 +00:00
< ? php
namespace Wallabag\CoreBundle\Controller ;
use Nelmio\ApiDocBundle\Annotation\ApiDoc ;
use FOS\RestBundle\Controller\Annotations\View ;
use Symfony\Bundle\FrameworkBundle\Controller\Controller ;
2015-01-29 19:32:11 +00:00
use Symfony\Component\HttpFoundation\Request ;
2015-01-29 15:56:58 +00:00
use Wallabag\CoreBundle\Entity\Entries ;
use Wallabag\CoreBundle\Entity\Tags ;
2015-01-30 08:05:54 +00:00
use Wallabag\CoreBundle\Service\Extractor ;
2015-01-29 15:56:58 +00:00
2015-01-30 06:50:52 +00:00
class WallabagRestController extends Controller
2015-01-29 15:56:58 +00:00
{
/**
2015-01-30 06:50:52 +00:00
* Retrieve all entries . It could be filtered by many options .
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* parameters = {
* { " name " = " archive " , " dataType " = " integer " , " required " = false , " format " = " '0' or '1', default '0' " , " description " = " filter by archived status. " },
* { " name " = " star " , " dataType " = " integer " , " required " = false , " format " = " '0' or '1', default '0' " , " description " = " filter by starred status. " },
* { " name " = " delete " , " dataType " = " integer " , " required " = false , " format " = " '0' or '1', default '0' " , " description " = " filter by deleted status. " },
* { " name " = " sort " , " dataType " = " string " , " required " = false , " format " = " 'created' or 'updated', default 'created' " , " description " = " sort entries by date. " },
* { " name " = " order " , " dataType " = " string " , " required " = false , " format " = " 'asc' or 'desc', default 'desc' " , " description " = " order of sort. " },
* { " name " = " page " , " dataType " = " integer " , " required " = false , " format " = " default '1' " , " description " = " what page you want. " },
* { " name " = " perPage " , " dataType " = " integer " , " required " = false , " format " = " default'30' " , " description " = " results per page. " },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " api%2Crest " , " description " = " a list of tags url encoded. Will returns entries that matches ALL tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
* @ return Entries
*/
2015-01-29 19:32:11 +00:00
public function getEntriesAction ( Request $request )
2015-01-29 15:56:58 +00:00
{
2015-01-30 06:50:52 +00:00
$isArchived = $request -> query -> get ( 'archive' , 0 );
$isStarred = $request -> query -> get ( 'star' , 0 );
$isDeleted = $request -> query -> get ( 'delete' , 0 );
$sort = $request -> query -> get ( 'sort' , 'created' );
$order = $request -> query -> get ( 'order' , 'desc' );
$page = $request -> query -> get ( 'page' , 1 );
$perPage = $request -> query -> get ( 'perPage' , 30 );
$tags = $request -> query -> get ( 'tags' , array ());
$entries = $this
-> getDoctrine ()
-> getRepository ( 'WallabagCoreBundle:Entries' )
-> findEntries ( 1 , ( int ) $isArchived , ( int ) $isStarred , ( int ) $isDeleted , $sort , $order );
if ( ! is_array ( $entries )) {
throw $this -> createNotFoundException ();
}
return $entries ;
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve a single entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
* @ return Entries
*/
public function getEntryAction ( Entries $entry )
{
return $entry ;
}
/**
2015-01-30 06:50:52 +00:00
* Create an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* parameters = {
* { " name " = " url " , " dataType " = " string " , " required " = true , " format " = " http://www.test.com/article.html " , " description " = " Url for the entry. " },
* { " name " = " title " , " dataType " = " string " , " required " = false , " description " = " Optional, we'll get the title from the page. " },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
*/
2015-01-30 08:05:54 +00:00
public function postEntriesAction ( Request $request )
2015-01-29 15:56:58 +00:00
{
2015-01-31 14:14:10 +00:00
//TODO la récup ne marche pas
2015-01-30 08:05:54 +00:00
//TODO gérer si on passe le titre
//TODO gérer si on passe les tags
//TODO ne pas avoir du code comme ça qui doit se trouver dans le Repository
2015-01-31 14:14:10 +00:00
$url = $request -> request -> get ( 'url' );
$content = Extractor :: extract ( $url );
2015-01-30 08:05:54 +00:00
$entry = new Entries ();
$entry -> setUserId ( 1 );
2015-01-31 14:14:10 +00:00
$entry -> setUrl ( $url );
2015-01-30 08:05:54 +00:00
$entry -> setTitle ( $content -> getTitle ());
$entry -> setContent ( $content -> getBody ());
$em = $this -> getDoctrine () -> getManager ();
$em -> persist ( $entry );
$em -> flush ();
return $entry ;
2015-01-29 15:56:58 +00:00
}
/**
2015-01-30 06:50:52 +00:00
* Change several properties of an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
2015-01-30 06:50:52 +00:00
* },
* parameters = {
* { " name " = " title " , " dataType " = " string " , " required " = false },
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
* { " name " = " archive " , " dataType " = " integer " , " required " = false , " format " = " '0' or '1', default '0' " , " description " = " archived the entry. " },
* { " name " = " star " , " dataType " = " integer " , " required " = false , " format " = " '0' or '1', default '0' " , " description " = " starred the entry. " },
* { " 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.. " },
* }
2015-01-29 15:56:58 +00:00
* )
*/
public function patchEntriesAction ( Entries $entry )
{
}
/**
2015-01-30 06:50:52 +00:00
* Delete ** permanently ** an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
2015-01-29 15:56:58 +00:00
* )
*/
2015-01-30 06:50:52 +00:00
public function deleteEntriesAction ( Entries $entry )
2015-01-29 15:56:58 +00:00
{
}
2015-01-30 06:50:52 +00:00
2015-01-29 15:56:58 +00:00
/**
2015-01-30 06:50:52 +00:00
* Retrieve all tags for an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
*/
public function getEntriesTagsAction ( Entries $entry ) {
}
/**
2015-01-30 06:50:52 +00:00
* Add one or more tags to an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
2015-01-30 06:50:52 +00:00
* },
* parameters = {
* { " name " = " tags " , " dataType " = " string " , " required " = false , " format " = " tag1,tag2,tag3 " , " description " = " a comma-separated list of tags. " },
* }
2015-01-29 15:56:58 +00:00
* )
*/
public function postEntriesTagsAction ( Entries $entry ) {
}
/**
2015-01-30 06:50:52 +00:00
* Permanently remove one tag for an entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " tag " , " dataType " = " string " , " requirement " = " \ w+ " , " description " = " The tag " },
* { " name " = " entry " , " dataType " = " integer " , " requirement " = " \ w+ " , " description " = " The entry ID " }
* }
* )
*/
public function deleteEntriesTagsAction ( Entries $entry , Tags $tag )
{
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve all tags
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* )
*/
public function getTagsAction () {
}
/**
2015-01-30 06:50:52 +00:00
* Retrieve a single tag
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
2015-01-30 06:50:52 +00:00
* requirements = {
2015-01-29 15:56:58 +00:00
* { " name " = " tag " , " dataType " = " string " , " requirement " = " \ w+ " , " description " = " The tag " }
2015-01-30 06:50:52 +00:00
* }
2015-01-29 15:56:58 +00:00
* )
*/
public function getTagAction ( Tags $tag ) {
}
/**
2015-01-30 06:50:52 +00:00
* Permanently remove one tag from ** every ** entry
2015-01-29 15:56:58 +00:00
*
* @ ApiDoc (
* requirements = {
* { " name " = " tag " , " dataType " = " string " , " requirement " = " \ w+ " , " description " = " The tag " }
* }
* )
*/
public function deleteTagAction ( Tags $tag )
{
}
}