class DisplayTest
Same name in this branch
- 9 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php \Drupal\views_test_data\Plugin\views\display\DisplayTest
- 9 core/modules/views_ui/tests/src/FunctionalJavascript/DisplayTest.php \Drupal\Tests\views_ui\FunctionalJavascript\DisplayTest
- 9 core/modules/views_ui/tests/src/Functional/DisplayTest.php \Drupal\Tests\views_ui\Functional\DisplayTest
Same name in other branches
- 8.9.x core/modules/views/tests/src/Functional/Plugin/DisplayTest.php \Drupal\Tests\views\Functional\Plugin\DisplayTest
- 8.9.x core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php \Drupal\views_test_data\Plugin\views\display\DisplayTest
- 8.9.x core/modules/views_ui/tests/src/FunctionalJavascript/DisplayTest.php \Drupal\Tests\views_ui\FunctionalJavascript\DisplayTest
- 8.9.x core/modules/views_ui/tests/src/Functional/DisplayTest.php \Drupal\Tests\views_ui\Functional\DisplayTest
- 10 core/modules/views/tests/src/Functional/Plugin/DisplayTest.php \Drupal\Tests\views\Functional\Plugin\DisplayTest
- 10 core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php \Drupal\views_test_data\Plugin\views\display\DisplayTest
- 10 core/modules/views_ui/tests/src/FunctionalJavascript/DisplayTest.php \Drupal\Tests\views_ui\FunctionalJavascript\DisplayTest
- 10 core/modules/views_ui/tests/src/Functional/DisplayTest.php \Drupal\Tests\views_ui\Functional\DisplayTest
- 11.x core/modules/views/tests/src/Functional/Plugin/DisplayTest.php \Drupal\Tests\views\Functional\Plugin\DisplayTest
- 11.x core/modules/views/tests/modules/views_test_data/src/Plugin/views/display/DisplayTest.php \Drupal\views_test_data\Plugin\views\display\DisplayTest
- 11.x core/modules/views_ui/tests/src/FunctionalJavascript/DisplayTest.php \Drupal\Tests\views_ui\FunctionalJavascript\DisplayTest
- 11.x core/modules/views_ui/tests/src/Functional/DisplayTest.php \Drupal\Tests\views_ui\Functional\DisplayTest
Tests the basic display plugin.
@group views
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\FunctionalTests\AssertLegacyTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\Tests\views\Functional\ViewTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\views\Tests\ViewResultAssertionTrait
- class \Drupal\Tests\views\Functional\Plugin\DisplayTest extends \Drupal\Tests\views\Functional\ViewTestBase
- class \Drupal\Tests\views\Functional\ViewTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\views\Tests\ViewResultAssertionTrait
Expanded class hierarchy of DisplayTest
1 string reference to 'DisplayTest'
- DisplayTest::calculateDependencies in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ display/ DisplayTest.php - Calculates dependencies for the configured plugin.
File
-
core/
modules/ views/ tests/ src/ Functional/ Plugin/ DisplayTest.php, line 16
Namespace
Drupal\Tests\views\Functional\PluginView source
class DisplayTest extends ViewTestBase {
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_filter_groups',
'test_get_attach_displays',
'test_view',
'test_display_more',
'test_display_invalid',
'test_display_empty',
'test_exposed_relationship_admin_ui',
'test_simple_argument',
];
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'views_ui',
'node',
'block',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp($import_test_views = TRUE, $modules = [
'views_test_config',
]) : void {
parent::setUp($import_test_views, $modules);
$this->enableViewsTestModule();
$this->drupalLogin($this->drupalCreateUser([
'administer views',
]));
// Create 10 nodes.
for ($i = 0; $i <= 10; $i++) {
$this->drupalCreateNode([
'promote' => TRUE,
]);
}
}
/**
* Tests the display test plugin.
*
* @see \Drupal\views_test_data\Plugin\views\display\DisplayTest
*/
public function testDisplayPlugin() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$view = Views::getView('test_view');
// Add a new 'display_test' display and test it's there.
$view->storage
->addDisplay('display_test');
$displays = $view->storage
->get('display');
$this->assertTrue(isset($displays['display_test_1']), 'Added display has been assigned to "display_test_1"');
// Check the display options are like expected.
$options = [
'display_options' => [],
'display_plugin' => 'display_test',
'id' => 'display_test_1',
'display_title' => 'Display test',
'position' => 1,
];
$this->assertEquals($options, $displays['display_test_1']);
// Add another one to ensure that position is counted up.
$view->storage
->addDisplay('display_test');
$displays = $view->storage
->get('display');
$options = [
'display_options' => [],
'display_plugin' => 'display_test',
'id' => 'display_test_2',
'display_title' => 'Display test 2',
'position' => 2,
];
$this->assertEquals($options, $displays['display_test_2']);
// Move the second display before the first one in order to test custom
// sorting.
$displays['display_test_1']['position'] = 2;
$displays['display_test_2']['position'] = 1;
$view->storage
->set('display', $displays);
$view->save();
$view->setDisplay('display_test_1');
$this->assertInstanceOf(DisplayTestPlugin::class, $view->display_handler);
// Check the test option.
$this->assertSame('', $view->display_handler
->getOption('test_option'));
$style = $view->display_handler
->getOption('style');
$style['type'] = 'test_style';
$view->display_handler
->setOption('style', $style);
$view->initDisplay();
$view->initStyle();
$view->style_plugin
->setUsesRowPlugin(FALSE);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('<h1></h1>', $output, 'An empty value for test_option found in output.');
// Change this option and check the title of out output.
$view->display_handler
->overrideOption('test_option', 'Test option title');
$view->save();
$output = $view->preview();
$output = $renderer->renderRoot($output);
// Test we have our custom <h1> tag in the output of the view.
$this->assertStringContainsString('<h1>Test option title</h1>', $output, 'The test_option value found in display output title.');
// Test that the display category/summary is in the UI.
$this->drupalGet('admin/structure/views/view/test_view/edit/display_test_1');
$this->assertSession()
->pageTextContains('Display test settings');
// Ensure that the order is as expected.
$result = $this->xpath('//ul[@id="views-display-menu-tabs"]/li/a/child::text()');
$this->assertEquals('Display test 2', $result[0]->getText());
$this->assertEquals('Display test', $result[1]->getText());
$this->clickLink('Test option title');
$test_option = $this->randomString();
$this->submitForm([
'test_option' => $test_option,
], 'Apply');
// Check the new value has been saved by checking the UI summary text.
$this->drupalGet('admin/structure/views/view/test_view/edit/display_test_1');
$this->assertSession()
->linkExists($test_option);
// Test the enable/disable status of a display.
$view->display_handler
->setOption('enabled', FALSE);
$this->assertFalse($view->display_handler
->isEnabled(), 'Make sure that isEnabled returns FALSE on a disabled display.');
$view->display_handler
->setOption('enabled', TRUE);
$this->assertTrue($view->display_handler
->isEnabled(), 'Make sure that isEnabled returns TRUE on a disabled display.');
}
/**
* Tests the overriding of filter_groups.
*/
public function testFilterGroupsOverriding() {
$view = Views::getView('test_filter_groups');
$view->initDisplay();
// mark is as overridden, yes FALSE, means overridden.
$view->displayHandlers
->get('page')
->setOverride('filter_groups', FALSE);
$this->assertFalse($view->displayHandlers
->get('page')
->isDefaulted('filter_groups'), "Make sure that 'filter_groups' is marked as overridden.");
$this->assertFalse($view->displayHandlers
->get('page')
->isDefaulted('filters'), "Make sure that 'filters'' is marked as overridden.");
}
/**
* Tests the getAttachedDisplays method.
*/
public function testGetAttachedDisplays() {
$view = Views::getView('test_get_attach_displays');
// Both the feed_1 and the feed_2 display are attached to the page display.
$view->setDisplay('page_1');
$this->assertEquals([
'feed_1',
'feed_2',
], $view->display_handler
->getAttachedDisplays());
$view->setDisplay('feed_1');
$this->assertEquals([], $view->display_handler
->getAttachedDisplays());
}
/**
* Tests the readmore validation.
*/
public function testReadMoreNoDisplay() {
$view = Views::getView('test_display_more');
// Confirm that the view validates when there is a page display.
$errors = $view->validate();
$this->assertEmpty($errors, 'More link validation has no errors.');
// Confirm that the view does not validate when the page display is disabled.
$view->setDisplay('page_1');
$view->display_handler
->setOption('enabled', FALSE);
$view->setDisplay('default');
$errors = $view->validate();
$this->assertNotEmpty($errors, 'More link validation has some errors.');
$this->assertEquals('Display "Default" uses a "more" link but there are no displays it can link to. You need to specify a custom URL.', $errors['default'][0], 'More link validation has the right error.');
// Confirm that the view does not validate when the page display does not exist.
$view = Views::getView('test_view');
$view->setDisplay('default');
$view->display_handler
->setOption('use_more', 1);
$errors = $view->validate();
$this->assertNotEmpty($errors, 'More link validation has some errors.');
$this->assertEquals('Display "Default" uses a "more" link but there are no displays it can link to. You need to specify a custom URL.', $errors['default'][0], 'More link validation has the right error.');
}
/**
* Tests the readmore with custom URL.
*/
public function testReadMoreCustomURL() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$view = Views::getView('test_display_more');
$view->setDisplay('default');
$view->display_handler
->setOption('use_more', 1);
$view->display_handler
->setOption('use_more_always', 1);
$view->display_handler
->setOption('link_display', 'custom_url');
// Test more link without leading slash.
$view->display_handler
->setOption('link_url', 'node');
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node', $output, 'The read more link with href "/node" was found.');
// Test more link with leading slash.
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', '/node');
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node', $output, 'The read more link with href "/node" was found.');
// Test more link with absolute url.
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', 'http://drupal.org');
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('http://drupal.org', $output, 'The read more link with href "http://drupal.org" was found.');
// Test more link with query parameters in the url.
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', 'node?page=1&foo=bar');
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node?page=1&foo=bar', $output, 'The read more link with href "/node?page=1&foo=bar" was found.');
// Test more link with fragment in the url.
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', 'node#target');
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node#target', $output, 'The read more link with href "/node#target" was found.');
// Test more link with arguments.
$view = Views::getView('test_simple_argument');
$view->setDisplay('default');
$view->display_handler
->setOption('use_more', 1);
$view->display_handler
->setOption('use_more_always', 1);
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', 'node?date={{ raw_arguments.age }}&foo=bar');
$view->setArguments([
22,
]);
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node?date=22&foo=bar', $output, 'The read more link with href "/node?date=22&foo=bar" was found.');
// Test more link with 1 dimension array query parameters with arguments.
$view = Views::getView('test_simple_argument');
$view->setDisplay('default');
$view->display_handler
->setOption('use_more', 1);
$view->display_handler
->setOption('use_more_always', 1);
$view->display_handler
->setOption('link_display', 'custom_url');
$view->display_handler
->setOption('link_url', '/node?f[0]=foo:bar&f[1]=foo:{{ raw_arguments.age }}');
$view->setArguments([
22,
]);
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node?f%5B0%5D=foo%3Abar&f%5B1%5D=foo%3A22', $output, 'The read more link with href "/node?f[0]=foo:bar&f[1]=foo:22" was found.');
// Test more link with arguments in path.
$view->display_handler
->setOption('link_url', 'node/{{ raw_arguments.age }}?date={{ raw_arguments.age }}&foo=bar');
$view->setArguments([
22,
]);
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node/22?date=22&foo=bar', $output, 'The read more link with href "/node/22?date=22&foo=bar" was found.');
// Test more link with arguments in fragment.
$view->display_handler
->setOption('link_url', 'node?date={{ raw_arguments.age }}&foo=bar#{{ raw_arguments.age }}');
$view->setArguments([
22,
]);
$this->executeView($view);
$output = $view->preview();
$output = $renderer->renderRoot($output);
$this->assertStringContainsString('/node?date=22&foo=bar#22', $output, 'The read more link with href "/node?date=22&foo=bar#22" was found.');
}
/**
* Tests invalid display plugins.
*/
public function testInvalidDisplayPlugins() {
$this->drupalGet('test_display_invalid');
$this->assertSession()
->statusCodeEquals(200);
// Change the page plugin id to an invalid one. Bypass the entity system
// so no menu rebuild was executed (so the path is still available).
$config = $this->config('views.view.test_display_invalid');
$config->set('display.page_1.display_plugin', 'invalid');
$config->save();
$this->drupalGet('test_display_invalid');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextContains('The "invalid" plugin does not exist.');
// Rebuild the router, and ensure that the path is not accessible anymore.
views_invalidate_cache();
\Drupal::service('router.builder')->rebuildIfNeeded();
$this->drupalGet('test_display_invalid');
$this->assertSession()
->statusCodeEquals(404);
// Change the display plugin ID back to the correct ID.
$config = $this->config('views.view.test_display_invalid');
$config->set('display.page_1.display_plugin', 'page');
$config->save();
// Place the block display.
$block = $this->drupalPlaceBlock('views_block:test_display_invalid-block_1', [
'label' => 'Invalid display',
]);
$this->drupalGet('<front>');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->elementsCount('xpath', "//div[@id = 'block-{$block->id()}']", 1);
// Change the block plugin ID to an invalid one.
$config = $this->config('views.view.test_display_invalid');
$config->set('display.block_1.display_plugin', 'invalid');
$config->save();
// Test the page is still displayed, the block not present, and has the
// plugin warning message.
$this->drupalGet('<front>');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextContains('The "invalid" plugin does not exist.');
$this->assertSession()
->elementNotExists('xpath', "//div[@id = 'block-{$block->id()}']");
}
/**
* Tests display validation when a required relationship is missing.
*/
public function testMissingRelationship() {
$view = Views::getView('test_exposed_relationship_admin_ui');
// Remove the relationship that is not used by other handlers.
$view->removeHandler('default', 'relationship', 'uid_1');
$errors = $view->validate();
// Check that no error message is shown.
$this->assertArrayNotHasKey('default', $errors, 'No errors found when removing unused relationship.');
// Unset cached relationships (see DisplayPluginBase::getHandlers())
unset($view->display_handler->handlers['relationship']);
// Remove the relationship used by other handlers.
$view->removeHandler('default', 'relationship', 'uid');
// Validate display
$errors = $view->validate();
// Check that the error messages are shown.
$this->assertCount(2, $errors['default'], 'Error messages found for required relationship');
$this->assertEquals(new FormattableMarkup('The %relationship_name relationship used in %handler_type %handler is not present in the %display_name display.', [
'%relationship_name' => 'uid',
'%handler_type' => 'field',
'%handler' => 'User: Last login',
'%display_name' => 'Default',
]), $errors['default'][0]);
$this->assertEquals(new FormattableMarkup('The %relationship_name relationship used in %handler_type %handler is not present in the %display_name display.', [
'%relationship_name' => 'uid',
'%handler_type' => 'field',
'%handler' => 'User: Created',
'%display_name' => 'Default',
]), $errors['default'][1]);
}
/**
* Tests the outputIsEmpty method on the display.
*/
public function testOutputIsEmpty() {
$view = Views::getView('test_display_empty');
$this->executeView($view);
$this->assertNotEmpty($view->result);
$this->assertFalse($view->display_handler
->outputIsEmpty(), 'Ensure the view output is marked as not empty.');
$view->destroy();
// Add a filter, so the view result is empty.
$view->setDisplay('default');
$item = [
'table' => 'views_test_data',
'field' => 'id',
'id' => 'id',
'value' => [
'value' => 7297,
],
];
$view->setHandler('default', 'filter', 'id', $item);
$this->executeView($view);
$this->assertEmpty($view->result, 'Ensure the result of the view is empty.');
$this->assertFalse($view->display_handler
->outputIsEmpty(), 'Ensure the view output is marked as not empty, because the empty text still appears.');
$view->destroy();
// Remove the empty area, but mark the header area to still appear.
$view->removeHandler('default', 'empty', 'area');
$item = $view->getHandler('default', 'header', 'area');
$item['empty'] = TRUE;
$view->setHandler('default', 'header', 'area', $item);
$this->executeView($view);
$this->assertEmpty($view->result, 'Ensure the result of the view is empty.');
$this->assertFalse($view->display_handler
->outputIsEmpty(), 'Ensure the view output is marked as not empty, because the header text still appears.');
$view->destroy();
// Hide the header on empty results.
$item = $view->getHandler('default', 'header', 'area');
$item['empty'] = FALSE;
$view->setHandler('default', 'header', 'area', $item);
$this->executeView($view);
$this->assertEmpty($view->result, 'Ensure the result of the view is empty.');
$this->assertTrue($view->display_handler
->outputIsEmpty(), 'Ensure the view output is marked as empty.');
}
/**
* Tests translation rendering settings based on entity translatability.
*/
public function testTranslationSetting() {
\Drupal::service('module_installer')->install([
'file',
]);
// By default there should be no language settings.
$this->checkTranslationSetting();
\Drupal::service('module_installer')->install([
'language',
]);
// Enabling the language module should not make a difference.
$this->checkTranslationSetting();
// Making the site multilingual should let translatable entity types support
// translation rendering.
ConfigurableLanguage::createFromLangcode('it')->save();
$this->checkTranslationSetting(TRUE);
}
/**
* Asserts a node and a file based view for the translation setting.
*
* The file based view should never expose that setting. The node based view
* should if the site is multilingual.
*
* @param bool $expected_node_translatability
* Whether the node based view should be expected to support translation
* settings.
*/
protected function checkTranslationSetting($expected_node_translatability = FALSE) {
$not_supported_text = 'The view is not based on a translatable entity type or the site is not multilingual.';
$supported_text = 'All content that supports translations will be displayed in the selected language.';
$this->drupalGet('admin/structure/views/nojs/display/content/page_1/rendering_language');
if ($expected_node_translatability) {
$this->assertSession()
->pageTextNotContains($not_supported_text);
$this->assertSession()
->pageTextContains($supported_text);
}
else {
$this->assertSession()
->pageTextContains($not_supported_text);
$this->assertSession()
->pageTextNotContains($supported_text);
}
$this->drupalGet('admin/structure/views/nojs/display/files/page_1/rendering_language');
$this->assertSession()
->pageTextContains($not_supported_text);
$this->assertSession()
->pageTextNotContains($supported_text);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
AssertLegacyTrait::assert | Deprecated | protected | function | ||||
AssertLegacyTrait::assertCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was present in the last response. | |||
AssertLegacyTrait::assertElementNotPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is not present. | |||
AssertLegacyTrait::assertElementPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is present. | |||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertEscaped | Deprecated | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertField | Deprecated | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertLegacyTrait::assertFieldById | Deprecated | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertLegacyTrait::assertFieldByName | Deprecated | protected | function | Asserts that a field exists with the given name and value. | |||
AssertLegacyTrait::assertFieldByXPath | Deprecated | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertLegacyTrait::assertFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertLegacyTrait::assertFieldsByValue | Deprecated | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertLegacyTrait::assertHeader | Deprecated | protected | function | Checks that current response header equals value. | |||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | ||||
AssertLegacyTrait::assertLink | Deprecated | protected | function | Passes if a link with the specified label is found. | |||
AssertLegacyTrait::assertLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertLegacyTrait::assertNoCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was absent in the last response. | |||
AssertLegacyTrait::assertNoEscaped | Deprecated | protected | function | Passes if the raw text is not found escaped on the loaded page. | |||
AssertLegacyTrait::assertNoField | Deprecated | protected | function | Asserts that a field does NOT exist with the given name or ID. | |||
AssertLegacyTrait::assertNoFieldById | Deprecated | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertLegacyTrait::assertNoFieldByName | Deprecated | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertLegacyTrait::assertNoFieldByXPath | Deprecated | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertLegacyTrait::assertNoFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertLegacyTrait::assertNoLink | Deprecated | protected | function | Passes if a link with the specified label is not found. | |||
AssertLegacyTrait::assertNoLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertLegacyTrait::assertNoOption | Deprecated | protected | function | Asserts that a select option does NOT exist in the current page. | |||
AssertLegacyTrait::assertNoPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |||
AssertLegacyTrait::assertNoRaw | Deprecated | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoText | Deprecated | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoUniqueText | Deprecated | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertLegacyTrait::assertOption | Deprecated | protected | function | Asserts that a select option in the current page exists. | |||
AssertLegacyTrait::assertOptionByText | Deprecated | protected | function | Asserts that a select option with the visible text exists. | |||
AssertLegacyTrait::assertOptionSelected | Deprecated | protected | function | Asserts that a select option in the current page is checked. | |||
AssertLegacyTrait::assertPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertLegacyTrait::assertRaw | Deprecated | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertResponse | Deprecated | protected | function | Asserts the page responds with the specified response code. | |||
AssertLegacyTrait::assertText | Deprecated | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertLegacyTrait::assertTextHelper | Deprecated | protected | function | Helper for assertText and assertNoText. | |||
AssertLegacyTrait::assertTitle | Deprecated | protected | function | Pass if the page title is the given string. | |||
AssertLegacyTrait::assertUniqueText | Deprecated | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertLegacyTrait::assertUrl | Deprecated | protected | function | Passes if the internal browser's URL matches the given path. | |||
AssertLegacyTrait::buildXPathQuery | Deprecated | protected | function | Builds an XPath query. | |||
AssertLegacyTrait::constructFieldXpath | Deprecated | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertLegacyTrait::getAllOptions | Deprecated | protected | function | Get all option elements, including nested options, in a select. | |||
AssertLegacyTrait::getRawContent | Deprecated | protected | function | Gets the current raw content. | |||
AssertLegacyTrait::pass | Deprecated | protected | function | ||||
AssertLegacyTrait::verbose | Deprecated | 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 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::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 drupal_rewrite_settings(). | ||||
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::$preserveGlobalState | protected | property | |||||
BrowserTestBase::$profile | protected | property | The profile to install as a basis for testing. | 37 | |||
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::drupalGetHeader | Deprecated | protected | function | Gets the value of an HTTP response header. | |||
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 Simpletest site. | 1 | |||
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::__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 | ||
DisplayTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
DisplayTest::$modules | protected static | property | Modules to enable. | Overrides ViewTestBase::$modules | |||
DisplayTest::$testViews | public static | property | Views used by this test. | ||||
DisplayTest::checkTranslationSetting | protected | function | Asserts a node and a file based view for the translation setting. | ||||
DisplayTest::setUp | protected | function | Sets up the test. | Overrides ViewTestBase::setUp | |||
DisplayTest::testDisplayPlugin | public | function | Tests the display test plugin. | ||||
DisplayTest::testFilterGroupsOverriding | public | function | Tests the overriding of filter_groups. | ||||
DisplayTest::testGetAttachedDisplays | public | function | Tests the getAttachedDisplays method. | ||||
DisplayTest::testInvalidDisplayPlugins | public | function | Tests invalid display plugins. | ||||
DisplayTest::testMissingRelationship | public | function | Tests display validation when a required relationship is missing. | ||||
DisplayTest::testOutputIsEmpty | public | function | Tests the outputIsEmpty method on the display. | ||||
DisplayTest::testReadMoreCustomURL | public | function | Tests the readmore with custom URL. | ||||
DisplayTest::testReadMoreNoDisplay | public | function | Tests the readmore validation. | ||||
DisplayTest::testTranslationSetting | public | function | Tests translation rendering settings based on entity translatability. | ||||
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::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. | ||||
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. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 22 | |||
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. | 3 | |||
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 | |||
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 | |||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | ||||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | 1 | |||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | ||||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 1 | |||
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::checkModuleRequirements | private | function | Checks missing module requirements. | ||||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | ||||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 1 | |||
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. | 1 | |||
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. | 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::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. | 2 | |||
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 | Deprecated | 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::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. | 2 | |||
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. | 2 | |||
ViewTestBase::viewsData | protected | function | Returns the views data definition. | 9 | |||
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.