Return null instead of false

This commit is contained in:
Jeremy Benoist 2017-06-28 08:15:06 +02:00
parent 18696f77fd
commit 39ffaba323
No known key found for this signature in database
GPG key ID: BCA73962457ACC3C
2 changed files with 30 additions and 6 deletions

View file

@ -4,6 +4,7 @@ namespace Wallabag\ApiBundle\Controller;
use Hateoas\Configuration\Route; use Hateoas\Configuration\Route;
use Hateoas\Representation\Factory\PagerfantaFactory; use Hateoas\Representation\Factory\PagerfantaFactory;
use JMS\Serializer\SerializationContext;
use Nelmio\ApiDocBundle\Annotation\ApiDoc; use Nelmio\ApiDocBundle\Annotation\ApiDoc;
use Symfony\Component\HttpKernel\Exception\HttpException; use Symfony\Component\HttpKernel\Exception\HttpException;
use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\Request;
@ -21,6 +22,8 @@ class EntryRestController extends WallabagRestController
* Return ID if entry(ies) exist (and if you give the return_id parameter). * Return ID if entry(ies) exist (and if you give the return_id parameter).
* Otherwise it returns false. * Otherwise it returns false.
* *
* @todo Remove that `return_id` in the next major release
*
* @ApiDoc( * @ApiDoc(
* parameters={ * parameters={
* {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"}, * {"name"="return_id", "dataType"="string", "required"=false, "format"="1 or 0", "description"="Set 1 if you want to retrieve ID in case entry(ies) exists, 0 by default"},
@ -46,7 +49,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry') ->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId()); ->findByUrlAndUserId($url, $this->getUser()->getId());
$results[$url] = $res instanceof Entry ? ($returnId ? $res->getId() : true) : false; $results[$url] = $this->returnExistInformation($res, $returnId);
} }
return $this->sendResponse($results); return $this->sendResponse($results);
@ -63,7 +66,7 @@ class EntryRestController extends WallabagRestController
->getRepository('WallabagCoreBundle:Entry') ->getRepository('WallabagCoreBundle:Entry')
->findByUrlAndUserId($url, $this->getUser()->getId()); ->findByUrlAndUserId($url, $this->getUser()->getId());
$exists = $res instanceof Entry ? ($returnId ? $res->getId() : true) : false; $exists = $this->returnExistInformation($res, $returnId);
return $this->sendResponse(['exists' => $exists]); return $this->sendResponse(['exists' => $exists]);
} }
@ -621,7 +624,11 @@ class EntryRestController extends WallabagRestController
*/ */
private function sendResponse($data) private function sendResponse($data)
{ {
$json = $this->get('serializer')->serialize($data, 'json'); // https://github.com/schmittjoh/JMSSerializerBundle/issues/293
$context = new SerializationContext();
$context->setSerializeNull(true);
$json = $this->get('serializer')->serialize($data, 'json', $context);
return (new JsonResponse())->setJson($json); return (new JsonResponse())->setJson($json);
} }
@ -698,4 +705,21 @@ class EntryRestController extends WallabagRestController
// entry saved, dispatch event about it! // entry saved, dispatch event about it!
$this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry)); $this->get('event_dispatcher')->dispatch(EntrySavedEvent::NAME, new EntrySavedEvent($entry));
} }
/**
* Return information about the entry if it exist and depending on the id or not.
*
* @param Entry|null $entry
* @param bool $returnId
*
* @return bool|int
*/
private function returnExistInformation($entry, $returnId)
{
if ($returnId) {
return $entry instanceof Entry ? $entry->getId() : null;
}
return $entry instanceof Entry ? true : false;
}
} }

View file

@ -800,7 +800,7 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey($url1, $content); $this->assertArrayHasKey($url1, $content);
$this->assertArrayHasKey($url2, $content); $this->assertArrayHasKey($url2, $content);
$this->assertSame(2, $content[$url1]); $this->assertSame(2, $content[$url1]);
$this->assertSame(false, $content[$url2]); $this->assertNull($content[$url2]);
} }
public function testGetEntriesExistsWithManyUrlsReturnBool() public function testGetEntriesExistsWithManyUrlsReturnBool()
@ -815,8 +815,8 @@ class EntryRestControllerTest extends WallabagApiTestCase
$this->assertArrayHasKey($url1, $content); $this->assertArrayHasKey($url1, $content);
$this->assertArrayHasKey($url2, $content); $this->assertArrayHasKey($url2, $content);
$this->assertEquals(true, $content[$url1]); $this->assertTrue($content[$url1]);
$this->assertEquals(false, $content[$url2]); $this->assertFalse($content[$url2]);
} }
public function testGetEntriesExistsWhichDoesNotExists() public function testGetEntriesExistsWhichDoesNotExists()