class ImageThemeFunctionTest

Same name in other branches
  1. 9 core/modules/image/tests/src/Kernel/ImageThemeFunctionTest.php \Drupal\Tests\image\Kernel\ImageThemeFunctionTest
  2. 8.9.x core/modules/image/tests/src/Kernel/ImageThemeFunctionTest.php \Drupal\Tests\image\Kernel\ImageThemeFunctionTest
  3. 11.x core/modules/image/tests/src/Kernel/ImageThemeFunctionTest.php \Drupal\Tests\image\Kernel\ImageThemeFunctionTest

Tests image theme functions.

@group image

Hierarchy

Expanded class hierarchy of ImageThemeFunctionTest

File

core/modules/image/tests/src/Kernel/ImageThemeFunctionTest.php, line 23

Namespace

Drupal\Tests\image\Kernel
View source
class ImageThemeFunctionTest extends KernelTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
        compareFiles as drupalCompareFiles;
    }
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'field',
        'file',
        'image',
        'system',
        'user',
    ];
    
    /**
     * Created file entity.
     *
     * @var \Drupal\file\Entity\File
     */
    protected $image;
    
    /**
     * @var \Drupal\Core\Image\ImageFactory
     */
    protected $imageFactory;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('entity_test');
        $this->installEntitySchema('file');
        $this->installSchema('file', [
            'file_usage',
        ]);
        $this->installEntitySchema('user');
        FieldStorageConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'image_test',
            'type' => 'image',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])->save();
        FieldConfig::create([
            'entity_type' => 'entity_test',
            'field_name' => 'image_test',
            'bundle' => 'entity_test',
        ])->save();
        \Drupal::service('file_system')->copy($this->root . '/core/misc/druplicon.png', 'public://example.jpg');
        $this->image = File::create([
            'uri' => 'public://example.jpg',
        ]);
        $this->image
            ->save();
        $this->imageFactory = $this->container
            ->get('image.factory');
    }
    
    /**
     * Tests usage of the image field formatters.
     */
    public function testImageFormatterTheme() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        // Create an image.
        $files = $this->drupalGetTestFiles('image');
        $file = reset($files);
        $original_uri = \Drupal::service('file_system')->copy($file->uri, 'public://', FileExists::Rename);
        // Create a style.
        $style = ImageStyle::create([
            'name' => 'test',
            'label' => 'Test',
        ]);
        $style->save();
        $url = \Drupal::service('file_url_generator')->transformRelative($style->buildUrl($original_uri));
        // Create a test entity with the image field set.
        $entity = EntityTest::create();
        $entity->image_test->target_id = $this->image
            ->id();
        $entity->image_test->alt = NULL;
        $entity->image_test->uri = $original_uri;
        $image = $this->imageFactory
            ->get('public://example.jpg');
        $entity->save();
        // Create the base element that we'll use in the tests below.
        $path = $this->randomMachineName();
        $base_element = [
            '#theme' => 'image_formatter',
            '#image_style' => 'test',
            '#item' => $entity->image_test,
            '#url' => Url::fromUri('base:' . $path),
        ];
        // Test using theme_image_formatter() with a NULL value for the alt option.
        $element = $base_element;
        $this->setRawContent($renderer->renderRoot($element));
        $elements = $this->xpath('//a[@href=:path]/img[@src=:url and @width=:width and @height=:height]', [
            ':path' => base_path() . $path,
            ':url' => $url,
            ':width' => $image->getWidth(),
            ':height' => $image->getHeight(),
        ]);
        $this->assertCount(1, $elements, 'theme_image_formatter() correctly renders with a NULL value for the alt option.');
        // Test using theme_image_formatter() without an image title, alt text, or
        // link options.
        $element = $base_element;
        $element['#item']->alt = '';
        $this->setRawContent($renderer->renderRoot($element));
        $elements = $this->xpath('//a[@href=:path]/img[@src=:url and @width=:width and @height=:height and @alt=""]', [
            ':path' => base_path() . $path,
            ':url' => $url,
            ':width' => $image->getWidth(),
            ':height' => $image->getHeight(),
        ]);
        $this->assertCount(1, $elements, 'theme_image_formatter() correctly renders without title, alt, or path options.');
        // Link the image to a fragment on the page, and not a full URL.
        $fragment = $this->randomMachineName();
        $element = $base_element;
        $element['#url'] = Url::fromRoute('<none>', [], [
            'fragment' => $fragment,
        ]);
        $this->setRawContent($renderer->renderRoot($element));
        $elements = $this->xpath('//a[@href=:fragment]/img[@src=:url and @width=:width and @height=:height and @alt=""]', [
            ':fragment' => '#' . $fragment,
            ':url' => $url,
            ':width' => $image->getWidth(),
            ':height' => $image->getHeight(),
        ]);
        $this->assertCount(1, $elements, 'theme_image_formatter() correctly renders a link fragment.');
    }
    
    /**
     * Tests usage of the image style theme function.
     */
    public function testImageStyleTheme() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        // Create an image.
        $files = $this->drupalGetTestFiles('image');
        $file = reset($files);
        $original_uri = \Drupal::service('file_system')->copy($file->uri, 'public://', FileExists::Rename);
        // Create a style.
        $style = ImageStyle::create([
            'name' => 'image_test',
            'label' => 'Test',
        ]);
        $style->save();
        $url = \Drupal::service('file_url_generator')->transformRelative($style->buildUrl($original_uri));
        // Create the base element that we'll use in the tests below.
        $base_element = [
            '#theme' => 'image_style',
            '#style_name' => 'image_test',
            '#uri' => $original_uri,
        ];
        $element = $base_element;
        $this->setRawContent($renderer->renderRoot($element));
        $elements = $this->xpath('//img[@src=:url and @alt=""]', [
            ':url' => $url,
        ]);
        $this->assertCount(1, $elements, 'theme_image_style() renders an image correctly.');
        // Test using theme_image_style() with a NULL value for the alt option.
        $element = $base_element;
        $element['#alt'] = NULL;
        $this->setRawContent($renderer->renderRoot($element));
        $elements = $this->xpath('//img[@src=:url]', [
            ':url' => $url,
        ]);
        $this->assertCount(1, $elements, 'theme_image_style() renders an image correctly with a NULL value for the alt option.');
    }
    
    /**
     * Tests image alt attribute functionality.
     */
    public function testImageAltFunctionality() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        // Test using alt directly with alt attribute.
        $image_with_alt_property = [
            '#theme' => 'image',
            '#uri' => '/core/themes/olivero/logo.svg',
            '#alt' => 'Regular alt',
            '#title' => 'Test title',
            '#width' => '50%',
            '#height' => '50%',
            '#attributes' => [
                'class' => 'image-with-regular-alt',
                'id' => 'my-img',
            ],
        ];
        $this->setRawContent($renderer->renderRoot($image_with_alt_property));
        $elements = $this->xpath('//img[contains(@class, class) and contains(@alt, :alt)]', [
            ":class" => "image-with-regular-alt",
            ":alt" => "Regular alt",
        ]);
        $this->assertCount(1, $elements, 'Regular alt displays correctly');
        // Test using alt attribute inside attributes.
        $image_with_alt_attribute_alt_attribute = [
            '#theme' => 'image',
            '#uri' => '/core/themes/olivero/logo.svg',
            '#width' => '50%',
            '#height' => '50%',
            '#attributes' => [
                'class' => 'image-with-attribute-alt',
                'id' => 'my-img',
                'title' => 'New test title',
                'alt' => 'Attribute alt',
            ],
        ];
        $this->setRawContent($renderer->renderRoot($image_with_alt_attribute_alt_attribute));
        $elements = $this->xpath('//img[contains(@class, class) and contains(@alt, :alt)]', [
            ":class" => "image-with-attribute-alt",
            ":alt" => "Attribute alt",
        ]);
        $this->assertCount(1, $elements, 'Attribute alt displays correctly');
        // Test using alt attribute as property and inside attributes.
        $image_with_alt_attribute_both = [
            '#theme' => 'image',
            '#uri' => '/core/themes/olivero/logo.svg',
            '#width' => '50%',
            '#height' => '50%',
            '#alt' => 'Kitten sustainable',
            '#attributes' => [
                'class' => 'image-with-attribute-alt',
                'id' => 'my-img',
                'title' => 'New test title',
                'alt' => 'Attribute alt',
            ],
        ];
        $this->setRawContent($renderer->renderRoot($image_with_alt_attribute_both));
        $elements = $this->xpath('//img[contains(@class, class) and contains(@alt, :alt)]', [
            ":class" => "image-with-attribute-alt",
            ":alt" => "Attribute alt",
        ]);
        $this->assertCount(1, $elements, 'Attribute alt overrides alt property if both set.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
ImageThemeFunctionTest::$image protected property Created file entity.
ImageThemeFunctionTest::$imageFactory protected property
ImageThemeFunctionTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
ImageThemeFunctionTest::setUp protected function Overrides KernelTestBase::setUp
ImageThemeFunctionTest::testImageAltFunctionality public function Tests image alt attribute functionality.
ImageThemeFunctionTest::testImageFormatterTheme public function Tests usage of the image field formatters.
ImageThemeFunctionTest::testImageStyleTheme public function Tests usage of the image style theme function.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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