class DisplayEntityReferenceTest

Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php \Drupal\Tests\views\Functional\Plugin\DisplayEntityReferenceTest
  2. 8.9.x core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php \Drupal\Tests\views\Functional\Plugin\DisplayEntityReferenceTest
  3. 10 core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php \Drupal\Tests\views\Functional\Plugin\DisplayEntityReferenceTest

Tests the entity reference display plugin.

@group views

Hierarchy

Expanded class hierarchy of DisplayEntityReferenceTest

See also

\Drupal\views\Plugin\views\display\EntityReference

File

core/modules/views/tests/src/Functional/Plugin/DisplayEntityReferenceTest.php, line 21

Namespace

Drupal\Tests\views\Functional\Plugin
View source
class DisplayEntityReferenceTest extends ViewTestBase {
    use EntityReferenceFieldCreationTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_display_entity_reference',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'field',
        'views_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The used field name in the test.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * The used entity reference field name in the test.
     *
     * @var string
     */
    protected $entityRefFieldName;
    
    /**
     * The field storage.
     *
     * @var \Drupal\field\Entity\FieldStorageConfig
     */
    protected $fieldStorage;
    
    /**
     * The field config.
     *
     * @var \Drupal\field\Entity\FieldConfig
     */
    protected $field;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        // Create the text field.
        $this->fieldName = 'field_test_entity_ref_display';
        $this->fieldStorage = FieldStorageConfig::create([
            'field_name' => $this->fieldName,
            'entity_type' => 'entity_test',
            'type' => 'text',
        ]);
        $this->fieldStorage
            ->save();
        // Create an instance of the text field on the content type.
        $this->field = FieldConfig::create([
            'field_storage' => $this->fieldStorage,
            'bundle' => 'entity_test',
        ]);
        $this->field
            ->save();
        // Add an entity reference field to reference the same base table.
        $this->entityRefFieldName = 'field_test_entity_ref_entity_ref';
        $this->createEntityReferenceField('entity_test', 'entity_test', $this->entityRefFieldName, NULL, 'entity_test');
        // Create some entities to search. Add a common string to the name and
        // the text field in two entities so we can test that we can search in both.
        for ($i = 0; $i < 5; $i++) {
            EntityTest::create([
                'bundle' => 'entity_test',
                'name' => 'name' . $i,
                $this->fieldName => 'text',
            ])
                ->save();
            EntityTest::create([
                'bundle' => 'entity_test',
                'name' => 'name',
                $this->fieldName => 'text' . $i,
            ])
                ->save();
        }
        EntityTest::create([
            'bundle' => 'entity_test',
            'name' => 'name',
            $this->fieldName => 'tex',
        ])
            ->save();
        EntityTest::create([
            'bundle' => 'entity_test',
            'name' => 'name',
            $this->fieldName => 'TEX',
        ])
            ->save();
        EntityTest::create([
            'bundle' => 'entity_test',
            'name' => 'name',
            $this->fieldName => 'some_text',
        ])
            ->save();
    }
    
    /**
     * Tests the entity reference display plugin.
     */
    public function testEntityReferenceDisplay() : void {
        // Test that the 'title' settings are not shown.
        $this->drupalGet('admin/structure/views/view/test_display_entity_reference/edit/entity_reference_1');
        $this->assertSession()
            ->linkByHrefNotExists('admin/structure/views/nojs/display/test_display_entity_reference/entity_reference_1/title');
        // Add the new field to the fields.
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_display_entity_reference/default/field');
        $this->submitForm([
            'name[entity_test__' . $this->fieldName . '.' . $this->fieldName . ']' => TRUE,
        ], 'Add and configure fields');
        $this->submitForm([], 'Apply');
        // Test that the right fields are shown on the display settings form.
        $this->drupalGet('admin/structure/views/nojs/display/test_display_entity_reference/entity_reference_1/style_options');
        $this->assertSession()
            ->pageTextContains('Test entity: Name');
        $this->assertSession()
            ->pageTextContains('Test entity: ' . $this->field
            ->label());
        // Add the new field to the search fields.
        $this->submitForm([
            'style_options[search_fields][' . $this->fieldName . ']' => $this->fieldName,
        ], 'Apply');
        $this->submitForm([], 'Save');
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        // Add the required settings to test a search operation.
        $options = [
            'match' => '1',
            'match_operator' => 'CONTAINS',
            'limit' => 0,
            'ids' => NULL,
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        // Test that we have searched in both fields.
        $this->assertCount(2, $view->result, 'Search returned two rows');
        $view->destroy();
        // Test the 'CONTAINS' match_operator.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        $options = [
            'match' => 'tex',
            'match_operator' => 'CONTAINS',
            'limit' => 0,
            'ids' => NULL,
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        $this->assertCount(13, $view->result, 'Search returned thirteen rows');
        $view->destroy();
        // Test the 'STARTS_WITH' match_operator.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        $options = [
            'match' => 'tex',
            'match_operator' => 'STARTS_WITH',
            'limit' => 0,
            'ids' => NULL,
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        $this->assertCount(12, $view->result, 'Search returned twelve rows');
        $view->destroy();
        // Test the '=' match_operator.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        $options = [
            'match' => 'tex',
            'match_operator' => '=',
            'limit' => 0,
            'ids' => NULL,
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        $this->assertCount(2, $view->result, 'Search returned two rows');
        $view->destroy();
        // Add a relationship and a field using that relationship.
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_display_entity_reference/default/relationship');
        $this->submitForm([
            'name[entity_test.user_id]' => TRUE,
        ], 'Add and configure relationships');
        $this->submitForm([], 'Apply');
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_display_entity_reference/default/field');
        $this->submitForm([
            'name[users_field_data.uid]' => TRUE,
        ], 'Add and configure fields');
        $this->submitForm([], 'Apply');
        // Add the new field to the search fields.
        $this->drupalGet('admin/structure/views/nojs/display/test_display_entity_reference/entity_reference_1/style_options');
        $this->submitForm([
            'style_options[search_fields][uid]' => 'uid',
        ], 'Apply');
        $this->submitForm([], 'Save');
        // Test that the search still works with the related field.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        // Add the required settings to test a search operation.
        $options = [
            'match' => '2',
            'match_operator' => 'CONTAINS',
            'limit' => 0,
            'ids' => NULL,
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        // Run validation when using a relationship to the same base table.
        $this->assertCount(2, $view->result, 'Search returned two rows');
        $view->destroy();
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_display_entity_reference/default/relationship');
        $this->submitForm([
            'name[entity_test__field_test_entity_ref_entity_ref.field_test_entity_ref_entity_ref]' => TRUE,
        ], 'Add and configure relationships');
        $this->submitForm([], 'Apply');
        $this->submitForm([], 'Save');
        // Test that the search still works with the related field.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        // Add IDs to trigger validation.
        $options = [
            'match' => '1',
            'match_operator' => 'CONTAINS',
            'limit' => 0,
            'ids' => [
                1,
                2,
            ],
        ];
        $view->display_handler
            ->setOption('entity_reference_options', $options);
        $this->executeView($view);
        $this->assertCount(2, $view->result, 'Search returned two rows');
        // Test that the render() return empty array for empty result.
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        $render = $view->display_handler
            ->render();
        $this->assertSame([], $render, 'Render returned empty array');
        // Execute the View without setting the 'entity_reference_options'.
        // This is equivalent to using the following as entity_reference_options.
        // @code
        // $options = [
        //   'match' => NULL,
        //   'match_operator' => 'CONTAINS',
        //   'limit' => 0,
        //   'ids' => NULL,
        // ];
        // @endcode
        // Assert that this view returns a row for each test entity.
        $view->destroy();
        $view = Views::getView('test_display_entity_reference');
        $view->setDisplay('entity_reference_1');
        $this->executeView($view);
        $this->assertCount(13, $view->result, 'Search returned thirteen rows');
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 42
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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. Aliased as: drupalCreateContentType 1
DisplayEntityReferenceTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DisplayEntityReferenceTest::$entityRefFieldName protected property The used entity reference field name in the test.
DisplayEntityReferenceTest::$field protected property The field config.
DisplayEntityReferenceTest::$fieldName protected property The used field name in the test.
DisplayEntityReferenceTest::$fieldStorage protected property The field storage.
DisplayEntityReferenceTest::$modules protected static property Modules to install. Overrides ViewTestBase::$modules
DisplayEntityReferenceTest::$testViews public static property Views used by this test.
DisplayEntityReferenceTest::setUp protected function Sets up the test. Overrides ViewTestBase::setUp
DisplayEntityReferenceTest::testEntityReferenceDisplay public function Tests the entity reference display plugin.
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.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 29
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
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. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
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.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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