class EntityReferenceSelectionAccessTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Entity/EntityReferenceSelection/EntityReferenceSelectionAccessTest.php \Drupal\Tests\system\Functional\Entity\EntityReferenceSelection\EntityReferenceSelectionAccessTest
  2. 8.9.x core/modules/system/tests/src/Functional/Entity/EntityReferenceSelection/EntityReferenceSelectionAccessTest.php \Drupal\Tests\system\Functional\Entity\EntityReferenceSelection\EntityReferenceSelectionAccessTest
  3. 11.x core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelection/EntityReferenceSelectionAccessTest.php \Drupal\Tests\system\Kernel\Entity\EntityReferenceSelection\EntityReferenceSelectionAccessTest

Tests for the base handlers provided by Entity Reference.

@group entity_reference

Hierarchy

Expanded class hierarchy of EntityReferenceSelectionAccessTest

File

core/modules/system/tests/src/Kernel/Entity/EntityReferenceSelection/EntityReferenceSelectionAccessTest.php, line 28

Namespace

Drupal\Tests\system\Kernel\Entity\EntityReferenceSelection
View source
class EntityReferenceSelectionAccessTest extends KernelTestBase {
    use CommentTestTrait;
    use ContentTypeCreationTrait;
    use MediaTypeCreationTrait;
    use UserCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'comment',
        'field',
        'file',
        'image',
        'node',
        'media',
        'system',
        'taxonomy',
        'text',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installSchema('comment', [
            'comment_entity_statistics',
        ]);
        $this->installSchema('file', [
            'file_usage',
        ]);
        $this->installEntitySchema('comment');
        $this->installEntitySchema('file');
        $this->installEntitySchema('media');
        $this->installEntitySchema('node');
        $this->installEntitySchema('taxonomy_term');
        $this->installEntitySchema('user');
        $this->installConfig([
            'comment',
            'field',
            'media',
            'node',
            'taxonomy',
            'user',
        ]);
        // Create the anonymous and the admin users.
        $anonymous_user = User::create([
            'uid' => 0,
            'name' => '',
        ]);
        $anonymous_user->save();
        // Create role for administrator.
        $admin_user = User::create([
            'uid' => 1,
            'name' => 'admin',
            'status' => 1,
            'roles' => [
                $this->createRole([
                    'administer users',
                ]),
            ],
        ]);
        $admin_user->save();
    }
    
    /**
     * Checks that a selection plugin returns the expected results.
     *
     * @param array $selection_options
     *   An array of options as required by entity reference selection plugins.
     * @param array $tests
     *   An array of tests to run.
     * @param string $handler_name
     *   The name of the entity type selection handler being tested.
     *
     * @internal
     */
    protected function assertReferenceable(array $selection_options, array $tests, string $handler_name) : void {
        $handler = \Drupal::service('plugin.manager.entity_reference_selection')->getInstance($selection_options);
        foreach ($tests as $test) {
            foreach ($test['arguments'] as $arguments) {
                $result = call_user_func_array([
                    $handler,
                    'getReferenceableEntities',
                ], $arguments);
                $this->assertEquals($test['result'], $result, "Valid result set returned by {$handler_name}.");
                $result = call_user_func_array([
                    $handler,
                    'countReferenceableEntities',
                ], $arguments);
                if (!empty($test['result'])) {
                    $bundle = key($test['result']);
                    $count = count($test['result'][$bundle]);
                }
                else {
                    $count = 0;
                }
                $this->assertEquals($count, $result, "Valid count returned by {$handler_name}.");
            }
        }
    }
    
    /**
     * Tests the node-specific overrides of the entity handler.
     */
    public function testNodeHandler() : void {
        $selection_options = [
            'target_type' => 'node',
            'handler' => 'default',
            'target_bundles' => NULL,
        ];
        // Build a set of test data.
        // Titles contain HTML-special characters to test escaping.
        $node_values = [
            'published1' => [
                'type' => 'article',
                'status' => NodeInterface::PUBLISHED,
                'title' => 'Node published1 (<&>)',
                'uid' => 1,
            ],
            'published2' => [
                'type' => 'article',
                'status' => NodeInterface::PUBLISHED,
                'title' => 'Node published2 (<&>)',
                'uid' => 1,
            ],
            'unpublished' => [
                'type' => 'article',
                'status' => NodeInterface::NOT_PUBLISHED,
                'title' => 'Node unpublished (<&>)',
                'uid' => 1,
            ],
        ];
        $nodes = [];
        $node_labels = [];
        foreach ($node_values as $key => $values) {
            $node = Node::create($values);
            $node->save();
            $nodes[$key] = $node;
            $node_labels[$key] = Html::escape($node->label());
        }
        // Test as a non-admin.
        $normal_user = $this->createUser([
            'access content',
        ]);
        $this->setCurrentUser($normal_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'article' => [
                        $nodes['published1']->id() => $node_labels['published1'],
                        $nodes['published2']->id() => $node_labels['published2'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'published1',
                        'CONTAINS',
                    ],
                    [
                        'Published1',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'article' => [
                        $nodes['published1']->id() => $node_labels['published1'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'published2',
                        'CONTAINS',
                    ],
                    [
                        'Published2',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'article' => [
                        $nodes['published2']->id() => $node_labels['published2'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'invalid node',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
            [
                'arguments' => [
                    [
                        'Node unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Node handler');
        // Test as an admin.
        $content_admin = $this->createUser([
            'access content',
            'bypass node access',
        ]);
        $this->setCurrentUser($content_admin);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'article' => [
                        $nodes['published1']->id() => $node_labels['published1'],
                        $nodes['published2']->id() => $node_labels['published2'],
                        $nodes['unpublished']->id() => $node_labels['unpublished'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Node unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'article' => [
                        $nodes['unpublished']->id() => $node_labels['unpublished'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Node handler (admin)');
    }
    
    /**
     * Tests the user-specific overrides of the entity handler.
     */
    public function testUserHandler() : void {
        $selection_options = [
            'target_type' => 'user',
            'handler' => 'default',
            'target_bundles' => NULL,
            'include_anonymous' => TRUE,
        ];
        // Build a set of test data.
        $user_values = [
            'anonymous' => User::load(0),
            'admin' => User::load(1),
            'non_admin' => [
                'name' => 'non_admin <&>',
                'mail' => 'non_admin@example.com',
                'roles' => [],
                'pass' => \Drupal::service('password_generator')->generate(),
                'status' => 1,
            ],
            'blocked' => [
                'name' => 'blocked <&>',
                'mail' => 'blocked@example.com',
                'roles' => [],
                'pass' => \Drupal::service('password_generator')->generate(),
                'status' => 0,
            ],
        ];
        $user_values['anonymous']->name = $this->config('user.settings')
            ->get('anonymous');
        $users = [];
        $user_labels = [];
        foreach ($user_values as $key => $values) {
            if (is_array($values)) {
                $account = User::create($values);
                $account->save();
            }
            else {
                $account = $values;
            }
            $users[$key] = $account;
            $user_labels[$key] = Html::escape($account->getAccountName());
        }
        // Test as a non-admin.
        $this->setCurrentUser($users['non_admin']);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['admin']->id() => $user_labels['admin'],
                        $users['non_admin']->id() => $user_labels['non_admin'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'non_admin',
                        'CONTAINS',
                    ],
                    [
                        'NON_ADMIN',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['non_admin']->id() => $user_labels['non_admin'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'invalid user',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
            [
                'arguments' => [
                    [
                        'blocked',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'User handler');
        $this->setCurrentUser($users['admin']);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['anonymous']->id() => $user_labels['anonymous'],
                        $users['admin']->id() => $user_labels['admin'],
                        $users['non_admin']->id() => $user_labels['non_admin'],
                        $users['blocked']->id() => $user_labels['blocked'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'blocked',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['blocked']->id() => $user_labels['blocked'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Anonymous',
                        'CONTAINS',
                    ],
                    [
                        'anonymous',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['anonymous']->id() => $user_labels['anonymous'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'User handler (admin)');
        // Test the 'include_anonymous' option.
        $selection_options['include_anonymous'] = FALSE;
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        'Anonymous',
                        'CONTAINS',
                    ],
                    [
                        'anonymous',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'User handler (does not include anonymous)');
        // Check that the Anonymous user is not included in the results when no
        // label matching is done, for example when using the 'options_select'
        // widget.
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                    ],
                ],
                'result' => [
                    'user' => [
                        $users['admin']->id() => $user_labels['admin'],
                        $users['non_admin']->id() => $user_labels['non_admin'],
                        $users['blocked']->id() => $user_labels['blocked'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'User handler (does not include anonymous)');
    }
    
    /**
     * Tests the comment-specific overrides of the entity handler.
     */
    public function testCommentHandler() : void {
        $selection_options = [
            'target_type' => 'comment',
            'handler' => 'default',
            'target_bundles' => NULL,
        ];
        // Build a set of test data.
        $this->createContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        $node_values = [
            'published' => [
                'type' => 'article',
                'status' => 1,
                'title' => 'Node published',
                'uid' => 1,
            ],
            'unpublished' => [
                'type' => 'article',
                'status' => 0,
                'title' => 'Node unpublished',
                'uid' => 1,
            ],
        ];
        $nodes = [];
        foreach ($node_values as $key => $values) {
            $node = Node::create($values);
            $node->save();
            $nodes[$key] = $node;
        }
        // Create comment field on article.
        $this->addDefaultCommentField('node', 'article');
        $comment_values = [
            'published_published' => [
                'entity_id' => $nodes['published']->id(),
                'entity_type' => 'node',
                'field_name' => 'comment',
                'uid' => 1,
                'cid' => NULL,
                'pid' => 0,
                'status' => CommentInterface::PUBLISHED,
                'subject' => 'Comment Published <&>',
                'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            ],
            'published_unpublished' => [
                'entity_id' => $nodes['published']->id(),
                'entity_type' => 'node',
                'field_name' => 'comment',
                'uid' => 1,
                'cid' => NULL,
                'pid' => 0,
                'status' => CommentInterface::NOT_PUBLISHED,
                'subject' => 'Comment Unpublished <&>',
                'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            ],
            'unpublished_published' => [
                'entity_id' => $nodes['unpublished']->id(),
                'entity_type' => 'node',
                'field_name' => 'comment',
                'uid' => 1,
                'cid' => NULL,
                'pid' => 0,
                'status' => CommentInterface::NOT_PUBLISHED,
                'subject' => 'Comment Published on Unpublished node <&>',
                'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
            ],
        ];
        $comments = [];
        $comment_labels = [];
        foreach ($comment_values as $key => $values) {
            $comment = Comment::create($values);
            $comment->save();
            $comments[$key] = $comment;
            $comment_labels[$key] = Html::escape($comment->label());
        }
        // Test as a non-admin.
        $normal_user = $this->createUser([
            'access content',
            'access comments',
        ]);
        $this->setCurrentUser($normal_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'comment' => [
                        $comments['published_published']->cid->value => $comment_labels['published_published'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Published',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'comment' => [
                        $comments['published_published']->cid->value => $comment_labels['published_published'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'invalid comment',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
            [
                'arguments' => [
                    [
                        'Comment Unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Comment handler');
        // Test as a comment admin.
        $admin_user = $this->createUser([
            'access content',
            'access comments',
            'administer comments',
        ]);
        $this->setCurrentUser($admin_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'comment' => [
                        $comments['published_published']->cid->value => $comment_labels['published_published'],
                        $comments['published_unpublished']->cid->value => $comment_labels['published_unpublished'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Comment handler (comment admin)');
        // Test as a node and comment admin.
        $admin_user = $this->createUser([
            'access content',
            'access comments',
            'administer comments',
            'bypass node access',
        ]);
        $this->setCurrentUser($admin_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'comment' => [
                        $comments['published_published']->cid->value => $comment_labels['published_published'],
                        $comments['published_unpublished']->cid->value => $comment_labels['published_unpublished'],
                        $comments['unpublished_published']->cid->value => $comment_labels['unpublished_published'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Comment handler (comment + node admin)');
    }
    
    /**
     * Tests the term-specific overrides of the selection handler.
     */
    public function testTermHandler() : void {
        // Create a 'Tags' vocabulary.
        Vocabulary::create([
            'name' => 'Tags',
            'description' => $this->randomMachineName(),
            'vid' => 'tags',
        ])
            ->save();
        $selection_options = [
            'target_type' => 'taxonomy_term',
            'handler' => 'default',
            'target_bundles' => NULL,
        ];
        // Build a set of test data.
        $term_values = [
            'published1' => [
                'vid' => 'tags',
                'status' => 1,
                'name' => 'Term published1',
            ],
            'published2' => [
                'vid' => 'tags',
                'status' => 1,
                'name' => 'Term published2',
            ],
            'unpublished' => [
                'vid' => 'tags',
                'status' => 0,
                'name' => 'Term unpublished',
            ],
            'published3' => [
                'vid' => 'tags',
                'status' => 1,
                'name' => 'Term published3',
                'parent' => 'unpublished',
            ],
            'published4' => [
                'vid' => 'tags',
                'status' => 1,
                'name' => 'Term published4',
                'parent' => 'published3',
            ],
        ];
        $terms = [];
        $term_labels = [];
        foreach ($term_values as $key => $values) {
            $term = Term::create($values);
            if (isset($values['parent'])) {
                $term->parent->entity = $terms[$values['parent']];
            }
            $term->save();
            $terms[$key] = $term;
            $term_labels[$key] = Html::escape($term->label());
        }
        // Test as a non-admin.
        $normal_user = $this->createUser([
            'access content',
        ]);
        $this->setCurrentUser($normal_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'tags' => [
                        $terms['published1']->id() => $term_labels['published1'],
                        $terms['published2']->id() => $term_labels['published2'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'published1',
                        'CONTAINS',
                    ],
                    [
                        'Published1',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'tags' => [
                        $terms['published1']->id() => $term_labels['published1'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'published2',
                        'CONTAINS',
                    ],
                    [
                        'Published2',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'tags' => [
                        $terms['published2']->id() => $term_labels['published2'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'invalid term',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
            [
                'arguments' => [
                    [
                        'Term unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Term handler');
        // Test as an admin.
        $admin_user = $this->createUser([
            'access content',
            'administer taxonomy',
        ]);
        $this->setCurrentUser($admin_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'tags' => [
                        $terms['published1']->id() => $term_labels['published1'],
                        $terms['published2']->id() => $term_labels['published2'],
                        $terms['unpublished']->id() => $term_labels['unpublished'],
                        $terms['published3']->id() => '-' . $term_labels['published3'],
                        $terms['published4']->id() => '--' . $term_labels['published4'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Term unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    'tags' => [
                        $terms['unpublished']->id() => $term_labels['unpublished'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Term handler (admin)');
    }
    
    /**
     * Tests the selection handler for the media entity type.
     */
    public function testMediaHandler() : void {
        $selection_options = [
            'target_type' => 'media',
            'handler' => 'default',
            'target_bundles' => NULL,
        ];
        // Build a set of test data.
        $media_type = $this->createMediaType('file');
        $media_values = [
            'published' => [
                'bundle' => $media_type->id(),
                'status' => 1,
                'name' => 'Media published',
                'uid' => 1,
            ],
            'unpublished' => [
                'bundle' => $media_type->id(),
                'status' => 0,
                'name' => 'Media unpublished',
                'uid' => 1,
            ],
        ];
        $media_entities = [];
        $media_labels = [];
        foreach ($media_values as $key => $values) {
            $media = Media::create($values);
            $media->save();
            $media_entities[$key] = $media;
            $media_labels[$key] = Html::escape($media->label());
        }
        // Test as a non-admin.
        $normal_user = $this->createUser([
            'view media',
        ]);
        $this->setCurrentUser($normal_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    $media_type->id() => [
                        $media_entities['published']->id() => $media_labels['published'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Media unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Media handler');
        // Test as an admin.
        $admin_user = $this->createUser([
            'view media',
            'administer media',
        ]);
        $this->setCurrentUser($admin_user);
        $referenceable_tests = [
            [
                'arguments' => [
                    [
                        NULL,
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    $media_type->id() => [
                        $media_entities['published']->id() => $media_labels['published'],
                        $media_entities['unpublished']->id() => $media_labels['unpublished'],
                    ],
                ],
            ],
            [
                'arguments' => [
                    [
                        'Media unpublished',
                        'CONTAINS',
                    ],
                ],
                'result' => [
                    $media_type->id() => [
                        $media_entities['unpublished']->id() => $media_labels['unpublished'],
                    ],
                ],
            ],
        ];
        $this->assertReferenceable($selection_options, $referenceable_tests, 'Media handler (admin)');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::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.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
EntityReferenceSelectionAccessTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
EntityReferenceSelectionAccessTest::assertReferenceable protected function Checks that a selection plugin returns the expected results.
EntityReferenceSelectionAccessTest::setUp protected function Overrides KernelTestBase::setUp
EntityReferenceSelectionAccessTest::testCommentHandler public function Tests the comment-specific overrides of the entity handler.
EntityReferenceSelectionAccessTest::testMediaHandler public function Tests the selection handler for the media entity type.
EntityReferenceSelectionAccessTest::testNodeHandler public function Tests the node-specific overrides of the entity handler.
EntityReferenceSelectionAccessTest::testTermHandler public function Tests the term-specific overrides of the selection handler.
EntityReferenceSelectionAccessTest::testUserHandler public function Tests the user-specific overrides of the entity handler.
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. 3
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. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 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 protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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::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.
RandomGeneratorTrait::randomStringValidate Deprecated 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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.

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