Skip to content

Adapt to changes in Yii Data #123

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.

Sign up for GitHub

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

Merged
vjik merged 7 commits into from
Dec 11, 2025
Merged

Adapt to changes in Yii Data #123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9088e15
Adapt to changes in Yii Data
vjik Dec 10, 2025
5763193
fix
vjik Dec 10, 2025
4e6e791
Apply PHP CS Fixer and Rector changes (CI)
vjik Dec 10, 2025
f9e718f
fix
vjik Dec 10, 2025
7b00f45
Merge remote-tracking branch 'origin/adapt-data' into adapt-data
vjik Dec 10, 2025
87b97df
fix
vjik Dec 10, 2025
ab4a087
Rename addFilterHandlers to extraFilterHandlers (#124)
Copilot Dec 11, 2025
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
19 changes: 3 additions & 16 deletions src/FilterHandler.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
*/
final class FilterHandler
{
private Context $context;
private readonly Context $context;

/**
* @psalm-var array<string, QueryFilterHandlerInterface>
Expand All @@ -32,25 +32,12 @@ final class FilterHandler
/**
* @psalm-param list<QueryFilterHandlerInterface> $handlers
*/
public function __construct(
array $handlers,
private readonly FieldMapperInterface $fieldMapper,
) {
public function __construct(array $handlers, FieldMapperInterface $fieldMapper)
{
$this->handlers = $this->prepareHandlers($handlers);
$this->context = new Context($this, $fieldMapper);
}

public function withAddedFilterHandlers(QueryFilterHandlerInterface ...$handlers): self
{
$new = clone $this;
$new->handlers = array_merge(
$this->handlers,
$this->prepareHandlers($handlers),
);
$new->context = new Context($new, $this->fieldMapper);
return $new;
}

public function handle(FilterInterface $filter): ConditionInterface
{
return $this->getHandlerByOperator($filter::class)->getCondition($filter, $this->context);
Expand Down
14 changes: 12 additions & 2 deletions src/FilterHandler/QueryFilterHandlerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,21 @@

namespace Yiisoft\Data\Db\FilterHandler;

use Yiisoft\Data\Reader\FilterHandlerInterface;
use Yiisoft\Data\Reader\FilterInterface;
use Yiisoft\Db\QueryBuilder\Condition\ConditionInterface;

interface QueryFilterHandlerInterface extends FilterHandlerInterface
interface QueryFilterHandlerInterface
{
public function getCondition(FilterInterface $filter, Context $context): ConditionInterface;

/**
* Get matching filter class name.
*
* If the filter is active, a corresponding handler will be used during matching.
*
* @return string The filter class name.
*
* @psalm-return class-string<FilterInterface>
*/
public function getFilterClass(): string;
}
81 changes: 25 additions & 56 deletions src/QueryDataReader.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

use Generator;
use InvalidArgumentException;
use LogicException;
use RuntimeException;
use Yiisoft\Data\Db\FieldMapper\ArrayFieldMapper;
use Yiisoft\Data\Db\FieldMapper\FieldMapperInterface;
Expand All @@ -28,7 +27,6 @@
use Yiisoft\Data\Db\FilterHandler\OrXHandler;
use Yiisoft\Data\Db\FilterHandler\QueryFilterHandlerInterface;
use Yiisoft\Data\Reader\Filter\All;
use Yiisoft\Data\Reader\FilterHandlerInterface;
use Yiisoft\Data\Reader\FilterInterface;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Db\Expression\CompositeExpression;
Expand Down Expand Up @@ -67,7 +65,7 @@ class QueryDataReader implements QueryDataReaderInterface

/**
* @psalm-param non-negative-int|null $limit
* @psalm-param list<QueryFilterHandlerInterface>|null $filterHandlers
* @psalm-param list<QueryFilterHandlerInterface> $extraFilterHandlers
* @psalm-param array<string, string|ExpressionInterface>|FieldMapperInterface $fieldMapper
*/
public function __construct(
Expand All @@ -79,13 +77,33 @@ public function __construct(
private FilterInterface $filter = new All(),
private FilterInterface $having = new All(),
private ?int $batchSize = null,
?array $filterHandlers = null,
array $extraFilterHandlers = [],
array|FieldMapperInterface $fieldMapper = [],
) {
$this->fieldMapper = is_array($fieldMapper) ? new ArrayFieldMapper($fieldMapper) : $fieldMapper;

$filterHandlers ??= $this->getDefaultFilterHandlers();
$this->filterHandler = new FilterHandler($filterHandlers, $this->fieldMapper);
$this->filterHandler = new FilterHandler(
[
new AllHandler(),
new NoneHandler(),
new AndXHandler(),
new OrXHandler(),
new EqualsHandler(),
new GreaterThanHandler(),
new GreaterThanOrEqualHandler(),
new LessThanHandler(),
new LessThanOrEqualHandler(),
new LikeHandler(),
new InHandler(),
new ExistsHandler(),
new NotHandler(),
new BetweenHandler(),
new EqualsNullHandler(),
new EqualsExpressionHandler(),
...$extraFilterHandlers,
],
$this->fieldMapper,
);
}

/**
Expand All @@ -98,6 +116,7 @@ final public function getIterator(): Generator
/** @psalm-var array<TKey, TValue> $data */
yield from $data;
}
/** @infection-ignore-all */
return;
}

Expand Down Expand Up @@ -296,31 +315,6 @@ final public function withBatchSize(?int $batchSize): static
return $new;
}

/**
* @return static The new instance with the specified filter handlers added.
*
* @psalm-return static<TKey, TValue>
*/
final public function withAddedFilterHandlers(FilterHandlerInterface ...$filterHandlers): static
{
foreach ($filterHandlers as $handler) {
if (!$handler instanceof QueryFilterHandlerInterface) {
throw new LogicException(
sprintf(
'Filter handler must implement "%s".',
QueryFilterHandlerInterface::class,
),
);
}
}
/** @var QueryFilterHandlerInterface[] $filterHandlers */

$new = clone $this;
$new->count = $new->cache = null;
$new->filterHandler = $this->filterHandler->withAddedFilterHandlers(...$filterHandlers);
return $new;
}

final public function getSort(): ?Sort
{
return $this->sort;
Expand All @@ -341,31 +335,6 @@ final public function getOffset(): int
return $this->offset;
}

/**
* @psalm-return list<QueryFilterHandlerInterface>
*/
private function getDefaultFilterHandlers(): array
{
return [
new AllHandler(),
new NoneHandler(),
new AndXHandler(),
new OrXHandler(),
new EqualsHandler(),
new GreaterThanHandler(),
new GreaterThanOrEqualHandler(),
new LessThanHandler(),
new LessThanOrEqualHandler(),
new LikeHandler(),
new InHandler(),
new ExistsHandler(),
new NotHandler(),
new BetweenHandler(),
new EqualsNullHandler(),
new EqualsExpressionHandler(),
];
}

private function convertSortToOrderBy(Sort $sort): array
{
$result = [];
Expand Down
41 changes: 0 additions & 41 deletions tests/Sqlite/FilterHandlerTest.php
View file
Open in desktop

This file was deleted.

48 changes: 0 additions & 48 deletions tests/Sqlite/QueryDataReaderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,64 +5,16 @@
namespace Yiisoft\Data\Db\Tests\Sqlite;

use InvalidArgumentException;
use LogicException;
use PHPUnit\Framework\TestCase;
use Yiisoft\Data\Db\FilterHandler\AllHandler;
use Yiisoft\Data\Db\FilterHandler\AndXHandler;
use Yiisoft\Data\Db\FilterHandler\NoneHandler;
use Yiisoft\Data\Db\FilterHandler\QueryFilterHandlerInterface;
use Yiisoft\Data\Db\QueryDataReader;
use Yiisoft\Data\Db\Tests\TestHelper;
use Yiisoft\Data\Reader\Filter\All;
use Yiisoft\Data\Reader\Filter\AndX;
use Yiisoft\Data\Reader\Filter\Equals;
use Yiisoft\Data\Reader\Filter\None;
use Yiisoft\Data\Reader\Sort;
use Yiisoft\Test\Support\Log\SimpleLogger;

final class QueryDataReaderTest extends TestCase
{
public function testWithAddedFilterHandlers(): void
{
$db = TestHelper::createSqliteConnection();
$columnBuilder = $db->getColumnBuilderClass();
$db->createCommand()->createTable('test', ['id' => $columnBuilder::text()])->execute();

$handler1 = new AllHandler();
$handler2 = new NoneHandler();
$handler3 = new AndXHandler();

$dataReader = new QueryDataReader(
$db->createQuery()->from('test'),
filterHandlers: [$handler1],
);

$dataReaderWithAdded = $dataReader->withAddedFilterHandlers($handler2, $handler3);

$this->assertNotSame($dataReader, $dataReaderWithAdded);

$dataReaderWithFilters = $dataReaderWithAdded->withFilter(new AndX(new All(), new None()));
$dataReaderWithFilters->read(); // No errors

$dataReaderWithUnsupportedFilter = $dataReaderWithAdded->withFilter(new Equals('id', 'test'));
$this->expectException(LogicException::class);
$this->expectExceptionMessage('Operator "' . Equals::class . '" is not supported.');
iterator_to_array($dataReaderWithUnsupportedFilter->read());
}

public function testWithAddedFilterHandlersWithIncorrectHandler(): void
{
$dataReader = new QueryDataReader(
TestHelper::createSqliteConnection()->createQuery(),
);

$iterableHandler = new \Yiisoft\Data\Reader\Iterable\FilterHandler\AllHandler();

$this->expectException(LogicException::class);
$this->expectExceptionMessage('Filter handler must implement "' . QueryFilterHandlerInterface::class . '".');
$dataReader->withAddedFilterHandlers($iterableHandler);
}

public function testGetIteratorAfterRead(): void
{
$data = [['id' => '1'], ['id' => '2']];
Expand Down