class PagePreviewTest
Same name in other branches
- 9 core/modules/node/tests/src/Functional/PagePreviewTest.php \Drupal\Tests\node\Functional\PagePreviewTest
- 8.9.x core/modules/node/tests/src/Functional/PagePreviewTest.php \Drupal\Tests\node\Functional\PagePreviewTest
- 11.x core/modules/node/tests/src/Functional/PagePreviewTest.php \Drupal\Tests\node\Functional\PagePreviewTest
Tests the node entity preview functionality.
@group node
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\node\Functional\NodeTestBase extends \Drupal\Tests\BrowserTestBase
- class \Drupal\Tests\node\Functional\PagePreviewTest extends \Drupal\Tests\node\Functional\NodeTestBase uses \Drupal\Tests\field\Traits\EntityReferenceFieldCreationTrait, \Drupal\comment\Tests\CommentTestTrait, \Drupal\Tests\TestFileCreationTrait
- class \Drupal\Tests\node\Functional\NodeTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of PagePreviewTest
File
-
core/
modules/ node/ tests/ src/ Functional/ PagePreviewTest.php, line 25
Namespace
Drupal\Tests\node\FunctionalView source
class PagePreviewTest extends NodeTestBase {
use EntityReferenceFieldCreationTrait;
use CommentTestTrait;
use TestFileCreationTrait {
getTestFiles as drupalGetTestFiles;
}
/**
* Enable the comment, node and taxonomy modules to test on the preview.
*
* @var array
*/
protected static $modules = [
'node',
'taxonomy',
'comment',
'image',
'file',
'text',
'node_test',
'menu_ui',
];
/**
* The theme to install as the default for testing.
*
* @var string
*/
protected $defaultTheme = 'starterkit_theme';
/**
* The name of the created field.
*
* @var string
*/
protected $fieldName;
/**
* A term.
*
* @var \Drupal\taxonomy\Entity\Term
*/
protected Term $term;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->addDefaultCommentField('node', 'page');
$web_user = $this->drupalCreateUser([
'edit own page content',
'create page content',
'administer menu',
]);
$this->drupalLogin($web_user);
// Add a vocabulary so we can test different view modes.
$vocabulary = Vocabulary::create([
'name' => $this->randomMachineName(),
'description' => $this->randomMachineName(),
'vid' => $this->randomMachineName(),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
'help' => '',
]);
$vocabulary->save();
// Add a term to the vocabulary.
$term = Term::create([
'name' => $this->randomMachineName(),
'description' => $this->randomMachineName(),
'vid' => $vocabulary->id(),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
$term->save();
$this->term = $term;
// Create an image field.
FieldStorageConfig::create([
'field_name' => 'field_image',
'entity_type' => 'node',
'type' => 'image',
'settings' => [],
'cardinality' => FieldStorageConfig::CARDINALITY_UNLIMITED,
])->save();
$field_config = FieldConfig::create([
'field_name' => 'field_image',
'label' => 'Images',
'entity_type' => 'node',
'bundle' => 'page',
'required' => FALSE,
'settings' => [],
]);
$field_config->save();
// Create a field.
$this->fieldName = $this->randomMachineName();
$handler_settings = [
'target_bundles' => [
$vocabulary->id() => $vocabulary->id(),
],
'auto_create' => TRUE,
];
$this->createEntityReferenceField('node', 'page', $this->fieldName, 'Tags', 'taxonomy_term', 'default', $handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
$display_repository->getFormDisplay('node', 'page')
->setComponent($this->fieldName, [
'type' => 'entity_reference_autocomplete_tags',
])
->save();
// Show on default display and teaser.
$display_repository->getViewDisplay('node', 'page')
->setComponent($this->fieldName, [
'type' => 'entity_reference_label',
])
->save();
$display_repository->getViewDisplay('node', 'page', 'teaser')
->setComponent($this->fieldName, [
'type' => 'entity_reference_label',
])
->save();
$display_repository->getFormDisplay('node', 'page')
->setComponent('field_image', [
'type' => 'image_image',
'settings' => [],
])
->save();
$display_repository->getViewDisplay('node', 'page')
->setComponent('field_image')
->save();
// Create a multi-value text field.
$field_storage = FieldStorageConfig::create([
'field_name' => 'field_test_multi',
'entity_type' => 'node',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'type' => 'text',
'settings' => [
'max_length' => 50,
],
]);
$field_storage->save();
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'page',
])->save();
$display_repository->getFormDisplay('node', 'page')
->setComponent('field_test_multi', [
'type' => 'text_textfield',
])
->save();
$display_repository->getViewDisplay('node', 'page')
->setComponent('field_test_multi', [
'type' => 'string',
])
->save();
}
/**
* Checks the node preview functionality.
*/
public function testPagePreview() : void {
$title_key = 'title[0][value]';
$body_key = 'body[0][value]';
$term_key = $this->fieldName . '[target_id]';
// Fill in node creation form and preview node.
$edit = [];
$edit[$title_key] = '<em>' . $this->randomMachineName(8) . '</em>';
$edit[$body_key] = $this->randomMachineName(16);
$edit[$term_key] = $this->term
->getName();
// Upload an image.
$test_image = current($this->drupalGetTestFiles('image', 39325));
$edit['files[field_image_0][]'] = \Drupal::service('file_system')->realpath($test_image->uri);
$this->drupalGet('node/add/page');
$this->submitForm($edit, 'Upload');
// Add an alt tag and preview the node.
$this->submitForm([
'field_image[0][alt]' => 'Picture of llamas',
], 'Preview');
// Check that the preview is displaying the title, body and term.
$expected_title = $edit[$title_key] . ' | Drupal';
$this->assertSession()
->titleEquals($expected_title);
$this->assertSession()
->assertEscaped($edit[$title_key]);
$this->assertSession()
->pageTextContains($edit[$body_key]);
$this->assertSession()
->pageTextContains($edit[$term_key]);
$this->assertSession()
->linkExists('Back to content editing');
// Check that we see the class of the node type on the body element.
$this->assertSession()
->elementExists('xpath', "//body[contains(@class, 'page-node-type-page')]");
// Get the UUID.
$url = parse_url($this->getUrl());
$paths = explode('/', $url['path']);
$view_mode = array_pop($paths);
$uuid = array_pop($paths);
// Switch view mode. We'll remove the body from the teaser view mode.
\Drupal::service('entity_display.repository')->getViewDisplay('node', 'page', 'teaser')
->removeComponent('body')
->save();
$view_mode_edit = [
'view_mode' => 'teaser',
];
$this->drupalGet('node/preview/' . $uuid . '/full');
$this->submitForm($view_mode_edit, 'Switch');
$this->assertSession()
->responseContains('view-mode-teaser');
$this->assertSession()
->pageTextNotContains($edit[$body_key]);
// Check that the title, body and term fields are displayed with the
// values after going back to the content edit page.
$this->clickLink('Back to content editing');
$this->assertSession()
->fieldValueEquals($title_key, $edit[$title_key]);
$this->assertSession()
->fieldValueEquals($body_key, $edit[$body_key]);
$this->assertSession()
->fieldValueEquals($term_key, $edit[$term_key]);
$this->assertSession()
->fieldValueEquals('field_image[0][alt]', 'Picture of llamas');
$this->getSession()
->getPage()
->pressButton('Add another item');
$this->assertSession()
->fieldExists('field_test_multi[0][value]');
$this->assertSession()
->fieldExists('field_test_multi[1][value]');
// Return to page preview to check everything is as expected.
$this->submitForm([], 'Preview');
$this->assertSession()
->titleEquals($expected_title);
$this->assertSession()
->assertEscaped($edit[$title_key]);
$this->assertSession()
->pageTextContains($edit[$body_key]);
$this->assertSession()
->pageTextContains($edit[$term_key]);
$this->assertSession()
->linkExists('Back to content editing');
// Assert the content is kept when reloading the page.
$this->drupalGet('node/add/page', [
'query' => [
'uuid' => $uuid,
],
]);
$this->assertSession()
->fieldValueEquals($title_key, $edit[$title_key]);
$this->assertSession()
->fieldValueEquals($body_key, $edit[$body_key]);
$this->assertSession()
->fieldValueEquals($term_key, $edit[$term_key]);
// Save the node - this is a new POST, so we need to upload the image.
$this->drupalGet('node/add/page');
$this->submitForm($edit, 'Upload');
$this->submitForm([
'field_image[0][alt]' => 'Picture of llamas',
], 'Save');
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
// Check the term was displayed on the saved node.
$this->drupalGet('node/' . $node->id());
$this->assertSession()
->pageTextContains($edit[$term_key]);
// Check the term appears again on the edit form.
$this->drupalGet('node/' . $node->id() . '/edit');
$this->assertSession()
->fieldValueEquals($term_key, $edit[$term_key] . ' (' . $this->term
->id() . ')');
// Check with two new terms on the edit form, additionally to the existing
// one.
$edit = [];
$new_term1 = $this->randomMachineName(8);
$new_term2 = $this->randomMachineName(8);
$edit[$term_key] = $this->term
->getName() . ', ' . $new_term1 . ', ' . $new_term2;
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Preview');
$this->assertSession()
->responseContains('>' . $new_term1 . '<');
$this->assertSession()
->responseContains('>' . $new_term2 . '<');
// The first term should be displayed as link, the others not.
$this->assertSession()
->linkExists($this->term
->getName());
$this->assertSession()
->linkNotExists($new_term1);
$this->assertSession()
->linkNotExists($new_term2);
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Save');
// Check with one more new term, keeping old terms, removing the existing
// one.
$edit = [];
$new_term3 = $this->randomMachineName(8);
$edit[$term_key] = $new_term1 . ', ' . $new_term3 . ', ' . $new_term2;
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Preview');
$this->assertSession()
->responseContains('>' . $new_term1 . '<');
$this->assertSession()
->responseContains('>' . $new_term2 . '<');
$this->assertSession()
->responseContains('>' . $new_term3 . '<');
$this->assertSession()
->pageTextNotContains($this->term
->getName());
$this->assertSession()
->linkExists($new_term1);
$this->assertSession()
->linkExists($new_term2);
$this->assertSession()
->linkNotExists($new_term3);
// Check that editing an existing node after it has been previewed and not
// saved doesn't remember the previous changes.
$edit = [
$title_key => $this->randomMachineName(8),
];
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Preview');
$this->assertSession()
->pageTextContains($edit[$title_key]);
$this->clickLink('Back to content editing');
$this->assertSession()
->fieldValueEquals($title_key, $edit[$title_key]);
// Navigate away from the node without saving.
$this->drupalGet('<front>');
// Go back to the edit form, the title should have its initial value.
$this->drupalGet('node/' . $node->id() . '/edit');
$this->assertSession()
->fieldValueEquals($title_key, $node->label());
// Check with required preview.
$node_type = NodeType::load('page');
$node_type->setPreviewMode(DRUPAL_REQUIRED);
$node_type->save();
$this->drupalGet('node/add/page');
$this->assertSession()
->responseNotContains('edit-submit');
$this->drupalGet('node/add/page');
$this->submitForm([
$title_key => 'Preview',
], 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->responseContains('edit-submit');
// Check that destination is remembered when clicking on preview. When going
// back to the edit form and clicking save, we should go back to the
// original destination, if set.
$destination = 'node';
$this->drupalGet($node->toUrl('edit-form'), [
'query' => [
'destination' => $destination,
],
]);
$this->submitForm([], 'Preview');
$parameters = [
'node_preview' => $node->uuid(),
'view_mode_id' => 'full',
];
$options = [
'absolute' => TRUE,
'query' => [
'destination' => $destination,
],
];
$this->assertSession()
->addressEquals(Url::fromRoute('entity.node.preview', $parameters, $options));
$this->submitForm([
'view_mode' => 'teaser',
], 'Switch');
$this->clickLink('Back to content editing');
$this->submitForm([], 'Save');
$this->assertSession()
->addressEquals($destination);
// Check that preview page works as expected without a destination set.
$this->drupalGet($node->toUrl('edit-form'));
$this->submitForm([], 'Preview');
$parameters = [
'node_preview' => $node->uuid(),
'view_mode_id' => 'full',
];
$this->assertSession()
->addressEquals(Url::fromRoute('entity.node.preview', $parameters));
$this->submitForm([
'view_mode' => 'teaser',
], 'Switch');
$this->clickLink('Back to content editing');
$this->submitForm([], 'Save');
$this->assertSession()
->addressEquals($node->toUrl());
$this->assertSession()
->statusCodeEquals(200);
/** @var \Drupal\Core\File\FileSystemInterface $file_system */
$file_system = \Drupal::service('file_system');
// Assert multiple items can be added and are not lost when previewing.
$test_image_1 = current($this->drupalGetTestFiles('image', 39325));
$edit_image_1['files[field_image_0][]'] = $file_system->realpath($test_image_1->uri);
$test_image_2 = current($this->drupalGetTestFiles('image', 39325));
$edit_image_2['files[field_image_1][]'] = $file_system->realpath($test_image_2->uri);
$edit['field_image[0][alt]'] = 'Alt 1';
$this->drupalGet('node/add/page');
$this->submitForm($edit_image_1, 'Upload');
$this->submitForm($edit, 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->fieldExists('files[field_image_1][]');
$this->submitForm($edit_image_2, 'Upload');
$this->assertSession()
->fieldNotExists('files[field_image_1][]');
$title = 'node_test_title';
$example_text_1 = 'example_text_preview_1';
$example_text_2 = 'example_text_preview_2';
$example_text_3 = 'example_text_preview_3';
$this->drupalGet('node/add/page');
$edit = [
'title[0][value]' => $title,
'field_test_multi[0][value]' => $example_text_1,
];
$this->assertSession()
->pageTextContains('Storage is not set');
$this->submitForm($edit, 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->pageTextContains('Storage is set');
$this->assertSession()
->fieldExists('field_test_multi[0][value]');
$this->submitForm([], 'Save');
$this->assertSession()
->pageTextContains('Basic page ' . $title . ' has been created.');
$node = $this->drupalGetNodeByTitle($title);
$this->drupalGet('node/' . $node->id() . '/edit');
$this->getSession()
->getPage()
->pressButton('Add another item');
$this->getSession()
->getPage()
->pressButton('Add another item');
$edit = [
'field_test_multi[1][value]' => $example_text_2,
'field_test_multi[2][value]' => $example_text_3,
];
$this->submitForm($edit, 'Preview');
$this->clickLink('Back to content editing');
$this->submitForm($edit, 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->fieldValueEquals('field_test_multi[0][value]', $example_text_1);
$this->assertSession()
->fieldValueEquals('field_test_multi[1][value]', $example_text_2);
$this->assertSession()
->fieldValueEquals('field_test_multi[2][value]', $example_text_3);
// Now save the node and make sure all values got saved.
$this->submitForm([], 'Save');
$this->assertSession()
->pageTextContains($example_text_1);
$this->assertSession()
->pageTextContains($example_text_2);
$this->assertSession()
->pageTextContains($example_text_3);
// Edit again, change the menu_ui settings and click on preview.
$this->drupalGet('node/' . $node->id() . '/edit');
$edit = [
'menu[enabled]' => TRUE,
'menu[title]' => 'Changed title',
];
$this->submitForm($edit, 'Preview');
$this->clickLink('Back to content editing');
$this->assertSession()
->checkboxChecked('edit-menu-enabled');
$this->assertSession()
->fieldValueEquals('menu[title]', 'Changed title');
// Save, change the title while saving and make sure that it is correctly
// saved.
$edit = [
'menu[enabled]' => TRUE,
'menu[title]' => 'Second title change',
];
$this->submitForm($edit, 'Save');
$this->drupalGet('node/' . $node->id() . '/edit');
$this->assertSession()
->fieldValueEquals('menu[title]', 'Second title change');
}
/**
* Checks the node preview functionality, when using revisions.
*/
public function testPagePreviewWithRevisions() : void {
$title_key = 'title[0][value]';
$body_key = 'body[0][value]';
$term_key = $this->fieldName . '[target_id]';
// Force revision on "Basic page" content.
$node_type = NodeType::load('page');
$node_type->setNewRevision(TRUE);
$node_type->save();
// Fill in node creation form and preview node.
$edit = [];
$edit[$title_key] = $this->randomMachineName(8);
$edit[$body_key] = $this->randomMachineName(16);
$edit[$term_key] = $this->term
->id();
$edit['revision_log[0][value]'] = $this->randomString(32);
$this->drupalGet('node/add/page');
$this->submitForm($edit, 'Preview');
// Check that the preview is displaying the title, body and term.
$this->assertSession()
->titleEquals($edit[$title_key] . ' | Drupal');
$this->assertSession()
->pageTextContains($edit[$title_key]);
$this->assertSession()
->pageTextContains($edit[$body_key]);
$this->assertSession()
->pageTextContains($edit[$term_key]);
// Check that the title and body fields are displayed with the correct
// values after going back to the content edit page.
$this->clickLink('Back to content editing');
$this->assertSession()
->fieldValueEquals($title_key, $edit[$title_key]);
$this->assertSession()
->fieldValueEquals($body_key, $edit[$body_key]);
$this->assertSession()
->fieldValueEquals($term_key, $edit[$term_key]);
// Check that the revision log field has the correct value.
$this->assertSession()
->fieldValueEquals('revision_log[0][value]', $edit['revision_log[0][value]']);
// Save the node after coming back from the preview page so we can create a
// pending revision for it.
$this->submitForm([], 'Save');
$node = $this->drupalGetNodeByTitle($edit[$title_key]);
// Check that previewing a pending revision of a node works. This can not be
// accomplished through the UI so we have to use API calls.
// @todo Change this test to use the UI when we will be able to create
// pending revisions in core.
// @see https://www.drupal.org/node/2725533
$node->setNewRevision(TRUE);
$node->isDefaultRevision(FALSE);
/** @var \Drupal\Core\Controller\ControllerResolverInterface $controller_resolver */
$controller_resolver = \Drupal::service('controller_resolver');
$node_preview_controller = $controller_resolver->getControllerFromDefinition('\\Drupal\\node\\Controller\\NodePreviewController::view');
$node_preview_controller($node, 'full');
}
/**
* Checks the node preview accessible for simultaneous node editing.
*/
public function testSimultaneousPreview() : void {
$title_key = 'title[0][value]';
$node = $this->drupalCreateNode([]);
$edit = [
$title_key => 'New page title',
];
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit, 'Preview');
$this->assertSession()
->pageTextContains($edit[$title_key]);
$user2 = $this->drupalCreateUser([
'edit any page content',
]);
$this->drupalLogin($user2);
$this->drupalGet('node/' . $node->id() . '/edit');
$this->assertSession()
->fieldValueEquals($title_key, $node->label());
$edit2 = [
$title_key => 'Another page title',
];
$this->drupalGet('node/' . $node->id() . '/edit');
$this->submitForm($edit2, 'Preview');
$this->assertSession()
->addressEquals(Url::fromRoute('entity.node.preview', [
'node_preview' => $node->uuid(),
'view_mode_id' => 'full',
]));
$this->assertSession()
->pageTextContains($edit2[$title_key]);
}
/**
* Tests node preview with dynamic_page_cache and anonymous users.
*/
public function testPagePreviewCache() : void {
\Drupal::service('module_installer')->uninstall([
'node_test',
]);
$this->drupalLogout();
$title_key = 'title[0][value]';
user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
'create page content',
'access content',
]);
$edit = [
$title_key => $this->randomMachineName(8),
];
$this->drupalGet('/node/add/page');
$this->submitForm($edit, 'Preview');
$this->assertSession()
->pageTextContains($edit[$title_key]);
$this->clickLink('Back to content editing');
$edit = [
$title_key => $this->randomMachineName(8),
];
$this->submitForm($edit, 'Preview');
$this->assertSession()
->pageTextContains($edit[$title_key]);
}
}
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::$profile | protected | property | The profile to install as a basis for testing. | 40 | |||
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. | ||||
CommentTestTrait::addDefaultCommentField | protected | function | Adds the default comment field to an entity. | ||||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
EntityReferenceFieldCreationTrait::createEntityReferenceField | protected | function | Creates a field of an entity reference field storage on the specified bundle. | ||||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | |||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | ||||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | ||||
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 10 | |||
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 | |||
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 | |||
NodeTestBase::$accessHandler | protected | property | The node access control handler. | ||||
NodeTestBase::assertNodeAccess | public | function | Asserts that node access correctly grants or denies access. | ||||
NodeTestBase::assertNodeCreateAccess | public | function | Asserts that node create access correctly grants or denies access. | ||||
NodeTestBase::nodeAccessAssertMessage | public | function | Constructs an assert message to display which node access was tested. | ||||
PagePreviewTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
PagePreviewTest::$fieldName | protected | property | The name of the created field. | ||||
PagePreviewTest::$modules | protected static | property | Enable the comment, node and taxonomy modules to test on the preview. | Overrides NodeTestBase::$modules | |||
PagePreviewTest::$term | protected | property | A term. | ||||
PagePreviewTest::setUp | protected | function | Overrides NodeTestBase::setUp | ||||
PagePreviewTest::testPagePreview | public | function | Checks the node preview functionality. | ||||
PagePreviewTest::testPagePreviewCache | public | function | Tests node preview with dynamic_page_cache and anonymous users. | ||||
PagePreviewTest::testPagePreviewWithRevisions | public | function | Checks the node preview functionality, when using revisions. | ||||
PagePreviewTest::testSimultaneousPreview | public | function | Checks the node preview accessible for simultaneous node editing. | ||||
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. | ||||
TestFileCreationTrait::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||||
TestFileCreationTrait::compareFiles | protected | function | Compares two files based on size and file name. | ||||
TestFileCreationTrait::generateFile | public static | function | Generates a test file. | ||||
TestFileCreationTrait::getTestFiles | protected | function | Gets a list of files that can be used in tests. | Aliased as: drupalGetTestFiles | |||
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.