TextFieldTest.php
Same filename in this branch
Same filename in other branches
- 9 core/modules/text/tests/src/Unit/Migrate/d6/TextFieldTest.php
- 9 core/modules/text/tests/src/Unit/Migrate/d7/TextFieldTest.php
- 9 core/modules/text/tests/src/Unit/Plugin/migrate/field/d6/TextFieldTest.php
- 9 core/modules/text/tests/src/Unit/Plugin/migrate/field/d7/TextFieldTest.php
- 9 core/modules/text/tests/src/Functional/TextFieldTest.php
- 9 core/tests/Drupal/Tests/Core/Render/Element/TextfieldTest.php
- 8.9.x core/modules/text/tests/src/Unit/Migrate/d6/TextFieldTest.php
- 8.9.x core/modules/text/tests/src/Unit/Migrate/d7/TextFieldTest.php
- 8.9.x core/modules/text/tests/src/Unit/Plugin/migrate/field/d6/TextFieldTest.php
- 8.9.x core/modules/text/tests/src/Unit/Plugin/migrate/field/d7/TextFieldTest.php
- 8.9.x core/modules/text/tests/src/Functional/TextFieldTest.php
- 8.9.x core/tests/Drupal/Tests/Core/Render/Element/TextfieldTest.php
- 10 core/modules/text/tests/src/Unit/Plugin/migrate/field/d6/TextFieldTest.php
- 10 core/modules/text/tests/src/Unit/Plugin/migrate/field/d7/TextFieldTest.php
- 10 core/modules/text/tests/src/Functional/TextFieldTest.php
- 10 core/tests/Drupal/Tests/Core/Render/Element/TextfieldTest.php
Namespace
Drupal\Tests\text\FunctionalFile
-
core/
modules/ text/ tests/ src/ Functional/ TextFieldTest.php
View source
<?php
declare (strict_types=1);
namespace Drupal\Tests\text\Functional;
use Drupal\Component\Utility\Html;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\filter\Entity\FilterFormat;
use Drupal\filter\Render\FilteredMarkup;
use Drupal\Tests\field\Functional\FunctionalString\StringFieldTest;
use Drupal\Tests\TestFileCreationTrait;
/**
* Tests the creation of text fields.
*
* @group text
*/
class TextFieldTest extends StringFieldTest {
use TestFileCreationTrait {
getTestFiles as drupalGetTestFiles;
}
/**
* {@inheritdoc}
*/
protected static $modules = [
'entity_test',
'file',
'field_ui',
];
/**
* A user with relevant administrative privileges.
*
* @var \Drupal\user\UserInterface
*/
protected $adminUser;
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->adminUser = $this->drupalCreateUser([
'administer filters',
'administer entity_test fields',
]);
}
// Test fields.
/**
* Tests text field validation.
*/
public function testTextFieldValidation() : void {
// Create a field with settings to validate.
$max_length = 3;
$field_name = $this->randomMachineName();
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'text',
'settings' => [
'max_length' => $max_length,
],
]);
$field_storage->save();
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
])->save();
// Test validation with valid and invalid values.
$entity = EntityTest::create();
for ($i = 0; $i <= $max_length + 2; $i++) {
$entity->{$field_name}->value = str_repeat('x', $i);
$violations = $entity->{$field_name}
->validate();
if ($i <= $max_length) {
$this->assertCount(0, $violations, "Length {$i} does not cause validation error when max_length is {$max_length}");
}
else {
$this->assertCount(1, $violations, "Length {$i} causes validation error when max_length is {$max_length}");
}
}
}
/**
* Tests required long text with file upload.
*/
public function testRequiredLongTextWithFileUpload() : void {
// Create a text field.
$text_field_name = 'text_long';
$field_storage = FieldStorageConfig::create([
'field_name' => $text_field_name,
'entity_type' => 'entity_test',
'type' => 'text_with_summary',
]);
$field_storage->save();
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
'label' => $this->randomMachineName() . '_label',
'required' => TRUE,
])
->save();
// Create a file field.
$file_field_name = 'file_field';
$field_storage = FieldStorageConfig::create([
'field_name' => $file_field_name,
'entity_type' => 'entity_test',
'type' => 'file',
]);
$field_storage->save();
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
'label' => $this->randomMachineName() . '_label',
])
->save();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
$display_repository->getFormDisplay('entity_test', 'entity_test')
->setComponent($text_field_name, [
'type' => 'text_textarea_with_summary',
])
->setComponent($file_field_name, [
'type' => 'file_generic',
])
->save();
$display_repository->getViewDisplay('entity_test', 'entity_test', 'full')
->setComponent($text_field_name)
->setComponent($file_field_name)
->save();
$test_file = current($this->drupalGetTestFiles('text'));
$edit['files[file_field_0]'] = \Drupal::service('file_system')->realpath($test_file->uri);
$this->drupalGet('entity_test/add');
$this->submitForm($edit, 'Upload');
$this->assertSession()
->statusCodeEquals(200);
$edit = [
'text_long[0][value]' => 'Long text',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->statusCodeEquals(200);
$this->drupalGet('entity_test/1');
$this->assertSession()
->pageTextContains('Long text');
}
/**
* Tests widgets.
*/
public function testTextfieldWidgets() : void {
$this->_testTextfieldWidgets('text', 'text_textfield');
$this->_testTextfieldWidgets('text_long', 'text_textarea');
}
/**
* Tests widgets + 'formatted_text' setting.
*/
public function testTextfieldWidgetsFormatted() : void {
$this->_testTextfieldWidgetsFormatted('text', 'text_textfield');
$this->_testTextfieldWidgetsFormatted('text_long', 'text_textarea');
}
/**
* Test widgets for fields with selected allowed formats.
*/
public function testTextfieldWidgetsAllowedFormats() : void {
// Create one text format.
$this->drupalLogin($this->adminUser);
$format1 = FilterFormat::create([
'format' => $this->randomMachineName(),
'name' => '1_' . $this->randomMachineName(),
]);
$format1->save();
// Create a second text format.
$format2 = FilterFormat::create([
'format' => $this->randomMachineName(),
'name' => '2_' . $this->randomMachineName(),
'filters' => [
'filter_html' => [
'status' => 1,
'settings' => [
'allowed_html' => '<strong>',
],
],
],
]);
$format2->save();
// Create a third text format.
$format3 = FilterFormat::create([
'format' => $this->randomMachineName(),
'name' => '3_' . $this->randomMachineName(),
]);
$format3->save();
// Grant access to both formats to the user.
$roles = $this->webUser
->getRoles();
$rid = $roles[0];
user_role_grant_permissions($rid, [
$format1->getPermissionName(),
$format2->getPermissionName(),
$format3->getPermissionName(),
]);
// Create a field with multiple formats allowed.
$field_name = $this->randomMachineName();
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'text',
]);
$field_storage->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
'label' => $this->randomMachineName() . '_label',
'settings' => [
'allowed_formats' => [],
],
]);
$field->save();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository */
$entity_display_repository = $this->container
->get('entity_display.repository');
$entity_display_repository->getFormDisplay('entity_test', 'entity_test', 'default')
->setComponent($field_name, [
'type' => 'text_textfield',
])
->save();
$entity_display_repository->getViewDisplay('entity_test', 'entity_test', 'full')
->setComponent($field_name)
->save();
// Display the creation form.
$this->drupalLogin($this->webUser);
$this->drupalGet('entity_test/add');
$this->assertSession()
->fieldExists("{$field_name}[0][value]", NULL);
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format1->id());
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format2->id());
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format3->id());
$filtered_markup = FilteredMarkup::create('<div><strong><span>Hello World</span></strong></div>');
$edit = [
"{$field_name}[0][value]" => $filtered_markup,
];
$this->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
$id = $match[1];
$this->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
// Display the entity.
$entity = EntityTest::load($id);
$display = $entity_display_repository->getViewDisplay($entity->getEntityTypeId(), $entity->bundle(), 'full');
$content = $display->build($entity);
$rendered_entity = \Drupal::service('renderer')->renderRoot($content);
$this->assertStringContainsString('<div><strong><span>', (string) $rendered_entity);
// Log back in as admin.
$this->drupalLogin($this->adminUser);
// Change field to allow only one format.
$path = "entity_test/structure/entity_test/fields/entity_test.entity_test.{$field_name}";
$this->drupalGet($path);
$this->submitForm([
"settings[allowed_formats][{$format1->id()}]" => $format1->id(),
], 'Save settings');
$this->drupalGet($path);
// Display the creation form.
$this->drupalLogin($this->webUser);
// We shouldn't have the 'format' selector since only one format is allowed.
$this->drupalGet('entity_test/add');
$this->assertSession()
->fieldExists("{$field_name}[0][value]", NULL);
$this->assertSession()
->fieldNotExists("{$field_name}[0][format]");
// Retest the entity renders fine even though filter2 is disabled.
$entity = EntityTest::load($id);
$display = $entity_display_repository->getViewDisplay($entity->getEntityTypeId(), $entity->bundle(), 'full');
$content = $display->build($entity);
$rendered_entity = \Drupal::service('renderer')->renderRoot($content);
$this->assertStringContainsString('<div><strong><span>', (string) $rendered_entity);
// Test when 2 of 3 formats are selected.
$field->setSetting('allowed_formats', [
$format1->id(),
$format2->id(),
]);
$field->save();
$this->drupalGet('entity_test/add');
// We should see the 'format' selector again.
$this->assertSession()
->fieldExists("{$field_name}[0][value]", NULL);
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format1->id());
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format2->id());
$this->assertSession()
->optionNotExists("{$field_name}[0][format]", $format3->id());
// Change field to allow all formats by configuring none as allowed.
$field->setSetting('allowed_formats', []);
$field->save();
$this->drupalGet('entity_test/add');
// We should see the 'format' selector again.
$this->assertSession()
->fieldExists("{$field_name}[0][value]", NULL);
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format1->id());
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format2->id());
$this->assertSession()
->optionExists("{$field_name}[0][format]", $format3->id());
}
/**
* Helper function for testTextfieldWidgetsFormatted().
*/
public function _testTextfieldWidgetsFormatted($field_type, $widget_type) : void {
// Create a field.
$field_name = $this->randomMachineName();
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => $field_type,
]);
$field_storage->save();
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
'label' => $this->randomMachineName() . '_label',
])
->save();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
$display_repository->getFormDisplay('entity_test', 'entity_test')
->setComponent($field_name, [
'type' => $widget_type,
])
->save();
$display_repository->getViewDisplay('entity_test', 'entity_test', 'full')
->setComponent($field_name)
->save();
// Disable all text formats besides the plain text fallback format.
$this->drupalLogin($this->adminUser);
foreach (filter_formats() as $format) {
if (!$format->isFallbackFormat()) {
$this->drupalGet('admin/config/content/formats/manage/' . $format->id() . '/disable');
$this->submitForm([], 'Disable');
}
}
$this->drupalLogin($this->webUser);
// Display the creation form. Since the user only has access to one format,
// no format selector will be displayed.
$this->drupalGet('entity_test/add');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][value]", '');
$this->assertSession()
->fieldNotExists("{$field_name}[0][format]");
// Submit with data that should be filtered.
$value = '<em>' . $this->randomMachineName() . '</em>';
$edit = [
"{$field_name}[0][value]" => $value,
];
$this->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
$id = $match[1];
$this->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
// Display the entity.
$entity = EntityTest::load($id);
$display = $display_repository->getViewDisplay($entity->getEntityTypeId(), $entity->bundle(), 'full');
$content = $display->build($entity);
$rendered_entity = \Drupal::service('renderer')->renderRoot($content);
$this->assertStringNotContainsString($value, (string) $rendered_entity);
$this->assertStringContainsString(Html::escape($value), (string) $rendered_entity);
// Create a new text format that does not escape HTML, and grant the user
// access to it.
$this->drupalLogin($this->adminUser);
$edit = [
'format' => $this->randomMachineName(),
'name' => $this->randomMachineName(),
];
$this->drupalGet('admin/config/content/formats/add');
$this->submitForm($edit, 'Save configuration');
filter_formats_reset();
$format = FilterFormat::load($edit['format']);
$format_id = $format->id();
$permission = $format->getPermissionName();
$roles = $this->webUser
->getRoles();
$rid = $roles[0];
user_role_grant_permissions($rid, [
$permission,
]);
$this->drupalLogin($this->webUser);
// Display edition form.
// We should now have a 'text format' selector.
$this->drupalGet('entity_test/manage/' . $id . '/edit');
$this->assertSession()
->fieldExists("{$field_name}[0][value]");
$this->assertSession()
->fieldExists("{$field_name}[0][format]");
// Edit and change the text format to the new one that was created.
$edit = [
"{$field_name}[0][format]" => $format_id,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('entity_test ' . $id . ' has been updated.');
// Display the entity.
$this->container
->get('entity_type.manager')
->getStorage('entity_test')
->resetCache([
$id,
]);
$entity = EntityTest::load($id);
$display = $display_repository->getViewDisplay($entity->getEntityTypeId(), $entity->bundle(), 'full');
$content = $display->build($entity);
$rendered_entity = \Drupal::service('renderer')->renderRoot($content);
$this->assertStringContainsString($value, (string) $rendered_entity);
}
}
Classes
Title | Deprecated | Summary |
---|---|---|
TextFieldTest | Tests the creation of text fields. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.