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

Doctrine filters #72

Merged
merged 3 commits into from
Mar 26, 2020
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
4 changes: 4 additions & 0 deletions .docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,10 @@ nettrine.orm:
entityListenerResolver: <class>
repositoryFactory: <class>
defaultQueryHints: <mixed[]>
filters:
<string>:
class: <string>
enabled: <boolean>

entityManagerDecoratorClass: <class>
configurationClass: <class>
Expand Down
22 changes: 21 additions & 1 deletion src/DI/OrmExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ public function getConfigSchema(): Schema
'entityListenerResolver' => Expect::string(),
'repositoryFactory' => Expect::string(),
'defaultQueryHints' => Expect::array(),
'filters' => Expect::arrayOf(
Expect::structure([
'class' => Expect::string()->required(),
'enabled' => Expect::bool(false),
])
),
]),
]);
}
Expand Down Expand Up @@ -141,6 +147,12 @@ public function loadDoctrineConfiguration(): void
if ($config->defaultQueryHints !== []) {
$configuration->addSetup('setDefaultQueryHints', [$config->defaultQueryHints]);
}

if ($config->filters !== []) {
foreach ($config->filters as $filterName => $filter) {
$configuration->addSetup('addFilter', [$filterName, $filter->class]);
}
}
}

public function loadEntityManagerConfiguration(): void
Expand All @@ -161,9 +173,17 @@ public function loadEntityManagerConfiguration(): void
]);

// Entity Manager Decorator
$builder->addDefinition($this->prefix('entityManagerDecorator'))
$decorator = $builder->addDefinition($this->prefix('entityManagerDecorator'))
->setFactory($entityManagerDecoratorClass, [$original]);

if ($config->configuration->filters !== []) {
foreach ($config->configuration->filters as $filterName => $filter) {
if ($filter->enabled) {
$decorator->addSetup(new Statement('$service->getFilters()->enable(?)', [$filterName]));
}
}
}

// ManagerRegistry
$builder->addDefinition($this->prefix('managerRegistry'))
->setType(ManagerRegistry::class)
Expand Down
34 changes: 34 additions & 0 deletions tests/cases/DI/OrmExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use stdClass;
use Tests\Fixtures\DummyConfiguration;
use Tests\Fixtures\DummyEntityManagerDecorator;
use Tests\Fixtures\DummyFilter;
use Tests\Toolkit\Nette\ContainerBuilder;
use Tests\Toolkit\TestCase;

Expand Down Expand Up @@ -41,6 +42,39 @@ public function testCustomEntityManager(): void
$this->assertInstanceOf(DummyConfiguration::class, $container->getByType(DummyConfiguration::class));
}

public function testFilters(): void
{
$container = ContainerBuilder::of()
->withDefaults()
->withCompiler(static function (Compiler $compiler): void {
$compiler->addConfig([
'nettrine.orm' => [
'configuration' => [
'filters' => [
'autoEnabledFilter' => [
'class' => DummyFilter::class,
'enabled' => true,
],
'autoDisabledFilter' => [
'class' => DummyFilter::class,
],
],
],
],
]);
})
->build();
/** @var EntityManagerDecorator $em */
$em = $container->getService('nettrine.orm.entityManagerDecorator');
$filters = $em->getFilters();

$this->assertEquals(true, $filters->has('autoEnabledFilter'));
$this->assertEquals(true, $filters->isEnabled('autoEnabledFilter'));

$this->assertEquals(true, $filters->has('autoDisabledFilter'));
$this->assertEquals(false, $filters->isEnabled('autoDisabledFilter'));
}

public function testConfigurationException(): void
{
$this->expectException(InvalidArgumentException::class);
Expand Down
19 changes: 19 additions & 0 deletions tests/fixtures/DummyFilter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php declare(strict_types = 1);

namespace Tests\Fixtures;

use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query\Filter\SQLFilter;

class DummyFilter extends SQLFilter
{

/**
* @inheritDoc
*/
public function addFilterConstraint(ClassMetadata $targetEntity, $targetTableAlias)
{
return '';
}

}