Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

IBX-8726: Added support for IsBookmarked criterion #123

Merged
merged 3 commits into from
Sep 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/bundle/Resources/config/input_parsers.yml
Original file line number Diff line number Diff line change
Expand Up @@ -863,3 +863,11 @@ services:
$validator: '@validator'
tags:
- { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.internal.criterion.Image }


ciastektk marked this conversation as resolved.
Show resolved Hide resolved
Ibexa\Rest\Server\Input\Parser\Criterion\IsBookmarked:
parent: Ibexa\Rest\Server\Common\Parser
arguments:
$parserTools: '@Ibexa\Rest\Input\ParserTools'
tags:
- { name: ibexa.rest.input.parser, mediaType: application/vnd.ibexa.api.internal.criterion.IsBookmarked }
38 changes: 38 additions & 0 deletions src/lib/Server/Input/Parser/Criterion/IsBookmarked.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<?php

/**
* @copyright Copyright (C) Ibexa AS. All rights reserved.
* @license For full copyright and license information view LICENSE file distributed with this source code.
*/
declare(strict_types=1);

namespace Ibexa\Rest\Server\Input\Parser\Criterion;

use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion\Location\IsBookmarked as IsBookmarkedCriterion;
use Ibexa\Contracts\Rest\Exceptions\Parser;
use Ibexa\Contracts\Rest\Input\ParsingDispatcher;
use Ibexa\Rest\Input\BaseParser;
use Ibexa\Rest\Input\ParserTools;

final class IsBookmarked extends BaseParser
{
public const IS_BOOKMARKED_CRITERION = 'IsBookmarkedCriterion';

private ParserTools $parserTools;

public function __construct(ParserTools $parserTools)
{
$this->parserTools = $parserTools;
}

public function parse(array $data, ParsingDispatcher $parsingDispatcher): IsBookmarkedCriterion
{
if (!array_key_exists(self::IS_BOOKMARKED_CRITERION, $data)) {
throw new Parser('Invalid <IsBookmarkedCriterion> format');
}

return new IsBookmarkedCriterion(
$this->parserTools->parseBooleanValue($data[self::IS_BOOKMARKED_CRITERION])
);
}
}
54 changes: 54 additions & 0 deletions tests/bundle/Functional/SearchView/Criterion/IsBookmarkedTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<?php

/**
* @copyright Copyright (C) Ibexa AS. All rights reserved.
* @license For full copyright and license information view LICENSE file distributed with this source code.
*/
namespace Ibexa\Tests\Bundle\Rest\Functional\SearchView\Criterion;
ciastektk marked this conversation as resolved.
Show resolved Hide resolved

use Ibexa\Tests\Bundle\Rest\Functional\SearchView\SearchCriterionTestCase;

final class IsBookmarkedTest extends SearchCriterionTestCase
{
protected function setUp(): void
{
parent::setUp();

$this->addMediaFolderToBookmarks();
}

/**
* @phpstan-return iterable<
* string,
* array{
* string,
* string,
* int,
* },
* >
*/
public function getCriteriaPayloads(): iterable
{
yield 'Bookmarked locations' => [
'json',
$this->buildJsonCriterionQuery('"IsBookmarkedCriterion": true'),
1,
];

yield 'Not bookmarked locations' => [
'json',
$this->buildJsonCriterionQuery('"IsBookmarkedCriterion": false'),
11,
];
}

private function addMediaFolderToBookmarks(): void
{
$request = $this->createHttpRequest(
'POST',
'/api/ibexa/v2/bookmark/43'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: relying on volatile database ID. However we'd need to rewrite this into new test-rest package tests, which is not possible for rest itself yet. Just keeping this as a note to myself here ;)

);

$this->sendHttpRequest($request);
}
}
Loading