class VocabularyPermissionsTest

Same name in other branches
  1. 9 core/modules/taxonomy/tests/src/Functional/VocabularyPermissionsTest.php \Drupal\Tests\taxonomy\Functional\VocabularyPermissionsTest
  2. 10 core/modules/taxonomy/tests/src/Functional/VocabularyPermissionsTest.php \Drupal\Tests\taxonomy\Functional\VocabularyPermissionsTest
  3. 11.x core/modules/taxonomy/tests/src/Functional/VocabularyPermissionsTest.php \Drupal\Tests\taxonomy\Functional\VocabularyPermissionsTest

Tests the taxonomy vocabulary permissions.

@group taxonomy

Hierarchy

Expanded class hierarchy of VocabularyPermissionsTest

File

core/modules/taxonomy/tests/src/Functional/VocabularyPermissionsTest.php, line 12

Namespace

Drupal\Tests\taxonomy\Functional
View source
class VocabularyPermissionsTest extends TaxonomyTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'help',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    protected function setUp() {
        parent::setUp();
        $this->drupalPlaceBlock('page_title_block');
        $this->drupalPlaceBlock('local_actions_block');
        $this->drupalPlaceBlock('help_block');
    }
    
    /**
     * Create, edit and delete a vocabulary via the user interface.
     */
    public function testVocabularyPermissionsVocabulary() {
        // VocabularyTest.php already tests for user with "administer taxonomy"
        // permission.
        // Test as user without proper permissions.
        $authenticated_user = $this->drupalCreateUser([]);
        $this->drupalLogin($authenticated_user);
        $assert_session = $this->assertSession();
        // Visit the main taxonomy administration page.
        $this->drupalGet('admin/structure/taxonomy');
        $assert_session->statusCodeEquals(403);
        // Test as user with "access taxonomy overview" permissions.
        $proper_user = $this->drupalCreateUser([
            'access taxonomy overview',
        ]);
        $this->drupalLogin($proper_user);
        // Visit the main taxonomy administration page.
        $this->drupalGet('admin/structure/taxonomy');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('Vocabulary name');
        $assert_session->linkNotExists('Add vocabulary');
    }
    
    /**
     * Test the vocabulary overview permission.
     */
    public function testTaxonomyVocabularyOverviewPermissions() {
        // Create two vocabularies, one with two terms, the other without any term.
        
        /** @var \Drupal\taxonomy\Entity\Vocabulary $vocabulary1 , $vocabulary2 */
        $vocabulary1 = $this->createVocabulary();
        $vocabulary2 = $this->createVocabulary();
        $vocabulary1_id = $vocabulary1->id();
        $vocabulary2_id = $vocabulary2->id();
        $this->createTerm($vocabulary1);
        $this->createTerm($vocabulary1);
        // Assert expected help texts on first vocabulary.
        $edit_help_text = t('You can reorganize the terms in @capital_name using their drag-and-drop handles, and group terms under a parent term by sliding them under and to the right of the parent.', [
            '@capital_name' => Unicode::ucfirst($vocabulary1->label()),
        ]);
        $no_edit_help_text = t('@capital_name contains the following terms.', [
            '@capital_name' => Unicode::ucfirst($vocabulary1->label()),
        ]);
        $assert_session = $this->assertSession();
        // Logged in as admin user with 'administer taxonomy' permission.
        $admin_user = $this->drupalCreateUser([
            'administer taxonomy',
        ]);
        $this->drupalLogin($admin_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkExists('Edit');
        $assert_session->linkExists('Delete');
        $assert_session->linkExists('Add term');
        $assert_session->buttonExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldExists('Weight');
        $assert_session->pageTextContains($edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkExists('Add term');
        // Login as a user without any of the required permissions.
        $no_permission_user = $this->drupalCreateUser();
        $this->drupalLogin($no_permission_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(403);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(403);
        // Log in as a user with only the overview permission, neither edit nor
        // delete operations must be available and no Save button.
        $overview_only_user = $this->drupalCreateUser([
            'access taxonomy overview',
        ]);
        $this->drupalLogin($overview_only_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkNotExists('Edit');
        $assert_session->linkNotExists('Delete');
        $assert_session->buttonNotExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldNotExists('Weight');
        $assert_session->linkNotExists('Add term');
        $assert_session->pageTextContains($no_edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should not be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkNotExists('Add term');
        // Login as a user with permission to edit terms, only edit link should be
        // visible.
        $edit_user = $this->createUser([
            'access taxonomy overview',
            'edit terms in ' . $vocabulary1_id,
            'edit terms in ' . $vocabulary2_id,
        ]);
        $this->drupalLogin($edit_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkExists('Edit');
        $assert_session->linkNotExists('Delete');
        $assert_session->buttonExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldExists('Weight');
        $assert_session->linkNotExists('Add term');
        $assert_session->pageTextContains($edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should not be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkNotExists('Add term');
        // Login as a user with permission only to delete terms.
        $edit_delete_user = $this->createUser([
            'access taxonomy overview',
            'delete terms in ' . $vocabulary1_id,
            'delete terms in ' . $vocabulary2_id,
        ]);
        $this->drupalLogin($edit_delete_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkNotExists('Edit');
        $assert_session->linkExists('Delete');
        $assert_session->linkNotExists('Add term');
        $assert_session->buttonNotExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldNotExists('Weight');
        $assert_session->pageTextContains($no_edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should not be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkNotExists('Add term');
        // Login as a user with permission to edit and delete terms.
        $edit_delete_user = $this->createUser([
            'access taxonomy overview',
            'edit terms in ' . $vocabulary1_id,
            'delete terms in ' . $vocabulary1_id,
            'edit terms in ' . $vocabulary2_id,
            'delete terms in ' . $vocabulary2_id,
        ]);
        $this->drupalLogin($edit_delete_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkExists('Edit');
        $assert_session->linkExists('Delete');
        $assert_session->linkNotExists('Add term');
        $assert_session->buttonExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldExists('Weight');
        $assert_session->pageTextContains($edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should not be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkNotExists('Add term');
        // Login as a user with permission to create new terms, only add new term
        // link should be visible.
        $edit_user = $this->createUser([
            'access taxonomy overview',
            'create terms in ' . $vocabulary1_id,
            'create terms in ' . $vocabulary2_id,
        ]);
        $this->drupalLogin($edit_user);
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary1_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->linkNotExists('Edit');
        $assert_session->linkNotExists('Delete');
        $assert_session->linkExists('Add term');
        $assert_session->buttonNotExists('Save');
        $assert_session->pageTextContains('Weight');
        $assert_session->fieldNotExists('Weight');
        $assert_session->pageTextContains($no_edit_help_text);
        // Visit vocabulary overview without terms. 'Add term' should not be shown.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary2_id . '/overview');
        $assert_session->statusCodeEquals(200);
        $assert_session->pageTextContains('No terms available');
        $assert_session->linkExists('Add term');
    }
    
    /**
     * Create, edit and delete a taxonomy term via the user interface.
     */
    public function testVocabularyPermissionsTaxonomyTerm() {
        // Vocabulary used for creating, removing and editing terms.
        $vocabulary = $this->createVocabulary();
        // Test as admin user.
        $user = $this->drupalCreateUser([
            'administer taxonomy',
        ]);
        $this->drupalLogin($user);
        // Visit the main taxonomy administration page.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary->id() . '/add');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertField('edit-name-0-value', 'Add taxonomy term form opened successfully.');
        // Submit the term.
        $edit = [];
        $edit['name[0][value]'] = $this->randomMachineName();
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertText(t('Created new term @name.', [
            '@name' => $edit['name[0][value]'],
        ]), 'Term created successfully.');
        // Verify that the creation message contains a link to a term.
        $view_link = $this->xpath('//div[@class="messages"]//a[contains(@href, :href)]', [
            ':href' => 'term/',
        ]);
        $this->assert(isset($view_link), 'The message area contains a link to a term');
        $terms = \Drupal::entityTypeManager()->getStorage('taxonomy_term')
            ->loadByProperties([
            'name' => $edit['name[0][value]'],
        ]);
        $term = reset($terms);
        // Edit the term.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertText($edit['name[0][value]'], 'Edit taxonomy term form opened successfully.');
        $edit['name[0][value]'] = $this->randomMachineName();
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertText(t('Updated term @name.', [
            '@name' => $edit['name[0][value]'],
        ]), 'Term updated successfully.');
        // Delete the vocabulary.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/delete');
        $this->assertRaw(t('Are you sure you want to delete the @entity-type %label?', [
            '@entity-type' => 'taxonomy term',
            '%label' => $edit['name[0][value]'],
        ]), 'Delete taxonomy term form opened successfully.');
        // Confirm deletion.
        $this->drupalPostForm(NULL, NULL, t('Delete'));
        $this->assertRaw(t('Deleted term %name.', [
            '%name' => $edit['name[0][value]'],
        ]), 'Term deleted.');
        // Test as user with "create" permissions.
        $user = $this->drupalCreateUser([
            "create terms in {$vocabulary->id()}",
        ]);
        $this->drupalLogin($user);
        $assert_session = $this->assertSession();
        // Create a new term.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary->id() . '/add');
        $assert_session->statusCodeEquals(200);
        $assert_session->fieldExists('name[0][value]');
        // Submit the term.
        $edit = [];
        $edit['name[0][value]'] = $this->randomMachineName();
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $assert_session->pageTextContains(t('Created new term @name.', [
            '@name' => $edit['name[0][value]'],
        ]));
        $terms = \Drupal::entityTypeManager()->getStorage('taxonomy_term')
            ->loadByProperties([
            'name' => $edit['name[0][value]'],
        ]);
        $term = reset($terms);
        // Ensure that edit and delete access is denied.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/edit');
        $assert_session->statusCodeEquals(403);
        $this->drupalGet('taxonomy/term/' . $term->id() . '/delete');
        $assert_session->statusCodeEquals(403);
        // Test as user with "edit" permissions.
        $user = $this->drupalCreateUser([
            "edit terms in {$vocabulary->id()}",
        ]);
        $this->drupalLogin($user);
        // Ensure the taxonomy term add form is denied.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary->id() . '/add');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Create a test term.
        $term = $this->createTerm($vocabulary);
        // Edit the term.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/edit');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertText($term->getName(), 'Edit taxonomy term form opened successfully.');
        $edit['name[0][value]'] = $this->randomMachineName();
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertText(t('Updated term @name.', [
            '@name' => $edit['name[0][value]'],
        ]), 'Term updated successfully.');
        // Verify that the update message contains a link to a term.
        $view_link = $this->xpath('//div[@class="messages"]//a[contains(@href, :href)]', [
            ':href' => 'term/',
        ]);
        $this->assert(isset($view_link), 'The message area contains a link to a term');
        // Ensure the term cannot be deleted.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/delete');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Test as user with "delete" permissions.
        $user = $this->drupalCreateUser([
            "delete terms in {$vocabulary->id()}",
        ]);
        $this->drupalLogin($user);
        // Ensure the taxonomy term add form is denied.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary->id() . '/add');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Create a test term.
        $term = $this->createTerm($vocabulary);
        // Ensure that the term cannot be edited.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/edit');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Delete the vocabulary.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/delete');
        $this->assertRaw(t('Are you sure you want to delete the @entity-type %label?', [
            '@entity-type' => 'taxonomy term',
            '%label' => $term->getName(),
        ]), 'Delete taxonomy term form opened successfully.');
        // Confirm deletion.
        $this->drupalPostForm(NULL, NULL, t('Delete'));
        $this->assertRaw(t('Deleted term %name.', [
            '%name' => $term->getName(),
        ]), 'Term deleted.');
        // Test as user without proper permissions.
        $user = $this->drupalCreateUser();
        $this->drupalLogin($user);
        // Ensure the taxonomy term add form is denied.
        $this->drupalGet('admin/structure/taxonomy/manage/' . $vocabulary->id() . '/add');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Create a test term.
        $term = $this->createTerm($vocabulary);
        // Ensure that the term cannot be edited.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/edit');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Ensure the term cannot be deleted.
        $this->drupalGet('taxonomy/term/' . $term->id() . '/delete');
        $this->assertSession()
            ->statusCodeEquals(403);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
EntityReferenceTestTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TaxonomyTestTrait::createTerm public function Returns a new term with random properties given a vocabulary.
TaxonomyTestTrait::createVocabulary public function Returns a new vocabulary with random properties.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
VocabularyPermissionsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
VocabularyPermissionsTest::$modules public static property Modules to enable. Overrides TaxonomyTestBase::$modules
VocabularyPermissionsTest::setUp protected function Overrides TaxonomyTestBase::setUp
VocabularyPermissionsTest::testTaxonomyVocabularyOverviewPermissions public function Test the vocabulary overview permission.
VocabularyPermissionsTest::testVocabularyPermissionsTaxonomyTerm public function Create, edit and delete a taxonomy term via the user interface.
VocabularyPermissionsTest::testVocabularyPermissionsVocabulary public function Create, edit and delete a vocabulary via the user interface.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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