oss/wallabag
oss/wallabag
1
0
Fork 0
mirror of https://github.com/wallabag/wallabag.git synced 2025-10-20 19:52:09 +00:00
Code Wiki Activity

api/entries: add parameter detail to exclude or include content in response

Browse source 
detail=metadata will nullify the content field of entries in order to
make smaller responses.

detail=full keeps the former behavior, it sends the content of entries.
It's the default, for backward compatibility.

Fixes #2817

Signed-off-by: Kevin Decherf <kevin@kdecherf.com>
This commit is contained in:
Kevin Decherf 2019-05-12 00:00:00 +02:00
parent de1162b91a
commit 2c290747cb
3 changed files with 42 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

17
src/Wallabag/CoreBundle/Repository/EntryRepository.php
View file

@ -139,15 +139,30 @@ class EntryRepository extends EntityRepository
* @param string $order
* @param int $since
* @param string $tags
* @param string $detail 'metadata' or 'full'. Include content field if 'full'
*
* @todo Breaking change: replace default detail=full by detail=metadata in a future version
*
* @return Pagerfanta
*/
public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '')
public function findEntries($userId, $isArchived = null, $isStarred = null, $isPublic = null, $sort = 'created', $order = 'asc', $since = 0, $tags = '', $detail = 'full')
{
if (!\in_array(strtolower($detail), ['full', 'metadata'], true)) {
throw new \Exception('Detail "' . $detail . '" parameter is wrong, allowed: full or metadata');
}
$qb = $this->createQueryBuilder('e')
->leftJoin('e.tags', 't')
->where('e.user = :userId')->setParameter('userId', $userId);
if ('metadata' === $detail) {
$fieldNames = $this->getClassMetadata()->getFieldNames();
$fields = array_filter($fieldNames, function ($k) {
return 'content' !== $k;
});
$qb->select(sprintf('partial e.{%s}', implode(',', $fields)));
}
if (null !== $isArchived) {
$qb->andWhere('e.isArchived = :isArchived')->setParameter('isArchived', (bool) $isArchived);
}