You are here

Home » API reference » Webform 8.5 » WebformElementManagedFileTest.php

class WebformElementManagedFileTest in Webform 8.5

Same name and namespace in other branches
  1. 6.x tests/src/Functional/Element/WebformElementManagedFileTest.php \Drupal\Tests\webform\Functional\Element\WebformElementManagedFileTest

Test for webform element managed file handling.

@group webform

Hierarchy

Expanded class hierarchy of WebformElementManagedFileTest

File

tests/src/Functional/Element/WebformElementManagedFileTest.php, line 14

Namespace

Drupal\Tests\webform\Functional\Element
View source 
class WebformElementManagedFileTest extends WebformElementManagedFileTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'file',
    'webform',
  ];

  /**
   * Webforms to load.
   *
   * @var array
   */
  protected static $testWebforms = [
    'test_element_managed_file',
    'test_element_managed_file_dis',
    'test_element_managed_file_name',
  ];

  /**
   * The 'test_element_managed_file' webform.
   *
   * @var \Drupal\webform\WebformInterface
   */
  protected $webform;

  /**
   * Admin submission user.
   *
   * @var \Drupal\user\Entity\User
   */
  protected $adminSubmissionUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->webform = Webform::load('test_element_managed_file');
    $this->adminSubmissionUser = $this
      ->drupalCreateUser([
      'administer webform submission',
    ]);
  }

  /**
   * Test single and multiple file upload.
   */
  public function testFileUpload() {

    /* Element rendering */
    $this
      ->drupalGet('/webform/test_element_managed_file');

    // Check single file upload button.
    $this
      ->assertRaw('<label for="edit-managed-file-single-button-upload-button--2" class="button button-action webform-file-button">Choose file</label>');

    // Check multiple file upload button.
    $this
      ->assertRaw('<label for="edit-managed-file-multiple-button-upload-button--2" class="button button-action webform-file-button">Choose files</label>');

    // Check single custom file upload button.
    $this
      ->assertRaw('<label style="color: red" for="edit-managed-file-single-button-custom-upload-button--2" class="button button-action webform-file-button">{Custom label}</label>');

    // Check comma delimited file extensions.
    $this
      ->assertRaw('Allowed types: txt, text.');

    /* Element processing */
    $this
      ->checkFileUpload('single', $this->files[0], $this->files[1]);
    $this
      ->checkFileUpload('multiple', $this->files[2], $this->files[3]);

    /* Multiple processing */

    // Check file input is visible.
    $this
      ->drupalGet('/webform/test_element_managed_file');
    $this
      ->assertFieldByName('files[managed_file_multiple_two][]');
    $this
      ->assertFieldByName('managed_file_multiple_two_upload_button');

    // Check that only two files can be uploaded.
    // @todo Determine how to submit multiple files.

    /*
    $edit = [
      'files[managed_file_multiple_two][]' => [
        \Drupal::service('file_system')->realpath($this->files[0]->uri),
        \Drupal::service('file_system')->realpath($this->files[1]->uri),
        \Drupal::service('file_system')->realpath($this->files[2]->uri),
      ],
    ];
    $this->drupalPostForm('/webform/test_element_managed_file', $edit, 'Upload');
    $this->assertRaw('<em class="placeholder">managed_file_multiple_two</em> can only hold 2 values but there were 3 uploaded. The following files have been omitted as a result: <em class="placeholder">text-2.txt</em>.');

    // Check file input is removed.
    $this->assertNoFieldByName('files[managed_file_multiple_two][]');
    $this->assertNoFieldByName('managed_file_multiple_two_upload_button');
    */

    /* File placeholder */

    // Check placeholder is displayed.
    $this
      ->drupalGet('/webform/test_element_managed_file');
    $this
      ->assertRaw('<div class="webform-managed-file-placeholder managed-file-placeholder js-form-wrapper form-wrapper" data-drupal-selector="edit-managed-file-single-placeholder-file-placeholder" id="edit-managed-file-single-placeholder-file-placeholder">This is the single file upload placeholder</div>');
    $this
      ->assertRaw('<div class="webform-managed-file-placeholder managed-file-placeholder js-form-wrapper form-wrapper" data-drupal-selector="edit-managed-file-multiple-placeholder-file-placeholder" id="edit-managed-file-multiple-placeholder-file-placeholder">This is the multiple file upload placeholder</div>');
    $this
      ->drupalLogin($this->rootUser);

    // Check placeholder is not displayed when files are uploaded.
    $this
      ->drupalGet('/webform/test_element_managed_file/test');
    $this
      ->assertNoRaw('<div class="webform-managed-file-placeholder managed-file-placeholder js-form-wrapper form-wrapper" data-drupal-selector="edit-managed-file-single-placeholder-file-placeholder" id="edit-managed-file-single-placeholder-file-placeholder">This is the single file upload placeholder</div>');
    $this
      ->assertNoRaw('<div class="webform-managed-file-placeholder managed-file-placeholder js-form-wrapper form-wrapper" data-drupal-selector="edit-managed-file-multiple-placeholder-file-placeholder" id="edit-managed-file-multiple-placeholder-file-placeholder">This is the multiple file upload placeholder</div>');
    $this
      ->drupalLogout();

    /* Required error */

    // Set required error.

    /** @var \Drupal\webform\WebformInterface $webform */
    $webform = Webform::load('test_element_managed_file');
    $webform
      ->setElementProperties('managed_file_single', $webform
      ->getElementDecoded('managed_file_single') + [
      '#required' => TRUE,
      '#required_error' => '{Custom required error}',
    ]);
    $webform
      ->save();

    // Check that required error is displayed.
    $this
      ->postSubmission($webform);
    $this
      ->assertRaw('<h2 class="visually-hidden">Error message</h2>');
    $this
      ->assertRaw('{Custom required error}');
  }

  /**
   * Test the file renaming feature.
   *
   * The property #file_name_pattern is tested.
   */
  public function testFileRename() {
    $webform = Webform::load('test_element_managed_file_name');
    $source_for_filename = $this
      ->randomMachineName();
    $sid = $this
      ->postSubmission($webform, [
      'source_for_filename' => $source_for_filename,
      'files[file_single]' => \Drupal::service('file_system')
        ->realpath($this->files[0]->uri),
      'files[file_multiple][]' => \Drupal::service('file_system')
        ->realpath($this->files[0]->uri),
      'files[file_truncate]' => \Drupal::service('file_system')
        ->realpath($this->files[0]->uri),
    ]);
    $this
      ->drupalLogin($this->adminSubmissionUser);

    // Edit the submission and insert 1 extra file into the multiple element.
    $this
      ->drupalPostForm('/webform/' . $webform
      ->id() . '/submissions/' . $sid . '/edit', [
      'files[file_multiple][]' => \Drupal::service('file_system')
        ->realpath($this->files[1]->uri),
    ], 'Save');
    $this
      ->drupalLogout();

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);

    /** @var \Drupal\file\FileInterface $single_file */
    $single_file = File::load($submission
      ->getElementData('file_single'));
    $this
      ->assertEqual('file_single_' . $source_for_filename . '.txt', $single_file
      ->getFilename());

    /** @var \Drupal\file\FileInterface[] $multiple_file */
    $multiple_file = File::loadMultiple($submission
      ->getElementData('file_multiple'));
    $this
      ->assertCount(2, $multiple_file, 'Two files found in the multiple element.');
    $i = -1;
    foreach ($multiple_file as $file) {
      $suffix = $i === -1 ? '' : '_' . $i;
      $this
        ->assertEqual('file_multiple_' . $source_for_filename . $suffix . '.txt', $file
        ->getFilename());
      $i++;
    }

    /** @var \Drupal\file\FileInterface $truncate_file */
    $truncate_file = File::load($submission
      ->getElementData('file_truncate'));
    $this
      ->assertEqual(strlen($truncate_file
      ->getFileUri()), 250);
    $this
      ->assertEqual('file_truncate_1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901.txt', $truncate_file
      ->getFilename());
  }

  /**
   * Test file management.
   */
  public function testFileManagement() {
    $this
      ->drupalLogin($this->rootUser);
    $webform = Webform::load('test_element_managed_file');

    /**************************************************************************/

    // Test immediately delete file.

    /**************************************************************************/

    // Upload files.
    $sid = $this
      ->postSubmissionTest($webform);

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);
    $managed_file_single = $this
      ->fileLoad($submission
      ->getElementData('managed_file_single'));

    // Check single file is not temporary.
    $this
      ->debug($submission
      ->getData());
    $this
      ->assertNotNull($managed_file_single);
    $this
      ->assertFalse($managed_file_single
      ->isTemporary());

    // Check deleting file completely deletes the file record.
    $submission
      ->delete();
    $managed_file_single = $this
      ->fileLoad($submission
      ->getElementData('managed_file_single'));
    $this
      ->assertNull($managed_file_single);

    /**************************************************************************/

    // Test disabling immediately deleted temporary managed files.

    /**************************************************************************/

    // Disable deleting of temporary files.
    $config = \Drupal::configFactory()
      ->getEditable('webform.settings');
    $config
      ->set('file.delete_temporary_managed_files', FALSE);
    $config
      ->save();

    // Upload files.
    $sid = $this
      ->postSubmissionTest($webform);
    $submission = WebformSubmission::load($sid);

    // Check deleting file completely deletes the file record.
    $submission
      ->delete();
    $managed_file_single = $this
      ->fileLoad($submission
      ->getElementData('managed_file_single'));
    $this
      ->assertNotNull($managed_file_single);
    $this
      ->assertTrue($managed_file_single
      ->isTemporary());

    /**************************************************************************/

    // Test disabling unused files marked temporary.

    /**************************************************************************/

    // Disable deleting of temporary files.
    $config = \Drupal::configFactory()
      ->getEditable('webform.settings');
    $config
      ->set('file.make_unused_managed_files_temporary', FALSE);
    $config
      ->save();

    // Upload files.
    $sid = $this
      ->postSubmissionTest($webform);
    $submission = WebformSubmission::load($sid);

    // Check deleting file completely deletes the file record.
    $submission
      ->delete();
    $managed_file_single = $this
      ->fileLoad($submission
      ->getElementData('managed_file_single'));
    $this
      ->assertNotNull($managed_file_single);
    $this
      ->assertFalse($managed_file_single
      ->isTemporary());
  }

  /**
   * Test file upload with disabled results.
   */
  public function testFileUploadWithDisabledResults() {
    $this
      ->drupalLogin($this->rootUser);
    $webform = Webform::load('test_element_managed_file_dis');

    // Upload new file.
    $sid = $this
      ->postSubmissionTest($webform);
    $file = File::load($this
      ->getLastFileId());

    // Check that no submission was saved to the database.
    $this
      ->assertNull($sid);

    // Check file URI.
    $this
      ->assertEqual($file
      ->getFileUri(), 'private://webform/test_element_managed_file_dis/_sid_/managed_file.txt');

    // Check file is temporary.
    $this
      ->assertTrue($file
      ->isTemporary());

    // Check file_managed table has 1 record.
    $this
      ->assertEqual(1, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_managed}')
      ->fetchField());

    // Check file_usage table has no records.
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_usage}')
      ->fetchField());
  }

  /****************************************************************************/

  // Helper functions. From: \Drupal\file\Tests\FileFieldTestBase::getTestFile

  /****************************************************************************/

  /**
   * Check file upload.
   *
   * @param string $type
   *   The type of file upload which can be either single or multiple.
   * @param object $first_file
   *   The first file to be uploaded.
   * @param object $second_file
   *   The second file that replaces the first file.
   */
  protected function checkFileUpload($type, $first_file, $second_file) {
    $key = 'managed_file_' . $type;
    $parameter_name = $type === 'multiple' ? "files[{$key}][]" : "files[{$key}]";
    $edit = [
      $parameter_name => \Drupal::service('file_system')
        ->realpath($first_file->uri),
    ];
    $sid = $this
      ->postSubmission($this->webform, $edit);

    /** @var \Drupal\webform\WebformSubmissionInterface $submission */
    $submission = WebformSubmission::load($sid);

    /** @var \Drupal\file\FileInterface $file */
    $fid = $this
      ->getLastFileId();
    $file = File::load($fid);

    // Check that test file was uploaded to the current submission.
    $second = $type === 'multiple' ? [
      $fid,
    ] : $fid;
    $this
      ->assertEqual($submission
      ->getElementData($key), $second, 'Test file was upload to the current submission');

    // Check test file file usage.
    $this
      ->assertIdentical([
      'webform' => [
        'webform_submission' => [
          $sid => '1',
        ],
      ],
    ], $this->fileUsage
      ->listUsage($file), 'The file has 1 usage.');

    // Check test file uploaded file path.
    $this
      ->assertEqual($file
      ->getFileUri(), 'private://webform/test_element_managed_file/' . $sid . '/' . $first_file->filename);

    // Check that test file exists.
    $this
      ->assertFileExists($file
      ->getFileUri());

    // Login admin user.
    $this
      ->drupalLogin($this->adminSubmissionUser);

    // Check managed file formatting.
    $this
      ->drupalGet('/admin/structure/webform/manage/test_element_managed_file/submission/' . $sid);
    if ($type === 'multiple') {
      $this
        ->assertRaw('<label>managed_file_multiple</label>');
      $this
        ->assertRaw('<ul>');
    }

    // @todo Remove once Drupal 9.1.x is only supported.
    if (floatval(\Drupal::VERSION) >= 9.1) {
      $this
        ->assertRaw('<span class="file file--mime-text-plain file--text"><a href="' . file_create_url($file
        ->getFileUri()) . '" type="text/plain">' . $file
        ->getFilename() . '</a></span>');
    }
    else {
      $this
        ->assertRaw('<span class="file file--mime-text-plain file--text"><a href="' . file_create_url($file
        ->getFileUri()) . '" type="text/plain; length=' . $file
        ->getSize() . '">' . $file
        ->getFilename() . '</a></span>');
    }

    // Remove the uploaded file.
    if ($type === 'multiple') {
      $edit = [
        'managed_file_multiple[file_' . $fid . '][selected]' => TRUE,
      ];
      $submit = 'Remove selected';
    }
    else {
      $edit = [];
      $submit = 'Remove';
    }
    $this
      ->drupalPostForm('/admin/structure/webform/manage/test_element_managed_file/submission/' . $sid . '/edit', $edit, $submit);

    // Upload new file.
    $edit = [
      $parameter_name => \Drupal::service('file_system')
        ->realpath($second_file->uri),
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Upload');

    // Submit the new file.
    $this
      ->drupalPostForm(NULL, [], 'Save');

    /** @var \Drupal\file\FileInterface $test_file_0 */
    $new_fid = $this
      ->getLastFileId();
    $new_file = File::load($new_fid);
    \Drupal::entityTypeManager()
      ->getStorage('webform_submission')
      ->resetCache();
    $submission = WebformSubmission::load($sid);

    // Check that test new file was uploaded to the current submission.
    $second = $type === 'multiple' ? [
      $new_fid,
    ] : $new_fid;
    $this
      ->assertEqual($submission
      ->getElementData($key), $second, 'Test new file was upload to the current submission');

    // Check that test file was deleted from the disk and database.
    $this
      ->assertFileNotExists($file
      ->getFileUri(), 'Test file deleted from disk');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_managed} WHERE fid = :fid', [
      ':fid' => $fid,
    ])
      ->fetchField(), 'Test file 0 deleted from database');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_usage} WHERE fid = :fid', [
      ':fid' => $fid,
    ])
      ->fetchField(), 'Test file 0 deleted from database');

    // Check test file 1 file usage.
    $this
      ->assertIdentical([
      'webform' => [
        'webform_submission' => [
          $sid => '1',
        ],
      ],
    ], $this->fileUsage
      ->listUsage($new_file), 'The new file has 1 usage.');

    // Check that file directory was create.
    $this
      ->assertFileExists('private://webform/test_element_managed_file/' . $sid . '/');

    // Delete the submission.
    $submission
      ->delete();

    // Check that test file 1 was deleted from the disk and database.
    $this
      ->assertFileNotExists($new_file
      ->getFileUri(), 'Test new file deleted from disk');
    $this
      ->assertEqual(0, \Drupal::database()
      ->query('SELECT COUNT(fid) AS total FROM {file_managed} WHERE fid = :fid', [
      ':fid' => $new_fid,
    ])
      ->fetchField(), 'Test new file deleted from database');

    // Check that empty file directory was deleted.
    $this
      ->assertFileNotExists('private://webform/test_element_managed_file/' . $sid . '/');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case.
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
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 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::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::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 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. 39
BrowserTestBase::$root protected property The app root.
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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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 Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
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
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
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. 2
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.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 3
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.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
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.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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. 2
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::buildUrl protected function Builds an a 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::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::drupalPostForm 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::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.
WebformAssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebformAssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
WebformAssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
WebformAssertLegacyTrait::assertEqual protected function
WebformAssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
WebformAssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
WebformAssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
WebformAssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
WebformAssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
WebformAssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
WebformAssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
WebformAssertLegacyTrait::assertIdentical protected function
WebformAssertLegacyTrait::assertIdenticalObject protected function
WebformAssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
WebformAssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
WebformAssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebformAssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
WebformAssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
WebformAssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
WebformAssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
WebformAssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
WebformAssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
WebformAssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
WebformAssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
WebformAssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
WebformAssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
WebformAssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertNotEqual protected function
WebformAssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
WebformAssertLegacyTrait::assertNotIdentical protected function
WebformAssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
WebformAssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
WebformAssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
WebformAssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
WebformAssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
WebformAssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
WebformAssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code.
WebformAssertLegacyTrait::assertSession abstract public function Returns WebAssert object.
WebformAssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
WebformAssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
WebformAssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
WebformAssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
WebformAssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebformAssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
WebformAssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
WebformAssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
WebformAssertLegacyTrait::getRawContent protected function Gets the current raw content.
WebformAssertLegacyTrait::pass protected function
WebformAssertLegacyTrait::verbose protected function
WebformBrowserTestBase::$defaultTheme protected property Set default theme to stable. Overrides BrowserTestBase::$defaultTheme 1
WebformBrowserTestBase::tearDown protected function Overrides BrowserTestBase::tearDown
WebformBrowserTestTrait::$basicHtmlFilter protected property Basic HTML filter format.
WebformBrowserTestTrait::$fullHtmlFilter protected property Full HTML filter format.
WebformBrowserTestTrait::assertCssSelect protected function Passes if the CSS selector IS found on the loaded page, fail otherwise.
WebformBrowserTestTrait::assertElementNotVisible protected function Asserts that the element with the given CSS selector is not visible.
WebformBrowserTestTrait::assertElementVisible protected function Asserts that the element with the given CSS selector is visible.
WebformBrowserTestTrait::assertNoCssSelect protected function Passes if the CSS selector IS NOT found on the loaded page, fail otherwise.
WebformBrowserTestTrait::createFilters protected function Create basic HTML filter format.
WebformBrowserTestTrait::createTags protected function Create the 'tags' taxonomy vocabulary.
WebformBrowserTestTrait::createWebform protected function Create a webform.
WebformBrowserTestTrait::debug protected function Logs verbose (debug) message in a text file.
WebformBrowserTestTrait::getExport protected function Request a webform results export CSV.
WebformBrowserTestTrait::getExportColumns protected function Get webform export columns.
WebformBrowserTestTrait::getLastEmail protected function Gets that last email sent during the currently running test case.
WebformBrowserTestTrait::getLastSubmissionId protected function Get the last submission id.
WebformBrowserTestTrait::getWebformSubmitButtonLabel protected function Get a webform's submit button label.
WebformBrowserTestTrait::loadSubmission protected function Load the specified webform submission from the storage.
WebformBrowserTestTrait::loadWebform protected function Lazy load a test webform.
WebformBrowserTestTrait::loadWebforms protected function Lazy load a test webforms.
WebformBrowserTestTrait::placeBlocks protected function Place breadcrumb page, tasks, and actions.
WebformBrowserTestTrait::placeWebformBlocks protected function Place webform test module blocks.
WebformBrowserTestTrait::postSubmission protected function Post a new submission to a webform.
WebformBrowserTestTrait::postSubmissionTest protected function Post a new test submission to a webform.
WebformBrowserTestTrait::purgeSubmissions protected function Purge all submission before the webform.module is uninstalled. 1
WebformBrowserTestTrait::reloadSubmission protected function Reload a test webform submission.
WebformBrowserTestTrait::reloadWebform protected function Reload a test webform.
WebformElementBrowserTestBase::assertElementPreview protected function Assert element preview.
WebformElementManagedFileTest::$adminSubmissionUser protected property Admin submission user.
WebformElementManagedFileTest::$modules public static property Modules to enable. Overrides WebformElementManagedFileTestBase::$modules
WebformElementManagedFileTest::$testWebforms protected static property Webforms to load. Overrides WebformBrowserTestBase::$testWebforms
WebformElementManagedFileTest::$webform protected property The 'test_element_managed_file' webform.
WebformElementManagedFileTest::checkFileUpload protected function Check file upload.
WebformElementManagedFileTest::setUp protected function Overrides WebformElementManagedFileTestBase::setUp
WebformElementManagedFileTest::testFileManagement public function Test file management.
WebformElementManagedFileTest::testFileRename public function Test the file renaming feature.
WebformElementManagedFileTest::testFileUpload public function Test single and multiple file upload.
WebformElementManagedFileTest::testFileUploadWithDisabledResults public function Test file upload with disabled results.
WebformElementManagedFileTestBase::$files protected property An array of plain text test files.
WebformElementManagedFileTestBase::$fileUsage protected property File usage manager.
WebformElementManagedFileTestBase::fileLoad protected function Load an uncached file entity.
WebformElementManagedFileTestBase::getLastFileId protected function Retrieves the fid of the last inserted file.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.