View source
<?php
namespace Drupal\Tests\image\Functional;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\StreamWrapper\StreamWrapperManager;
use Drupal\Core\Url;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\image\Entity\ImageStyle;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\Tests\TestFileCreationTrait;
use Drupal\user\RoleInterface;
class ImageFieldDisplayTest extends ImageFieldTestBase {
use AssertPageCacheContextsAndTagsTrait;
use TestFileCreationTrait {
getTestFiles as drupalGetTestFiles;
compareFiles as drupalCompareFiles;
}
protected static $modules = [
'field_ui',
];
protected $defaultTheme = 'stark';
public function testImageFieldFormattersPublic() {
$this
->_testImageFieldFormatters('public');
}
public function testImageFieldFormattersPrivate() {
user_role_change_permissions(RoleInterface::ANONYMOUS_ID, [
'access content' => FALSE,
]);
$this
->_testImageFieldFormatters('private');
}
public function _testImageFieldFormatters($scheme) {
$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);
$this
->drupalGet("admin/structure/types/manage/article/display");
$this
->submitForm([], "{$field_name}_settings_edit");
$this
->assertSession()
->linkByHrefExists(Url::fromRoute('entity.image_style.collection')
->toString(), 0, 'Link to image styles configuration is found');
$admin_user_roles = $this->adminUser
->getRoles(TRUE);
user_role_change_permissions(reset($admin_user_roles), [
'administer image styles' => FALSE,
]);
$this
->drupalGet("admin/structure/types/manage/article/display");
$this
->submitForm([], "{$field_name}_settings_edit");
$this
->assertSession()
->linkByHrefNotExists(Url::fromRoute('entity.image_style.collection')
->toString(), 'Link to image styles configuration is absent when permissions are insufficient');
user_role_change_permissions(reset($admin_user_roles), [
'administer image styles' => TRUE,
]);
$test_image = current($this
->drupalGetTestFiles('image'));
$this
->previewNodeImage($test_image, $field_name, 'article');
$instance
->setSetting('alt_field_required', 1);
$instance
->save();
$alt = $this
->randomMachineName();
$nid = $this
->uploadNodeImage($test_image, $field_name, 'article', $alt);
$node_storage
->resetCache([
$nid,
]);
$node = $node_storage
->load($nid);
$file = $node->{$field_name}->entity;
$image_uri = $file
->getFileUri();
$image = [
'#theme' => 'image',
'#uri' => $image_uri,
'#width' => 40,
'#height' => 20,
'#alt' => $alt,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->assertSession()
->responseContains($default_output);
$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,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = '<a href="' . $file
->createFileUrl() . '">' . $renderer
->renderRoot($image) . '</a>';
$this
->drupalGet('node/' . $nid);
$this
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $file
->getCacheTags()[0]);
$this
->assertCacheContext('url.site');
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$this
->assertSession()
->responseContains($default_output);
$this
->assertEquals(file_get_contents($test_image->uri), $this
->drupalGet($file
->createFileUrl(FALSE)), 'File was downloaded successfully.');
if ($scheme == 'private') {
$this
->assertSession()
->responseHeaderEquals('Content-Type', 'image/png');
$this
->assertSession()
->responseHeaderContains('Cache-Control', 'private');
$this
->drupalLogout();
$this
->drupalGet($file
->createFileUrl(FALSE));
$this
->assertSession()
->statusCodeEquals(403);
$this
->drupalLogin($this->adminUser);
}
$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
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $file
->getCacheTags()[0]);
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$elements = $this
->xpath('//a[@href=:path]/img[@src=:url and @alt=:alt and @width=:width and @height=:height]', [
':path' => $node
->toUrl()
->toString(),
':url' => $file
->createFileUrl(),
':width' => $image['#width'],
':height' => $image['#height'],
':alt' => $alt,
]);
$this
->assertCount(1, $elements, 'Image linked to content formatter displaying correctly on full node view.');
$display_options['settings']['image_link'] = '';
$display_options['settings']['image_style'] = 'thumbnail';
$display
->setComponent($field_name, $display_options)
->save();
$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,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = $renderer
->renderRoot($image_style);
$this
->drupalGet('node/' . $nid);
$image_style = ImageStyle::load('thumbnail');
$this
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $image_style
->getCacheTags()[0]);
$this
->assertSession()
->responseContains($default_output);
if ($scheme == 'private') {
$this
->drupalLogout();
$this
->drupalGet(ImageStyle::load('thumbnail')
->buildUrl($image_uri));
$this
->assertSession()
->statusCodeEquals(403);
}
$display_options = [
'type' => 'image_url',
'settings' => [
'image_style' => '',
],
];
$expected_url = $file
->createFileUrl();
$this
->assertEquals($expected_url, $node->{$field_name}
->view($display_options)[0]['#markup']);
$display_options['settings']['image_style'] = 'thumbnail';
$expected_url = \Drupal::service('file_url_generator')
->transformRelative(ImageStyle::load('thumbnail')
->buildUrl($image_uri));
$this
->assertEquals($expected_url, $node->{$field_name}
->view($display_options)[0]['#markup']);
}
public function testImageFieldSettings() {
$renderer = $this->container
->get('renderer');
$node_storage = $this->container
->get('entity_type.manager')
->getStorage('node');
$test_image = current($this
->drupalGetTestFiles('image'));
[
,
$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);
$this
->drupalGet('admin/structure/types/manage/article/fields/' . $field
->id());
$this
->assertSession()
->fieldValueEquals('settings[max_resolution][x]', '100');
$this
->assertSession()
->fieldValueEquals('settings[max_resolution][y]', '100');
$this
->assertSession()
->fieldValueEquals('settings[min_resolution][x]', '10');
$this
->assertSession()
->fieldValueEquals('settings[min_resolution][y]', '10');
$this
->drupalGet('node/add/article');
$this
->assertSession()
->pageTextContains('50 KB limit.');
$this
->assertSession()
->pageTextContains('Allowed types: ' . $test_image_extension . '.');
$this
->assertSession()
->pageTextContains('Images must be larger than 10x10 pixels. Images larger than 100x100 pixels will be resized.');
$alt = $this
->randomMachineName();
$nid = $this
->uploadNodeImage($test_image, $field_name, 'article', $alt);
$this
->drupalGet('node/' . $nid . '/edit');
$this
->assertSession()
->fieldValueEquals($field_name . '[0][alt]', $alt);
$this
->assertSession()
->fieldValueEquals($field_name . '[0][title]', '');
$node_storage
->resetCache([
$nid,
]);
$node = $node_storage
->load($nid);
$file = $node->{$field_name}->entity;
$file_url_generator = \Drupal::service('file_url_generator');
$url = $file_url_generator
->transformRelative(ImageStyle::load('medium')
->buildUrl($file
->getFileUri()));
$this
->assertSession()
->elementExists('css', 'img[width=40][height=20][src="' . $url . '"]');
$image = [
'#theme' => 'image',
'#uri' => $file
->getFileUri(),
'#alt' => $alt,
'#title' => $this
->randomMachineName(),
'#width' => 40,
'#height' => 20,
'#attributes' => [
'loading' => 'lazy',
],
];
$edit = [
$field_name . '[0][alt]' => $image['#alt'],
$field_name . '[0][title]' => $image['#title'],
];
$this
->drupalGet('node/' . $nid . '/edit');
$this
->submitForm($edit, 'Save');
$default_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->assertSession()
->responseContains($default_output);
$test_size = 2000;
$edit = [
$field_name . '[0][alt]' => $this
->randomMachineName($test_size),
$field_name . '[0][title]' => $this
->randomMachineName($test_size),
];
$this
->drupalGet('node/' . $nid . '/edit');
$this
->submitForm($edit, 'Save');
$schema = $field
->getFieldStorageDefinition()
->getSchema();
$this
->assertSession()
->statusMessageContains("Alternative text cannot be longer than {$schema['columns']['alt']['length']} characters but is currently {$test_size} characters long.", 'error');
$this
->assertSession()
->statusMessageContains("Title cannot be longer than {$schema['columns']['title']['length']} characters but is currently {$test_size} characters long.", 'error');
$this
->drupalGet('admin/structure/types/manage/article/fields/node.article.' . $field_name . '/storage');
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
], 'Save field settings');
$edit = [
'files[' . $field_name . '_1][]' => \Drupal::service('file_system')
->realpath($test_image->uri),
];
$this
->drupalGet('node/' . $node
->id() . '/edit');
$this
->submitForm($edit, 'Save');
$this
->submitForm([
$field_name . '[1][alt]' => $alt,
], 'Save');
$this
->assertSession()
->statusMessageContains('Article ' . $node
->getTitle() . ' has been updated.', 'status');
$this
->drupalGet('node/' . $node
->id() . '/edit');
$edit = [
'files[' . $field_name . '_2][]' => \Drupal::service('file_system')
->realpath($test_image->uri),
];
$this
->submitForm($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][]"]');
}
public function testImageLoadingAttribute() : void {
$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', [], $field_settings);
$this
->drupalGet("admin/structure/types/manage/article/display");
$this
->submitForm([], "{$field_name}_settings_edit");
$this
->assertSession()
->linkByHrefExists(Url::fromRoute('entity.image_style.collection')
->toString(), 0, 'Link to image styles configuration is found');
$admin_user_roles = $this->adminUser
->getRoles(TRUE);
user_role_change_permissions(reset($admin_user_roles), [
'administer image styles' => FALSE,
]);
$this
->drupalGet("admin/structure/types/manage/article/display");
$this
->submitForm([], "{$field_name}_settings_edit");
$this
->assertSession()
->linkByHrefNotExists(Url::fromRoute('entity.image_style.collection')
->toString(), 'Link to image styles configuration is absent when permissions are insufficient');
user_role_change_permissions(reset($admin_user_roles), [
'administer image styles' => TRUE,
]);
$test_image = current($this
->drupalGetTestFiles('image'));
$this
->previewNodeImage($test_image, $field_name, 'article');
$instance
->setSetting('alt_field_required', 1);
$instance
->save();
$alt = $this
->randomMachineName();
$nid = $this
->uploadNodeImage($test_image, $field_name, 'article', $alt);
$node_storage
->resetCache([
$nid,
]);
$node = $node_storage
->load($nid);
$file = $node->{$field_name}->entity;
$image_uri = $file
->getFileUri();
$image = [
'#theme' => 'image',
'#uri' => $image_uri,
'#width' => 40,
'#height' => 20,
'#alt' => $alt,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->assertSession()
->responseContains($default_output);
$display_options = [
'type' => 'image',
'settings' => [
'image_link' => '',
'image_style' => '',
'image_loading' => [
'attribute' => 'eager',
],
],
];
$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,
'#attributes' => [
'loading' => 'eager',
],
];
$default_output = $renderer
->renderRoot($image);
$this
->drupalGet('node/' . $nid);
$this
->assertSession()
->responseContains($default_output);
$display_options['settings']['image_style'] = 'thumbnail';
$display
->setComponent($field_name, $display_options)
->save();
$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,
'#attributes' => [
'loading' => 'eager',
],
];
$default_output = $renderer
->renderRoot($image_style);
$this
->drupalGet('node/' . $nid);
$this
->assertSession()
->responseContains($default_output);
}
public function testImageFieldDefaultImage() {
$renderer = $this->container
->get('renderer');
$node_storage = $this->container
->get('entity_type.manager')
->getStorage('node');
$field_name = strtolower($this
->randomMachineName());
$this
->createImageField($field_name, 'article');
$node = $this
->drupalCreateNode([
'type' => 'article',
]);
$this
->drupalGet('node/' . $node
->id());
$this
->assertSession()
->responseNotMatches('<div class="(.*?)field--name-' . strtr($field_name, '_', '-') . '(.*?)">');
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$images = $this
->drupalGetTestFiles('image');
$alt = $this
->randomString(512);
$title = $this
->randomString(1024);
$edit = [
'files[settings_default_image_uuid]' => \Drupal::service('file_system')
->realpath($images[0]->uri),
'settings[default_image][alt]' => $alt,
'settings[default_image][title]' => $title,
];
$this
->drupalGet("admin/structure/types/manage/article/fields/node.article.{$field_name}/storage");
$this
->submitForm($edit, 'Save field settings');
\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,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->drupalGet('node/' . $node
->id());
$this
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $file
->getCacheTags()[0]);
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$this
->assertSession()
->responseContains($default_output);
$alt = $this
->randomMachineName();
$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,
'#attributes' => [
'loading' => 'lazy',
],
];
$image_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->drupalGet('node/' . $nid);
$this
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $file
->getCacheTags()[0]);
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$this
->assertSession()
->responseNotContains($default_output);
$this
->assertSession()
->responseContains($image_output);
$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('Save field settings');
\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.');
$private_field_name = strtolower($this
->randomMachineName());
$this
->createImageField($private_field_name, 'article', [
'uri_scheme' => 'private',
]);
$edit = [
'files[settings_default_image_uuid]' => \Drupal::service('file_system')
->realpath($images[2]->uri),
'settings[default_image][alt]' => $alt,
'settings[default_image][title]' => $title,
];
$this
->drupalGet('admin/structure/types/manage/article/fields/node.article.' . $private_field_name . '/storage');
$this
->submitForm($edit, 'Save field settings');
\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
->assertEquals('private', StreamWrapperManager::getScheme($file
->getFileUri()), 'Default image uses private:// scheme.');
$this
->assertTrue($file
->isPermanent(), 'The default image status is permanent.');
$node = $this
->drupalCreateNode([
'type' => 'article',
]);
$image = [
'#theme' => 'image',
'#uri' => $file
->getFileUri(),
'#alt' => $alt,
'#title' => $title,
'#width' => 40,
'#height' => 20,
'#attributes' => [
'loading' => 'lazy',
],
];
$default_output = str_replace("\n", '', $renderer
->renderRoot($image));
$this
->drupalGet('node/' . $node
->id());
$this
->assertSession()
->responseHeaderContains('X-Drupal-Cache-Tags', $file
->getCacheTags()[0]);
$this
->assertSession()
->responseHeaderNotContains('X-Drupal-Cache-Tags', 'image_style:');
$this
->assertSession()
->responseContains($default_output);
}
}