class FilterAdminTest
Same name in other branches
- 8.9.x core/modules/filter/tests/src/Functional/FilterAdminTest.php \Drupal\Tests\filter\Functional\FilterAdminTest
- 10 core/modules/filter/tests/src/Functional/FilterAdminTest.php \Drupal\Tests\filter\Functional\FilterAdminTest
- 11.x core/modules/filter/tests/src/Functional/FilterAdminTest.php \Drupal\Tests\filter\Functional\FilterAdminTest
Thoroughly test the administrative interface of the filter module.
@group filter
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\filter\Functional\FilterAdminTest extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of FilterAdminTest
File
-
core/
modules/ filter/ tests/ src/ Functional/ FilterAdminTest.php, line 19
Namespace
Drupal\Tests\filter\FunctionalView source
class FilterAdminTest extends BrowserTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'block',
'filter',
'node',
'filter_test_plugin',
'dblog',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* A user with administration permissions.
*
* @var \Drupal\user\UserInterface
*/
protected $adminUser;
/**
* A user with permissions to create pages.
*
* @var \Drupal\user\UserInterface
*/
protected $webUser;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->drupalCreateContentType([
'type' => 'page',
'name' => 'Basic page',
]);
// Set up the filter formats used by this test.
$basic_html_format = FilterFormat::create([
'format' => 'basic_html',
'name' => 'Basic HTML',
'filters' => [
'filter_html' => [
'status' => 1,
'settings' => [
'allowed_html' => '<p> <br> <strong> <a> <em>',
],
],
],
]);
$basic_html_format->save();
$restricted_html_format = FilterFormat::create([
'format' => 'restricted_html',
'name' => 'Restricted HTML',
'filters' => [
'filter_html' => [
'status' => TRUE,
'weight' => -10,
'settings' => [
'allowed_html' => '<p> <br> <strong> <a> <em> <h4>',
],
],
'filter_autop' => [
'status' => TRUE,
'weight' => 0,
],
'filter_url' => [
'status' => TRUE,
'weight' => 0,
],
'filter_htmlcorrector' => [
'status' => TRUE,
'weight' => 10,
],
],
]);
$restricted_html_format->save();
$full_html_format = FilterFormat::create([
'format' => 'full_html',
'name' => 'Full HTML',
'weight' => 1,
'filters' => [],
]);
$full_html_format->save();
$this->adminUser = $this->drupalCreateUser([
'administer filters',
$basic_html_format->getPermissionName(),
$restricted_html_format->getPermissionName(),
$full_html_format->getPermissionName(),
'access site reports',
]);
$this->webUser = $this->drupalCreateUser([
'create page content',
'edit own page content',
]);
user_role_grant_permissions('authenticated', [
$basic_html_format->getPermissionName(),
]);
user_role_grant_permissions('anonymous', [
$restricted_html_format->getPermissionName(),
]);
$this->drupalLogin($this->adminUser);
$this->drupalPlaceBlock('local_actions_block');
}
/**
* Tests the format administration functionality.
*/
public function testFormatAdmin() {
// Add text format.
$this->drupalGet('admin/config/content/formats');
$this->clickLink('Add text format');
$format_id = mb_strtolower($this->randomMachineName());
$name = $this->randomMachineName();
$edit = [
'format' => $format_id,
'name' => $name,
];
$this->submitForm($edit, 'Save configuration');
// Verify default weight of the text format.
$this->drupalGet('admin/config/content/formats');
$this->assertSession()
->fieldValueEquals("formats[{$format_id}][weight]", 0);
// Change the weight of the text format.
$edit = [
"formats[{$format_id}][weight]" => 5,
];
$this->drupalGet('admin/config/content/formats');
$this->submitForm($edit, 'Save');
$this->assertSession()
->fieldValueEquals("formats[{$format_id}][weight]", 5);
// Edit text format.
$this->drupalGet('admin/config/content/formats');
$destination = Url::fromRoute('filter.admin_overview')->toString();
$edit_href = Url::fromRoute('entity.filter_format.edit_form', [
'filter_format' => $format_id,
], [
'query' => [
'destination' => $destination,
],
])->toString();
$this->assertSession()
->linkByHrefExists($edit_href);
$this->drupalGet('admin/config/content/formats/manage/' . $format_id);
$this->submitForm([], 'Save configuration');
// Verify that the custom weight of the text format has been retained.
$this->drupalGet('admin/config/content/formats');
$this->assertSession()
->fieldValueEquals("formats[{$format_id}][weight]", 5);
// Disable text format.
$this->assertSession()
->linkByHrefExists('admin/config/content/formats/manage/' . $format_id . '/disable');
$this->drupalGet('admin/config/content/formats/manage/' . $format_id . '/disable');
$this->submitForm([], 'Disable');
// Verify that disabled text format no longer exists.
$this->drupalGet('admin/config/content/formats/manage/' . $format_id);
$this->assertSession()
->statusCodeEquals(404);
// Attempt to create a format of the same machine name as the disabled
// format but with a different human readable name.
$edit = [
'format' => $format_id,
'name' => 'New format',
];
$this->drupalGet('admin/config/content/formats/add');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->statusMessageContains('The machine-readable name is already in use. It must be unique.', 'error');
// Attempt to create a format of the same human readable name as the
// disabled format but with a different machine name.
$edit = [
'format' => 'new_format',
'name' => $name,
];
$this->drupalGet('admin/config/content/formats/add');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->statusMessageContains("Text format names must be unique. A format named {$name} already exists.", 'error');
}
/**
* Tests filter administration functionality.
*/
public function testFilterAdmin() {
$first_filter = 'filter_autop';
$second_filter = 'filter_url';
$basic = 'basic_html';
$restricted = 'restricted_html';
$full = 'full_html';
$plain = 'plain_text';
// Check that the fallback format exists and cannot be disabled.
$this->assertSame($plain, filter_fallback_format(), 'The fallback format is set to plain text.');
$this->drupalGet('admin/config/content/formats');
$this->assertSession()
->responseNotContains('admin/config/content/formats/manage/' . $plain . '/disable');
$this->drupalGet('admin/config/content/formats/manage/' . $plain . '/disable');
$this->assertSession()
->statusCodeEquals(403);
// Verify access permissions to Full HTML format.
$full_format = FilterFormat::load($full);
$this->assertTrue($full_format->access('use', $this->adminUser), 'Admin user may use Full HTML.');
$this->assertFalse($full_format->access('use', $this->webUser), 'Web user may not use Full HTML.');
// Add an additional tag and extra spaces and returns.
$edit = [];
$edit['filters[filter_html][settings][allowed_html]'] = "<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>\r\n<quote>";
$this->drupalGet('admin/config/content/formats/manage/' . $restricted);
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $restricted);
$this->drupalGet('admin/config/content/formats/manage/' . $restricted);
// Check that the allowed HTML tag was added and the string reformatted.
$this->assertSession()
->fieldValueEquals('filters[filter_html][settings][allowed_html]', "<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <quote>");
$this->assertSession()
->elementExists('xpath', "//select[@name='filters[" . $first_filter . "][weight]']/following::select[@name='filters[" . $second_filter . "][weight]']");
// Reorder filters.
$edit = [];
$edit['filters[' . $second_filter . '][weight]'] = 1;
$edit['filters[' . $first_filter . '][weight]'] = 2;
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $restricted);
$this->drupalGet('admin/config/content/formats/manage/' . $restricted);
$this->assertSession()
->fieldValueEquals('filters[' . $second_filter . '][weight]', 1);
$this->assertSession()
->fieldValueEquals('filters[' . $first_filter . '][weight]', 2);
$this->assertSession()
->elementExists('xpath', "//select[@name='filters[" . $second_filter . "][weight]']/following::select[@name='filters[" . $first_filter . "][weight]']");
$filter_format = FilterFormat::load($restricted);
foreach ($filter_format->filters() as $filter_name => $filter) {
if ($filter_name == $second_filter || $filter_name == $first_filter) {
$filters[] = $filter_name;
}
}
// Ensure that the second filter is now before the first filter.
$this->assertEquals($filter_format->filters($second_filter)->weight + 1, $filter_format->filters($first_filter)->weight, 'Order confirmed in configuration.');
// Add format.
$edit = [];
$edit['format'] = mb_strtolower($this->randomMachineName());
$edit['name'] = $this->randomMachineName();
$edit['roles[' . RoleInterface::AUTHENTICATED_ID . ']'] = 1;
$edit['filters[' . $second_filter . '][status]'] = TRUE;
$edit['filters[' . $first_filter . '][status]'] = TRUE;
$this->drupalGet('admin/config/content/formats/add');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats');
$this->assertSession()
->statusMessageContains("Added text format {$edit['name']}.", 'status');
filter_formats_reset();
$format = FilterFormat::load($edit['format']);
$this->assertNotNull($format, 'Format found in database.');
$this->drupalGet('admin/config/content/formats/manage/' . $format->id());
$this->assertSession()
->checkboxChecked('roles[' . RoleInterface::AUTHENTICATED_ID . ']');
$this->assertSession()
->checkboxChecked('filters[' . $second_filter . '][status]');
$this->assertSession()
->checkboxChecked('filters[' . $first_filter . '][status]');
/** @var \Drupal\user\Entity\Role $role */
\Drupal::entityTypeManager()->getStorage('user_role')
->resetCache([
RoleInterface::AUTHENTICATED_ID,
]);
$role = Role::load(RoleInterface::AUTHENTICATED_ID);
$this->assertTrue($role->hasPermission($format->getPermissionName()), 'The authenticated role has permission to use the filter.');
// Disable new filter.
$this->drupalGet('admin/config/content/formats/manage/' . $format->id() . '/disable');
$this->submitForm([], 'Disable');
$this->assertSession()
->addressEquals('admin/config/content/formats');
$this->assertSession()
->statusMessageContains("Disabled text format {$edit['name']}.", 'status');
\Drupal::entityTypeManager()->getStorage('user_role')
->resetCache([
RoleInterface::AUTHENTICATED_ID,
]);
$role = Role::load(RoleInterface::AUTHENTICATED_ID);
$this->assertFalse($role->hasPermission($format->getPermissionName()), 'The filter permission has been removed from the authenticated role');
// Allow authenticated users on full HTML.
$format = FilterFormat::load($full);
$edit = [];
$edit['roles[' . RoleInterface::ANONYMOUS_ID . ']'] = 0;
$edit['roles[' . RoleInterface::AUTHENTICATED_ID . ']'] = 1;
$this->drupalGet('admin/config/content/formats/manage/' . $full);
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $full);
$this->assertSession()
->statusMessageContains("The text format {$format->label()} has been updated.", 'status');
// Switch user.
$this->drupalLogin($this->webUser);
$this->drupalGet('node/add/page');
$this->assertSession()
->responseContains('<option value="' . $full . '">Full HTML</option>');
// Use basic HTML and see if it removes tags that are not allowed.
$body = '<em>' . $this->randomMachineName() . '</em>';
$extra_text = 'text';
$text = $body . '<random>' . $extra_text . '</random>';
$edit = [];
$edit['title[0][value]'] = $this->randomMachineName();
$edit['body[0][value]'] = $text;
$edit['body[0][format]'] = $basic;
$this->drupalGet('node/add/page');
$this->submitForm($edit, 'Save');
$this->assertSession()
->statusMessageContains('Basic page ' . $edit['title[0][value]'] . ' has been created.', 'status');
// Verify that the creation message contains a link to a node.
$this->assertSession()
->elementExists('xpath', '//div[@aria-label="Status message"]//a[contains(@href, "node/")]');
$node = $this->drupalGetNodeByTitle($edit['title[0][value]']);
$this->assertNotEmpty($node, 'Node found in database.');
$this->drupalGet('node/' . $node->id());
// Check that filter removed invalid tag.
$this->assertSession()
->responseContains($body . $extra_text);
// Use plain text and see if it escapes all tags, whether allowed or not.
// In order to test plain text, we have to enable the hidden variable for
// "show_fallback_format", which displays plain text in the format list.
$this->config('filter.settings')
->set('always_show_fallback_choice', TRUE)
->save();
$edit = [];
$edit['body[0][format]'] = $plain;
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->drupalGet('node/' . $node->id());
$this->assertSession()
->assertEscaped($text);
$this->config('filter.settings')
->set('always_show_fallback_choice', FALSE)
->save();
// Switch user.
$this->drupalLogin($this->adminUser);
// Clean up.
// Allowed tags.
$edit = [];
$edit['filters[filter_html][settings][allowed_html]'] = '<a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd>';
$this->drupalGet('admin/config/content/formats/manage/' . $basic);
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $basic);
$this->drupalGet('admin/config/content/formats/manage/' . $basic);
$this->assertSession()
->fieldValueEquals('filters[filter_html][settings][allowed_html]', $edit['filters[filter_html][settings][allowed_html]']);
// Full HTML.
$edit = [];
$edit['roles[' . RoleInterface::AUTHENTICATED_ID . ']'] = FALSE;
$this->drupalGet('admin/config/content/formats/manage/' . $full);
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $full);
$this->assertSession()
->statusMessageContains("The text format {$format->label()} has been updated.", 'status');
$this->drupalGet('admin/config/content/formats/manage/' . $full);
$this->assertSession()
->fieldValueEquals('roles[' . RoleInterface::AUTHENTICATED_ID . ']', $edit['roles[' . RoleInterface::AUTHENTICATED_ID . ']']);
// Filter order.
$edit = [];
$edit['filters[' . $second_filter . '][weight]'] = 2;
$edit['filters[' . $first_filter . '][weight]'] = 1;
$this->drupalGet('admin/config/content/formats/manage/' . $basic);
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->addressEquals('admin/config/content/formats/manage/' . $basic);
$this->drupalGet('admin/config/content/formats/manage/' . $basic);
$this->assertSession()
->fieldValueEquals('filters[' . $second_filter . '][weight]', $edit['filters[' . $second_filter . '][weight]']);
$this->assertSession()
->fieldValueEquals('filters[' . $first_filter . '][weight]', $edit['filters[' . $first_filter . '][weight]']);
}
/**
* Tests the URL filter settings form is properly validated.
*/
public function testUrlFilterAdmin() {
// The form does not save with an invalid filter URL length.
$edit = [
'filters[filter_url][settings][filter_url_length]' => $this->randomMachineName(4),
];
$this->drupalGet('admin/config/content/formats/manage/basic_html');
$this->submitForm($edit, 'Save configuration');
$this->assertSession()
->statusMessageNotContains('The text format Basic HTML has been updated.');
}
/**
* Tests whether filter tips page is not HTML escaped.
*/
public function testFilterTipHtmlEscape() {
$this->drupalLogin($this->adminUser);
global $base_url;
$site_name_with_markup = 'Filter test <script>alert(\'here\');</script> site name';
$this->config('system.site')
->set('name', $site_name_with_markup)
->save();
// It is not possible to test the whole filter tip page.
// Therefore we test only some parts.
$link = '<a href="' . $base_url . '">' . Html::escape($site_name_with_markup) . '</a>';
$ampersand = '&';
$link_as_code = '<code>' . Html::escape($link) . '</code>';
$ampersand_as_code = '<code>' . Html::escape($ampersand) . '</code>';
$this->drupalGet('filter/tips');
$this->assertSession()
->responseContains('<td class="type">' . $link_as_code . '</td>');
$this->assertSession()
->responseContains('<td class="get">' . $link . '</td>');
$this->assertSession()
->responseContains('<td class="type">' . $ampersand_as_code . '</td>');
$this->assertSession()
->responseContains('<td class="get">' . $ampersand . '</td>');
}
/**
* Tests whether a field using a disabled format is rendered.
*/
public function testDisabledFormat() {
// Create a node type and add a standard body field.
$node_type = NodeType::create([
'type' => mb_strtolower($this->randomMachineName()),
]);
$node_type->save();
node_add_body_field($node_type, $this->randomString());
// Create a text format with a filter that returns a static string.
$format = FilterFormat::create([
'name' => $this->randomString(),
'format' => $format_id = mb_strtolower($this->randomMachineName()),
]);
$format->setFilterConfig('filter_static_text', [
'status' => TRUE,
]);
$format->save();
// Create a new node of the new node type.
$node = Node::create([
'type' => $node_type->id(),
'title' => $this->randomString(),
]);
$body_value = $this->randomString();
$node->body->value = $body_value;
$node->body->format = $format_id;
$node->save();
// The format is used and we should see the static text instead of the body
// value.
$this->drupalGet($node->toUrl());
$this->assertSession()
->pageTextContains('filtered text');
// Disable the format.
$format->disable()
->save();
$this->drupalGet($node->toUrl());
// The format is not used anymore.
$this->assertSession()
->pageTextNotContains('filtered text');
// The text is not displayed unfiltered or escaped.
$this->assertSession()
->responseNotContains($body_value);
$this->assertSession()
->assertNoEscaped($body_value);
// Visit the dblog report page.
$this->drupalLogin($this->adminUser);
$this->drupalGet('admin/reports/dblog');
// The correct message has been logged.
$this->assertSession()
->pageTextContains(sprintf('Disabled text format: %s.', $format_id));
// Programmatically change the text format to something random so we trigger
// the missing text format message.
$format_id = $this->randomMachineName();
$node->body->format = $format_id;
$node->save();
$this->drupalGet($node->toUrl());
// The text is not displayed unfiltered or escaped.
$this->assertSession()
->responseNotContains($body_value);
$this->assertSession()
->assertNoEscaped($body_value);
// Visit the dblog report page.
$this->drupalGet('admin/reports/dblog');
// The missing text format message has been logged.
$this->assertSession()
->pageTextContains(sprintf('Missing text format: %s.', $format_id));
}
}
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 | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
FilterAdminTest::$adminUser | protected | property | A user with administration permissions. | ||||
FilterAdminTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
FilterAdminTest::$modules | protected static | property | Modules to enable. | Overrides BrowserTestBase::$modules | |||
FilterAdminTest::$webUser | protected | property | A user with permissions to create pages. | ||||
FilterAdminTest::setUp | protected | function | Overrides BrowserTestBase::setUp | ||||
FilterAdminTest::testDisabledFormat | public | function | Tests whether a field using a disabled format is rendered. | ||||
FilterAdminTest::testFilterAdmin | public | function | Tests filter administration functionality. | ||||
FilterAdminTest::testFilterTipHtmlEscape | public | function | Tests whether filter tips page is not HTML escaped. | ||||
FilterAdminTest::testFormatAdmin | public | function | Tests the format administration functionality. | ||||
FilterAdminTest::testUrlFilterAdmin | public | function | Tests the URL filter settings form is properly validated. | ||||
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. | ||||
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.