class FilterTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FilterTest.php \Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler\FilterTest
  2. 11.x core/modules/views/tests/src/Functional/Plugin/FilterTest.php \Drupal\Tests\views\Functional\Plugin\FilterTest
  3. 11.x core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php \Drupal\views_test_data\Plugin\views\filter\FilterTest
Same name in other branches
  1. 9 core/modules/jsonapi/tests/src/Kernel/Query/FilterTest.php \Drupal\Tests\jsonapi\Kernel\Query\FilterTest
  2. 9 core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FilterTest.php \Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler\FilterTest
  3. 9 core/modules/views/tests/src/Functional/Plugin/FilterTest.php \Drupal\Tests\views\Functional\Plugin\FilterTest
  4. 9 core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php \Drupal\views_test_data\Plugin\views\filter\FilterTest
  5. 8.9.x core/modules/jsonapi/tests/src/Kernel/Query/FilterTest.php \Drupal\Tests\jsonapi\Kernel\Query\FilterTest
  6. 8.9.x core/modules/views/tests/src/Functional/Plugin/FilterTest.php \Drupal\Tests\views\Functional\Plugin\FilterTest
  7. 8.9.x core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php \Drupal\views_test_data\Plugin\views\filter\FilterTest
  8. 10 core/modules/jsonapi/tests/src/Kernel/Query/FilterTest.php \Drupal\Tests\jsonapi\Kernel\Query\FilterTest
  9. 10 core/modules/views/tests/src/FunctionalJavascript/Plugin/views/Handler/FilterTest.php \Drupal\Tests\views\FunctionalJavascript\Plugin\views\Handler\FilterTest
  10. 10 core/modules/views/tests/src/Functional/Plugin/FilterTest.php \Drupal\Tests\views\Functional\Plugin\FilterTest
  11. 10 core/modules/views/tests/modules/views_test_data/src/Plugin/views/filter/FilterTest.php \Drupal\views_test_data\Plugin\views\filter\FilterTest

@coversDefaultClass \Drupal\jsonapi\Query\Filter @group jsonapi @group jsonapi_query

@internal

Hierarchy

Expanded class hierarchy of FilterTest

File

core/modules/jsonapi/tests/src/Kernel/Query/FilterTest.php, line 25

Namespace

Drupal\Tests\jsonapi\Kernel\Query
View source
class FilterTest extends JsonapiKernelTestBase {
    use ImageFieldCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field',
        'file',
        'image',
        'jsonapi',
        'node',
        'serialization',
        'system',
        'text',
        'user',
    ];
    
    /**
     * A node storage instance.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $nodeStorage;
    
    /**
     * The JSON:API resource type repository.
     *
     * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
     */
    protected $resourceTypeRepository;
    
    /**
     * @var \Drupal\jsonapi\Context\FieldResolver
     */
    protected FieldResolver $fieldResolver;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->setUpSchemas();
        $this->savePaintingType();
        // ((RED or CIRCLE) or (YELLOW and SQUARE))
        $this->savePaintings([
            [
                'colors' => [
                    'red',
                ],
                'shapes' => [
                    'triangle',
                ],
                'title' => 'FIND',
            ],
            [
                'colors' => [
                    'orange',
                ],
                'shapes' => [
                    'circle',
                ],
                'title' => 'FIND',
            ],
            [
                'colors' => [
                    'orange',
                ],
                'shapes' => [
                    'triangle',
                ],
                'title' => 'DO_NOT_FIND',
            ],
            [
                'colors' => [
                    'yellow',
                ],
                'shapes' => [
                    'square',
                ],
                'title' => 'FIND',
            ],
            [
                'colors' => [
                    'yellow',
                ],
                'shapes' => [
                    'triangle',
                ],
                'title' => 'DO_NOT_FIND',
            ],
            [
                'colors' => [
                    'orange',
                ],
                'shapes' => [
                    'square',
                ],
                'title' => 'DO_NOT_FIND',
            ],
        ]);
        $this->nodeStorage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->fieldResolver = $this->container
            ->get('jsonapi.field_resolver');
        $this->resourceTypeRepository = $this->container
            ->get('jsonapi.resource_type.repository');
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueToMissingPropertyName() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The field `colors`, given in the path `colors` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'colors' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueToMissingPropertyNameReferenceFieldWithMetaProperties() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The field `photo`, given in the path `photo` is incomplete, it must end with one of the following specifiers: `id`, `meta.drupal_internal__target_id`, `meta.alt`, `meta.title`, `meta.width`, `meta.height`.');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'photo' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueMissingMetaPrefixReferenceFieldWithMetaProperties() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The property `alt`, given in the path `photo.alt` belongs to the meta object of a relationship and must be preceded by `meta`.');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'photo.alt' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueToMissingPropertyNameReferenceFieldWithoutMetaProperties() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The field `uid`, given in the path `uid` is incomplete, it must end with one of the following specifiers: `id`, `meta.drupal_internal__target_id`.');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'uid' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueToNonexistentProperty() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The property `foobar`, given in the path `colors.foobar`, does not exist. Must be one of the following property names: `value`, `format`, `processed`.');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'colors.foobar' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testInvalidFilterPathDueToElidedSoleProperty() : void {
        $this->expectException(CacheableBadRequestHttpException::class);
        $this->expectExceptionMessage('Invalid nested filtering. The property `value`, given in the path `promote.value`, does not exist. Filter by `promote`, not `promote.value` (the JSON:API module elides property names from single-property fields).');
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        Filter::createFromQueryParameter([
            'promote.value' => '',
        ], $resource_type, $this->fieldResolver);
    }
    
    /**
     * @covers ::queryCondition
     */
    public function testQueryCondition() : void {
        // Can't use a data provider because we need access to the container.
        $data = $this->queryConditionData();
        $get_sql_query_for_entity_query = function ($entity_query) {
            // Expose parts of \Drupal\Core\Entity\Query\Sql\Query::execute().
            $o = new \ReflectionObject($entity_query);
            $m1 = $o->getMethod('prepare');
            $m2 = $o->getMethod('compile');
            // The private property computed by the two previous private calls, whose
            // value we need to inspect.
            $p = $o->getProperty('sqlQuery');
            $m1->invoke($entity_query);
            $m2->invoke($entity_query);
            return (string) $p->getValue($entity_query);
        };
        $resource_type = $this->resourceTypeRepository
            ->get('node', 'painting');
        foreach ($data as $case) {
            $parameter = $case[0];
            $expected_query = $case[1];
            $filter = Filter::createFromQueryParameter($parameter, $resource_type, $this->fieldResolver);
            $query = $this->nodeStorage
                ->getQuery()
                ->accessCheck(FALSE);
            // Get the query condition parsed from the input.
            $condition = $filter->queryCondition($query);
            // Apply it to the query.
            $query->condition($condition);
            // Verify the SQL query is exactly the same.
            $expected_sql_query = $get_sql_query_for_entity_query($expected_query);
            $actual_sql_query = $get_sql_query_for_entity_query($query);
            $this->assertSame($expected_sql_query, $actual_sql_query);
            // Compare the results.
            $this->assertEquals($expected_query->execute(), $query->execute());
        }
    }
    
    /**
     * Simply provides test data to keep the actual test method tidy.
     */
    protected function queryConditionData() : array {
        // ((RED or CIRCLE) or (YELLOW and SQUARE))
        $query = $this->nodeStorage
            ->getQuery()
            ->accessCheck(FALSE);
        $or_group = $query->orConditionGroup();
        $nested_or_group = $query->orConditionGroup();
        $nested_or_group->condition('colors', 'red', 'CONTAINS');
        $nested_or_group->condition('shapes', 'circle', 'CONTAINS');
        $or_group->condition($nested_or_group);
        $nested_and_group = $query->andConditionGroup();
        $nested_and_group->condition('colors', 'yellow', 'CONTAINS');
        $nested_and_group->condition('shapes', 'square', 'CONTAINS');
        $nested_and_group->notExists('photo.alt');
        $or_group->condition($nested_and_group);
        $query->condition($or_group);
        return [
            [
                [
                    'or-group' => [
                        'group' => [
                            'conjunction' => 'OR',
                        ],
                    ],
                    'nested-or-group' => [
                        'group' => [
                            'conjunction' => 'OR',
                            'memberOf' => 'or-group',
                        ],
                    ],
                    'nested-and-group' => [
                        'group' => [
                            'conjunction' => 'AND',
                            'memberOf' => 'or-group',
                        ],
                    ],
                    'condition-0' => [
                        'condition' => [
                            'path' => 'colors.value',
                            'value' => 'red',
                            'operator' => 'CONTAINS',
                            'memberOf' => 'nested-or-group',
                        ],
                    ],
                    'condition-1' => [
                        'condition' => [
                            'path' => 'shapes.value',
                            'value' => 'circle',
                            'operator' => 'CONTAINS',
                            'memberOf' => 'nested-or-group',
                        ],
                    ],
                    'condition-2' => [
                        'condition' => [
                            'path' => 'colors.value',
                            'value' => 'yellow',
                            'operator' => 'CONTAINS',
                            'memberOf' => 'nested-and-group',
                        ],
                    ],
                    'condition-3' => [
                        'condition' => [
                            'path' => 'shapes.value',
                            'value' => 'square',
                            'operator' => 'CONTAINS',
                            'memberOf' => 'nested-and-group',
                        ],
                    ],
                    'condition-4' => [
                        'condition' => [
                            'path' => 'photo.meta.alt',
                            'operator' => 'IS NULL',
                            'memberOf' => 'nested-and-group',
                        ],
                    ],
                ],
                $query,
            ],
        ];
    }
    
    /**
     * Sets up the schemas.
     */
    protected function setUpSchemas() : void {
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installSchema('user', [
            'users_data',
        ]);
        $this->installSchema('user', []);
        foreach ([
            'user',
            'node',
        ] as $entity_type_id) {
            $this->installEntitySchema($entity_type_id);
        }
    }
    
    /**
     * Creates a painting node type.
     */
    protected function savePaintingType() : void {
        NodeType::create([
            'type' => 'painting',
            'name' => 'Painting',
        ])->save();
        $this->createTextField('node', 'painting', 'colors', 'Colors', FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->createTextField('node', 'painting', 'shapes', 'Shapes', FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        $this->createImageField('photo', 'node', 'painting');
    }
    
    /**
     * Creates painting nodes.
     */
    protected function savePaintings($paintings) : void {
        foreach ($paintings as $painting) {
            Node::create(array_merge([
                'type' => 'painting',
            ], $painting))->save();
        }
    }
    
    /**
     * @covers ::createFromQueryParameter
     * @dataProvider parameterProvider
     */
    public function testCreateFromQueryParameter($case, $expected) : void {
        $resource_type = new ResourceType('foo', 'bar', NULL);
        $actual = Filter::createFromQueryParameter($case, $resource_type, $this->getFieldResolverMock($resource_type));
        $conditions = $actual->root()
            ->members();
        for ($i = 0; $i < count($case); $i++) {
            $this->assertEquals($expected[$i]['path'], $conditions[$i]->field());
            $this->assertEquals($expected[$i]['value'], $conditions[$i]->value());
            $this->assertEquals($expected[$i]['operator'], $conditions[$i]->operator());
        }
    }
    
    /**
     * Data provider for testCreateFromQueryParameter.
     */
    public static function parameterProvider() {
        return [
            'shorthand' => [
                [
                    'uid' => [
                        'value' => 1,
                    ],
                ],
                [
                    [
                        'path' => 'uid',
                        'value' => 1,
                        'operator' => '=',
                    ],
                ],
            ],
            'extreme shorthand' => [
                [
                    'uid' => 1,
                ],
                [
                    [
                        'path' => 'uid',
                        'value' => 1,
                        'operator' => '=',
                    ],
                ],
            ],
        ];
    }
    
    /**
     * @covers ::createFromQueryParameter
     */
    public function testCreateFromQueryParameterNested() : void {
        $parameter = [
            'or-group' => [
                'group' => [
                    'conjunction' => 'OR',
                ],
            ],
            'nested-or-group' => [
                'group' => [
                    'conjunction' => 'OR',
                    'memberOf' => 'or-group',
                ],
            ],
            'nested-and-group' => [
                'group' => [
                    'conjunction' => 'AND',
                    'memberOf' => 'or-group',
                ],
            ],
            'condition-0' => [
                'condition' => [
                    'path' => 'field0',
                    'value' => 'value0',
                    'memberOf' => 'nested-or-group',
                ],
            ],
            'condition-1' => [
                'condition' => [
                    'path' => 'field1',
                    'value' => 'value1',
                    'memberOf' => 'nested-or-group',
                ],
            ],
            'condition-2' => [
                'condition' => [
                    'path' => 'field2',
                    'value' => 'value2',
                    'memberOf' => 'nested-and-group',
                ],
            ],
            'condition-3' => [
                'condition' => [
                    'path' => 'field3',
                    'value' => 'value3',
                    'memberOf' => 'nested-and-group',
                ],
            ],
        ];
        $resource_type = new ResourceType('foo', 'bar', NULL);
        $filter = Filter::createFromQueryParameter($parameter, $resource_type, $this->getFieldResolverMock($resource_type));
        $root = $filter->root();
        // Make sure the implicit root group was added.
        $this->assertEquals('AND', $root->conjunction());
        // Ensure the or-group and the and-group were added correctly.
        $members = $root->members();
        // Ensure the OR group was added.
        $or_group = $members[0];
        $this->assertEquals('OR', $or_group->conjunction());
        $or_group_members = $or_group->members();
        // Make sure the nested OR group was added with the right conditions.
        $nested_or_group = $or_group_members[0];
        $this->assertEquals('OR', $nested_or_group->conjunction());
        $nested_or_group_members = $nested_or_group->members();
        $this->assertEquals('field0', $nested_or_group_members[0]->field());
        $this->assertEquals('field1', $nested_or_group_members[1]->field());
        // Make sure the nested AND group was added with the right conditions.
        $nested_and_group = $or_group_members[1];
        $this->assertEquals('AND', $nested_and_group->conjunction());
        $nested_and_group_members = $nested_and_group->members();
        $this->assertEquals('field2', $nested_and_group_members[0]->field());
        $this->assertEquals('field3', $nested_and_group_members[1]->field());
    }
    
    /**
     * Provides a mock field resolver.
     */
    protected function getFieldResolverMock(ResourceType $resource_type) {
        $field_resolver = $this->prophesize(FieldResolver::class);
        $field_resolver->resolveInternalEntityQueryPath($resource_type, Argument::any(), Argument::any())
            ->willReturnArgument(1);
        return $field_resolver->reveal();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern Deprecated protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FilterTest::$fieldResolver protected property
FilterTest::$modules protected static property Modules to install. Overrides JsonapiKernelTestBase::$modules
FilterTest::$nodeStorage protected property A node storage instance.
FilterTest::$resourceTypeRepository protected property The JSON:API resource type repository.
FilterTest::getFieldResolverMock protected function Provides a mock field resolver.
FilterTest::parameterProvider public static function Data provider for testCreateFromQueryParameter.
FilterTest::queryConditionData protected function Simply provides test data to keep the actual test method tidy.
FilterTest::savePaintings protected function Creates painting nodes.
FilterTest::savePaintingType protected function Creates a painting node type.
FilterTest::setUp protected function Overrides KernelTestBase::setUp
FilterTest::setUpSchemas protected function Sets up the schemas.
FilterTest::testCreateFromQueryParameter public function @covers ::createFromQueryParameter
@dataProvider parameterProvider
FilterTest::testCreateFromQueryParameterNested public function @covers ::createFromQueryParameter
FilterTest::testInvalidFilterPathDueMissingMetaPrefixReferenceFieldWithMetaProperties public function @covers ::queryCondition
FilterTest::testInvalidFilterPathDueToElidedSoleProperty public function @covers ::queryCondition
FilterTest::testInvalidFilterPathDueToMissingPropertyName public function @covers ::queryCondition
FilterTest::testInvalidFilterPathDueToMissingPropertyNameReferenceFieldWithMetaProperties public function @covers ::queryCondition
FilterTest::testInvalidFilterPathDueToMissingPropertyNameReferenceFieldWithoutMetaProperties public function @covers ::queryCondition
FilterTest::testInvalidFilterPathDueToNonexistentProperty public function @covers ::queryCondition
FilterTest::testQueryCondition public function @covers ::queryCondition
ImageFieldCreationTrait::createImageField protected function Create a new image field.
JsonapiKernelTestBase::createTextField protected function Creates a field of an entity reference field storage on the bundle.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 2
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 2
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.