CallbackFilterTest::customCallback() - Code Metrics - Inspection of "Allow to override Operator option" - sonata-project/SonataDoctrineORMAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 3.x (#955)

by Vincent

created 2019-11-27 19:17 UTC

CallbackFilterTest::customCallback() A

↳ Parent: CallbackFilterTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	7
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	4

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\DoctrineORMAdminBundle\Tests\Filter;

use PHPUnit\Framework\TestCase;
use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
use Sonata\DoctrineORMAdminBundle\Filter\CallbackFilter;
use Sonata\Form\Type\HiddentType;

class CallbackFilterTest extends TestCase
{
    public function testRenderSettings(): void
    {
        $filter = new CallbackFilter();
        $options = $filter->getRenderSettings()[1];

        $this->assertSame(HiddentType::class, $options['operator_type']);
        $this->assertSame([], $options['operator_options']);
    }

    public function testFilterClosure(): void
    {
        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter = new CallbackFilter();
        $filter->initialize('field_name', [
            'callback' => static function ($builder, $alias, $field, $value) {
                $builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
                $builder->setParameter('value', $value);

                return true;
            },
        ]);

        $filter->filter($builder, 'alias', 'field', 'myValue');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->assertSame(['CUSTOM QUERY alias.field'], $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertSame(['value' => 'myValue'], $builder->parameters);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertTrue($filter->isActive());
    }

    public function testFilterMethod(): void
    {
        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter = new CallbackFilter();
        $filter->initialize('field_name', [
            'callback' => [$this, 'customCallback'],
        ]);

        $filter->filter($builder, 'alias', 'field', 'myValue');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $this->assertSame(['CUSTOM QUERY alias.field'], $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertSame(['value' => 'myValue'], $builder->parameters);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertTrue($filter->isActive());
    }

    public function customCallback($builder, $alias, $field, $value)
    {
        $builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
        $builder->setParameter('value', $value);

        return true;
    }

    public function testFilterException(): void
    {
        $this->expectException(\RuntimeException::class);

        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter = new CallbackFilter();
        $filter->initialize('field_name', []);

        $filter->filter($builder, 'alias', 'field', 'myValue');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testApplyMethod(): void
    {
        $builder = new ProxyQuery(new QueryBuilder());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        $filter = new CallbackFilter();
        $filter->initialize('field_name_test', [
            'callback' => static function ($builder, $alias, $field, $value) {
                $builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
                $builder->setParameter('value', $value['value']);

                return true;
            },
            'field_name' => 'field_name_test',
        ]);

        $filter->apply($builder, ['value' => 'myValue']);

        $this->assertSame(['CUSTOM QUERY o.field_name_test'], $builder->query);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertSame(['value' => 'myValue'], $builder->parameters);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $this->assertTrue($filter->isActive());
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\DoctrineORMAdminBundle\Tests\Filter;
15
16			use PHPUnit\Framework\TestCase;
17			use Sonata\DoctrineORMAdminBundle\Datagrid\ProxyQuery;
18			use Sonata\DoctrineORMAdminBundle\Filter\CallbackFilter;
19			use Sonata\Form\Type\HiddentType;
20
21			class CallbackFilterTest extends TestCase
22			{
23			public function testRenderSettings(): void
24			{
25			$filter = new CallbackFilter();
26			$options = $filter->getRenderSettings()[1];
27
28			$this->assertSame(HiddentType::class, $options['operator_type']);
29			$this->assertSame([], $options['operator_options']);
30			}
31
32			public function testFilterClosure(): void
33			{
34			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
35
36			$filter = new CallbackFilter();
37			$filter->initialize('field_name', [
38			'callback' => static function ($builder, $alias, $field, $value) {
39			$builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
40			$builder->setParameter('value', $value);
41
42			return true;
43			},
44			]);
45
46			$filter->filter($builder, 'alias', 'field', 'myValue');
			0 ignored issues – show Documentation introduced 2017-11-22 12:27 UTC by Report Bug Copy Issue Report `'myValue'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
47
48			$this->assertSame(['CUSTOM QUERY alias.field'], $builder->query);
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
49			$this->assertSame(['value' => 'myValue'], $builder->parameters);
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report The property `parameters` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
50			$this->assertTrue($filter->isActive());
51			}
52
53			public function testFilterMethod(): void
54			{
55			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
56
57			$filter = new CallbackFilter();
58			$filter->initialize('field_name', [
59			'callback' => [$this, 'customCallback'],
60			]);
61
62			$filter->filter($builder, 'alias', 'field', 'myValue');
			0 ignored issues – show Documentation introduced 2017-11-22 12:27 UTC by Report Bug Copy Issue Report `'myValue'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
63
64			$this->assertSame(['CUSTOM QUERY alias.field'], $builder->query);
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
65			$this->assertSame(['value' => 'myValue'], $builder->parameters);
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report The property `parameters` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
66			$this->assertTrue($filter->isActive());
67			}
68
69			public function customCallback($builder, $alias, $field, $value)
70			{
71			$builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
72			$builder->setParameter('value', $value);
73
74			return true;
75			}
76
77			public function testFilterException(): void
78			{
79			$this->expectException(\RuntimeException::class);
80
81			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2015-11-23 21:03 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
82
83			$filter = new CallbackFilter();
84			$filter->initialize('field_name', []);
85
86			$filter->filter($builder, 'alias', 'field', 'myValue');
			0 ignored issues – show Documentation introduced 2017-11-22 12:27 UTC by Report Bug Copy Issue Report `'myValue'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
87			}
88
89			public function testApplyMethod(): void
90			{
91			$builder = new ProxyQuery(new QueryBuilder());
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report `new \Sonata\DoctrineORMA...s\Filter\QueryBuilder()` is of type `object<Sonata\DoctrineOR...ts\Filter\QueryBuilder>`, but the function expects a `object<Doctrine\ORM\QueryBuilder>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
92
93			$filter = new CallbackFilter();
94			$filter->initialize('field_name_test', [
95			'callback' => static function ($builder, $alias, $field, $value) {
96			$builder->andWhere(sprintf('CUSTOM QUERY %s.%s', $alias, $field));
97			$builder->setParameter('value', $value['value']);
98
99			return true;
100			},
101			'field_name' => 'field_name_test',
102			]);
103
104			$filter->apply($builder, ['value' => 'myValue']);
105
106			$this->assertSame(['CUSTOM QUERY o.field_name_test'], $builder->query);
			0 ignored issues – show Documentation introduced 2015-11-23 21:03 UTC by Report Bug Copy Issue Report The property `query` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
107			$this->assertSame(['value' => 'myValue'], $builder->parameters);
			0 ignored issues – show Documentation introduced 2017-04-03 14:05 UTC by Report Bug Copy Issue Report The property `parameters` does not exist on `object<Sonata\DoctrineOR...le\Datagrid\ProxyQuery>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
108			$this->assertTrue($filter->isActive());
109			}
110			}
111

sonata-project / SonataDoctrineORMAdminBundle

Pull Request — 3.x (#955)

CallbackFilterTest::customCallback() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like