class FilterEntityReferenceTest

Same name in this branch
  1. 11.x core/modules/views_ui/tests/src/FunctionalJavascript/FilterEntityReferenceTest.php \Drupal\Tests\views_ui\FunctionalJavascript\FilterEntityReferenceTest

Tests the core Drupal\views\Plugin\views\filter\EntityReference handler.

@group views

Hierarchy

Expanded class hierarchy of FilterEntityReferenceTest

File

core/modules/views/tests/src/Kernel/Handler/FilterEntityReferenceTest.php, line 23

Namespace

Drupal\Tests\views\Kernel\Handler
View source
class FilterEntityReferenceTest extends ViewsKernelTestBase {
    use ContentTypeCreationTrait;
    use EntityReferenceFieldCreationTrait;
    use NodeCreationTrait;
    use UserCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    public static $testViews = [
        'test_filter_entity_reference',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'node',
        'user',
        'field',
        'text',
        'filter',
        'views',
        'views_test_entity_reference',
    ];
    
    /**
     * Test host nodes containing the entity reference.
     *
     * @var \Drupal\node\NodeInterface[]
     */
    protected array $hostNodes;
    
    /**
     * Test target nodes referenced by the entity reference.
     *
     * @var \Drupal\node\NodeInterface[]
     */
    protected array $targetNodes;
    
    /**
     * First test user as node author.
     *
     * @var \Drupal\user\UserInterface
     */
    protected UserInterface $user1;
    
    /**
     * Second test user as node author.
     *
     * @var \Drupal\user\UserInterface
     */
    protected UserInterface $user2;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) : void {
        parent::setUp(FALSE);
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        $this->installConfig([
            'node',
            'user',
            'filter',
        ]);
        ViewTestData::createTestViews(static::class, [
            'views_test_config',
        ]);
        // Create two node types.
        $this->createContentType([
            'type' => 'page',
        ]);
        $this->createContentType([
            'type' => 'article',
        ]);
        // Add an entity reference field to the page type referencing the article
        // type.
        $selection_handler_settings = [
            'target_bundles' => [
                'article' => 'article',
            ],
        ];
        $this->createEntityReferenceField('node', 'page', 'field_test', 'Test reference', 'node', $selection_handler = 'default', $selection_handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        // Create user 1.
        $this->user1 = $this->createUser();
        $this->user2 = $this->createUser();
        // Create target nodes to be referenced.
        foreach (range(0, 5) as $count) {
            $this->targetNodes[$count] = $this->createNode([
                'type' => 'article',
                'title' => 'Article ' . $count,
                'status' => 1,
                'uid' => $this->user1,
            ]);
        }
        // Create a page referencing Article 0 and Article 1.
        $this->hostNodes[0] = $this->createNode([
            'type' => 'page',
            'title' => 'Page 0',
            'status' => 1,
            'created' => time(),
            'field_test' => [
                $this->targetNodes[0]
                    ->id(),
                $this->targetNodes[1]
                    ->id(),
            ],
            'uid' => $this->user2,
        ]);
        // Create a page referencing Article 1, Article 2, and Article 3.
        $this->hostNodes[1] = $this->createNode([
            'type' => 'page',
            'title' => 'Page 1',
            'status' => 1,
            'created' => time() - 100,
            'field_test' => [
                $this->targetNodes[1]
                    ->id(),
                $this->targetNodes[2]
                    ->id(),
                $this->targetNodes[3]
                    ->id(),
            ],
            'uid' => $this->user2,
        ]);
        // Create a page referencing nothing.
        $this->hostNodes[2] = $this->createNode([
            'type' => 'page',
            'title' => 'Page 2',
            'status' => 1,
            'created' => time() - 200,
            'uid' => $this->user2,
        ]);
    }
    
    /**
     * Tests that results are successfully filtered by the select list widget.
     */
    public function testViewEntityReferenceAsSelectList() : void {
        $view = Views::getView('test_filter_entity_reference');
        $view->setDisplay();
        $view->preExecute([]);
        $view->setExposedInput([
            'field_test_target_id' => [
                $this->targetNodes[0]
                    ->id(),
            ],
        ]);
        $this->executeView($view);
        // Expect to have only Page 0, with Article 0 referenced.
        $expected = [
            [
                'title' => 'Page 0',
            ],
        ];
        $this->assertIdenticalResultset($view, $expected, [
            'title' => 'title',
        ]);
        // Change to both Article 0 and Article 3.
        $view = Views::getView('test_filter_entity_reference');
        $view->setDisplay();
        $view->setExposedInput([
            'field_test_target_id' => [
                $this->targetNodes[0]
                    ->id(),
                $this->targetNodes[3]
                    ->id(),
            ],
        ]);
        $this->executeView($view);
        // Expect to have Page 0 and 1, with Article 0 and 3 referenced.
        $expected = [
            [
                'title' => 'Page 0',
            ],
            [
                'title' => 'Page 1',
            ],
        ];
        $this->assertIdenticalResultset($view, $expected, [
            'title' => 'title',
        ]);
    }
    
    /**
     * Tests that results are successfully filtered by the autocomplete widget.
     */
    public function testViewEntityReferenceAsAutocomplete() : void {
        // Change the widget to autocomplete.
        $view = Views::getView('test_filter_entity_reference');
        $view->setDisplay();
        $filters = $view->displayHandlers
            ->get('default')
            ->getOption('filters');
        $filters['field_test_target_id']['widget'] = EntityReference::WIDGET_AUTOCOMPLETE;
        $view->displayHandlers
            ->get('default')
            ->overrideOption('filters', $filters);
        $view->setExposedInput([
            'field_test_target_id' => [
                [
                    'target_id' => $this->targetNodes[0]
                        ->id(),
                ],
                [
                    'target_id' => $this->targetNodes[3]
                        ->id(),
                ],
            ],
        ]);
        $this->executeView($view);
        // Expect to have Page 0 and 1, with Article 0 and 3 referenced.
        $expected = [
            [
                'title' => 'Page 0',
            ],
            [
                'title' => 'Page 1',
            ],
        ];
        $this->assertIdenticalResultset($view, $expected, [
            'title' => 'title',
        ]);
    }
    
    /**
     * Tests that content dependencies are added to the view.
     */
    public function testViewContentDependencies() : void {
        $view = Views::getView('test_filter_entity_reference');
        $value = [
            $this->targetNodes[0]
                ->id(),
            $this->targetNodes[3]
                ->id(),
        ];
        $view->setHandlerOption('default', 'filter', 'field_test_target_id', 'value', $value);
        // Dependencies are sorted.
        $content_dependencies = [
            $this->targetNodes[0]
                ->getConfigDependencyName(),
            $this->targetNodes[3]
                ->getConfigDependencyName(),
        ];
        sort($content_dependencies);
        $this->assertEquals([
            'config' => [
                'node.type.page',
            ],
            'content' => $content_dependencies,
            'module' => [
                'node',
                'user',
            ],
        ], $view->getDependencies());
    }

}

Members

Title Sort descending 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::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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
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.
FilterEntityReferenceTest::$hostNodes protected property Test host nodes containing the entity reference.
FilterEntityReferenceTest::$modules protected static property Modules to install. Overrides ViewsKernelTestBase::$modules
FilterEntityReferenceTest::$targetNodes protected property Test target nodes referenced by the entity reference.
FilterEntityReferenceTest::$testViews public static property Views to be enabled. Overrides ViewsKernelTestBase::$testViews
FilterEntityReferenceTest::$user1 protected property First test user as node author.
FilterEntityReferenceTest::$user2 protected property Second test user as node author.
FilterEntityReferenceTest::setUp protected function Overrides ViewsKernelTestBase::setUp
FilterEntityReferenceTest::testViewContentDependencies public function Tests that content dependencies are added to the view.
FilterEntityReferenceTest::testViewEntityReferenceAsAutocomplete public function Tests that results are successfully filtered by the autocomplete widget.
FilterEntityReferenceTest::testViewEntityReferenceAsSelectList public function Tests that results are successfully filtered by the select list widget.
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. 3
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. 1
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 27
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. 2
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.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 10
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 7
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 6
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 23

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