class EntityReferenceFormatterTest

Same name in other branches
  1. 8.9.x core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceFormatterTest.php \Drupal\Tests\field\Kernel\EntityReference\EntityReferenceFormatterTest
  2. 10 core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceFormatterTest.php \Drupal\Tests\field\Kernel\EntityReference\EntityReferenceFormatterTest
  3. 11.x core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceFormatterTest.php \Drupal\Tests\field\Kernel\EntityReference\EntityReferenceFormatterTest

Tests the formatters functionality.

@group entity_reference

Hierarchy

Expanded class hierarchy of EntityReferenceFormatterTest

File

core/modules/field/tests/src/Kernel/EntityReference/EntityReferenceFormatterTest.php, line 24

Namespace

Drupal\Tests\field\Kernel\EntityReference
View source
class EntityReferenceFormatterTest extends EntityKernelTestBase {
    use EntityReferenceTestTrait;
    
    /**
     * The entity type used in this test.
     *
     * @var string
     */
    protected $entityType = 'entity_test';
    
    /**
     * The bundle used in this test.
     *
     * @var string
     */
    protected $bundle = 'entity_test';
    
    /**
     * The name of the field used in this test.
     *
     * @var string
     */
    protected $fieldName = 'field_test';
    
    /**
     * The entity to be referenced in this test.
     *
     * @var \Drupal\Core\Entity\EntityInterface
     */
    protected $referencedEntity;
    
    /**
     * An entity that is not yet saved to its persistent storage.
     *
     * @var \Drupal\Core\Entity\EntityInterface
     */
    protected $unsavedReferencedEntity;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Use Stark theme for testing markup output.
        \Drupal::service('theme_installer')->install([
            'stark',
        ]);
        $this->config('system.theme')
            ->set('default', 'stark')
            ->save();
        $this->installEntitySchema('entity_test');
        // Grant the 'view test entity' permission.
        $this->installConfig([
            'user',
        ]);
        Role::load(RoleInterface::ANONYMOUS_ID)->grantPermission('view test entity')
            ->save();
        $this->createEntityReferenceField($this->entityType, $this->bundle, $this->fieldName, 'Field test', $this->entityType, 'default', [], FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
        // Set up a field, so that the entity that'll be referenced bubbles up a
        // cache tag when rendering it entirely.
        FieldStorageConfig::create([
            'field_name' => 'body',
            'entity_type' => $this->entityType,
            'type' => 'text',
            'settings' => [],
        ])
            ->save();
        FieldConfig::create([
            'entity_type' => $this->entityType,
            'bundle' => $this->bundle,
            'field_name' => 'body',
            'label' => 'Body',
        ])
            ->save();
        \Drupal::service('entity_display.repository')->getViewDisplay($this->entityType, $this->bundle)
            ->setComponent('body', [
            'type' => 'text_default',
            'settings' => [],
        ])
            ->save();
        FilterFormat::create([
            'format' => 'full_html',
            'name' => 'Full HTML',
        ])->save();
        // Create the entity to be referenced.
        $this->referencedEntity = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityType)
            ->create([
            'name' => $this->randomMachineName(),
        ]);
        $this->referencedEntity->body = [
            'value' => '<p>Hello, world!</p>',
            'format' => 'full_html',
        ];
        $this->referencedEntity
            ->save();
        // Create another entity to be referenced but do not save it.
        $this->unsavedReferencedEntity = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityType)
            ->create([
            'name' => $this->randomMachineName(),
        ]);
        $this->unsavedReferencedEntity->body = [
            'value' => '<p>Hello, unsaved world!</p>',
            'format' => 'full_html',
        ];
    }
    
    /**
     * Assert inaccessible items don't change the data of the fields.
     */
    public function testAccess() {
        // Revoke the 'view test entity' permission for this test.
        Role::load(RoleInterface::ANONYMOUS_ID)->revokePermission('view test entity')
            ->save();
        $field_name = $this->fieldName;
        $referencing_entity = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityType)
            ->create([
            'name' => $this->randomMachineName(),
        ]);
        $referencing_entity->save();
        $referencing_entity->{$field_name}->entity = $this->referencedEntity;
        // Assert user doesn't have access to the entity.
        $this->assertFalse($this->referencedEntity
            ->access('view'), 'Current user does not have access to view the referenced entity.');
        $formatter_manager = $this->container
            ->get('plugin.manager.field.formatter');
        // Get all the existing formatters.
        foreach ($formatter_manager->getOptions('entity_reference') as $formatter => $name) {
            // Set formatter type for the 'full' view mode.
            \Drupal::service('entity_display.repository')->getViewDisplay($this->entityType, $this->bundle)
                ->setComponent($field_name, [
                'type' => $formatter,
            ])
                ->save();
            // Invoke entity view.
            \Drupal::entityTypeManager()->getViewBuilder($referencing_entity->getEntityTypeId())
                ->view($referencing_entity, 'default');
            // Verify the un-accessible item still exists.
            $this->assertEquals($this->referencedEntity
                ->id(), $referencing_entity->{$field_name}->target_id, new FormattableMarkup('The un-accessible item still exists after @name formatter was executed.', [
                '@name' => $name,
            ]));
        }
    }
    
    /**
     * Tests the merging of cache metadata.
     */
    public function testCustomCacheTagFormatter() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $formatter = 'entity_reference_custom_cache_tag';
        $build = $this->buildRenderArray([
            $this->referencedEntity,
        ], $formatter);
        $renderer->renderRoot($build);
        $this->assertContains('custom_cache_tag', $build['#cache']['tags']);
    }
    
    /**
     * Tests the ID formatter.
     */
    public function testIdFormatter() {
        $formatter = 'entity_reference_entity_id';
        $build = $this->buildRenderArray([
            $this->referencedEntity,
            $this->unsavedReferencedEntity,
        ], $formatter);
        $this->assertEquals($this->referencedEntity
            ->id(), $build[0]['#plain_text'], sprintf('The markup returned by the %s formatter is correct for an item with a saved entity.', $formatter));
        $this->assertEquals($this->referencedEntity
            ->getCacheTags(), $build[0]['#cache']['tags'], sprintf('The %s formatter has the expected cache tags.', $formatter));
        $this->assertTrue(!isset($build[1]), sprintf('The markup returned by the %s formatter is correct for an item with a unsaved entity.', $formatter));
    }
    
    /**
     * Tests the entity formatter.
     */
    public function testEntityFormatter() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $formatter = 'entity_reference_entity_view';
        $build = $this->buildRenderArray([
            $this->referencedEntity,
            $this->unsavedReferencedEntity,
        ], $formatter);
        // Test the first field item.
        $expected_rendered_name_field_1 = '
            <div>' . $this->referencedEntity
            ->label() . '</div>
      ';
        $expected_rendered_body_field_1 = '
  <div>
    <div>Body</div>
              <div><p>Hello, world!</p></div>
          </div>
';
        $renderer->renderRoot($build[0]);
        $this->assertEquals('default | ' . $this->referencedEntity
            ->label() . $expected_rendered_name_field_1 . $expected_rendered_body_field_1, $build[0]['#markup'], sprintf('The markup returned by the %s formatter is correct for an item with a saved entity.', $formatter));
        $expected_cache_tags = Cache::mergeTags(\Drupal::entityTypeManager()->getViewBuilder($this->entityType)
            ->getCacheTags(), $this->referencedEntity
            ->getCacheTags());
        $expected_cache_tags = Cache::mergeTags($expected_cache_tags, FilterFormat::load('full_html')->getCacheTags());
        $this->assertEquals($expected_cache_tags, $build[0]['#cache']['tags'], new FormattableMarkup('The @formatter formatter has the expected cache tags.', [
            '@formatter' => $formatter,
        ]));
        // Test the second field item.
        $expected_rendered_name_field_2 = '
            <div>' . $this->unsavedReferencedEntity
            ->label() . '</div>
      ';
        $expected_rendered_body_field_2 = '
  <div>
    <div>Body</div>
              <div><p>Hello, unsaved world!</p></div>
          </div>
';
        $renderer->renderRoot($build[1]);
        $this->assertEquals('default | ' . $this->unsavedReferencedEntity
            ->label() . $expected_rendered_name_field_2 . $expected_rendered_body_field_2, $build[1]['#markup'], sprintf('The markup returned by the %s formatter is correct for an item with a unsaved entity.', $formatter));
    }
    
    /**
     * Tests the recursive rendering protection of the entity formatter.
     */
    public function testEntityFormatterRecursiveRendering() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $formatter = 'entity_reference_entity_view';
        $view_builder = $this->entityTypeManager
            ->getViewBuilder($this->entityType);
        // Set the default view mode to use the 'entity_reference_entity_view'
        // formatter.
        \Drupal::service('entity_display.repository')->getViewDisplay($this->entityType, $this->bundle)
            ->setComponent($this->fieldName, [
            'type' => $formatter,
        ])
            ->save();
        $storage = \Drupal::entityTypeManager()->getStorage($this->entityType);
        $referencing_entity_1 = $storage->create([
            'name' => $this->randomMachineName(),
        ]);
        $referencing_entity_1->save();
        // Create a self-reference.
        $referencing_entity_1->{$this->fieldName}->entity = $referencing_entity_1;
        $referencing_entity_1->save();
        // Check that the recursive rendering stops after it reaches the specified
        // limit.
        $build = $view_builder->view($referencing_entity_1, 'default');
        $output = $renderer->renderRoot($build);
        // The title of entity_test entities is printed twice by default, so we have
        // to multiply the formatter's recursive rendering protection limit by 2.
        // Additionally, we have to take into account 2 additional occurrences of
        // the entity title because we're rendering the full entity, not just the
        // reference field.
        $expected_occurrences = EntityReferenceEntityFormatter::RECURSIVE_RENDER_LIMIT * 2 + 2;
        $actual_occurrences = substr_count($output, $referencing_entity_1->label());
        $this->assertEquals($expected_occurrences, $actual_occurrences);
        // Repeat the process with another entity in order to check that the
        // 'recursive_render_id' counter is generated properly.
        $referencing_entity_2 = $storage->create([
            'name' => $this->randomMachineName(),
        ]);
        $referencing_entity_2->save();
        $referencing_entity_2->{$this->fieldName}->entity = $referencing_entity_2;
        $referencing_entity_2->save();
        $build = $view_builder->view($referencing_entity_2, 'default');
        $output = $renderer->renderRoot($build);
        $actual_occurrences = substr_count($output, $referencing_entity_2->label());
        $this->assertEquals($expected_occurrences, $actual_occurrences);
        // Now render both entities at the same time and check again.
        $build = $view_builder->viewMultiple([
            $referencing_entity_1,
            $referencing_entity_2,
        ], 'default');
        $output = $renderer->renderRoot($build);
        $actual_occurrences = substr_count($output, $referencing_entity_1->label());
        $this->assertEquals($expected_occurrences, $actual_occurrences);
        $actual_occurrences = substr_count($output, $referencing_entity_2->label());
        $this->assertEquals($expected_occurrences, $actual_occurrences);
    }
    
    /**
     * Renders the same entity referenced from different places.
     */
    public function testEntityReferenceRecursiveProtectionWithManyRenderedEntities() {
        $formatter = 'entity_reference_entity_view';
        $view_builder = $this->entityTypeManager
            ->getViewBuilder($this->entityType);
        // Set the default view mode to use the 'entity_reference_entity_view'
        // formatter.
        \Drupal::service('entity_display.repository')->getViewDisplay($this->entityType, $this->bundle)
            ->setComponent($this->fieldName, [
            'type' => $formatter,
        ])
            ->save();
        $storage = $this->entityTypeManager
            ->getStorage($this->entityType);
        
        /** @var \Drupal\Core\Entity\ContentEntityInterface $referenced_entity */
        $referenced_entity = $storage->create([
            'name' => $this->randomMachineName(),
        ]);
        $range = range(0, 30);
        $referencing_entities = array_map(function () use ($storage, $referenced_entity) {
            $referencing_entity = $storage->create([
                'name' => $this->randomMachineName(),
                $this->fieldName => $referenced_entity,
            ]);
            $referencing_entity->save();
            return $referencing_entity;
        }, $range);
        $build = $view_builder->viewMultiple($referencing_entities, 'default');
        $output = $this->render($build);
        // The title of entity_test entities is printed twice by default, so we have
        // to multiply the formatter's recursive rendering protection limit by 2.
        // Additionally, we have to take into account 2 additional occurrences of
        // the entity title because we're rendering the full entity, not just the
        // reference field.
        $expected_occurrences = 30 * 2 + 2;
        $actual_occurrences = substr_count($output, $referenced_entity->get('name')->value);
        $this->assertEquals($expected_occurrences, $actual_occurrences);
    }
    
    /**
     * Tests the label formatter.
     */
    public function testLabelFormatter() {
        $this->installEntitySchema('entity_test_label');
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $formatter = 'entity_reference_label';
        // The 'link' settings is TRUE by default.
        $build = $this->buildRenderArray([
            $this->referencedEntity,
            $this->unsavedReferencedEntity,
        ], $formatter);
        $expected_field_cacheability = [
            'contexts' => [],
            'tags' => [],
            'max-age' => Cache::PERMANENT,
        ];
        $this->assertEquals($expected_field_cacheability, $build['#cache'], 'The field render array contains the entity access cacheability metadata');
        $expected_item_1 = [
            '#type' => 'link',
            '#title' => $this->referencedEntity
                ->label(),
            '#url' => $this->referencedEntity
                ->toUrl(),
            '#options' => $this->referencedEntity
                ->toUrl()
                ->getOptions(),
            '#cache' => [
                'contexts' => [
                    'user.permissions',
                ],
                'tags' => $this->referencedEntity
                    ->getCacheTags(),
            ],
        ];
        $this->assertEquals($renderer->renderRoot($expected_item_1), $renderer->renderRoot($build[0]), sprintf('The markup returned by the %s formatter is correct for an item with a saved entity.', $formatter));
        $this->assertEquals(CacheableMetadata::createFromRenderArray($expected_item_1), CacheableMetadata::createFromRenderArray($build[0]));
        // The second referenced entity is "autocreated", therefore not saved and
        // lacking any URL info.
        $expected_item_2 = [
            '#plain_text' => $this->unsavedReferencedEntity
                ->label(),
            '#cache' => [
                'contexts' => [
                    'user.permissions',
                ],
                'tags' => $this->unsavedReferencedEntity
                    ->getCacheTags(),
                'max-age' => Cache::PERMANENT,
            ],
        ];
        $this->assertEquals($expected_item_2, $build[1], sprintf('The render array returned by the %s formatter is correct for an item with a unsaved entity.', $formatter));
        // Test with the 'link' setting set to FALSE.
        $build = $this->buildRenderArray([
            $this->referencedEntity,
            $this->unsavedReferencedEntity,
        ], $formatter, [
            'link' => FALSE,
        ]);
        $this->assertEquals($this->referencedEntity
            ->label(), $build[0]['#plain_text'], sprintf('The markup returned by the %s formatter is correct for an item with a saved entity.', $formatter));
        $this->assertEquals($this->unsavedReferencedEntity
            ->label(), $build[1]['#plain_text'], sprintf('The markup returned by the %s formatter is correct for an item with a unsaved entity.', $formatter));
        // Test an entity type that doesn't have any link templates, which means
        // \Drupal\Core\Entity\EntityInterface::urlInfo() will throw an exception
        // and the label formatter will output only the label instead of a link.
        $field_storage_config = FieldStorageConfig::loadByName($this->entityType, $this->fieldName);
        $field_storage_config->setSetting('target_type', 'entity_test_label');
        $field_storage_config->save();
        $referenced_entity_with_no_link_template = EntityTestLabel::create([
            'name' => $this->randomMachineName(),
        ]);
        $referenced_entity_with_no_link_template->save();
        $build = $this->buildRenderArray([
            $referenced_entity_with_no_link_template,
        ], $formatter, [
            'link' => TRUE,
        ]);
        $this->assertEquals($referenced_entity_with_no_link_template->label(), $build[0]['#plain_text'], sprintf('The markup returned by the %s formatter is correct for an entity type with no valid link template.', $formatter));
    }
    
    /**
     * Sets field values and returns a render array.
     *
     * The render array structure is as built by
     * \Drupal\Core\Field\FieldItemListInterface::view().
     *
     * @param \Drupal\Core\Entity\EntityInterface[] $referenced_entities
     *   An array of entity objects that will be referenced.
     * @param string $formatter
     *   The formatted plugin that will be used for building the render array.
     * @param array $formatter_options
     *   Settings specific to the formatter. Defaults to the formatter's default
     *   settings.
     *
     * @return array
     *   A render array.
     */
    protected function buildRenderArray(array $referenced_entities, $formatter, $formatter_options = []) {
        // Create the entity that will have the entity reference field.
        $referencing_entity = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityType)
            ->create([
            'name' => $this->randomMachineName(),
        ]);
        $items = $referencing_entity->get($this->fieldName);
        // Assign the referenced entities.
        foreach ($referenced_entities as $referenced_entity) {
            $items[] = [
                'entity' => $referenced_entity,
            ];
        }
        // Build the renderable array for the field.
        return $items->view([
            'type' => $formatter,
            'settings' => $formatter_options,
        ]);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules 61
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityReferenceFormatterTest::$bundle protected property The bundle used in this test.
EntityReferenceFormatterTest::$entityType protected property The entity type used in this test.
EntityReferenceFormatterTest::$fieldName protected property The name of the field used in this test.
EntityReferenceFormatterTest::$referencedEntity protected property The entity to be referenced in this test.
EntityReferenceFormatterTest::$unsavedReferencedEntity protected property An entity that is not yet saved to its persistent storage.
EntityReferenceFormatterTest::buildRenderArray protected function Sets field values and returns a render array.
EntityReferenceFormatterTest::setUp protected function Overrides EntityKernelTestBase::setUp
EntityReferenceFormatterTest::testAccess public function Assert inaccessible items don&#039;t change the data of the fields.
EntityReferenceFormatterTest::testCustomCacheTagFormatter public function Tests the merging of cache metadata.
EntityReferenceFormatterTest::testEntityFormatter public function Tests the entity formatter.
EntityReferenceFormatterTest::testEntityFormatterRecursiveRendering public function Tests the recursive rendering protection of the entity formatter.
EntityReferenceFormatterTest::testEntityReferenceRecursiveProtectionWithManyRenderedEntities public function Renders the same entity referenced from different places.
EntityReferenceFormatterTest::testIdFormatter public function Tests the ID formatter.
EntityReferenceFormatterTest::testLabelFormatter public function Tests the label formatter.
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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