class ImageAdminStylesTest

Same name in this branch
  1. 8.9.x core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
Same name in other branches
  1. 9 core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
  2. 9 core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest
  3. 10 core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
  4. 10 core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest
  5. 11.x core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
  6. 11.x core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest

Tests creation, deletion, and editing of image styles and effects.

@group image

Hierarchy

Expanded class hierarchy of ImageAdminStylesTest

File

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

Namespace

Drupal\Tests\image\Functional
View source
class ImageAdminStylesTest extends ImageFieldTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
        compareFiles as drupalCompareFiles;
    }
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Given an image style, generate an image.
     */
    public function createSampleImage(ImageStyleInterface $style) {
        static $file_path;
        // First, we need to make sure we have an image in our testing
        // file directory. Copy over an image on the first run.
        if (!isset($file_path)) {
            $files = $this->drupalGetTestFiles('image');
            $file = reset($files);
            $file_path = \Drupal::service('file_system')->copy($file->uri, 'public://');
        }
        return $style->buildUrl($file_path) ? $file_path : FALSE;
    }
    
    /**
     * Count the number of images currently create for a style.
     */
    public function getImageCount(ImageStyleInterface $style) {
        $count = 0;
        if (is_dir('public://styles/' . $style->id())) {
            $count = count(\Drupal::service('file_system')->scanDirectory('public://styles/' . $style->id(), '/.*/'));
        }
        return $count;
    }
    
    /**
     * Test creating an image style with a numeric name and ensuring it can be
     * applied to an image.
     */
    public function testNumericStyleName() {
        $style_name = rand();
        $style_label = $this->randomString();
        $edit = [
            'name' => $style_name,
            'label' => $style_label,
        ];
        $this->drupalPostForm('admin/config/media/image-styles/add', $edit, t('Create new style'));
        $this->assertRaw(t('Style %name was created.', [
            '%name' => $style_label,
        ]));
        $options = image_style_options();
        $this->assertArrayHasKey($style_name, $options);
    }
    
    /**
     * General test to add a style, add/remove/edit effects to it, then delete it.
     */
    public function testStyle() {
        $admin_path = 'admin/config/media/image-styles';
        // Setup a style to be created and effects to add to it.
        $style_name = strtolower($this->randomMachineName(10));
        $style_label = $this->randomString();
        $style_path = $admin_path . '/manage/' . $style_name;
        $effect_edits = [
            'image_resize' => [
                'width' => 100,
                'height' => 101,
            ],
            'image_scale' => [
                'width' => 110,
                'height' => 111,
                'upscale' => 1,
            ],
            'image_scale_and_crop' => [
                'width' => 120,
                'height' => 121,
            ],
            'image_crop' => [
                'width' => 130,
                'height' => 131,
                'anchor' => 'left-top',
            ],
            'image_desaturate' => [],
            'image_rotate' => [
                'degrees' => 5,
                'random' => 1,
                'bgcolor' => '#FFFF00',
            ],
        ];
        // Add style form.
        $edit = [
            'name' => $style_name,
            'label' => $style_label,
        ];
        $this->drupalPostForm($admin_path . '/add', $edit, t('Create new style'));
        $this->assertRaw(t('Style %name was created.', [
            '%name' => $style_label,
        ]));
        // Ensure that the expected entity operations are there.
        $this->drupalGet($admin_path);
        $this->assertLinkByHref($style_path);
        $this->assertLinkByHref($style_path . '/flush');
        $this->assertLinkByHref($style_path . '/delete');
        // Add effect form.
        // Add each sample effect to the style.
        foreach ($effect_edits as $effect => $edit) {
            $edit_data = [];
            foreach ($edit as $field => $value) {
                $edit_data['data[' . $field . ']'] = $value;
            }
            // Add the effect.
            $this->drupalPostForm($style_path, [
                'new' => $effect,
            ], t('Add'));
            if (!empty($edit)) {
                $this->drupalPostForm(NULL, $edit_data, t('Add effect'));
            }
        }
        // Load the saved image style.
        $style = ImageStyle::load($style_name);
        // Ensure that third party settings were added to the config entity.
        // These are added by a hook_image_style_presave() implemented in
        // image_module_test module.
        $this->assertEqual('bar', $style->getThirdPartySetting('image_module_test', 'foo'), 'Third party settings were added to the image style.');
        // Ensure that the image style URI matches our expected path.
        $style_uri_path = $style->toUrl()
            ->toString();
        $this->assertStringContainsString($style_path, $style_uri_path, 'The image style URI is correct.');
        // Confirm that all effects on the image style have settings that match
        // what was saved.
        $uuids = [];
        foreach ($style->getEffects() as $uuid => $effect) {
            // Store the uuid for later use.
            $uuids[$effect->getPluginId()] = $uuid;
            $effect_configuration = $effect->getConfiguration();
            foreach ($effect_edits[$effect->getPluginId()] as $field => $value) {
                $this->assertEqual($value, $effect_configuration['data'][$field], new FormattableMarkup('The %field field in the %effect effect has the correct value of %value.', [
                    '%field' => $field,
                    '%effect' => $effect->getPluginId(),
                    '%value' => $value,
                ]));
            }
        }
        // Assert that every effect was saved.
        foreach (array_keys($effect_edits) as $effect_name) {
            $this->assertTrue(isset($uuids[$effect_name]), new FormattableMarkup('A %effect_name effect was saved with ID %uuid', [
                '%effect_name' => $effect_name,
                '%uuid' => $uuids[$effect_name],
            ]));
        }
        // Image style overview form (ordering and renaming).
        // Confirm the order of effects is maintained according to the order we
        // added the fields.
        $effect_edits_order = array_keys($effect_edits);
        $order_correct = TRUE;
        $index = 0;
        foreach ($style->getEffects() as $effect) {
            if ($effect_edits_order[$index] != $effect->getPluginId()) {
                $order_correct = FALSE;
            }
            $index++;
        }
        $this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
        // Test the style overview form.
        // Change the name of the style and adjust the weights of effects.
        $style_name = strtolower($this->randomMachineName(10));
        $style_label = $this->randomMachineName();
        $weight = count($effect_edits);
        $edit = [
            'name' => $style_name,
            'label' => $style_label,
        ];
        foreach ($style->getEffects() as $uuid => $effect) {
            $edit['effects[' . $uuid . '][weight]'] = $weight;
            $weight--;
        }
        // Create an image to make sure it gets flushed after saving.
        $image_path = $this->createSampleImage($style);
        $this->assertEqual($this->getImageCount($style), 1, new FormattableMarkup('Image style %style image %file successfully generated.', [
            '%style' => $style->label(),
            '%file' => $image_path,
        ]));
        $this->drupalPostForm($style_path, $edit, t('Save'));
        // Note that after changing the style name, the style path is changed.
        $style_path = 'admin/config/media/image-styles/manage/' . $style_name;
        // Check that the URL was updated.
        $this->drupalGet($style_path);
        $this->assertTitle("Edit style {$style_label} | Drupal");
        // Check that the available image effects are properly sorted.
        $option = $this->xpath('//select[@id=:id]//option', [
            ':id' => 'edit-new--2',
        ]);
        $this->assertEquals('Ajax test', $option[1]->getText(), '"Ajax test" is the first selectable effect.');
        // Check that the image was flushed after updating the style.
        // This is especially important when renaming the style. Make sure that
        // the old image directory has been deleted.
        $this->assertEqual($this->getImageCount($style), 0, new FormattableMarkup('Image style %style was flushed after renaming the style and updating the order of effects.', [
            '%style' => $style->label(),
        ]));
        // Load the style by the new name with the new weights.
        $style = ImageStyle::load($style_name);
        // Confirm the new style order was saved.
        $effect_edits_order = array_reverse($effect_edits_order);
        $order_correct = TRUE;
        $index = 0;
        foreach ($style->getEffects() as $effect) {
            if ($effect_edits_order[$index] != $effect->getPluginId()) {
                $order_correct = FALSE;
            }
            $index++;
        }
        $this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
        // Image effect deletion form.
        // Create an image to make sure it gets flushed after deleting an effect.
        $image_path = $this->createSampleImage($style);
        $this->assertEqual($this->getImageCount($style), 1, new FormattableMarkup('Image style %style image %file successfully generated.', [
            '%style' => $style->label(),
            '%file' => $image_path,
        ]));
        // Delete the 'image_crop' effect from the style.
        $this->drupalPostForm($style_path . '/effects/' . $uuids['image_crop'] . '/delete', [], t('Delete'));
        // Confirm that the form submission was successful.
        $this->assertSession()
            ->statusCodeEquals(200);
        $image_crop_effect = $style->getEffect($uuids['image_crop']);
        $this->assertRaw(t('The image effect %name has been deleted.', [
            '%name' => $image_crop_effect->label(),
        ]));
        // Confirm that there is no longer a link to the effect.
        $this->assertNoLinkByHref($style_path . '/effects/' . $uuids['image_crop'] . '/delete');
        // Refresh the image style information and verify that the effect was
        // actually deleted.
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $style = $entity_type_manager->getStorage('image_style')
            ->loadUnchanged($style->id());
        $this->assertFalse($style->getEffects()
            ->has($uuids['image_crop']), new FormattableMarkup('Effect with ID %uuid no longer found on image style %style', [
            '%uuid' => $uuids['image_crop'],
            '%style' => $style->label(),
        ]));
        // Additional test on Rotate effect, for transparent background.
        $edit = [
            'data[degrees]' => 5,
            'data[random]' => 0,
            'data[bgcolor]' => '',
        ];
        $this->drupalPostForm($style_path, [
            'new' => 'image_rotate',
        ], t('Add'));
        $this->drupalPostForm(NULL, $edit, t('Add effect'));
        $entity_type_manager = $this->container
            ->get('entity_type.manager');
        $style = $entity_type_manager->getStorage('image_style')
            ->loadUnchanged($style_name);
        $this->assertCount(6, $style->getEffects(), 'Rotate effect with transparent background was added.');
        // Style deletion form.
        // Delete the style.
        $this->drupalPostForm($style_path . '/delete', [], t('Delete'));
        // Confirm the style directory has been removed.
        $directory = 'public://styles/' . $style_name;
        $this->assertDirectoryNotExists($directory);
        $this->assertNull(ImageStyle::load($style_name), new FormattableMarkup('Image style %style successfully deleted.', [
            '%style' => $style->label(),
        ]));
        // Test empty text when there are no image styles.
        // Delete all image styles.
        foreach (ImageStyle::loadMultiple() as $image_style) {
            $image_style->delete();
        }
        // Confirm that the empty text is correct on the image styles page.
        $this->drupalGet($admin_path);
        $this->assertRaw(t('There are currently no styles. <a href=":url">Add a new one</a>.', [
            ':url' => Url::fromRoute('image.style_add')->toString(),
        ]));
    }
    
    /**
     * Test deleting a style and choosing a replacement style.
     */
    public function testStyleReplacement() {
        // Create a new style.
        $style_name = strtolower($this->randomMachineName(10));
        $style_label = $this->randomString();
        $style = ImageStyle::create([
            'name' => $style_name,
            'label' => $style_label,
        ]);
        $style->save();
        $style_path = 'admin/config/media/image-styles/manage/';
        // Create an image field that uses the new style.
        $field_name = strtolower($this->randomMachineName(10));
        $this->createImageField($field_name, 'article');
        \Drupal::service('entity_display.repository')->getViewDisplay('node', 'article')
            ->setComponent($field_name, [
            'type' => 'image',
            'settings' => [
                'image_style' => $style_name,
            ],
        ])
            ->save();
        // Create a new node with an image attached.
        $test_image = current($this->drupalGetTestFiles('image'));
        $nid = $this->uploadNodeImage($test_image, $field_name, 'article', $this->randomMachineName());
        $node = Node::load($nid);
        // Get node field original image URI.
        $fid = $node->get($field_name)->target_id;
        $original_uri = File::load($fid)->getFileUri();
        // Test that image is displayed using newly created style.
        $this->drupalGet('node/' . $nid);
        $this->assertRaw(file_url_transform_relative($style->buildUrl($original_uri)), new FormattableMarkup('Image displayed using style @style.', [
            '@style' => $style_name,
        ]));
        // Rename the style and make sure the image field is updated.
        $new_style_name = strtolower($this->randomMachineName(10));
        $new_style_label = $this->randomString();
        $edit = [
            'name' => $new_style_name,
            'label' => $new_style_label,
        ];
        $this->drupalPostForm($style_path . $style_name, $edit, t('Save'));
        $this->assertText(t('Changes to the style have been saved.'), new FormattableMarkup('Style %name was renamed to %new_name.', [
            '%name' => $style_name,
            '%new_name' => $new_style_name,
        ]));
        $this->drupalGet('node/' . $nid);
        // Reload the image style using the new name.
        $style = ImageStyle::load($new_style_name);
        $this->assertRaw(file_url_transform_relative($style->buildUrl($original_uri)), 'Image displayed using style replacement style.');
        // Delete the style and choose a replacement style.
        $edit = [
            'replacement' => 'thumbnail',
        ];
        $this->drupalPostForm($style_path . $new_style_name . '/delete', $edit, t('Delete'));
        $message = t('The image style %name has been deleted.', [
            '%name' => $new_style_label,
        ]);
        $this->assertRaw($message);
        $replacement_style = ImageStyle::load('thumbnail');
        $this->drupalGet('node/' . $nid);
        $this->assertRaw(file_url_transform_relative($replacement_style->buildUrl($original_uri)), 'Image displayed using style replacement style.');
    }
    
    /**
     * Verifies that editing an image effect does not cause it to be duplicated.
     */
    public function testEditEffect() {
        // Add a scale effect.
        $style_name = 'test_style_effect_edit';
        $this->drupalGet('admin/config/media/image-styles/add');
        $this->drupalPostForm(NULL, [
            'label' => 'Test style effect edit',
            'name' => $style_name,
        ], t('Create new style'));
        $this->drupalPostForm(NULL, [
            'new' => 'image_scale_and_crop',
        ], t('Add'));
        $this->drupalPostForm(NULL, [
            'data[width]' => '300',
            'data[height]' => '200',
        ], t('Add effect'));
        $this->assertText(t('Scale and crop 300×200'));
        // There should normally be only one edit link on this page initially.
        $this->clickLink(t('Edit'));
        $this->drupalPostForm(NULL, [
            'data[width]' => '360',
            'data[height]' => '240',
        ], t('Update effect'));
        $this->assertText(t('Scale and crop 360×240'));
        // Check that the previous effect is replaced.
        $this->assertNoText(t('Scale and crop 300×200'));
        // Add another scale effect.
        $this->drupalGet('admin/config/media/image-styles/add');
        $this->drupalPostForm(NULL, [
            'label' => 'Test style scale edit scale',
            'name' => 'test_style_scale_edit_scale',
        ], t('Create new style'));
        $this->drupalPostForm(NULL, [
            'new' => 'image_scale',
        ], t('Add'));
        $this->drupalPostForm(NULL, [
            'data[width]' => '12',
            'data[height]' => '19',
        ], t('Add effect'));
        // Edit the scale effect that was just added.
        $this->clickLink(t('Edit'));
        $this->drupalPostForm(NULL, [
            'data[width]' => '24',
            'data[height]' => '19',
        ], t('Update effect'));
        // Add another scale effect and make sure both exist. Click through from
        // the overview to make sure that it is possible to add new effect then.
        $this->drupalGet('admin/config/media/image-styles');
        $rows = $this->xpath('//table/tbody/tr');
        $i = 0;
        foreach ($rows as $row) {
            if ($row->find('css', 'td')
                ->getText() === 'Test style scale edit scale') {
                $this->clickLink('Edit', $i);
                break;
            }
            $i++;
        }
        $this->drupalPostForm(NULL, [
            'new' => 'image_scale',
        ], t('Add'));
        $this->drupalPostForm(NULL, [
            'data[width]' => '12',
            'data[height]' => '19',
        ], t('Add effect'));
        $this->assertText(t('Scale 24×19'));
        $this->assertText(t('Scale 12×19'));
        // Try to edit a nonexistent effect.
        $uuid = $this->container
            ->get('uuid');
        $this->drupalGet('admin/config/media/image-styles/manage/' . $style_name . '/effects/' . $uuid->generate());
        $this->assertSession()
            ->statusCodeEquals(404);
    }
    
    /**
     * Test flush user interface.
     */
    public function testFlushUserInterface() {
        $admin_path = 'admin/config/media/image-styles';
        // Create a new style.
        $style_name = strtolower($this->randomMachineName(10));
        $style = ImageStyle::create([
            'name' => $style_name,
            'label' => $this->randomString(),
        ]);
        $style->save();
        // Create an image to make sure it gets flushed.
        $files = $this->drupalGetTestFiles('image');
        $image_uri = $files[0]->uri;
        $derivative_uri = $style->buildUri($image_uri);
        $this->assertTrue($style->createDerivative($image_uri, $derivative_uri));
        $this->assertEqual($this->getImageCount($style), 1);
        // Go to image styles list page and check if the flush operation link
        // exists.
        $this->drupalGet($admin_path);
        $flush_path = $admin_path . '/manage/' . $style_name . '/flush';
        $this->assertLinkByHref($flush_path);
        // Flush the image style derivatives using the user interface.
        $this->drupalPostForm($flush_path, [], t('Flush'));
        // The derivative image file should have been deleted.
        $this->assertEqual($this->getImageCount($style), 0);
    }
    
    /**
     * Tests image style configuration import that does a delete.
     */
    public function testConfigImport() {
        // Create a new style.
        $style_name = strtolower($this->randomMachineName(10));
        $style_label = $this->randomString();
        $style = ImageStyle::create([
            'name' => $style_name,
            'label' => $style_label,
        ]);
        $style->save();
        // Create an image field that uses the new style.
        $field_name = strtolower($this->randomMachineName(10));
        $this->createImageField($field_name, 'article');
        \Drupal::service('entity_display.repository')->getViewDisplay('node', 'article')
            ->setComponent($field_name, [
            'type' => 'image',
            'settings' => [
                'image_style' => $style_name,
            ],
        ])
            ->save();
        // Create a new node with an image attached.
        $test_image = current($this->drupalGetTestFiles('image'));
        $nid = $this->uploadNodeImage($test_image, $field_name, 'article', $this->randomMachineName());
        $node = Node::load($nid);
        // Get node field original image URI.
        $fid = $node->get($field_name)->target_id;
        $original_uri = File::load($fid)->getFileUri();
        // Test that image is displayed using newly created style.
        $this->drupalGet('node/' . $nid);
        $this->assertRaw(file_url_transform_relative($style->buildUrl($original_uri)), new FormattableMarkup('Image displayed using style @style.', [
            '@style' => $style_name,
        ]));
        // Copy config to sync, and delete the image style.
        $sync = $this->container
            ->get('config.storage.sync');
        $active = $this->container
            ->get('config.storage');
        // Remove the image field from the display, to avoid a dependency error
        // during import.
        EntityViewDisplay::load('node.article.default')->removeComponent($field_name)
            ->save();
        $this->copyConfig($active, $sync);
        $sync->delete('image.style.' . $style_name);
        $this->configImporter()
            ->import();
        $this->assertNull(ImageStyle::load($style_name), 'Style deleted after config import.');
        $this->assertEqual($this->getImageCount($style), 0, 'Image style was flushed after being deleted by config import.');
    }
    
    /**
     * Tests access for the image style listing.
     */
    public function testImageStyleAccess() {
        $style = ImageStyle::create([
            'name' => 'style_foo',
            'label' => $this->randomString(),
        ]);
        $style->save();
        $this->drupalGet('admin/config/media/image-styles');
        $this->clickLink(t('Edit'));
        $this->assertRaw(t('Select a new effect'));
    }

}

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
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
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
AssertLegacyTrait::assertIdenticalObject protected function
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
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
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
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
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.
ImageAdminStylesTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ImageAdminStylesTest::createSampleImage public function Given an image style, generate an image.
ImageAdminStylesTest::getImageCount public function Count the number of images currently create for a style.
ImageAdminStylesTest::testConfigImport public function Tests image style configuration import that does a delete.
ImageAdminStylesTest::testEditEffect public function Verifies that editing an image effect does not cause it to be duplicated.
ImageAdminStylesTest::testFlushUserInterface public function Test flush user interface.
ImageAdminStylesTest::testImageStyleAccess public function Tests access for the image style listing.
ImageAdminStylesTest::testNumericStyleName public function Test creating an image style with a numeric name and ensuring it can be
applied to an image.
ImageAdminStylesTest::testStyle public function General test to add a style, add/remove/edit effects to it, then delete it.
ImageAdminStylesTest::testStyleReplacement public function Test deleting a style and choosing a replacement style.
ImageFieldCreationTrait::createImageField protected function Create a new image field.
ImageFieldTestBase::$adminUser protected property An user with permissions to administer content types and image styles.
ImageFieldTestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules 5
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.