class ImageFieldDisplayTest

Same name in other branches
  1. 9 core/modules/image/tests/src/Functional/ImageFieldDisplayTest.php \Drupal\Tests\image\Functional\ImageFieldDisplayTest
  2. 10 core/modules/image/tests/src/Functional/ImageFieldDisplayTest.php \Drupal\Tests\image\Functional\ImageFieldDisplayTest
  3. 11.x core/modules/image/tests/src/Functional/ImageFieldDisplayTest.php \Drupal\Tests\image\Functional\ImageFieldDisplayTest

Tests the display of image fields.

@group image

Hierarchy

Expanded class hierarchy of ImageFieldDisplayTest

File

core/modules/image/tests/src/Functional/ImageFieldDisplayTest.php, line 20

Namespace

Drupal\Tests\image\Functional
View source
class ImageFieldDisplayTest extends ImageFieldTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
        compareFiles as drupalCompareFiles;
    }
    protected $dumpHeaders = TRUE;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * Test image formatters on node display for public files.
     */
    public function testImageFieldFormattersPublic() {
        $this->_testImageFieldFormatters('public');
    }
    
    /**
     * Test image formatters on node display for private files.
     */
    public function testImageFieldFormattersPrivate() {
        // Remove access content permission from anonymous users.
        user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
            'access content' => FALSE,
        ]);
        $this->_testImageFieldFormatters('private');
    }
    
    /**
     * Test image formatters on node display.
     */
    public function _testImageFieldFormatters($scheme) {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $field_name = strtolower($this->randomMachineName());
        $field_settings = [
            'alt_field_required' => 0,
        ];
        $instance = $this->createImageField($field_name, 'article', [
            'uri_scheme' => $scheme,
        ], $field_settings);
        // Go to manage display page.
        $this->drupalGet("admin/structure/types/manage/article/display");
        // Test for existence of link to image styles configuration.
        $this->drupalPostForm(NULL, [], "{$field_name}_settings_edit");
        $this->assertLinkByHref(Url::fromRoute('entity.image_style.collection')->toString(), 0, 'Link to image styles configuration is found');
        // Remove 'administer image styles' permission from testing admin user.
        $admin_user_roles = $this->adminUser
            ->getRoles(TRUE);
        user_role_change_permissions(reset($admin_user_roles), [
            'administer image styles' => FALSE,
        ]);
        // Go to manage display page again.
        $this->drupalGet("admin/structure/types/manage/article/display");
        // Test for absence of link to image styles configuration.
        $this->drupalPostForm(NULL, [], "{$field_name}_settings_edit");
        $this->assertNoLinkByHref(Url::fromRoute('entity.image_style.collection')->toString(), 'Link to image styles configuration is absent when permissions are insufficient');
        // Restore 'administer image styles' permission to testing admin user
        user_role_change_permissions(reset($admin_user_roles), [
            'administer image styles' => TRUE,
        ]);
        // Create a new node with an image attached.
        $test_image = current($this->drupalGetTestFiles('image'));
        // Ensure that preview works.
        $this->previewNodeImage($test_image, $field_name, 'article');
        // After previewing, make the alt field required. It cannot be required
        // during preview because the form validation will fail.
        $instance->setSetting('alt_field_required', 1);
        $instance->save();
        // Create alt text for the image.
        $alt = $this->randomMachineName();
        // Save node.
        $nid = $this->uploadNodeImage($test_image, $field_name, 'article', $alt);
        $node_storage->resetCache([
            $nid,
        ]);
        $node = $node_storage->load($nid);
        // Test that the default formatter is being used.
        $file = $node->{$field_name}->entity;
        $image_uri = $file->getFileUri();
        $image = [
            '#theme' => 'image',
            '#uri' => $image_uri,
            '#width' => 40,
            '#height' => 20,
            '#alt' => $alt,
        ];
        $default_output = str_replace("\n", NULL, $renderer->renderRoot($image));
        $this->assertRaw($default_output, 'Default formatter displaying correctly on full node view.');
        // Test the image linked to file formatter.
        $display_options = [
            'type' => 'image',
            'settings' => [
                'image_link' => 'file',
            ],
        ];
        $display = \Drupal::service('entity_display.repository')->getViewDisplay('node', $node->getType());
        $display->setComponent($field_name, $display_options)
            ->save();
        $image = [
            '#theme' => 'image',
            '#uri' => $image_uri,
            '#width' => 40,
            '#height' => 20,
            '#alt' => $alt,
        ];
        $default_output = '<a href="' . file_create_url($image_uri) . '">' . $renderer->renderRoot($image) . '</a>';
        $this->drupalGet('node/' . $nid);
        $this->assertCacheTag($file->getCacheTags()[0]);
        // @todo Remove in https://www.drupal.org/node/2646744.
        $this->assertCacheContext('url.site');
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        $this->assertRaw($default_output, 'Image linked to file formatter displaying correctly on full node view.');
        // Verify that the image can be downloaded.
        $this->assertEqual(file_get_contents($test_image->uri), $this->drupalGet(file_create_url($image_uri)), 'File was downloaded successfully.');
        if ($scheme == 'private') {
            // Only verify HTTP headers when using private scheme and the headers are
            // sent by Drupal.
            $this->assertEqual($this->drupalGetHeader('Content-Type'), 'image/png', 'Content-Type header was sent.');
            $this->assertTrue(strstr($this->drupalGetHeader('Cache-Control'), 'private') !== FALSE, 'Cache-Control header was sent.');
            // Log out and ensure the file cannot be accessed.
            $this->drupalLogout();
            $this->drupalGet(file_create_url($image_uri));
            $this->assertSession()
                ->statusCodeEquals(403);
            // Log in again.
            $this->drupalLogin($this->adminUser);
        }
        // Test the image linked to content formatter.
        $display_options['settings']['image_link'] = 'content';
        $display->setComponent($field_name, $display_options)
            ->save();
        $image = [
            '#theme' => 'image',
            '#uri' => $image_uri,
            '#width' => 40,
            '#height' => 20,
        ];
        $this->drupalGet('node/' . $nid);
        $this->assertCacheTag($file->getCacheTags()[0]);
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        $elements = $this->xpath('//a[@href=:path]/img[@src=:url and @alt=:alt and @width=:width and @height=:height]', [
            ':path' => $node->toUrl()
                ->toString(),
            ':url' => file_url_transform_relative(file_create_url($image['#uri'])),
            ':width' => $image['#width'],
            ':height' => $image['#height'],
            ':alt' => $alt,
        ]);
        $this->assertCount(1, $elements, 'Image linked to content formatter displaying correctly on full node view.');
        // Test the image style 'thumbnail' formatter.
        $display_options['settings']['image_link'] = '';
        $display_options['settings']['image_style'] = 'thumbnail';
        $display->setComponent($field_name, $display_options)
            ->save();
        // Ensure the derivative image is generated so we do not have to deal with
        // image style callback paths.
        $this->drupalGet(ImageStyle::load('thumbnail')->buildUrl($image_uri));
        $image_style = [
            '#theme' => 'image_style',
            '#uri' => $image_uri,
            '#width' => 40,
            '#height' => 20,
            '#style_name' => 'thumbnail',
            '#alt' => $alt,
        ];
        $default_output = $renderer->renderRoot($image_style);
        $this->drupalGet('node/' . $nid);
        $image_style = ImageStyle::load('thumbnail');
        $this->assertCacheTag($image_style->getCacheTags()[0]);
        $this->assertRaw($default_output, 'Image style thumbnail formatter displaying correctly on full node view.');
        if ($scheme == 'private') {
            // Log out and ensure the file cannot be accessed.
            $this->drupalLogout();
            $this->drupalGet(ImageStyle::load('thumbnail')->buildUrl($image_uri));
            $this->assertSession()
                ->statusCodeEquals(403);
        }
        // Test the image URL formatter without an image style.
        $display_options = [
            'type' => 'image_url',
            'settings' => [
                'image_style' => '',
            ],
        ];
        $expected_url = file_url_transform_relative(file_create_url($image_uri));
        $this->assertEqual($expected_url, $node->{$field_name}
            ->view($display_options)[0]['#markup']);
        // Test the image URL formatter with an image style.
        $display_options['settings']['image_style'] = 'thumbnail';
        $expected_url = file_url_transform_relative(ImageStyle::load('thumbnail')->buildUrl($image_uri));
        $this->assertEqual($expected_url, $node->{$field_name}
            ->view($display_options)[0]['#markup']);
    }
    
    /**
     * Tests for image field settings.
     */
    public function testImageFieldSettings() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $test_image = current($this->drupalGetTestFiles('image'));
        list(, $test_image_extension) = explode('.', $test_image->filename);
        $field_name = strtolower($this->randomMachineName());
        $field_settings = [
            'alt_field' => 1,
            'file_extensions' => $test_image_extension,
            'max_filesize' => '50 KB',
            'max_resolution' => '100x100',
            'min_resolution' => '10x10',
            'title_field' => 1,
        ];
        $widget_settings = [
            'preview_image_style' => 'medium',
        ];
        $field = $this->createImageField($field_name, 'article', [], $field_settings, $widget_settings);
        // Verify that the min/max resolution set on the field are properly
        // extracted, and displayed, on the image field's configuration form.
        $this->drupalGet('admin/structure/types/manage/article/fields/' . $field->id());
        $this->assertFieldByName('settings[max_resolution][x]', '100', 'Expected max resolution X value of 100.');
        $this->assertFieldByName('settings[max_resolution][y]', '100', 'Expected max resolution Y value of 100.');
        $this->assertFieldByName('settings[min_resolution][x]', '10', 'Expected min resolution X value of 10.');
        $this->assertFieldByName('settings[min_resolution][y]', '10', 'Expected min resolution Y value of 10.');
        $this->drupalGet('node/add/article');
        $this->assertText(t('50 KB limit.'), 'Image widget max file size is displayed on article form.');
        $this->assertText(t('Allowed types: @extensions.', [
            '@extensions' => $test_image_extension,
        ]), 'Image widget allowed file types displayed on article form.');
        $this->assertText(t('Images must be larger than 10x10 pixels. Images larger than 100x100 pixels will be resized.'), 'Image widget allowed resolution displayed on article form.');
        // We have to create the article first and then edit it because the alt
        // and title fields do not display until the image has been attached.
        // Create alt text for the image.
        $alt = $this->randomMachineName();
        $nid = $this->uploadNodeImage($test_image, $field_name, 'article', $alt);
        $this->drupalGet('node/' . $nid . '/edit');
        // Verify that the optional fields alt & title are saved & filled.
        $this->assertFieldByName($field_name . '[0][alt]', $alt, 'Alt field displayed on article form.');
        $this->assertFieldByName($field_name . '[0][title]', '', 'Title field displayed on article form.');
        // Verify that the attached image is being previewed using the 'medium'
        // style.
        $node_storage->resetCache([
            $nid,
        ]);
        $node = $node_storage->load($nid);
        $file = $node->{$field_name}->entity;
        $url = file_url_transform_relative(ImageStyle::load('medium')->buildUrl($file->getFileUri()));
        $this->assertSession()
            ->elementExists('css', 'img[width=40][height=20][class=image-style-medium][src="' . $url . '"]');
        // Add alt/title fields to the image and verify that they are displayed.
        $image = [
            '#theme' => 'image',
            '#uri' => $file->getFileUri(),
            '#alt' => $alt,
            '#title' => $this->randomMachineName(),
            '#width' => 40,
            '#height' => 20,
        ];
        $edit = [
            $field_name . '[0][alt]' => $image['#alt'],
            $field_name . '[0][title]' => $image['#title'],
        ];
        $this->drupalPostForm('node/' . $nid . '/edit', $edit, t('Save'));
        $default_output = str_replace("\n", NULL, $renderer->renderRoot($image));
        $this->assertRaw($default_output, 'Image displayed using user supplied alt and title attributes.');
        // Verify that alt/title longer than allowed results in a validation error.
        $test_size = 2000;
        $edit = [
            $field_name . '[0][alt]' => $this->randomMachineName($test_size),
            $field_name . '[0][title]' => $this->randomMachineName($test_size),
        ];
        $this->drupalPostForm('node/' . $nid . '/edit', $edit, t('Save'));
        $schema = $field->getFieldStorageDefinition()
            ->getSchema();
        $this->assertRaw(t('Alternative text cannot be longer than %max characters but is currently %length characters long.', [
            '%max' => $schema['columns']['alt']['length'],
            '%length' => $test_size,
        ]));
        $this->assertRaw(t('Title cannot be longer than %max characters but is currently %length characters long.', [
            '%max' => $schema['columns']['title']['length'],
            '%length' => $test_size,
        ]));
        // Set cardinality to unlimited and add upload a second image.
        // The image widget is extending on the file widget, but the image field
        // type does not have the 'display_field' setting which is expected by
        // the file widget. This resulted in notices before when cardinality is not
        // 1, so we need to make sure the file widget prevents these notices by
        // providing all settings, even if they are not used.
        // @see FileWidget::formMultipleElements().
        $this->drupalPostForm('admin/structure/types/manage/article/fields/node.article.' . $field_name . '/storage', [
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ], t('Save field settings'));
        $edit = [
            'files[' . $field_name . '_1][]' => \Drupal::service('file_system')->realpath($test_image->uri),
        ];
        $this->drupalPostForm('node/' . $node->id() . '/edit', $edit, t('Save'));
        // Add the required alt text.
        $this->drupalPostForm(NULL, [
            $field_name . '[1][alt]' => $alt,
        ], t('Save'));
        $this->assertText(new FormattableMarkup('Article @title has been updated.', [
            '@title' => $node->getTitle(),
        ]));
        // Assert ImageWidget::process() calls FieldWidget::process().
        $this->drupalGet('node/' . $node->id() . '/edit');
        $edit = [
            'files[' . $field_name . '_2][]' => \Drupal::service('file_system')->realpath($test_image->uri),
        ];
        $this->drupalPostForm(NULL, $edit, $field_name . '_2_upload_button');
        $this->assertSession()
            ->elementNotExists('css', 'input[name="files[' . $field_name . '_2][]"]');
        $this->assertSession()
            ->elementExists('css', 'input[name="files[' . $field_name . '_3][]"]');
    }
    
    /**
     * Test use of a default image with an image field.
     */
    public function testImageFieldDefaultImage() {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        // Create a new image field.
        $field_name = strtolower($this->randomMachineName());
        $this->createImageField($field_name, 'article');
        // Create a new node, with no images and verify that no images are
        // displayed.
        $node = $this->drupalCreateNode([
            'type' => 'article',
        ]);
        $this->drupalGet('node/' . $node->id());
        // Verify that no image is displayed on the page by checking for the class
        // that would be used on the image field.
        $this->assertSession()
            ->responseNotMatches('<div class="(.*?)field--name-' . strtr($field_name, '_', '-') . '(.*?)">', 'No image displayed when no image is attached and no default image specified.');
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        // Add a default image to the public image field.
        $images = $this->drupalGetTestFiles('image');
        $alt = $this->randomString(512);
        $title = $this->randomString(1024);
        $edit = [
            // Get the path of the 'image-test.png' file.
'files[settings_default_image_uuid]' => \Drupal::service('file_system')->realpath($images[0]->uri),
            'settings[default_image][alt]' => $alt,
            'settings[default_image][title]' => $title,
        ];
        $this->drupalPostForm("admin/structure/types/manage/article/fields/node.article.{$field_name}/storage", $edit, t('Save field settings'));
        // Clear field definition cache so the new default image is detected.
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        $field_storage = FieldStorageConfig::loadByName('node', $field_name);
        $default_image = $field_storage->getSetting('default_image');
        $file = \Drupal::service('entity.repository')->loadEntityByUuid('file', $default_image['uuid']);
        $this->assertTrue($file->isPermanent(), 'The default image status is permanent.');
        $image = [
            '#theme' => 'image',
            '#uri' => $file->getFileUri(),
            '#alt' => $alt,
            '#title' => $title,
            '#width' => 40,
            '#height' => 20,
        ];
        $default_output = str_replace("\n", NULL, $renderer->renderRoot($image));
        $this->drupalGet('node/' . $node->id());
        $this->assertCacheTag($file->getCacheTags()[0]);
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        $this->assertRaw($default_output, 'Default image displayed when no user supplied image is present.');
        // Create a node with an image attached and ensure that the default image
        // is not displayed.
        // Create alt text for the image.
        $alt = $this->randomMachineName();
        // Upload the 'image-test.gif' file.
        $nid = $this->uploadNodeImage($images[2], $field_name, 'article', $alt);
        $node_storage->resetCache([
            $nid,
        ]);
        $node = $node_storage->load($nid);
        $file = $node->{$field_name}->entity;
        $image = [
            '#theme' => 'image',
            '#uri' => $file->getFileUri(),
            '#width' => 40,
            '#height' => 20,
            '#alt' => $alt,
        ];
        $image_output = str_replace("\n", NULL, $renderer->renderRoot($image));
        $this->drupalGet('node/' . $nid);
        $this->assertCacheTag($file->getCacheTags()[0]);
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        $this->assertNoRaw($default_output, 'Default image is not displayed when user supplied image is present.');
        $this->assertRaw($image_output, 'User supplied image is displayed.');
        // Remove default image from the field and make sure it is no longer used.
        // Can't use fillField cause Mink can't fill hidden fields.
        $this->drupalGet("admin/structure/types/manage/article/fields/node.article.{$field_name}/storage");
        $this->getSession()
            ->getPage()
            ->find('css', 'input[name="settings[default_image][uuid][fids]"]')
            ->setValue(0);
        $this->getSession()
            ->getPage()
            ->pressButton(t('Save field settings'));
        // Clear field definition cache so the new default image is detected.
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        $field_storage = FieldStorageConfig::loadByName('node', $field_name);
        $default_image = $field_storage->getSetting('default_image');
        $this->assertEmpty($default_image['uuid'], 'Default image removed from field.');
        // Create an image field that uses the private:// scheme and test that the
        // default image works as expected.
        $private_field_name = strtolower($this->randomMachineName());
        $this->createImageField($private_field_name, 'article', [
            'uri_scheme' => 'private',
        ]);
        // Add a default image to the new field.
        $edit = [
            // Get the path of the 'image-test.gif' file.
'files[settings_default_image_uuid]' => \Drupal::service('file_system')->realpath($images[2]->uri),
            'settings[default_image][alt]' => $alt,
            'settings[default_image][title]' => $title,
        ];
        $this->drupalPostForm('admin/structure/types/manage/article/fields/node.article.' . $private_field_name . '/storage', $edit, t('Save field settings'));
        // Clear field definition cache so the new default image is detected.
        \Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
        $private_field_storage = FieldStorageConfig::loadByName('node', $private_field_name);
        $default_image = $private_field_storage->getSetting('default_image');
        $file = \Drupal::service('entity.repository')->loadEntityByUuid('file', $default_image['uuid']);
        $this->assertEqual('private', StreamWrapperManager::getScheme($file->getFileUri()), 'Default image uses private:// scheme.');
        $this->assertTrue($file->isPermanent(), 'The default image status is permanent.');
        // Create a new node with no image attached and ensure that default private
        // image is displayed.
        $node = $this->drupalCreateNode([
            'type' => 'article',
        ]);
        $image = [
            '#theme' => 'image',
            '#uri' => $file->getFileUri(),
            '#alt' => $alt,
            '#title' => $title,
            '#width' => 40,
            '#height' => 20,
        ];
        $default_output = str_replace("\n", NULL, $renderer->renderRoot($image));
        $this->drupalGet('node/' . $node->id());
        $this->assertCacheTag($file->getCacheTags()[0]);
        $cache_tags_header = $this->drupalGetHeader('X-Drupal-Cache-Tags');
        $this->assertTrue(!preg_match('/ image_style\\:/', $cache_tags_header), 'No image style cache tag found.');
        $this->assertRaw($default_output, 'Default private image displayed when no user supplied image is present.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title 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&#039;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
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; 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 &quot;#1&quot; 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.
ImageFieldDisplayTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ImageFieldDisplayTest::$dumpHeaders protected property
ImageFieldDisplayTest::$modules public static property Modules to enable. Overrides ImageFieldTestBase::$modules
ImageFieldDisplayTest::testImageFieldDefaultImage public function Test use of a default image with an image field.
ImageFieldDisplayTest::testImageFieldFormattersPrivate public function Test image formatters on node display for private files.
ImageFieldDisplayTest::testImageFieldFormattersPublic public function Test image formatters on node display for public files.
ImageFieldDisplayTest::testImageFieldSettings public function Tests for image field settings.
ImageFieldDisplayTest::_testImageFieldFormatters public function Test image formatters on node display.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.