class HandlerTest

Same name in this branch
  1. 11.x core/modules/views_ui/tests/src/Functional/HandlerTest.php \Drupal\Tests\views_ui\Functional\HandlerTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/Handler/HandlerTest.php \Drupal\Tests\views\Functional\Handler\HandlerTest
  2. 9 core/modules/views_ui/tests/src/Functional/HandlerTest.php \Drupal\Tests\views_ui\Functional\HandlerTest
  3. 8.9.x core/modules/views/tests/src/Functional/Handler/HandlerTest.php \Drupal\Tests\views\Functional\Handler\HandlerTest
  4. 8.9.x core/modules/views_ui/tests/src/Functional/HandlerTest.php \Drupal\Tests\views_ui\Functional\HandlerTest
  5. 10 core/modules/views/tests/src/Functional/Handler/HandlerTest.php \Drupal\Tests\views\Functional\Handler\HandlerTest
  6. 10 core/modules/views_ui/tests/src/Functional/HandlerTest.php \Drupal\Tests\views_ui\Functional\HandlerTest

Tests abstract handler definitions.

@group views

Hierarchy

  • class \Drupal\Tests\views\Functional\Handler\HandlerTest extends \Drupal\Tests\views\Functional\ViewTestBase uses \Drupal\comment\Tests\CommentTestTrait

Expanded class hierarchy of HandlerTest

File

core/modules/views/tests/src/Functional/Handler/HandlerTest.php, line 21

Namespace

Drupal\Tests\views\Functional\Handler
View source 
class HandlerTest extends ViewTestBase {
    use CommentTestTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view',
        'test_view_handler_weight',
        'test_handler_relationships',
        'test_handler_test_access',
        'test_filter_in_operator_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'views_ui',
        'comment',
        'node',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->addDefaultCommentField('node', 'page');
        $this->enableViewsTestModule();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function viewsData() {
        $data = parent::viewsData();
        // Override the name handler to be able to call placeholder() from outside.
        $data['views_test_data']['name']['field']['id'] = 'test_field';
        // Setup one field with an access callback and one with an access callback
        // and arguments.
        $data['views_test_data']['access_callback'] = $data['views_test_data']['id'];
        $data['views_test_data']['access_callback_arguments'] = $data['views_test_data']['id'];
        foreach (ViewExecutable::getHandlerTypes() as $type => $info) {
            if (isset($data['views_test_data']['access_callback'][$type]['id'])) {
                $data['views_test_data']['access_callback'][$type]['access callback'] = 'views_test_data_handler_test_access_callback';
                $data['views_test_data']['access_callback_arguments'][$type]['access callback'] = 'views_test_data_handler_test_access_callback_argument';
                $data['views_test_data']['access_callback_arguments'][$type]['access arguments'] = [
                    TRUE,
                ];
            }
        }
        return $data;
    }
    
    /**
     * Tests the breakString method.
     */
    public function testBreakString() : void {
        // Check defaults.
        $this->assertEquals((object) [
            'value' => [],
            'operator' => NULL,
        ], HandlerBase::breakString(''));
        // Test ors
        $handler = HandlerBase::breakString('word1 word2+word');
        $this->assertEquals([
            'word1',
            'word2',
            'word',
        ], $handler->value);
        $this->assertEquals('or', $handler->operator);
        $handler = HandlerBase::breakString('word1+word2+word');
        $this->assertEquals([
            'word1',
            'word2',
            'word',
        ], $handler->value);
        $this->assertEquals('or', $handler->operator);
        $handler = HandlerBase::breakString('word1 word2 word');
        $this->assertEquals([
            'word1',
            'word2',
            'word',
        ], $handler->value);
        $this->assertEquals('or', $handler->operator);
        $handler = HandlerBase::breakString('word-1+word-2+word');
        $this->assertEquals([
            'word-1',
            'word-2',
            'word',
        ], $handler->value);
        $this->assertEquals('or', $handler->operator);
        $handler = HandlerBase::breakString('wõrd1+wõrd2+wõrd');
        $this->assertEquals([
            'wõrd1',
            'wõrd2',
            'wõrd',
        ], $handler->value);
        $this->assertEquals('or', $handler->operator);
        // Test ands.
        $handler = HandlerBase::breakString('word1,word2,word');
        $this->assertEquals([
            'word1',
            'word2',
            'word',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        $handler = HandlerBase::breakString('word1 word2,word');
        $this->assertEquals([
            'word1 word2',
            'word',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        $handler = HandlerBase::breakString('word1,word2 word');
        $this->assertEquals([
            'word1',
            'word2 word',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        $handler = HandlerBase::breakString('word-1,word-2,word');
        $this->assertEquals([
            'word-1',
            'word-2',
            'word',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        $handler = HandlerBase::breakString('wõrd1,wõrd2,wõrd');
        $this->assertEquals([
            'wõrd1',
            'wõrd2',
            'wõrd',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        // Test a single word
        $handler = HandlerBase::breakString('word');
        $this->assertEquals([
            'word',
        ], $handler->value);
        $this->assertEquals('and', $handler->operator);
        $s1 = $this->randomMachineName();
        // Generate three random numbers which can be used below;
        $n1 = rand(0, 100);
        $n2 = rand(0, 100);
        $n3 = rand(0, 100);
        // Test "or"s.
        $handlerBase = HandlerBase::breakString("{$s1} {$n2}+{$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1}+{$n2}+{$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1} {$n2} {$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1} {$n2}++{$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        // Test "and"s.
        $handlerBase = HandlerBase::breakString("{$s1},{$n2},{$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1},,{$n2},{$n3}");
        $this->assertEquals([
            $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
        // Enforce int values.
        $handlerBase = HandlerBase::breakString("{$n1},{$n2},{$n3}", TRUE);
        $this->assertEquals([
            $n1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$n1}+{$n2}+{$n3}", TRUE);
        $this->assertEquals([
            $n1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1},{$n2},{$n3}", TRUE);
        $this->assertEquals([
            (int) $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1}+{$n2}+{$n3}", TRUE);
        $this->assertEquals([
            (int) $s1,
            $n2,
            $n3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        // Generate three random decimals which can be used below;
        $d1 = rand(0, 10) / 10;
        $d2 = rand(0, 10) / 10;
        $d3 = rand(0, 10) / 10;
        // Test "or"s.
        $handlerBase = HandlerBase::breakString("{$s1} {$d1}+{$d2}");
        $this->assertEquals([
            $s1,
            $d1,
            $d2,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1}+{$d1}+{$d3}");
        $this->assertEquals([
            $s1,
            $d1,
            $d3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1} {$d2} {$d3}");
        $this->assertEquals([
            $s1,
            $d2,
            $d3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1} {$d2}++{$d3}");
        $this->assertEquals([
            $s1,
            $d2,
            $d3,
        ], $handlerBase->value);
        $this->assertEquals('or', $handlerBase->operator);
        // Test "and"s.
        $handlerBase = HandlerBase::breakString("{$s1},{$d2},{$d3}");
        $this->assertEquals([
            $s1,
            $d2,
            $d3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
        $handlerBase = HandlerBase::breakString("{$s1},,{$d2},{$d3}");
        $this->assertEquals([
            $s1,
            $d2,
            $d3,
        ], $handlerBase->value);
        $this->assertEquals('and', $handlerBase->operator);
    }
    
    /**
     * Tests the order of handlers is the same before and after saving.
     */
    public function testHandlerWeights() : void {
        $handler_types = [
            'fields',
            'filters',
            'sorts',
        ];
        $view = Views::getView('test_view_handler_weight');
        $view->initDisplay();
        // Store the order of handlers before saving the view.
        $original_order = [];
        foreach ($handler_types as $type) {
            $original_order[$type] = array_keys($view->display_handler
                ->getOption($type));
        }
        // Save the view and see if our filters are in the same order.
        $view->save();
        $view = views::getView('test_view_handler_weight');
        $view->initDisplay();
        foreach ($handler_types as $type) {
            $loaded_order = array_keys($view->display_handler
                ->getOption($type));
            $this->assertSame($original_order[$type], $loaded_order);
        }
    }
    
    /**
     * Tests the relationship ui for field/filter/argument/relationship.
     */
    public function testRelationshipUI() : void {
        $views_admin = $this->drupalCreateUser([
            'administer views',
        ]);
        $this->drupalLogin($views_admin);
        // Make sure the link to the field options exists.
        $handler_options_path = 'admin/structure/views/nojs/handler/test_handler_relationships/default/field/title';
        $view_edit_path = 'admin/structure/views/view/test_handler_relationships/edit';
        $this->drupalGet($view_edit_path);
        $this->assertSession()
            ->linkByHrefExists($handler_options_path);
        // The test view has a relationship to node_revision so the field should
        // show a relationship selection.
        $this->drupalGet($handler_options_path);
        $relationship_name = 'options[relationship]';
        $this->assertSession()
            ->fieldExists($relationship_name);
        // Check for available options.
        $fields = $this->getSession()
            ->getPage()
            ->findAll('named_exact', [
            'field',
            $relationship_name,
        ]);
        $options = [];
        foreach ($fields as $field) {
            $items = $field->findAll('css', 'option');
            foreach ($items as $item) {
                $options[] = $item->getAttribute('value');
            }
        }
        $expected_options = [
            'none',
            'nid',
        ];
        $this->assertEquals($expected_options, $options);
        // Change the Row plugin to display "Content".
        $this->drupalGet('admin/structure/views/nojs/display/test_handler_relationships/default/row');
        $this->submitForm([
            'row[type]' => 'entity:node',
        ], 'Apply');
        $this->assertSession()
            ->fieldExists('row_options[relationship]');
        $this->submitForm([
            'row_options[view_mode]' => 'default',
        ], 'Apply');
        // Remove the relationship and make sure no relationship option appears.
        $this->drupalGet('admin/structure/views/nojs/handler/test_handler_relationships/default/relationship/nid');
        $this->submitForm([], 'Remove');
        $this->drupalGet($handler_options_path);
        $this->assertSession()
            ->fieldNotExists($relationship_name);
        // Create a view of comments with node relationship.
        View::create([
            'base_table' => 'comment_field_data',
            'id' => 'test_get_entity_type',
            'label' => 'Test',
        ])->save();
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_get_entity_type/default/relationship');
        $this->submitForm([
            'name[comment_field_data.node]' => 'comment_field_data.node',
        ], 'Add and configure relationships');
        $this->submitForm([], 'Apply');
        // Add a content type filter.
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_get_entity_type/default/filter');
        $this->submitForm([
            'name[node_field_data.type]' => 'node_field_data.type',
        ], 'Add and configure filter criteria');
        $this->assertTrue($this->assertSession()
            ->optionExists('edit-options-relationship', 'node')
            ->isSelected());
        $this->submitForm([
            'options[value][page]' => 'page',
        ], 'Apply');
        // Check content type filter options.
        $this->drupalGet('admin/structure/views/nojs/handler/test_get_entity_type/default/filter/type');
        $this->assertTrue($this->assertSession()
            ->optionExists('edit-options-relationship', 'node')
            ->isSelected());
        $this->assertSession()
            ->checkboxChecked('edit-options-value-page');
    }
    
    /**
     * Tests the relationship method on the base class.
     */
    public function testSetRelationship() : void {
        $view = Views::getView('test_handler_relationships');
        $view->setDisplay();
        // Setup a broken relationship.
        $view->addHandler('default', 'relationship', $this->randomMachineName(), $this->randomMachineName(), [], 'broken_relationship');
        // Setup a valid relationship.
        $view->addHandler('default', 'relationship', 'comment_field_data', 'node', [
            'relationship' => 'cid',
        ], 'valid_relationship');
        $view->initHandlers();
        $field = $view->field['title'];
        $field->options['relationship'] = NULL;
        $field->setRelationship();
        $this->assertNull($field->relationship, 'Make sure that an empty relationship does not create a relationship on the field.');
        $field->options['relationship'] = $this->randomMachineName();
        $field->setRelationship();
        $this->assertNull($field->relationship, 'Make sure that a random relationship does not create a relationship on the field.');
        $field->options['relationship'] = 'broken_relationship';
        $field->setRelationship();
        $this->assertNull($field->relationship, 'Make sure that a broken relationship does not create a relationship on the field.');
        $field->options['relationship'] = 'valid_relationship';
        $field->setRelationship();
        $this->assertEmpty($field->relationship, 'Make sure that the relationship alias was not set without building a views query before.');
        // Remove the invalid relationship.
        unset($view->relationship['broken_relationship']);
        $view->build();
        $field->setRelationship();
        $this->assertEquals($field->relationship, $view->relationship['valid_relationship']->alias, 'Make sure that a valid relationship does create the right relationship query alias.');
    }
    
    /**
     * Tests the placeholder function.
     *
     * @see \Drupal\views\Plugin\views\HandlerBase::placeholder()
     */
    public function testPlaceholder() : void {
        $view = Views::getView('test_view');
        $view->initHandlers();
        $view->initQuery();
        $handler = $view->field['name'];
        $table = $handler->table;
        $field = $handler->field;
        $string = ':' . $table . '_' . $field;
        // Make sure the placeholder variables are like expected.
        $this->assertEquals($string, $handler->getPlaceholder());
        $this->assertEquals($string . 1, $handler->getPlaceholder());
        $this->assertEquals($string . 2, $handler->getPlaceholder());
        // Set another table/field combination and make sure there are new
        // placeholders.
        $table = $handler->table = $this->randomMachineName();
        $field = $handler->field = $this->randomMachineName();
        $string = ':' . $table . '_' . $field;
        // Make sure the placeholder variables are like expected.
        $this->assertEquals($string, $handler->getPlaceholder());
        $this->assertEquals($string . 1, $handler->getPlaceholder());
        $this->assertEquals($string . 2, $handler->getPlaceholder());
    }
    
    /**
     * Tests access to a handler.
     *
     * @see views_test_data_handler_test_access_callback
     */
    public function testAccess() : void {
        $view = Views::getView('test_handler_test_access');
        $views_data = $this->viewsData();
        $views_data = $views_data['views_test_data'];
        // Enable access to callback only field and deny for callback + arguments.
        $this->config('views_test_data.tests')
            ->set('handler_access_callback', TRUE)
            ->save();
        $this->config('views_test_data.tests')
            ->set('handler_access_callback_argument', FALSE)
            ->save();
        $view->initDisplay();
        $view->initHandlers();
        foreach ($views_data['access_callback'] as $type => $info) {
            if (!in_array($type, [
                'title',
                'help',
            ])) {
                $this->assertInstanceOf(HandlerBase::class, $view->field['access_callback']);
                $this->assertFalse(isset($view->field['access_callback_arguments']), 'Make sure the user got no access to the access_callback_arguments field ');
            }
        }
        // Enable access to the callback + argument handlers and deny for callback.
        $this->config('views_test_data.tests')
            ->set('handler_access_callback', FALSE)
            ->save();
        $this->config('views_test_data.tests')
            ->set('handler_access_callback_argument', TRUE)
            ->save();
        $view->destroy();
        $view->initDisplay();
        $view->initHandlers();
        foreach ($views_data['access_callback'] as $type => $info) {
            if (!in_array($type, [
                'title',
                'help',
            ])) {
                $this->assertFalse(isset($view->field['access_callback']), 'Make sure the user got no access to the access_callback field ');
                $this->assertInstanceOf(HandlerBase::class, $view->field['access_callback_arguments']);
            }
        }
    }

}

Members

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