class ViewsEntitySchemaSubscriberIntegrationTest

Same name in other branches
  1. 9 core/modules/views/tests/src/Kernel/EventSubscriber/ViewsEntitySchemaSubscriberIntegrationTest.php \Drupal\Tests\views\Kernel\EventSubscriber\ViewsEntitySchemaSubscriberIntegrationTest
  2. 10 core/modules/views/tests/src/Kernel/EventSubscriber/ViewsEntitySchemaSubscriberIntegrationTest.php \Drupal\Tests\views\Kernel\EventSubscriber\ViewsEntitySchemaSubscriberIntegrationTest
  3. 11.x core/modules/views/tests/src/Kernel/EventSubscriber/ViewsEntitySchemaSubscriberIntegrationTest.php \Drupal\Tests\views\Kernel\EventSubscriber\ViewsEntitySchemaSubscriberIntegrationTest

Tests \Drupal\views\EventSubscriber\ViewsEntitySchemaSubscriber

@group Views

Hierarchy

Expanded class hierarchy of ViewsEntitySchemaSubscriberIntegrationTest

File

core/modules/views/tests/src/Kernel/EventSubscriber/ViewsEntitySchemaSubscriberIntegrationTest.php, line 15

Namespace

Drupal\Tests\views\Kernel\EventSubscriber
View source
class ViewsEntitySchemaSubscriberIntegrationTest extends ViewsKernelTestBase {
    use EntityDefinitionTestTrait;
    
    /**
     * The entity definition update manager.
     *
     * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
     */
    protected $entityDefinitionUpdateManager;
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'entity_test',
        'entity_test_update',
        'user',
        'text',
    ];
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view_entity_test',
        'test_view_entity_test_revision',
        'test_view_entity_test_data',
        'test_view_entity_test_additional_base_field',
    ];
    
    /**
     * The event dispatcher.
     *
     * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
     */
    protected $eventDispatcher;
    
    /**
     * The tested event subscriber of views.
     *
     * @var \Drupal\views\EventSubscriber\ViewsEntitySchemaSubscriber
     */
    protected $eventSubscriber;
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * The state service.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) {
        parent::setUp();
        $this->eventDispatcher = $this->container
            ->get('event_dispatcher');
        $this->eventSubscriber = $this->container
            ->get('views.entity_schema_subscriber');
        $this->entityDefinitionUpdateManager = $this->container
            ->get('entity.definition_update_manager');
        $this->entityTypeManager = $this->container
            ->get('entity_type.manager');
        $this->state = $this->container
            ->get('state');
        $this->database = $this->container
            ->get('database');
        // Install every entity type's schema that wasn't installed in the parent
        // method.
        foreach (array_diff_key($this->entityTypeManager
            ->getDefinitions(), array_flip([
            'user',
            'entity_test',
        ])) as $entity_type_id => $entity_type) {
            $this->installEntitySchema($entity_type_id);
        }
    }
    
    /**
     * Tests that views are disabled when an entity type is deleted.
     */
    public function testDeleteEntityType() {
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        // Make the test entity type revisionable.
        $this->updateEntityTypeToRevisionable(TRUE);
        $views = $entity_storage->loadMultiple();
        // Ensure that all test views exists.
        $this->assertTrue(isset($views['test_view_entity_test']));
        $this->assertTrue(isset($views['test_view_entity_test_revision']));
        $this->assertTrue(isset($views['test_view_entity_test_data']));
        $this->assertTrue(isset($views['test_view_entity_test_additional_base_field']));
        $event = new EntityTypeEvent($this->entityTypeManager
            ->getDefinition('entity_test_update'));
        $this->eventDispatcher
            ->dispatch(EntityTypeEvents::DELETE, $event);
        // We expect that views which use 'entity_test_update' as base tables are
        // disabled.
        $views = $entity_storage->loadMultiple();
        // Ensure that all test views still exists after the deletion of the
        // entity type.
        $this->assertTrue(isset($views['test_view_entity_test']));
        $this->assertTrue(isset($views['test_view_entity_test_revision']));
        $this->assertTrue(isset($views['test_view_entity_test_data']));
        $this->assertTrue(isset($views['test_view_entity_test_additional_base_field']));
        // Ensure that they are all disabled.
        $this->assertFalse($views['test_view_entity_test']->status());
        $this->assertFalse($views['test_view_entity_test_revision']->status());
        $this->assertFalse($views['test_view_entity_test_data']->status());
        $this->assertFalse($views['test_view_entity_test_additional_base_field']->status());
    }
    
    /**
     * Tests that renaming base tables adapts the views.
     */
    public function testBaseTableRename() {
        $this->renameBaseTable();
        $this->applyEntityUpdates('entity_test_update');
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test');
        // Ensure the base table got renamed, so also the views fields.
        $this->assertEqual('entity_test_update_new', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update_new', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_new', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
            'test_view_entity_test_data',
            'test_view_entity_test_additional_base_field',
        ]);
    }
    
    /**
     * Tests that renaming data tables adapts the views.
     */
    public function testDataTableRename() {
        $this->updateEntityTypeToTranslatable(TRUE);
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_data');
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        // Ensure that the data table is used.
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->renameDataTable();
        $this->applyEntityUpdates('entity_test_update');
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_data');
        // Ensure the data table got renamed, so also the views fields.
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data_new', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
            'test_view_entity_test_data',
        ]);
    }
    
    /**
     * Tests that renaming revision tables adapts the views.
     */
    public function testRevisionBaseTableRename() {
        $this->updateEntityTypeToRevisionable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_revision');
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['name']['table']);
        $this->renameRevisionBaseTable();
        $this->applyEntityUpdates('entity_test_update');
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_revision');
        // Ensure the base table got renamed, so also the views fields.
        $this->assertEqual('entity_test_update_revision_new', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update_revision_new', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision_new', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test_revision',
        ]);
    }
    
    /**
     * Tests that renaming revision tables adapts the views.
     */
    public function testRevisionDataTableRename() {
        $this->updateEntityTypeToRevisionableAndTranslatable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_revision');
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision_data', $display['display_options']['fields']['name']['table']);
        $this->renameRevisionDataTable();
        $this->applyEntityUpdates('entity_test_update');
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_revision');
        // Ensure the base table got renamed, so also the views fields.
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision_data_new', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
            'test_view_entity_test_revision',
        ]);
    }
    
    /**
     * Tests that adding data tables adapts the views.
     */
    public function testDataTableAddition() {
        $this->updateEntityTypeToTranslatable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test');
        // Ensure the data table got renamed, so also the views fields.
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
        ]);
    }
    
    /**
     * Tests that enabling revisions doesn't do anything.
     */
    public function testRevisionEnabling() {
        $this->updateEntityTypeToRevisionable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test');
        // Ensure that nothing happens.
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([]);
    }
    
    /**
     * Tests that removing revision support disables the view.
     */
    public function testRevisionDisabling() {
        $this->updateEntityTypeToRevisionable(TRUE);
        $this->updateEntityTypeToNotRevisionable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test_revision');
        $this->assertFalse($view->status());
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test_revision',
        ]);
    }
    
    /**
     * Tests a bunch possible entity definition table updates.
     */
    public function testVariousTableUpdates() {
        // We want to test the following permutations of entity definition updates:
        // base <-> base + translation
        // base + translation <-> base + translation + revision
        // base + revision <-> base + translation + revision
        // base <-> base + revision
        // base <-> base + translation + revision
        // base <-> base + translation
        $this->updateEntityTypeToTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        $this->resetEntityType();
        // base + translation <-> base + translation + revision
        $this->updateEntityTypeToTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToRevisionable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotRevisionable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->resetEntityType();
        // base + revision <-> base + translation + revision
        $this->updateEntityTypeToRevisionable();
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        $this->resetEntityType();
        // base <-> base + revision
        $this->updateEntityTypeToRevisionable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotRevisionable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        $this->resetEntityType();
        // base <-> base + translation + revision
        $this->updateEntityTypeToRevisionable(TRUE);
        $this->updateEntityTypeToTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotRevisionable(TRUE);
        $this->updateEntityTypeToNotTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay();
        $this->assertEqual('entity_test_update', $view->get('base_table'));
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
            'test_view_entity_test_data',
            'test_view_entity_test_revision',
        ]);
    }
    
    /**
     * Tests some possible entity table updates for a revision view.
     */
    public function testVariousTableUpdatesForRevisionView() {
        // base + revision <-> base + translation + revision
        $this->updateEntityTypeToRevisionable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay(TRUE);
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay(TRUE);
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision_data', $display['display_options']['fields']['name']['table']);
        $this->updateEntityTypeToNotTranslatable(TRUE);
        list($view, $display) = $this->getUpdatedViewAndDisplay(TRUE);
        $this->assertEqual('entity_test_update_revision', $view->get('base_table'));
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['id']['table']);
        $this->assertEqual('entity_test_update_revision', $display['display_options']['fields']['name']['table']);
        // Check that only the impacted views have been updated.
        $this->assertUpdatedViews([
            'test_view_entity_test',
            'test_view_entity_test_data',
            'test_view_entity_test_revision',
        ]);
    }
    
    /**
     * Tests the case when a view could not be updated automatically.
     */
    public function testViewSaveException() {
        $this->renameBaseTable();
        \Drupal::state()->set('entity_test_update.throw_view_exception', 'test_view_entity_test');
        $this->applyEntityUpdates('entity_test_update');
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load('test_view_entity_test');
        // Check that the table names were not updated automatically for the
        // 'test_view_entity_test' view.
        $this->assertEquals('entity_test_update', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEquals('entity_test_update', $display['display_options']['fields']['id']['table']);
        $this->assertEquals('entity_test_update', $display['display_options']['fields']['name']['table']);
        // Check that the other two views impacted by the entity update were updated
        // automatically.
        $view = $entity_storage->load('test_view_entity_test_data');
        $this->assertEquals('entity_test_update_new', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEquals('entity_test_update_new', $display['display_options']['fields']['id']['table']);
        $this->assertEquals('entity_test_update_data', $display['display_options']['fields']['name']['table']);
        $view = $entity_storage->load('test_view_entity_test_additional_base_field');
        $this->assertEquals('entity_test_update_new', $view->get('base_table'));
        $display = $view->getDisplay('default');
        $this->assertEquals('entity_test_update_new', $display['display_options']['fields']['id']['table']);
        $this->assertEquals('entity_test_update_new', $display['display_options']['fields']['new_base_field']['table']);
        $this->assertUpdatedViews([
            'test_view_entity_test_data',
            'test_view_entity_test_additional_base_field',
        ]);
    }
    
    /**
     * Tests that broken views are handled gracefully.
     */
    public function testBrokenView() {
        $view_id = 'test_view_entity_test';
        $this->state
            ->set('views_test_config.broken_view', $view_id);
        $this->updateEntityTypeToTranslatable(TRUE);
        
        /** @var \Drupal\views\Entity\View $view */
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        $view = $entity_storage->load($view_id);
        // The broken handler should have been removed.
        $display = $view->getDisplay('default');
        $this->assertFalse(isset($display['display_options']['fields']['id_broken']));
        $this->assertUpdatedViews([
            $view_id,
        ]);
    }
    
    /**
     * Gets a view and its display.
     *
     * @param bool $revision
     *   (optional) TRUE if we want to get a revision view.
     *
     * @return array
     *   An array with the view as first item, and the display as second.
     */
    protected function getUpdatedViewAndDisplay($revision = FALSE) {
        $entity_storage = $this->entityTypeManager
            ->getStorage('view');
        
        /** @var \Drupal\views\Entity\View $view */
        $view = $entity_storage->load($revision ? 'test_view_entity_test_revision' : 'test_view_entity_test');
        $display = $view->getDisplay('default');
        return [
            $view,
            $display,
        ];
    }
    
    /**
     * Checks that the passed-in view IDs were the only ones updated.
     *
     * @param string[] $updated_view_ids
     *   An array of view IDs.
     */
    protected function assertUpdatedViews($updated_view_ids) {
        $all_view_ids = array_keys($this->entityTypeManager
            ->getStorage('view')
            ->loadMultiple());
        $view_save_count = \Drupal::state()->get('views_test_data.view_save_count', []);
        foreach ($all_view_ids as $view_id) {
            if (in_array($view_id, $updated_view_ids, TRUE)) {
                $this->assertTrue(isset($view_save_count[$view_id]), "The {$view_id} view has been updated.");
            }
            else {
                $this->assertFalse(isset($view_save_count[$view_id]), "The {$view_id} view has not been updated.");
            }
        }
        // Check that all test cases are updating only a subset of all the available
        // views.
        $this->assertGreaterThan(count($updated_view_ids), count($all_view_ids));
    }

}

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 the raw text IS NOT found escaped on the 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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame()
instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals()
instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use
self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use
self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue()
instead.
AssertLegacyTrait::verbose 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.
EntityDefinitionTestTrait::addBaseField protected function Adds a new base field to the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::addBaseFieldIndex protected function Adds a single-field index to the base field.
EntityDefinitionTestTrait::addBundleField protected function Adds a new bundle field to the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::addEntityIndex protected function Adds an index to the &#039;entity_test_update&#039; entity type&#039;s base table.
EntityDefinitionTestTrait::addLongNameBaseField protected function Adds a long-named base field to the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::addRevisionableBaseField protected function Adds a new revisionable base field to the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::applyEntityUpdates protected function Applies all the detected valid changes.
EntityDefinitionTestTrait::deleteEntityType protected function Removes the entity type.
EntityDefinitionTestTrait::doEntityUpdate protected function Performs an entity type definition update.
EntityDefinitionTestTrait::doFieldUpdate protected function Performs a field storage definition update.
EntityDefinitionTestTrait::enableNewEntityType protected function Enables a new entity type definition.
EntityDefinitionTestTrait::getUpdatedEntityTypeDefinition protected function Returns an entity type definition, possibly updated to be rev or mul.
EntityDefinitionTestTrait::getUpdatedFieldStorageDefinitions protected function Returns the required rev / mul field definitions for an entity type.
EntityDefinitionTestTrait::makeBaseFieldEntityKey protected function Promotes a field to an entity key.
EntityDefinitionTestTrait::modifyBaseField protected function Modifies the new base field from &#039;string&#039; to &#039;text&#039;.
EntityDefinitionTestTrait::modifyBundleField protected function Modifies the new bundle field from &#039;string&#039; to &#039;text&#039;.
EntityDefinitionTestTrait::removeBaseField protected function Removes the new base field from the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::removeBaseFieldIndex protected function Removes the index added in addBaseFieldIndex().
EntityDefinitionTestTrait::removeBundleField protected function Removes the new bundle field from the &#039;entity_test_update&#039; entity type.
EntityDefinitionTestTrait::removeEntityIndex protected function Removes the index added in addEntityIndex().
EntityDefinitionTestTrait::renameBaseTable protected function Renames the base table to &#039;entity_test_update_new&#039;.
EntityDefinitionTestTrait::renameDataTable protected function Renames the data table to &#039;entity_test_update_data_new&#039;.
EntityDefinitionTestTrait::renameRevisionBaseTable protected function Renames the revision table to &#039;entity_test_update_revision_new&#039;.
EntityDefinitionTestTrait::renameRevisionDataTable protected function Renames the revision data table to &#039;entity_test_update_revision_data_new&#039;.
EntityDefinitionTestTrait::resetEntityType protected function Resets the entity type definition.
EntityDefinitionTestTrait::updateEntityTypeToNotRevisionable protected function Updates the &#039;entity_test_update&#039; entity type not revisionable.
EntityDefinitionTestTrait::updateEntityTypeToNotTranslatable protected function Updates the &#039;entity_test_update&#039; entity type to not translatable.
EntityDefinitionTestTrait::updateEntityTypeToRevisionable protected function Updates the &#039;entity_test_update&#039; entity type to revisionable.
EntityDefinitionTestTrait::updateEntityTypeToRevisionableAndTranslatable protected function Updates the &#039;entity_test_update&#039; entity type to revisionable and
translatable.
EntityDefinitionTestTrait::updateEntityTypeToTranslatable protected function Updates the &#039;entity_test_update&#039; entity type to translatable.
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. 7
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::$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. 6
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
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.
ViewsEntitySchemaSubscriberIntegrationTest::$entityDefinitionUpdateManager protected property The entity definition update manager.
ViewsEntitySchemaSubscriberIntegrationTest::$entityTypeManager protected property The entity type manager service.
ViewsEntitySchemaSubscriberIntegrationTest::$eventDispatcher protected property The event dispatcher.
ViewsEntitySchemaSubscriberIntegrationTest::$eventSubscriber protected property The tested event subscriber of views.
ViewsEntitySchemaSubscriberIntegrationTest::$modules public static property Modules to enable. Overrides ViewsKernelTestBase::$modules
ViewsEntitySchemaSubscriberIntegrationTest::$state protected property The state service.
ViewsEntitySchemaSubscriberIntegrationTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
ViewsEntitySchemaSubscriberIntegrationTest::assertUpdatedViews protected function Checks that the passed-in view IDs were the only ones updated.
ViewsEntitySchemaSubscriberIntegrationTest::getUpdatedViewAndDisplay protected function Gets a view and its display.
ViewsEntitySchemaSubscriberIntegrationTest::setUp protected function Overrides ViewsKernelTestBase::setUp
ViewsEntitySchemaSubscriberIntegrationTest::testBaseTableRename public function Tests that renaming base tables adapts the views.
ViewsEntitySchemaSubscriberIntegrationTest::testBrokenView public function Tests that broken views are handled gracefully.
ViewsEntitySchemaSubscriberIntegrationTest::testDataTableAddition public function Tests that adding data tables adapts the views.
ViewsEntitySchemaSubscriberIntegrationTest::testDataTableRename public function Tests that renaming data tables adapts the views.
ViewsEntitySchemaSubscriberIntegrationTest::testDeleteEntityType public function Tests that views are disabled when an entity type is deleted.
ViewsEntitySchemaSubscriberIntegrationTest::testRevisionBaseTableRename public function Tests that renaming revision tables adapts the views.
ViewsEntitySchemaSubscriberIntegrationTest::testRevisionDataTableRename public function Tests that renaming revision tables adapts the views.
ViewsEntitySchemaSubscriberIntegrationTest::testRevisionDisabling public function Tests that removing revision support disables the view.
ViewsEntitySchemaSubscriberIntegrationTest::testRevisionEnabling public function Tests that enabling revisions doesn&#039;t do anything.
ViewsEntitySchemaSubscriberIntegrationTest::testVariousTableUpdates public function Tests a bunch possible entity definition table updates.
ViewsEntitySchemaSubscriberIntegrationTest::testVariousTableUpdatesForRevisionView public function Tests some possible entity table updates for a revision view.
ViewsEntitySchemaSubscriberIntegrationTest::testViewSaveException public function Tests the case when a view could not be updated automatically.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 8
ViewsKernelTestBase::executeView protected function Executes a view with debugging.
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. 5
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. 21

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