You are here

class ImageFieldDefaultImagesTest in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php \Drupal\Tests\image\Functional\ImageFieldDefaultImagesTest

Tests setting up default images both to the field and field storage.

@group image

Hierarchy

Expanded class hierarchy of ImageFieldDefaultImagesTest

File

core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php, line 19

Namespace

Drupal\Tests\image\Functional
View source
class ImageFieldDefaultImagesTest extends ImageFieldTestBase {
  use TestFileCreationTrait {
    getTestFiles as drupalGetTestFiles;
    compareFiles as drupalCompareFiles;
  }
  use EntityViewTrait {
    buildEntityView as drupalBuildEntityView;
  }

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

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * Tests CRUD for fields and field storages with default images.
   */
  public function testDefaultImages() {
    $node_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('node');

    // Create files to use as the default images.
    $files = $this
      ->drupalGetTestFiles('image');

    // Create 10 files so the default image fids are not a single value.
    for ($i = 1; $i <= 10; $i++) {
      $filename = $this
        ->randomMachineName() . "{$i}";
      $desired_filepath = 'public://' . $filename;
      \Drupal::service('file_system')
        ->copy($files[0]->uri, $desired_filepath, FileSystemInterface::EXISTS_ERROR);
      $file = File::create([
        'uri' => $desired_filepath,
        'filename' => $filename,
        'name' => $filename,
      ]);
      $file
        ->save();
    }
    $default_images = [];
    foreach ([
      'field_storage',
      'field',
      'field2',
      'field_storage_new',
      'field_new',
      'field_storage_private',
      'field_private',
    ] as $image_target) {
      $file = File::create((array) array_pop($files));
      $file
        ->save();
      $default_images[$image_target] = $file;
    }

    // Create an image field storage and add a field to the article content
    // type.
    $field_name = strtolower($this
      ->randomMachineName());
    $storage_settings['default_image'] = [
      'uuid' => $default_images['field_storage']
        ->uuid(),
      'alt' => '',
      'title' => '',
      'width' => 0,
      'height' => 0,
    ];
    $field_settings['default_image'] = [
      'uuid' => $default_images['field']
        ->uuid(),
      'alt' => '',
      'title' => '',
      'width' => 0,
      'height' => 0,
    ];
    $widget_settings = [
      'preview_image_style' => 'medium',
    ];
    $field = $this
      ->createImageField($field_name, 'article', $storage_settings, $field_settings, $widget_settings);

    // The field default image id should be 2.
    $this
      ->assertEqual($field
      ->getSetting('default_image')['uuid'], $default_images['field']
      ->uuid());

    // Also test \Drupal\field\Entity\FieldConfig::getSettings().
    $this
      ->assertEqual($field
      ->getSettings()['default_image']['uuid'], $default_images['field']
      ->uuid());
    $field_storage = $field
      ->getFieldStorageDefinition();

    // The field storage default image id should be 1.
    $this
      ->assertEqual($field_storage
      ->getSetting('default_image')['uuid'], $default_images['field_storage']
      ->uuid());

    // Also test \Drupal\field\Entity\FieldStorageConfig::getSettings().
    $this
      ->assertEqual($field_storage
      ->getSettings()['default_image']['uuid'], $default_images['field_storage']
      ->uuid());

    // Add another field with another default image to the page content type.
    $field2 = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
      'label' => $field
        ->label(),
      'required' => $field
        ->isRequired(),
      'settings' => [
        'default_image' => [
          'uuid' => $default_images['field2']
            ->uuid(),
          'alt' => '',
          'title' => '',
          'width' => 0,
          'height' => 0,
        ],
      ],
    ]);
    $field2
      ->save();

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');
    $widget_settings = $display_repository
      ->getFormDisplay('node', $field
      ->getTargetBundle())
      ->getComponent($field_name);
    $display_repository
      ->getFormDisplay('node', 'page')
      ->setComponent($field_name, $widget_settings)
      ->save();
    $display_repository
      ->getViewDisplay('node', 'page')
      ->setComponent($field_name)
      ->save();

    // Confirm the defaults are present on the article field storage settings
    // form.
    $field_id = $field
      ->id();
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}/storage");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_storage']
      ->id(), new FormattableMarkup('Article image field storage default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_storage']
        ->id(),
    ]));

    // Confirm the defaults are present on the article field edit form.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field']
      ->id(), new FormattableMarkup('Article image field default equals expected file ID of @fid.', [
      '@fid' => $default_images['field']
        ->id(),
    ]));

    // Confirm the defaults are present on the page field storage settings form.
    $this
      ->drupalGet("admin/structure/types/manage/page/fields/{$field_id}/storage");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_storage']
      ->id(), new FormattableMarkup('Page image field storage default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_storage']
        ->id(),
    ]));

    // Confirm the defaults are present on the page field edit form.
    $field2_id = $field2
      ->id();
    $this
      ->drupalGet("admin/structure/types/manage/page/fields/{$field2_id}");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field2']
      ->id(), new FormattableMarkup('Page image field default equals expected file ID of @fid.', [
      '@fid' => $default_images['field2']
        ->id(),
    ]));

    // Confirm that the image default is shown for a new article node.
    $article = $this
      ->drupalCreateNode([
      'type' => 'article',
    ]);
    $article_built = $this
      ->drupalBuildEntityView($article);
    $this
      ->assertEqual($article_built[$field_name][0]['#item']->target_id, $default_images['field']
      ->id(), new FormattableMarkup('A new article node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field']
        ->id(),
    ]));

    // Also check that the field renders without warnings when the label is
    // hidden.
    EntityViewDisplay::load('node.article.default')
      ->setComponent($field_name, [
      'label' => 'hidden',
      'type' => 'image',
    ])
      ->save();
    $this
      ->drupalGet('node/' . $article
      ->id());

    // Confirm that the image default is shown for a new page node.
    $page = $this
      ->drupalCreateNode([
      'type' => 'page',
    ]);
    $page_built = $this
      ->drupalBuildEntityView($page);
    $this
      ->assertEqual($page_built[$field_name][0]['#item']->target_id, $default_images['field2']
      ->id(), new FormattableMarkup('A new page node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field2']
        ->id(),
    ]));

    // Upload a new default for the field storage.
    $default_image_settings = $field_storage
      ->getSetting('default_image');
    $default_image_settings['uuid'] = $default_images['field_storage_new']
      ->uuid();
    $field_storage
      ->setSetting('default_image', $default_image_settings);
    $field_storage
      ->save();

    // Confirm that the new default is used on the article field storage
    // settings form.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}/storage");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_storage_new']
      ->id(), new FormattableMarkup('Updated image field storage default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_storage_new']
        ->id(),
    ]));

    // Reload the nodes and confirm the field defaults are used.
    $node_storage
      ->resetCache([
      $article
        ->id(),
      $page
        ->id(),
    ]);
    $article_built = $this
      ->drupalBuildEntityView($article = $node_storage
      ->load($article
      ->id()));
    $page_built = $this
      ->drupalBuildEntityView($page = $node_storage
      ->load($page
      ->id()));
    $this
      ->assertEqual($article_built[$field_name][0]['#item']->target_id, $default_images['field']
      ->id(), new FormattableMarkup('An existing article node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field']
        ->id(),
    ]));
    $this
      ->assertEqual($page_built[$field_name][0]['#item']->target_id, $default_images['field2']
      ->id(), new FormattableMarkup('An existing page node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field2']
        ->id(),
    ]));

    // Upload a new default for the article's field.
    $default_image_settings = $field
      ->getSetting('default_image');
    $default_image_settings['uuid'] = $default_images['field_new']
      ->uuid();
    $field
      ->setSetting('default_image', $default_image_settings);
    $field
      ->save();

    // Confirm the new field default is used on the article field admin form.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_new']
      ->id(), new FormattableMarkup('Updated article image field default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_new']
        ->id(),
    ]));

    // Reload the nodes.
    $node_storage
      ->resetCache([
      $article
        ->id(),
      $page
        ->id(),
    ]);
    $article_built = $this
      ->drupalBuildEntityView($article = $node_storage
      ->load($article
      ->id()));
    $page_built = $this
      ->drupalBuildEntityView($page = $node_storage
      ->load($page
      ->id()));

    // Confirm the article uses the new default.
    $this
      ->assertEqual($article_built[$field_name][0]['#item']->target_id, $default_images['field_new']
      ->id(), new FormattableMarkup('An existing article node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field_new']
        ->id(),
    ]));

    // Confirm the page remains unchanged.
    $this
      ->assertEqual($page_built[$field_name][0]['#item']->target_id, $default_images['field2']
      ->id(), new FormattableMarkup('An existing page node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field2']
        ->id(),
    ]));

    // Confirm the default image is shown on the node form.
    $file = File::load($default_images['field_new']
      ->id());
    $this
      ->drupalGet('node/add/article');
    $this
      ->assertRaw($file
      ->getFilename());

    // Remove the field default from articles.
    $default_image_settings = $field
      ->getSetting('default_image');
    $default_image_settings['uuid'] = 0;
    $field
      ->setSetting('default_image', $default_image_settings);
    $field
      ->save();

    // Confirm the article field default has been removed.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', '', 'Updated article image field default has been successfully removed.');

    // Reload the nodes.
    $node_storage
      ->resetCache([
      $article
        ->id(),
      $page
        ->id(),
    ]);
    $article_built = $this
      ->drupalBuildEntityView($article = $node_storage
      ->load($article
      ->id()));
    $page_built = $this
      ->drupalBuildEntityView($page = $node_storage
      ->load($page
      ->id()));

    // Confirm the article uses the new field storage (not field) default.
    $this
      ->assertEqual($article_built[$field_name][0]['#item']->target_id, $default_images['field_storage_new']
      ->id(), new FormattableMarkup('An existing article node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field_storage_new']
        ->id(),
    ]));

    // Confirm the page remains unchanged.
    $this
      ->assertEqual($page_built[$field_name][0]['#item']->target_id, $default_images['field2']
      ->id(), new FormattableMarkup('An existing page node without an image has the expected default image file ID of @fid.', [
      '@fid' => $default_images['field2']
        ->id(),
    ]));
    $non_image = $this
      ->drupalGetTestFiles('text');
    $this
      ->drupalPostForm(NULL, [
      'files[settings_default_image_uuid]' => \Drupal::service('file_system')
        ->realpath($non_image[0]->uri),
    ], t("Upload"));
    $this
      ->assertText('The specified file text-0.txt could not be uploaded.');
    $this
      ->assertText('Only files with the following extensions are allowed: png gif jpg jpeg.');

    // Confirm the default image is shown on the node form.
    $file = File::load($default_images['field_storage_new']
      ->id());
    $this
      ->drupalGet('node/add/article');
    $this
      ->assertRaw($file
      ->getFilename());

    // Change the default image for the field storage and also change the upload
    // destination to the private filesystem at the same time.
    $default_image_settings = $field_storage
      ->getSetting('default_image');
    $default_image_settings['uuid'] = $default_images['field_storage_private']
      ->uuid();
    $field_storage
      ->setSetting('default_image', $default_image_settings);
    $field_storage
      ->setSetting('uri_scheme', 'private');
    $field_storage
      ->save();

    // Confirm that the new default is used on the article field storage
    // settings form.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}/storage");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_storage_private']
      ->id(), new FormattableMarkup('Updated image field storage default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_storage_private']
        ->id(),
    ]));

    // Upload a new default for the article's field after setting the field
    // storage upload destination to 'private'.
    $default_image_settings = $field
      ->getSetting('default_image');
    $default_image_settings['uuid'] = $default_images['field_private']
      ->uuid();
    $field
      ->setSetting('default_image', $default_image_settings);
    $field
      ->save();

    // Confirm the new field field default is used on the article field
    // admin form.
    $this
      ->drupalGet("admin/structure/types/manage/article/fields/{$field_id}");
    $this
      ->assertFieldByXpath('//input[@name="settings[default_image][uuid][fids]"]', $default_images['field_private']
      ->id(), new FormattableMarkup('Updated article image field default equals expected file ID of @fid.', [
      '@fid' => $default_images['field_private']
        ->id(),
    ]));
  }

  /**
   * Tests image field and field storage having an invalid default image.
   */
  public function testInvalidDefaultImage() {
    $field_storage = FieldStorageConfig::create([
      'field_name' => mb_strtolower($this
        ->randomMachineName()),
      'entity_type' => 'node',
      'type' => 'image',
      'settings' => [
        'default_image' => [
          'uuid' => 100000,
        ],
      ],
    ]);
    $field_storage
      ->save();
    $settings = $field_storage
      ->getSettings();

    // The non-existent default image should not be saved.
    $this
      ->assertNull($settings['default_image']['uuid']);
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
      'label' => $this
        ->randomMachineName(),
      'settings' => [
        'default_image' => [
          'uuid' => 100000,
        ],
      ],
    ]);
    $field
      ->save();
    $settings = $field
      ->getSettings();

    // The non-existent default image should not be saved.
    $this
      ->assertNull($settings['default_image']['uuid']);
  }

}

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.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output 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::tearDown protected function 3
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
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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.
ImageFieldCreationTrait::createImageField protected function Create a new image field.
ImageFieldDefaultImagesTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ImageFieldDefaultImagesTest::$modules public static property Modules to enable. Overrides ImageFieldTestBase::$modules
ImageFieldDefaultImagesTest::testDefaultImages public function Tests CRUD for fields and field storages with default images.
ImageFieldDefaultImagesTest::testInvalidDefaultImage public function Tests image field and field storage having an invalid default image.
ImageFieldTestBase::$adminUser protected property An user with permissions to administer content types and image styles.
ImageFieldTestBase::getLastFileId protected function Retrieves the fid of the last inserted file.
ImageFieldTestBase::previewNodeImage public function Preview an image in a node.
ImageFieldTestBase::setUp protected function Overrides BrowserTestBase::setUp 4
ImageFieldTestBase::uploadNodeImage public function Upload an image to a node.
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. Aliased as: drupalCompareFiles
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 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::assertSession public function Returns WebAssert object. 1
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.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.