class FieldResolverTest

Same name in other branches
  1. 8.9.x core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest
  2. 10 core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest
  3. 11.x core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php \Drupal\Tests\jsonapi\Kernel\Context\FieldResolverTest

@coversDefaultClass \Drupal\jsonapi\Context\FieldResolver @group jsonapi

@internal

Hierarchy

Expanded class hierarchy of FieldResolverTest

File

core/modules/jsonapi/tests/src/Kernel/Context/FieldResolverTest.php, line 17

Namespace

Drupal\Tests\jsonapi\Kernel\Context
View source
class FieldResolverTest extends JsonapiKernelTestBase {
    protected static $modules = [
        'entity_test',
        'jsonapi_test_field_aliasing',
        'jsonapi_test_field_filter_access',
        'serialization',
        'field',
        'text',
        'user',
    ];
    
    /**
     * The subject under test.
     *
     * @var \Drupal\jsonapi\Context\FieldResolver
     */
    protected $sut;
    
    /**
     * The JSON:API resource type repository.
     *
     * @var \Drupal\jsonapi\ResourceType\ResourceTypeRepositoryInterface
     */
    protected $resourceTypeRepository;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test_with_bundle');
        $this->sut = \Drupal::service('jsonapi.field_resolver');
        $this->makeBundle('bundle1');
        $this->makeBundle('bundle2');
        $this->makeBundle('bundle3');
        $this->makeField('string', 'field_test1', 'entity_test_with_bundle', [
            'bundle1',
        ]);
        $this->makeField('string', 'field_test2', 'entity_test_with_bundle', [
            'bundle1',
        ]);
        $this->makeField('string', 'field_test3', 'entity_test_with_bundle', [
            'bundle2',
            'bundle3',
        ]);
        // Provides entity reference fields.
        $settings = [
            'target_type' => 'entity_test_with_bundle',
        ];
        $this->makeField('entity_reference', 'field_test_ref1', 'entity_test_with_bundle', [
            'bundle1',
        ], $settings, [
            'handler_settings' => [
                'target_bundles' => [
                    'bundle2',
                    'bundle3',
                ],
            ],
        ]);
        $this->makeField('entity_reference', 'field_test_ref2', 'entity_test_with_bundle', [
            'bundle1',
        ], $settings);
        $this->makeField('entity_reference', 'field_test_ref3', 'entity_test_with_bundle', [
            'bundle2',
            'bundle3',
        ], $settings);
        // Add a field with multiple properties.
        $this->makeField('text', 'field_test_text', 'entity_test_with_bundle', [
            'bundle1',
            'bundle2',
        ]);
        // Add two fields that have different internal names but have the same
        // public name.
        $this->makeField('entity_reference', 'field_test_alias_a', 'entity_test_with_bundle', [
            'bundle2',
        ], $settings);
        $this->makeField('entity_reference', 'field_test_alias_b', 'entity_test_with_bundle', [
            'bundle3',
        ], $settings);
        $this->resourceTypeRepository = $this->container
            ->get('jsonapi.resource_type.repository');
    }
    
    /**
     * @covers ::resolveInternalEntityQueryPath
     * @dataProvider resolveInternalIncludePathProvider
     */
    public function testResolveInternalIncludePath($expect, $external_path, $entity_type_id = 'entity_test_with_bundle', $bundle = 'bundle1') {
        $path_parts = explode('.', $external_path);
        $resource_type = $this->resourceTypeRepository
            ->get($entity_type_id, $bundle);
        $this->assertEquals($expect, $this->sut
            ->resolveInternalIncludePath($resource_type, $path_parts));
    }
    
    /**
     * Provides test cases for resolveInternalEntityQueryPath.
     */
    public function resolveInternalIncludePathProvider() {
        return [
            'entity reference' => [
                [
                    [
                        'field_test_ref2',
                    ],
                ],
                'field_test_ref2',
            ],
            'entity reference with multi target bundles' => [
                [
                    [
                        'field_test_ref1',
                    ],
                ],
                'field_test_ref1',
            ],
            'entity reference then another entity reference' => [
                [
                    [
                        'field_test_ref1',
                        'field_test_ref3',
                    ],
                ],
                'field_test_ref1.field_test_ref3',
            ],
            'entity reference with multiple target bundles, each with different field, but the same public field name' => [
                [
                    [
                        'field_test_ref1',
                        'field_test_alias_a',
                    ],
                    [
                        'field_test_ref1',
                        'field_test_alias_b',
                    ],
                ],
                'field_test_ref1.field_test_alias',
            ],
        ];
    }
    
    /**
     * Expects an error when an invalid field is provided for include.
     *
     * @param string $entity_type
     *   The entity type for which to test field resolution.
     * @param string $bundle
     *   The entity bundle for which to test field resolution.
     * @param string $external_path
     *   The external field path to resolve.
     * @param string $expected_message
     *   (optional) An expected exception message.
     *
     * @covers ::resolveInternalIncludePath
     * @dataProvider resolveInternalIncludePathErrorProvider
     */
    public function testResolveInternalIncludePathError($entity_type, $bundle, $external_path, $expected_message = '') {
        $path_parts = explode('.', $external_path);
        $this->expectException(CacheableBadRequestHttpException::class);
        if (!empty($expected_message)) {
            $this->expectExceptionMessage($expected_message);
        }
        $resource_type = $this->resourceTypeRepository
            ->get($entity_type, $bundle);
        $this->sut
            ->resolveInternalIncludePath($resource_type, $path_parts);
    }
    
    /**
     * Provides test cases for ::testResolveInternalIncludePathError.
     */
    public function resolveInternalIncludePathErrorProvider() {
        return [
            // Should fail because none of these bundles have these fields.
[
                'entity_test_with_bundle',
                'bundle1',
                'host.fail!!.deep',
            ],
            [
                'entity_test_with_bundle',
                'bundle2',
                'field_test_ref2',
            ],
            [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref3',
            ],
            // Should fail because the nested fields don't exist on the targeted
            // resource types.
[
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test1',
            ],
            [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test2',
            ],
            [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test_ref1',
            ],
            [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test_ref2',
            ],
            // Should fail because the nested fields is not a valid relationship
            // field name.
[
                'entity_test_with_bundle',
                'bundle1',
                'field_test1',
                '`field_test1` is not a valid relationship field name.',
            ],
            // Should fail because the nested fields is not a valid include path.
[
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test3',
                '`field_test_ref1.field_test3` is not a valid include path.',
            ],
        ];
    }
    
    /**
     * @covers ::resolveInternalEntityQueryPath
     * @dataProvider resolveInternalEntityQueryPathProvider
     */
    public function testResolveInternalEntityQueryPath($expect, $external_path, $entity_type_id = 'entity_test_with_bundle', $bundle = 'bundle1') {
        $resource_type = $this->resourceTypeRepository
            ->get($entity_type_id, $bundle);
        $this->assertEquals($expect, $this->sut
            ->resolveInternalEntityQueryPath($resource_type, $external_path));
    }
    
    /**
     * Provides test cases for ::testResolveInternalEntityQueryPath.
     */
    public function resolveInternalEntityQueryPathProvider() {
        return [
            'config entity as base' => [
                'uuid',
                'id',
                'entity_test_bundle',
                'entity_test_bundle',
            ],
            'config entity as target' => [
                'type.entity:entity_test_bundle.uuid',
                'type.id',
            ],
            'primitive field; variation A' => [
                'field_test1',
                'field_test1',
            ],
            'primitive field; variation B' => [
                'field_test2',
                'field_test2',
            ],
            'entity reference then a primitive field; variation A' => [
                'field_test_ref2.entity:entity_test_with_bundle.field_test1',
                'field_test_ref2.field_test1',
            ],
            'entity reference then a primitive field; variation B' => [
                'field_test_ref2.entity:entity_test_with_bundle.field_test2',
                'field_test_ref2.field_test2',
            ],
            'entity reference then a complex field with property specifier `value`' => [
                'field_test_ref2.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref2.field_test_text.value',
            ],
            'entity reference then a complex field with property specifier `format`' => [
                'field_test_ref2.entity:entity_test_with_bundle.field_test_text.format',
                'field_test_ref2.field_test_text.format',
            ],
            'entity reference then no delta with property specifier `id`' => [
                'field_test_ref1.entity:entity_test_with_bundle.uuid',
                'field_test_ref1.id',
            ],
            'entity reference then delta 0 with property specifier `id`' => [
                'field_test_ref1.0.entity:entity_test_with_bundle.uuid',
                'field_test_ref1.0.id',
            ],
            'entity reference then delta 1 with property specifier `id`' => [
                'field_test_ref1.1.entity:entity_test_with_bundle.uuid',
                'field_test_ref1.1.id',
            ],
            'entity reference then no reference property and a complex field with property specifier `value`' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref1.field_test_text.value',
            ],
            'entity reference then a reference property and a complex field with property specifier `value`' => [
                'field_test_ref1.entity.field_test_text.value',
                'field_test_ref1.entity.field_test_text.value',
            ],
            'entity reference then no reference property and a complex field with property specifier `format`' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_text.format',
                'field_test_ref1.field_test_text.format',
            ],
            'entity reference then a reference property and a complex field with property specifier `format`' => [
                'field_test_ref1.entity.field_test_text.format',
                'field_test_ref1.entity.field_test_text.format',
            ],
            'entity reference then property specifier `entity:entity_test_with_bundle` then a complex field with property specifier `value`' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref1.entity:entity_test_with_bundle.field_test_text.value',
            ],
            'entity reference with a delta and no reference property then a complex field and property specifier `value`' => [
                'field_test_ref1.0.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref1.0.field_test_text.value',
            ],
            'entity reference with a delta and a reference property then a complex field and property specifier `value`' => [
                'field_test_ref1.0.entity.field_test_text.value',
                'field_test_ref1.0.entity.field_test_text.value',
            ],
            'entity reference with no reference property then another entity reference with no reference property a complex field with property specifier `value`' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref1.field_test_ref3.field_test_text.value',
            ],
            'entity reference with a reference property then another entity reference with no reference property a complex field with property specifier `value`' => [
                'field_test_ref1.entity.field_test_ref3.entity:entity_test_with_bundle.field_test_text.value',
                'field_test_ref1.entity.field_test_ref3.field_test_text.value',
            ],
            'entity reference with no reference property then another entity reference with a reference property a complex field with property specifier `value`' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity.field_test_text.value',
                'field_test_ref1.field_test_ref3.entity.field_test_text.value',
            ],
            'entity reference with a reference property then another entity reference with a reference property a complex field with property specifier `value`' => [
                'field_test_ref1.entity.field_test_ref3.entity.field_test_text.value',
                'field_test_ref1.entity.field_test_ref3.entity.field_test_text.value',
            ],
            'entity reference with target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on multiple bundles' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test3',
                'field_test_ref1.entity:entity_test_with_bundle.field_test3',
            ],
            'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on a single bundle' => [
                'field_test_ref2.entity:entity_test_with_bundle.field_test1',
                'field_test_ref2.entity:entity_test_with_bundle.field_test1',
            ],
            'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on multiple bundles' => [
                'field_test_ref3.entity:entity_test_with_bundle.field_test3',
                'field_test_ref3.entity:entity_test_with_bundle.field_test3',
                'entity_test_with_bundle',
                'bundle2',
            ],
            'entity reference without target bundles then property specifier `entity:entity_test_with_bundle` then a primitive field on a single bundle starting from a different resource type' => [
                'field_test_ref3.entity:entity_test_with_bundle.field_test2',
                'field_test_ref3.entity:entity_test_with_bundle.field_test2',
                'entity_test_with_bundle',
                'bundle3',
            ],
            'entity reference then property specifier `entity:entity_test_with_bundle` then another entity reference before a primitive field' => [
                'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.entity:entity_test_with_bundle.field_test2',
                'field_test_ref1.entity:entity_test_with_bundle.field_test_ref3.field_test2',
            ],
        ];
    }
    
    /**
     * Expects an error when an invalid field is provided for filter and sort.
     *
     * @param string $entity_type
     *   The entity type for which to test field resolution.
     * @param string $bundle
     *   The entity bundle for which to test field resolution.
     * @param string $external_path
     *   The external field path to resolve.
     * @param string $expected_message
     *   (optional) An expected exception message.
     *
     * @covers ::resolveInternalEntityQueryPath
     * @dataProvider resolveInternalEntityQueryPathErrorProvider
     */
    public function testResolveInternalEntityQueryPathError($entity_type, $bundle, $external_path, $expected_message = '') {
        $this->expectException(CacheableBadRequestHttpException::class);
        if (!empty($expected_message)) {
            $this->expectExceptionMessage($expected_message);
        }
        $resource_type = $this->resourceTypeRepository
            ->get($entity_type, $bundle);
        $this->sut
            ->resolveInternalEntityQueryPath($resource_type, $external_path);
    }
    
    /**
     * Provides test cases for ::testResolveInternalEntityQueryPathError.
     */
    public function resolveInternalEntityQueryPathErrorProvider() {
        return [
            'nested fields' => [
                'entity_test_with_bundle',
                'bundle1',
                'none.of.these.exist',
            ],
            'field does not exist on bundle' => [
                'entity_test_with_bundle',
                'bundle2',
                'field_test_ref2',
            ],
            'field does not exist on different bundle' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref3',
            ],
            'field does not exist on targeted bundle' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test1',
            ],
            'different field does not exist on same targeted bundle' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test2',
            ],
            'entity reference field does not exist on targeted bundle' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test_ref1',
            ],
            'different entity reference field does not exist on same targeted bundle' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test_ref2',
            ],
            'message correctly identifies missing field' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.entity:entity_test_with_bundle.field_test1',
                'Invalid nested filtering. The field `field_test1`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test1`, does not exist.',
            ],
            'message correctly identifies different missing field' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.entity:entity_test_with_bundle.field_test2',
                'Invalid nested filtering. The field `field_test2`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test2`, does not exist.',
            ],
            'message correctly identifies missing entity reference field' => [
                'entity_test_with_bundle',
                'bundle2',
                'field_test_ref1.entity:entity_test_with_bundle.field_test2',
                'Invalid nested filtering. The field `field_test_ref1`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test2`, does not exist.',
            ],
            'entity reference then a complex field with no property specifier' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref2.field_test_text',
                'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref2.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
            ],
            'entity reference then no delta with property specifier `target_id`' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.target_id',
                'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.target_id`, does not exist.',
            ],
            'entity reference then delta 0 with property specifier `target_id`' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.0.target_id',
                'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.0.target_id`, does not exist.',
            ],
            'entity reference then delta 1 with property specifier `target_id`' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.1.target_id',
                'Invalid nested filtering. The field `target_id`, given in the path `field_test_ref1.1.target_id`, does not exist.',
            ],
            'entity reference then no reference property then a complex field' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.field_test_text',
                'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
            ],
            'entity reference then reference property then a complex field' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.entity.field_test_text',
                'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.entity.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
            ],
            'entity reference then property specifier `entity:entity_test_with_bundle` then a complex field' => [
                'entity_test_with_bundle',
                'bundle1',
                'field_test_ref1.entity:entity_test_with_bundle.field_test_text',
                'Invalid nested filtering. The field `field_test_text`, given in the path `field_test_ref1.entity:entity_test_with_bundle.field_test_text` is incomplete, it must end with one of the following specifiers: `value`, `format`, `processed`.',
            ],
        ];
    }
    
    /**
     * Create a simple bundle.
     *
     * @param string $name
     *   The name of the bundle to create.
     */
    protected function makeBundle($name) {
        EntityTestBundle::create([
            'id' => $name,
        ])->save();
    }
    
    /**
     * Creates a field for a specified entity type/bundle.
     *
     * @param string $type
     *   The field type.
     * @param string $name
     *   The name of the field to create.
     * @param string $entity_type
     *   The entity type to which the field will be attached.
     * @param string[] $bundles
     *   The entity bundles to which the field will be attached.
     * @param array $storage_settings
     *   Custom storage settings for the field.
     * @param array $config_settings
     *   Custom configuration settings for the field.
     */
    protected function makeField($type, $name, $entity_type, array $bundles, array $storage_settings = [], array $config_settings = []) {
        $storage_config = [
            'field_name' => $name,
            'type' => $type,
            'entity_type' => $entity_type,
            'settings' => $storage_settings,
        ];
        FieldStorageConfig::create($storage_config)->save();
        foreach ($bundles as $bundle) {
            FieldConfig::create([
                'field_name' => $name,
                'entity_type' => $entity_type,
                'bundle' => $bundle,
                'settings' => $config_settings,
            ])->save();
        }
    }

}

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 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 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 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 protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked 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 protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected 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 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 protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector 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 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 protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper 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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldResolverTest::$modules protected static property Modules to enable. Overrides JsonapiKernelTestBase::$modules
FieldResolverTest::$resourceTypeRepository protected property The JSON:API resource type repository.
FieldResolverTest::$sut protected property The subject under test.
FieldResolverTest::makeBundle protected function Create a simple bundle.
FieldResolverTest::makeField protected function Creates a field for a specified entity type/bundle.
FieldResolverTest::resolveInternalEntityQueryPathErrorProvider public function Provides test cases for ::testResolveInternalEntityQueryPathError.
FieldResolverTest::resolveInternalEntityQueryPathProvider public function Provides test cases for ::testResolveInternalEntityQueryPath.
FieldResolverTest::resolveInternalIncludePathErrorProvider public function Provides test cases for ::testResolveInternalIncludePathError.
FieldResolverTest::resolveInternalIncludePathProvider public function Provides test cases for resolveInternalEntityQueryPath.
FieldResolverTest::setUp protected function Overrides KernelTestBase::setUp
FieldResolverTest::testResolveInternalEntityQueryPath public function @covers ::resolveInternalEntityQueryPath
@dataProvider resolveInternalEntityQueryPathProvider
FieldResolverTest::testResolveInternalEntityQueryPathError public function Expects an error when an invalid field is provided for filter and sort.
FieldResolverTest::testResolveInternalIncludePath public function @covers ::resolveInternalEntityQueryPath
@dataProvider resolveInternalIncludePathProvider
FieldResolverTest::testResolveInternalIncludePathError public function Expects an error when an invalid field is provided for include.
JsonapiKernelTestBase::createEntityReferenceField protected function Creates a field of an entity reference field storage on the bundle.
JsonapiKernelTestBase::createTextField protected function Creates a field of an entity reference field storage on the bundle.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
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 private function Bootstraps a kernel for a test.
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.
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. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 26
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 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
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.