class ModerationFormTest
Same name in other branches
- 9 core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php \Drupal\Tests\content_moderation\Functional\ModerationFormTest
- 8.9.x core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php \Drupal\Tests\content_moderation\Functional\ModerationFormTest
- 11.x core/modules/content_moderation/tests/src/Functional/ModerationFormTest.php \Drupal\Tests\content_moderation\Functional\ModerationFormTest
Tests the moderation form, specifically on nodes.
@group content_moderation @group #slow
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\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\content_moderation\Functional\ModerationStateTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\content_moderation\Traits\ContentModerationTestTrait
- class \Drupal\Tests\content_moderation\Functional\ModerationFormTest extends \Drupal\Tests\content_moderation\Functional\ModerationStateTestBase uses \Drupal\Tests\content_translation\Traits\ContentTranslationTestTrait
- class \Drupal\Tests\content_moderation\Functional\ModerationStateTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\content_moderation\Traits\ContentModerationTestTrait
Expanded class hierarchy of ModerationFormTest
File
-
core/
modules/ content_moderation/ tests/ src/ Functional/ ModerationFormTest.php, line 17
Namespace
Drupal\Tests\content_moderation\FunctionalView source
class ModerationFormTest extends ModerationStateTestBase {
use ContentTranslationTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'node',
'content_moderation',
'locale',
'content_translation',
];
/**
* {@inheritdoc}
*
* @todo Remove and fix test to not rely on super user.
* @see https://www.drupal.org/project/drupal/issues/3437620
*/
protected bool $usesSuperUserAccessPolicy = TRUE;
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->drupalLogin($this->adminUser);
$this->createContentTypeFromUi('Moderated content', 'moderated_content', TRUE);
$this->grantUserPermissionToCreateContentOfType($this->adminUser, 'moderated_content');
}
/**
* Tests the moderation form that shows on the latest version page.
*
* The latest version page only shows if there is a pending revision.
*
* @see \Drupal\content_moderation\EntityOperations
* @see \Drupal\Tests\content_moderation\Functional\ModerationStateBlockTest::testCustomBlockModeration
*/
public function testModerationForm() : void {
// Test the states that appear by default when creating a new item of
// content.
$this->drupalGet('node/add/moderated_content');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
// Previewing a new item of content should not change the available states.
$this->submitForm([
'moderation_state[0][state]' => 'published',
'title[0][value]' => 'Some moderated content',
'body[0][value]' => 'First version of the content.',
], 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
// Create new moderated content in draft.
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save');
$node = $this->drupalGetNodeByTitle('Some moderated content');
$canonical_path = sprintf('node/%d', $node->id());
$edit_path = sprintf('node/%d/edit', $node->id());
$latest_version_path = sprintf('node/%d/latest', $node->id());
$this->assertTrue($this->adminUser
->hasPermission('edit any moderated_content content'));
// The canonical view should have a moderation form, because it is not the
// live revision.
$this->drupalGet($canonical_path);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->fieldExists('edit-new-state');
// The latest version page should not show, because there is no pending
// revision.
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(403);
// Update the draft.
$this->drupalGet($edit_path);
$this->submitForm([
'body[0][value]' => 'Second version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save');
// The canonical view should have a moderation form, because it is not the
// live revision.
$this->drupalGet($canonical_path);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->fieldExists('edit-new-state');
// Preview the draft.
$this->drupalGet($edit_path);
$this->submitForm([
'body[0][value]' => 'Second version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Preview');
// The preview view should not have a moderation form.
$preview_url = Url::fromRoute('entity.node.preview', [
'node_preview' => $node->uuid(),
'view_mode_id' => 'full',
]);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->addressEquals($preview_url);
$this->assertSession()
->fieldNotExists('edit-new-state');
// The latest version page should not show, because there is still no
// pending revision.
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(403);
// Publish the draft.
$this->drupalGet($edit_path);
$this->submitForm([
'body[0][value]' => 'Third version of the content.',
'moderation_state[0][state]' => 'published',
], 'Save');
// Check widget default value.
$this->drupalGet($edit_path);
$this->assertSession()
->fieldValueEquals('moderation_state[0][state]', 'published');
// Preview the content while selecting the "draft" state and when the user
// returns to the edit form, ensure all of the available transitions are
// still those available from the "published" source state.
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
// The published view should not have a moderation form, because it is the
// live revision.
$this->drupalGet($canonical_path);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->fieldNotExists('edit-new-state');
// The latest version page should not show, because there is still no
// pending revision.
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(403);
// Make a pending revision.
$this->drupalGet($edit_path);
$this->submitForm([
'body[0][value]' => 'Fourth version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save');
// The published view should not have a moderation form, because it is the
// live revision.
$this->drupalGet($canonical_path);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->fieldNotExists('edit-new-state');
// The latest version page should show the moderation form and have "Draft"
// status, because the pending revision is in "Draft".
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->fieldExists('edit-new-state');
$this->assertSession()
->pageTextContains('Draft');
// Submit the moderation form to change status to published.
$this->drupalGet($latest_version_path);
$this->submitForm([
'new_state' => 'published',
], 'Apply');
// The latest version page should not show, because there is no
// pending revision.
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(403);
}
/**
* Tests moderation non-bundle entity type.
*/
public function testNonBundleModerationForm() : void {
$this->drupalLogin($this->rootUser);
$this->workflow
->getTypePlugin()
->addEntityTypeAndBundle('entity_test_mulrevpub', 'entity_test_mulrevpub');
$this->workflow
->save();
// Create new moderated content in draft.
$this->drupalGet('entity_test_mulrevpub/add');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save');
// The latest version page should not show, because there is no pending
// revision.
$this->drupalGet('/entity_test_mulrevpub/manage/1/latest');
$this->assertSession()
->statusCodeEquals(403);
// Update the draft.
$this->drupalGet('entity_test_mulrevpub/manage/1/edit');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save');
// The latest version page should not show, because there is still no
// pending revision.
$this->drupalGet('/entity_test_mulrevpub/manage/1/latest');
$this->assertSession()
->statusCodeEquals(403);
// Publish the draft.
$this->drupalGet('entity_test_mulrevpub/manage/1/edit');
$this->submitForm([
'moderation_state[0][state]' => 'published',
], 'Save');
// The published view should not have a moderation form, because it is the
// default revision.
$this->drupalGet('entity_test_mulrevpub/manage/1');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextNotContains('Status');
// The latest version page should not show, because there is still no
// pending revision.
$this->drupalGet('entity_test_mulrevpub/manage/1/latest');
$this->assertSession()
->statusCodeEquals(403);
// Make a pending revision.
$this->drupalGet('entity_test_mulrevpub/manage/1/edit');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save');
// The published view should not have a moderation form, because it is the
// default revision.
$this->drupalGet('entity_test_mulrevpub/manage/1');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextNotContains('Status');
// The latest version page should show the moderation form and have "Draft"
// status, because the pending revision is in "Draft".
$this->drupalGet('entity_test_mulrevpub/manage/1/latest');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextContains('Moderation state');
$this->assertSession()
->pageTextContains('Draft');
// Submit the moderation form to change status to published.
$this->drupalGet('entity_test_mulrevpub/manage/1/latest');
$this->submitForm([
'new_state' => 'published',
], 'Apply');
// The latest version page should not show, because there is no
// pending revision.
$this->drupalGet('entity_test_mulrevpub/manage/1/latest');
$this->assertSession()
->statusCodeEquals(403);
}
/**
* Tests the revision author is updated when the moderation form is used.
*/
public function testModerationFormSetsRevisionAuthor() : void {
// Create new moderated content in published.
$node = $this->createNode([
'type' => 'moderated_content',
'moderation_state' => 'published',
]);
// Make a pending revision.
$node->title = $this->randomMachineName();
$node->moderation_state->value = 'draft';
$node->setRevisionCreationTime(12345);
$node->save();
$another_user = $this->drupalCreateUser($this->permissions);
$this->grantUserPermissionToCreateContentOfType($another_user, 'moderated_content');
$this->drupalLogin($another_user);
$this->drupalGet(sprintf('node/%d/latest', $node->id()));
$this->submitForm([
'new_state' => 'published',
], 'Apply');
$this->drupalGet(sprintf('node/%d/revisions', $node->id()));
$this->assertSession()
->pageTextContains('by ' . $another_user->getAccountName());
// Verify the revision creation time has been updated.
$node = $node->load($node->id());
$this->assertGreaterThan(12345, $node->getRevisionCreationTime());
}
/**
* Tests translated and moderated nodes.
*/
public function testContentTranslationNodeForm() : void {
$this->drupalLogin($this->rootUser);
// Add French language.
static::createLanguageFromLangcode('fr');
// Enable content translation on moderated_content.
$this->enableContentTranslation('node', 'moderated_content');
// Adding languages requires a container rebuild in the test running
// environment so that multilingual services are used.
$this->rebuildContainer();
// Create new moderated content in draft (revision 1).
$this->drupalGet('node/add/moderated_content');
$this->submitForm([
'title[0][value]' => 'Some moderated content',
'body[0][value]' => 'First version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save');
$this->assertSession()
->elementExists('xpath', '//ul[@class="entity-moderation-form"]');
$node = $this->drupalGetNodeByTitle('Some moderated content');
$this->assertNotEmpty($node->language(), 'en');
$edit_path = sprintf('node/%d/edit', $node->id());
$translate_path = sprintf('node/%d/translations/add/en/fr', $node->id());
$latest_version_path = sprintf('node/%d/latest', $node->id());
$french = \Drupal::languageManager()->getLanguage('fr');
$this->drupalGet($latest_version_path);
$this->assertSession()
->statusCodeEquals(403);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Add french translation (revision 2).
$this->drupalGet($translate_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Second version of the content.',
'moderation_state[0][state]' => 'published',
], 'Save (this translation)');
$this->drupalGet($latest_version_path, [
'language' => $french,
]);
$this->assertSession()
->statusCodeEquals(403);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Add french pending revision (revision 3).
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
// Preview the content while selecting the "draft" state and when the user
// returns to the edit form, ensure all of the available transitions are
// still those available from the "published" source state.
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Third version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save (this translation)');
$this->drupalGet($latest_version_path, [
'language' => $french,
]);
$this->assertSession()
->elementExists('xpath', '//ul[@class="entity-moderation-form"]');
$this->drupalGet($edit_path);
$this->clickLink('Delete');
$this->assertSession()
->buttonExists('Delete');
$this->drupalGet($latest_version_path);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Publish the french pending revision (revision 4).
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Fifth version of the content.',
'moderation_state[0][state]' => 'published',
], 'Save (this translation)');
$this->drupalGet($latest_version_path, [
'language' => $french,
]);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Publish the English pending revision (revision 5).
$this->drupalGet($edit_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Sixth version of the content.',
'moderation_state[0][state]' => 'published',
], 'Save (this translation)');
$this->drupalGet($latest_version_path);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Make sure we are allowed to create a pending French revision.
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
// Add an English pending revision (revision 6).
$this->drupalGet($edit_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Seventh version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save (this translation)');
$this->drupalGet($latest_version_path);
$this->assertSession()
->elementExists('xpath', '//ul[@class="entity-moderation-form"]');
$this->drupalGet($latest_version_path, [
'language' => $french,
]);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Publish the English pending revision (revision 7)
$this->drupalGet($edit_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'body[0][value]' => 'Eighth version of the content.',
'moderation_state[0][state]' => 'published',
], 'Save (this translation)');
$this->drupalGet($latest_version_path);
$this->assertSession()
->elementNotExists('xpath', '//ul[@class="entity-moderation-form"]');
// Make sure we are allowed to create a pending French revision.
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
// Make sure we are allowed to create a pending English revision.
$this->drupalGet($edit_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
// Create new moderated content (revision 1).
$this->drupalGet('node/add/moderated_content');
$this->submitForm([
'title[0][value]' => 'Third moderated content',
'moderation_state[0][state]' => 'published',
], 'Save');
$node = $this->drupalGetNodeByTitle('Third moderated content');
$this->assertNotEmpty($node->language(), 'en');
$edit_path = sprintf('node/%d/edit', $node->id());
$translate_path = sprintf('node/%d/translations/add/en/fr', $node->id());
// Translate it, without updating data (revision 2).
$this->drupalGet($translate_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save (this translation)');
// Add another draft for the translation (revision 3).
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save (this translation)');
// Updating and publishing the french translation is still possible.
$this->drupalGet($edit_path, [
'language' => $french,
]);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionNotExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'moderation_state[0][state]' => 'published',
], 'Save (this translation)');
// Now the french translation is published, an english draft can be added.
$this->drupalGet($edit_path);
$this->assertSession()
->optionExists('moderation_state[0][state]', 'draft');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'published');
$this->assertSession()
->optionExists('moderation_state[0][state]', 'archived');
$this->submitForm([
'moderation_state[0][state]' => 'draft',
], 'Save (this translation)');
}
/**
* Tests the moderation_state field when an alternative widget is set.
*/
public function testAlternativeModerationStateWidget() : void {
$entity_form_display = EntityFormDisplay::load('node.moderated_content.default');
$entity_form_display->setComponent('moderation_state', [
'type' => 'string_textfield',
'region' => 'content',
]);
$entity_form_display->save();
$this->drupalGet('node/add/moderated_content');
$this->submitForm([
'title[0][value]' => 'Test content',
'moderation_state[0][value]' => 'published',
], 'Save');
$this->assertSession()
->pageTextContains('Moderated content Test content has been created.');
}
/**
* Tests that workflows and states can not be deleted if they are in use.
*
* @covers \Drupal\content_moderation\Plugin\WorkflowType\ContentModeration::workflowHasData
* @covers \Drupal\content_moderation\Plugin\WorkflowType\ContentModeration::workflowStateHasData
*/
public function testWorkflowInUse() : void {
$user = $this->createUser([
'administer workflows',
'create moderated_content content',
'edit own moderated_content content',
'use editorial transition create_new_draft',
'use editorial transition publish',
'use editorial transition archive',
]);
$this->drupalLogin($user);
$paths = [
'archived_state' => 'admin/config/workflow/workflows/manage/editorial/state/archived/delete',
'editorial_workflow' => 'admin/config/workflow/workflows/manage/editorial/delete',
];
$messages = [
'archived_state' => 'This workflow state is in use. You cannot remove this workflow state until you have removed all content using it.',
'editorial_workflow' => 'This workflow is in use. You cannot remove this workflow until you have removed all content using it.',
];
foreach ($paths as $path) {
$this->drupalGet($path);
$this->assertSession()
->buttonExists('Delete');
}
// Create new moderated content in draft.
$this->drupalGet('node/add/moderated_content');
$this->submitForm([
'title[0][value]' => 'Some moderated content',
'body[0][value]' => 'First version of the content.',
'moderation_state[0][state]' => 'draft',
], 'Save');
// The archived state is not used yet, so can still be deleted.
$this->drupalGet($paths['archived_state']);
$this->assertSession()
->buttonExists('Delete');
// The workflow is being used, so can't be deleted.
$this->drupalGet($paths['editorial_workflow']);
$this->assertSession()
->buttonNotExists('Delete');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextContains($messages['editorial_workflow']);
$node = $this->drupalGetNodeByTitle('Some moderated content');
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm([
'moderation_state[0][state]' => 'published',
], 'Save');
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm([
'moderation_state[0][state]' => 'archived',
], 'Save');
// Now the archived state is being used so it can not be deleted either.
foreach ($paths as $type => $path) {
$this->drupalGet($path);
$this->assertSession()
->buttonNotExists('Delete');
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->pageTextContains($messages[$type]);
}
}
}
Members
Title Sort descending | Deprecated | 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::$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 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::$preserveGlobalState | protected | property | |||||
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 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::__get | public | function | |||||
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. | ||||
ContentModerationTestTrait::addEntityTypeAndBundleToWorkflow | protected | function | Adds an entity type ID / bundle ID to the given workflow. | 1 | |||
ContentModerationTestTrait::createEditorialWorkflow | protected | function | Creates the editorial workflow. | 1 | |||
ContentTranslationTestTrait::enableContentTranslation | public | function | Enables content translation for the given entity type bundle. | ||||
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. | ||||
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. | 2 | |||
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. | 28 | |||
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 | |||
LanguageTestTrait::createLanguageFromLangcode | public static | function | Creates a configurable language object from a langcode. | ||||
LanguageTestTrait::disableBundleTranslation | public static | function | Disables translations for the given entity type bundle. | ||||
LanguageTestTrait::enableBundleTranslation | public static | function | Enables translations for the given entity type bundle. | ||||
LanguageTestTrait::setFieldTranslatable | public static | function | Sets and saves a given field instance translation status. | ||||
ModerationFormTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
ModerationFormTest::$modules | protected static | property | Modules to install. | Overrides ModerationStateTestBase::$modules | |||
ModerationFormTest::$usesSuperUserAccessPolicy | protected | property | @todo Remove and fix test to not rely on super user. | Overrides FunctionalTestSetupTrait::$usesSuperUserAccessPolicy | |||
ModerationFormTest::setUp | protected | function | Sets the test up. | Overrides ModerationStateTestBase::setUp | |||
ModerationFormTest::testAlternativeModerationStateWidget | public | function | Tests the moderation_state field when an alternative widget is set. | ||||
ModerationFormTest::testContentTranslationNodeForm | public | function | Tests translated and moderated nodes. | ||||
ModerationFormTest::testModerationForm | public | function | Tests the moderation form that shows on the latest version page. | ||||
ModerationFormTest::testModerationFormSetsRevisionAuthor | public | function | Tests the revision author is updated when the moderation form is used. | ||||
ModerationFormTest::testNonBundleModerationForm | public | function | Tests moderation non-bundle entity type. | ||||
ModerationFormTest::testWorkflowInUse | public | function | Tests that workflows and states can not be deleted if they are in use. | ||||
ModerationStateTestBase::$adminUser | protected | property | Admin user. | ||||
ModerationStateTestBase::$permissions | protected | property | Permissions to grant admin user. | 1 | |||
ModerationStateTestBase::$profile | protected | property | Profile to use. | Overrides BrowserTestBase::$profile | |||
ModerationStateTestBase::$workflow | protected | property | The editorial workflow entity. | ||||
ModerationStateTestBase::createContentTypeFromUi | protected | function | Creates a content-type from the UI. | ||||
ModerationStateTestBase::enableModerationThroughUi | public | function | Enable moderation for a specified content type, using the UI. | ||||
ModerationStateTestBase::getWorkflowTransitionPermission | protected | function | Gets the permission machine name for a transition. | ||||
ModerationStateTestBase::grantUserPermissionToCreateContentOfType | protected | function | Grants given user permission to create content of given type. | ||||
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::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||||
RandomGeneratorTrait::randomStringValidate | Deprecated | public | function | Callback for random string validation. | |||
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::checkModuleRequirements | Deprecated | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | Deprecated | protected | function | Check module requirements for the Drupal use case. | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 2 | |||
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::getDatabaseConnection | Deprecated | public static | function | Returns the database connection to the site under 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. | ||||
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.