class FieldKernelTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/tests/src/Kernel/Handler/FieldKernelTest.php \Drupal\Tests\views\Kernel\Handler\FieldKernelTest
Tests the generic field handler.
@group views
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
- class \Drupal\Tests\views\Kernel\Handler\FieldKernelTest
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
Expanded class hierarchy of FieldKernelTest
See also
\Drupal\views\Plugin\views\field\FieldPluginBase
File
- core/
modules/ views/ tests/ src/ Kernel/ Handler/ FieldKernelTest.php, line 17
Namespace
Drupal\Tests\views\Kernel\HandlerView source
class FieldKernelTest extends ViewsKernelTestBase {
protected static $modules = [
'user',
];
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_view',
'test_field_tokens',
'test_field_argument_tokens',
'test_field_output',
];
/**
* Map column names.
*
* @var array
*/
protected $columnMap = [
'views_test_data_name' => 'name',
];
/**
* {@inheritdoc}
*/
protected function viewsData() {
$data = parent::viewsData();
$data['views_test_data']['job']['field']['id'] = 'test_field';
$data['views_test_data']['job']['field']['click sortable'] = FALSE;
$data['views_test_data']['id']['field']['click sortable'] = TRUE;
return $data;
}
/**
* Tests that the render function is called.
*/
public function testRender() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_field_tokens');
$this
->executeView($view);
$random_text = $this
->randomMachineName();
$view->field['job']
->setTestValue($random_text);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['job']
->theme($view->result[0]);
});
$this
->assertEquals($random_text, $output, 'Make sure the render method rendered the manual set value.');
}
/**
* Tests all things related to the query.
*/
public function testQuery() {
// Tests adding additional fields to the query.
$view = Views::getView('test_view');
$view
->initHandlers();
$id_field = $view->field['id'];
$id_field->additional_fields['job'] = 'job';
// Choose also a field alias key which doesn't match to the table field.
$id_field->additional_fields['created_test'] = [
'table' => 'views_test_data',
'field' => 'created',
];
$view
->build();
// Make sure the field aliases have the expected value.
$this
->assertEquals('views_test_data_job', $id_field->aliases['job']);
$this
->assertEquals('views_test_data_created', $id_field->aliases['created_test']);
$this
->executeView($view);
// Tests the getValue method with and without a field aliases.
foreach ($this
->dataSet() as $key => $row) {
$id = $key + 1;
$result = $view->result[$key];
$this
->assertEquals($id, $id_field
->getValue($result));
$this
->assertEquals($row['job'], $id_field
->getValue($result, 'job'));
$this
->assertEquals($row['created'], $id_field
->getValue($result, 'created_test'));
}
}
/**
* Asserts that a string is part of another string.
*
* @param string $haystack
* The value to search in.
* @param string $needle
* The value to search for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param string $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*/
protected function assertSubString($haystack, $needle, $message = '', $group = 'Other') {
$this
->assertStringContainsString($needle, $haystack, $message);
}
/**
* Asserts that a string is not part of another string.
*
* @param string $haystack
* The value to search in.
* @param string $needle
* The value to search for.
* @param string $message
* (optional) A message to display with the assertion. Do not translate
* messages: use \Drupal\Component\Render\FormattableMarkup to embed
* variables in the message text, not t(). If left blank, a default message
* will be displayed.
* @param string $group
* (optional) The group this message is in, which is displayed in a column
* in test output. Use 'Debug' to indicate this is debugging output. Do not
* translate this string. Defaults to 'Other'; most tests do not override
* this default.
*/
protected function assertNotSubString($haystack, $needle, $message = '', $group = 'Other') {
$this
->assertStringNotContainsString($needle, $haystack, $message);
}
/**
* Tests general rewriting of the output.
*/
public function testRewrite() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->initHandlers();
$this
->executeView($view);
$row = $view->result[0];
$id_field = $view->field['id'];
// Don't check the rewrite checkbox, so the text shouldn't appear.
$id_field->options['alter']['text'] = $random_text = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertNotSubString($output, $random_text);
$id_field->options['alter']['alter_text'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, $random_text);
}
/**
* Tests rewriting of the output with HTML.
*/
public function testRewriteHtmlWithTokens() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->initHandlers();
$this
->executeView($view);
$row = $view->result[0];
$id_field = $view->field['id'];
$id_field->options['alter']['text'] = '<p>{{ id }}</p>';
$id_field->options['alter']['alter_text'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, '<p>1</p>');
// Add a non-safe HTML tag and make sure this gets removed.
$id_field->options['alter']['text'] = '<p>{{ id }} <script>alert("Script removed")</script></p>';
$id_field->options['alter']['alter_text'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, '<p>1 alert("Script removed")</p>');
}
/**
* Tests rewriting of the output with HTML and aggregation.
*/
public function testRewriteHtmlWithTokensAndAggregation() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->setDisplay();
$view->displayHandlers
->get('default')->options['fields']['id']['group_type'] = 'sum';
$view->displayHandlers
->get('default')
->setOption('group_by', TRUE);
$view
->initHandlers();
$this
->executeView($view);
$row = $view->result[0];
$id_field = $view->field['id'];
$id_field->options['alter']['text'] = '<p>{{ id }}</p>';
$id_field->options['alter']['alter_text'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, '<p>1</p>');
// Add a non-safe HTML tag and make sure this gets removed.
$id_field->options['alter']['text'] = '<p>{{ id }} <script>alert("Script removed")</script></p>';
$id_field->options['alter']['alter_text'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, '<p>1 alert("Script removed")</p>');
}
/**
* Tests the arguments tokens on field level.
*/
public function testArgumentTokens() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_field_argument_tokens');
$this
->executeView($view, [
'{{ { "#pre_render": ["\\Drupal\\views_test_data\\Controller\\ViewsTestDataController::preRender"]} }}',
]);
$name_field_0 = $view->field['name'];
// Test the old style tokens.
$name_field_0->options['alter']['alter_text'] = TRUE;
$name_field_0->options['alter']['text'] = '%1 !1';
$row = $view->result[0];
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field_0, $row) {
return $name_field_0
->advancedRender($row);
});
$this
->assertStringNotContainsString('\\Drupal\\views_test_data\\Controller\\ViewsTestDataController::preRender executed', (string) $output, 'Ensure that the pre_render function was not executed');
$this
->assertEquals('%1 !1', (string) $output, "Ensure that old style placeholders aren't replaced");
// This time use new style tokens but ensure that we still don't allow
// arbitrary code execution.
$name_field_0->options['alter']['alter_text'] = TRUE;
$name_field_0->options['alter']['text'] = '{{ arguments.null }} {{ raw_arguments.null }}';
$row = $view->result[0];
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field_0, $row) {
return $name_field_0
->advancedRender($row);
});
$this
->assertStringNotContainsString('\\Drupal\\views_test_data\\Controller\\ViewsTestDataController::preRender executed', (string) $output, 'Ensure that the pre_render function was not executed');
$this
->assertEquals('{{ { "#pre_render": ["\\Drupal\\views_test_data\\Controller\\ViewsTestDataController::preRender"]} }} {{ { "#pre_render": ["\\Drupal\\views_test_data\\Controller\\ViewsTestDataController::preRender"]} }}', (string) $output, 'Ensure that new style placeholders are replaced');
}
/**
* Tests the field tokens, row level and field level.
*/
public function testFieldTokens() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_field_tokens');
$this
->executeView($view);
$name_field_0 = $view->field['name'];
$name_field_1 = $view->field['name_1'];
$name_field_2 = $view->field['name_2'];
$row = $view->result[0];
$name_field_0->options['alter']['alter_text'] = TRUE;
$name_field_0->options['alter']['text'] = '{{ name }}';
$name_field_1->options['alter']['alter_text'] = TRUE;
$name_field_1->options['alter']['text'] = '{{ name_1 }} {{ name }}';
$name_field_2->options['alter']['alter_text'] = TRUE;
$name_field_2->options['alter']['text'] = '{% if name_2|length > 3 %}{{ name_2 }} {{ name_1 }}{% endif %}';
foreach ($view->result as $row) {
$expected_output_0 = $row->views_test_data_name;
$expected_output_1 = "{$row->views_test_data_name} {$row->views_test_data_name}";
$expected_output_2 = "{$row->views_test_data_name} {$row->views_test_data_name} {$row->views_test_data_name}";
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field_0, $row) {
return $name_field_0
->advancedRender($row);
});
$this
->assertEquals($expected_output_0, $output, new FormattableMarkup('Test token replacement: "@token" gave "@output"', [
'@token' => $name_field_0->options['alter']['text'],
'@output' => $output,
]));
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field_1, $row) {
return $name_field_1
->advancedRender($row);
});
$this
->assertEquals($expected_output_1, $output, new FormattableMarkup('Test token replacement: "@token" gave "@output"', [
'@token' => $name_field_1->options['alter']['text'],
'@output' => $output,
]));
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field_2, $row) {
return $name_field_2
->advancedRender($row);
});
$this
->assertEquals($expected_output_2, $output, new FormattableMarkup('Test token replacement: "@token" gave "@output"', [
'@token' => $name_field_2->options['alter']['text'],
'@output' => $output,
]));
}
$job_field = $view->field['job'];
$job_field->options['alter']['alter_text'] = TRUE;
$job_field->options['alter']['text'] = '{{ job }}';
$random_text = $this
->randomMachineName();
$job_field
->setTestValue($random_text);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($job_field, $row) {
return $job_field
->advancedRender($row);
});
$this
->assertSubString($output, $random_text, new FormattableMarkup('Make sure the self token (@token => @value) appears in the output (@output)', [
'@value' => $random_text,
'@output' => $output,
'@token' => $job_field->options['alter']['text'],
]));
// Verify the token format used in D7 and earlier does not get substituted.
$old_token = '[job]';
$job_field->options['alter']['text'] = $old_token;
$random_text = $this
->randomMachineName();
$job_field
->setTestValue($random_text);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($job_field, $row) {
return $job_field
->advancedRender($row);
});
$this
->assertEquals($old_token, $output, new FormattableMarkup('Make sure the old token style (@token => @value) is not changed in the output (@output)', [
'@value' => $random_text,
'@output' => $output,
'@token' => $job_field->options['alter']['text'],
]));
// Verify HTML tags are allowed in rewrite templates while token
// replacements are escaped.
$job_field->options['alter']['text'] = '<h1>{{ job }}</h1>';
$random_text = $this
->randomMachineName();
$job_field
->setTestValue('<span>' . $random_text . '</span>');
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($job_field, $row) {
return $job_field
->advancedRender($row);
});
$this
->assertEquals('<h1><span>' . $random_text . '</span></h1>', $output, 'Valid tags are allowed in rewrite templates and token replacements.');
// Verify <script> tags are correctly removed from rewritten text.
$rewrite_template = '<script>alert("malicious");</script>';
$job_field->options['alter']['text'] = $rewrite_template;
$random_text = $this
->randomMachineName();
$job_field
->setTestValue($random_text);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($job_field, $row) {
return $job_field
->advancedRender($row);
});
$this
->assertNotSubString($output, '<script>', 'Ensure a script tag in the rewrite template is removed.');
$rewrite_template = '<script>{{ job }}</script>';
$job_field->options['alter']['text'] = $rewrite_template;
$random_text = $this
->randomMachineName();
$job_field
->setTestValue($random_text);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($job_field, $row) {
return $job_field
->advancedRender($row);
});
$this
->assertEquals($random_text, $output, new FormattableMarkup('Make sure a script tag in the template (@template) is removed, leaving only the replaced token in the output (@output)', [
'@output' => $output,
'@template' => $rewrite_template,
]));
}
/**
* Tests the exclude setting.
*/
public function testExclude() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$view = Views::getView('test_field_output');
$view
->initHandlers();
// Hide the field and see whether it's rendered.
$view->field['name']->options['exclude'] = TRUE;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
foreach ($this
->dataSet() as $entry) {
$this
->assertNotSubString($output, $entry['name']);
}
// Show and check the field.
$view->field['name']->options['exclude'] = FALSE;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
foreach ($this
->dataSet() as $entry) {
$this
->assertSubString($output, $entry['name']);
}
}
/**
* Tests everything related to empty output of a field.
*/
public function testEmpty() {
$this
->_testHideIfEmpty();
$this
->_testEmptyText();
}
/**
* Tests the hide if empty functionality.
*
* This tests alters the result to get easier and less coupled results. It is
* important that assertSame() is used in this test since in PHP 0 == ''.
*/
public function _testHideIfEmpty() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->initDisplay();
$this
->executeView($view);
$column_map_reversed = array_flip($this->columnMap);
$view->row_index = 0;
$random_name = $this
->randomMachineName();
$random_value = $this
->randomMachineName();
// Test when results are not rewritten and empty values are not hidden.
$view->field['name']->options['hide_alter_empty'] = FALSE;
$view->field['name']->options['hide_empty'] = FALSE;
$view->field['name']->options['empty_zero'] = FALSE;
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'By default, a string should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'By default, "" should not be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame('0', (string) $render, 'By default, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'By default, "0" should not be treated as empty.');
// Test when results are not rewritten and non-zero empty values are hidden.
$view->field['name']->options['hide_alter_empty'] = TRUE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = FALSE;
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If hide_empty is checked, a string should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If hide_empty is checked, "" should be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame('0', (string) $render, 'If hide_empty is checked, but not empty_zero, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If hide_empty is checked, but not empty_zero, "0" should not be treated as empty.');
// Test when results are not rewritten and all empty values are hidden.
$view->field['name']->options['hide_alter_empty'] = TRUE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = TRUE;
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If hide_empty and empty_zero are checked, 0 should be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If hide_empty and empty_zero are checked, "0" should be treated as empty.');
// Test when results are rewritten to a valid string and non-zero empty
// results are hidden.
$view->field['name']->options['hide_alter_empty'] = FALSE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = FALSE;
$view->field['name']->options['alter']['alter_text'] = TRUE;
$view->field['name']->options['alter']['text'] = $random_name;
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_value;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If the rewritten string is not empty, it should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If the rewritten string is not empty, "" should not be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If the rewritten string is not empty, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If the rewritten string is not empty, "0" should not be treated as empty.');
// Test when results are rewritten to an empty string and non-zero empty results are hidden.
$view->field['name']->options['hide_alter_empty'] = TRUE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = FALSE;
$view->field['name']->options['alter']['alter_text'] = TRUE;
$view->field['name']->options['alter']['text'] = "";
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_name, (string) $render, 'If the rewritten string is empty, it should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If the rewritten string is empty, "" should be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame('0', (string) $render, 'If the rewritten string is empty, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If the rewritten string is empty, "0" should not be treated as empty.');
// Test when results are rewritten to zero as a string and non-zero empty
// results are hidden.
$view->field['name']->options['hide_alter_empty'] = FALSE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = FALSE;
$view->field['name']->options['alter']['alter_text'] = TRUE;
$view->field['name']->options['alter']['text'] = "0";
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If the rewritten string is zero and empty_zero is not checked, the string rewritten as 0 should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If the rewritten string is zero and empty_zero is not checked, "" rewritten as 0 should not be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If the rewritten string is zero and empty_zero is not checked, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If the rewritten string is zero and empty_zero is not checked, "0" should not be treated as empty.');
// Test when results are rewritten to a valid string and non-zero empty
// results are hidden.
$view->field['name']->options['hide_alter_empty'] = TRUE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = FALSE;
$view->field['name']->options['alter']['alter_text'] = TRUE;
$view->field['name']->options['alter']['text'] = $random_value;
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_value, (string) $render, 'If the original and rewritten strings are valid, it should not be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If either the original or rewritten string is invalid, "" should be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_value, (string) $render, 'If the original and rewritten strings are valid, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($random_value, (string) $render, 'If the original and rewritten strings are valid, "0" should not be treated as empty.');
// Test when results are rewritten to zero as a string and all empty
// original values and results are hidden.
$view->field['name']->options['hide_alter_empty'] = TRUE;
$view->field['name']->options['hide_empty'] = TRUE;
$view->field['name']->options['empty_zero'] = TRUE;
$view->field['name']->options['alter']['alter_text'] = TRUE;
$view->field['name']->options['alter']['text'] = "0";
// Test a valid string.
$view->result[0]->{$column_map_reversed['name']} = $random_name;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", (string) $render, 'If the rewritten string is zero, it should be treated as empty.');
// Test an empty string.
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If the rewritten string is zero, "" should be treated as empty.');
// Test zero as an integer.
$view->result[0]->{$column_map_reversed['name']} = 0;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If the rewritten string is zero, 0 should not be treated as empty.');
// Test zero as a string.
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("", $render, 'If the rewritten string is zero, "0" should not be treated as empty.');
}
/**
* Tests the usage of the empty text.
*/
public function _testEmptyText() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->initDisplay();
$this
->executeView($view);
$column_map_reversed = array_flip($this->columnMap);
$view->row_index = 0;
$empty_text = $view->field['name']->options['empty'] = $this
->randomMachineName();
$view->result[0]->{$column_map_reversed['name']} = "";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($empty_text, (string) $render, 'If a field is empty, the empty text should be used for the output.');
$view->result[0]->{$column_map_reversed['name']} = "0";
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame("0", (string) $render, 'If a field is 0 and empty_zero is not checked, the empty text should not be used for the output.');
$view->result[0]->{$column_map_reversed['name']} = "0";
$view->field['name']->options['empty_zero'] = TRUE;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($empty_text, (string) $render, 'If a field is 0 and empty_zero is checked, the empty text should be used for the output.');
$view->result[0]->{$column_map_reversed['name']} = "";
$view->field['name']->options['alter']['alter_text'] = TRUE;
$alter_text = $view->field['name']->options['alter']['text'] = $this
->randomMachineName();
$view->field['name']->options['hide_alter_empty'] = FALSE;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($alter_text, (string) $render, 'If a field is empty, some rewrite text exists, but hide_alter_empty is not checked, render the rewrite text.');
$view->field['name']->options['hide_alter_empty'] = TRUE;
$render = $renderer
->executeInRenderContext(new RenderContext(), function () use ($view) {
return $view->field['name']
->advancedRender($view->result[0]);
});
$this
->assertSame($empty_text, (string) $render, 'If a field is empty, some rewrite text exists, and hide_alter_empty is checked, use the empty text.');
}
/**
* Tests views_handler_field::isValueEmpty().
*/
public function testIsValueEmpty() {
$view = Views::getView('test_view');
$view
->initHandlers();
$field = $view->field['name'];
$this
->assertFalse($field
->isValueEmpty("not empty", TRUE), 'A normal string is not empty.');
$this
->assertTrue($field
->isValueEmpty("not empty", TRUE, FALSE), 'A normal string which skips empty() can be seen as empty.');
$this
->assertTrue($field
->isValueEmpty("", TRUE), '"" is considered as empty.');
$this
->assertTrue($field
->isValueEmpty('0', TRUE), '"0" is considered as empty if empty_zero is TRUE.');
$this
->assertTrue($field
->isValueEmpty(0, TRUE), '0 is considered as empty if empty_zero is TRUE.');
$this
->assertFalse($field
->isValueEmpty('0', FALSE), '"0" is considered not as empty if empty_zero is FALSE.');
$this
->assertFalse($field
->isValueEmpty(0, FALSE), '0 is considered not as empty if empty_zero is FALSE.');
$this
->assertTrue($field
->isValueEmpty(NULL, TRUE, TRUE), 'Null should be always seen as empty, regardless of no_skip_empty.');
$this
->assertTrue($field
->isValueEmpty(NULL, TRUE, FALSE), 'Null should be always seen as empty, regardless of no_skip_empty.');
}
/**
* Tests whether the filters are click sortable as expected.
*/
public function testClickSortable() {
// Test that clickSortable is TRUE by default.
$item = [
'table' => 'views_test_data',
'field' => 'name',
];
$plugin = $this->container
->get('plugin.manager.views.field')
->getHandler($item);
$this
->assertTrue($plugin
->clickSortable(), 'TRUE as a default value is correct.');
// Test that clickSortable is TRUE by when set TRUE in the data.
$item['field'] = 'id';
$plugin = $this->container
->get('plugin.manager.views.field')
->getHandler($item);
$this
->assertTrue($plugin
->clickSortable(), 'TRUE as a views data value is correct.');
// Test that clickSortable is FALSE by when set FALSE in the data.
$item['field'] = 'job';
$plugin = $this->container
->get('plugin.manager.views.field')
->getHandler($item);
$this
->assertFalse($plugin
->clickSortable(), 'FALSE as a views data value is correct.');
}
/**
* Tests the trimText method.
*/
public function testTrimText() {
// Test unicode. See https://www.drupal.org/node/513396#comment-2839416.
// cSpell:disable
$text = [
'Tuy nhiên, những hi vọng',
'Giả sử chúng tôi có 3 Apple',
'siêu nhỏ này là bộ xử lý',
'Di động của nhà sản xuất Phần Lan',
'khoảng cách từ đại lí đến',
'của hãng bao gồm ba dòng',
'сд асд асд ас',
'асд асд асд ас',
];
// Just test maxlength without word boundary.
$alter = [
'max_length' => 10,
];
$expect = [
'Tuy nhiên,',
'Giả sử chú',
'siêu nhỏ n',
'Di động củ',
'khoảng các',
'của hãng b',
'сд асд асд',
'асд асд ас',
];
foreach ($text as $key => $line) {
$result_text = FieldPluginBase::trimText($alter, $line);
$this
->assertEquals($expect[$key], $result_text);
}
// Test also word_boundary
$alter['word_boundary'] = TRUE;
$expect = [
'Tuy nhiên',
'Giả sử',
'siêu nhỏ',
'Di động',
'khoảng',
'của hãng',
'сд асд',
'асд асд',
];
foreach ($text as $key => $line) {
$result_text = FieldPluginBase::trimText($alter, $line);
$this
->assertEquals($expect[$key], $result_text);
}
// cSpell:enable
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FieldKernelTest:: |
protected | property | Map column names. | |
FieldKernelTest:: |
protected static | property |
Modules to enable. Overrides ViewsKernelTestBase:: |
|
FieldKernelTest:: |
public static | property |
Views used by this test. Overrides ViewsKernelTestBase:: |
|
FieldKernelTest:: |
protected | function | Asserts that a string is not part of another string. | |
FieldKernelTest:: |
protected | function | Asserts that a string is part of another string. | |
FieldKernelTest:: |
public | function | Tests the arguments tokens on field level. | |
FieldKernelTest:: |
public | function | Tests whether the filters are click sortable as expected. | |
FieldKernelTest:: |
public | function | Tests everything related to empty output of a field. | |
FieldKernelTest:: |
public | function | Tests the exclude setting. | |
FieldKernelTest:: |
public | function | Tests the field tokens, row level and field level. | |
FieldKernelTest:: |
public | function | Tests views_handler_field::isValueEmpty(). | |
FieldKernelTest:: |
public | function | Tests all things related to the query. | |
FieldKernelTest:: |
public | function | Tests that the render function is called. | |
FieldKernelTest:: |
public | function | Tests general rewriting of the output. | |
FieldKernelTest:: |
public | function | Tests rewriting of the output with HTML. | |
FieldKernelTest:: |
public | function | Tests rewriting of the output with HTML and aggregation. | |
FieldKernelTest:: |
public | function | Tests the trimText method. | |
FieldKernelTest:: |
protected | function |
Returns the views data definition. Overrides ViewsKernelTestBase:: |
|
FieldKernelTest:: |
public | function | Tests the usage of the empty text. | |
FieldKernelTest:: |
public | function | Tests the hide if empty functionality. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View matches expected values. | |
ViewResultAssertionTrait:: |
protected | function | Performs View result assertions. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View differs from certain values. | |
ViewsKernelTestBase:: |
protected | function | Returns a very simple test dataset. | 8 |
ViewsKernelTestBase:: |
protected | function | Executes a view. | |
ViewsKernelTestBase:: |
protected | function | Orders a nested array containing a result set based on a given column. | |
ViewsKernelTestBase:: |
protected | function | Returns the schema definition. | 6 |
ViewsKernelTestBase:: |
protected | function |
Overrides KernelTestBase:: |
66 |
ViewsKernelTestBase:: |
protected | function | Sets up the configuration and schema of views and views_test_data modules. | 7 |