View source
<?php
namespace Drupal\Tests\views\Functional\Handler;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\UrlHelper;
use Drupal\Core\Render\RenderContext;
use Drupal\Core\Url;
use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Views;
class FieldWebTest extends ViewTestBase {
use AssertPageCacheContextsAndTagsTrait;
public static $testViews = [
'test_view',
'test_field_classes',
'test_field_output',
'test_click_sort',
'test_distinct_click_sorting',
];
protected static $modules = [
'node',
'language',
];
protected $defaultTheme = 'stark';
protected $columnMap = [
'views_test_data_name' => 'name',
];
protected function setUp($import_test_views = TRUE) : void {
parent::setUp($import_test_views);
$this
->enableViewsTestModule();
}
protected function viewsData() {
$data = parent::viewsData();
$data['views_test_data']['job']['field']['id'] = 'test_field';
return $data;
}
public function testClickSorting() {
$this
->drupalGet('test_click_sort');
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->linkByHrefExists(Url::fromRoute('<none>', [], [
'query' => [
'order' => 'id',
'sort' => 'asc',
],
])
->toString());
$this
->assertSession()
->linkByHrefExists(Url::fromRoute('<none>', [], [
'query' => [
'order' => 'name',
'sort' => 'desc',
],
])
->toString());
$this
->assertSession()
->linkByHrefNotExists(Url::fromRoute('<none>', [], [
'query' => [
'order' => 'created',
],
])
->toString());
$expected_contexts = [
'languages:language_interface',
'theme',
'url.query_args',
];
$this
->assertCacheContexts($expected_contexts);
$this
->clickLink('ID');
$href = Url::fromRoute('<none>', [], [
'query' => [
'order' => 'id',
'sort' => 'desc',
],
])
->toString();
$this
->assertSession()
->linkByHrefExists($href);
$ids = $this
->clickSortLoadIdsFromOutput();
$this
->assertEquals(range(1, 5), $ids);
$this
->assertSession()
->elementAttributeContains('xpath', "//a[@href='{$href}']", 'rel', 'nofollow');
$this
->clickLink('ID Sort descending');
$ids = $this
->clickSortLoadIdsFromOutput();
$this
->assertEquals(range(5, 1, -1), $ids);
}
public function testClickSortingDistinct() {
ConfigurableLanguage::createFromLangcode('es')
->save();
$node = $this
->drupalCreateNode();
$this
->drupalGet('test_distinct_click_sorting');
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->linkByHrefExists(Url::fromRoute('<none>', [], [
'query' => [
'order' => 'changed',
'sort' => 'desc',
],
])
->toString());
$this
->assertSession()
->pageTextContains($node
->getTitle());
$this
->clickLink('Changed');
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->pageTextContains($node
->getTitle());
}
protected function clickSortLoadIdsFromOutput() {
$fields = $this
->xpath("//td[contains(@class, 'views-field-id')]");
$ids = [];
foreach ($fields as $field) {
$ids[] = (int) $field
->getText();
}
return $ids;
}
protected function assertSubString($haystack, $needle, $message = '', $group = 'Other') {
$this
->assertStringContainsString($needle, $haystack, $message);
}
protected function assertNotSubString($haystack, $needle, $message = '', $group = 'Other') {
$this
->assertStringNotContainsString($needle, $haystack, $message);
}
protected function parseContent($content) {
$htmlDom = new \DOMDocument();
@$htmlDom
->loadHTML('<?xml encoding="UTF-8">' . $content);
$elements = simplexml_import_dom($htmlDom);
return $elements;
}
protected function xpathContent($content, $xpath, array $arguments = []) {
if ($elements = $this
->parseContent($content)) {
$xpath = $this
->assertSession()
->buildXPathQuery($xpath, $arguments);
$result = $elements
->xpath($xpath);
return $result ? $result : [];
}
else {
return FALSE;
}
}
public function testAlterUrl() {
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_view');
$view
->setDisplay();
$view
->initHandlers();
$this
->executeView($view);
$row = $view->result[0];
$id_field = $view->field['id'];
$id_field->options['alter']['make_link'] = TRUE;
$id_field->options['alter']['path'] = $path = $this
->randomMachineName();
$id_field->options['alter']['prefix'] = $prefix = $this
->randomMachineName();
$id_field->options['alter']['suffix'] = $suffix = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, $prefix);
$this
->assertSubString($output, $suffix);
unset($id_field->options['alter']['prefix']);
unset($id_field->options['alter']['suffix']);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, $path, 'Make sure that the path is part of the output');
foreach ([
FALSE,
TRUE,
] as $absolute) {
$alter =& $id_field->options['alter'];
$alter['path'] = 'node/123';
$expected_result = Url::fromRoute('entity.node.canonical', [
'node' => '123',
], [
'absolute' => $absolute,
])
->toString();
$alter['absolute'] = $absolute;
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($result, $expected_result);
$expected_result = Url::fromRoute('entity.node.canonical', [
'node' => '123',
], [
'fragment' => 'foo',
'absolute' => $absolute,
])
->toString();
$alter['path'] = 'node/123#foo';
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($result, $expected_result);
$expected_result = Url::fromRoute('entity.node.canonical', [
'node' => '123',
], [
'query' => [
'foo' => NULL,
],
'absolute' => $absolute,
])
->toString();
$alter['path'] = 'node/123?foo';
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($result, $expected_result);
$expected_result = Url::fromRoute('entity.node.canonical', [
'node' => '123',
], [
'query' => [
'foo' => 'bar',
'bar' => 'baz',
],
'absolute' => $absolute,
])
->toString();
$alter['path'] = 'node/123?foo=bar&bar=baz';
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString(Html::decodeEntities($result), Html::decodeEntities($expected_result));
$expected_result = Url::fromUserInput('/node/123', [
'query' => [
'foo' => NULL,
],
'fragment' => 'bar',
'absolute' => $absolute,
])
->toString();
$alter['path'] = 'node/123?foo#bar';
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString(Html::decodeEntities($result), Html::decodeEntities($expected_result));
$expected_result = Url::fromRoute('<front>', [], [
'absolute' => $absolute,
])
->toString();
$alter['path'] = '<front>';
$result = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($result, $expected_result);
}
$id_field->options['alter']['replace_spaces'] = TRUE;
$id_field->options['alter']['path'] = $path = $this
->randomMachineName() . ' ' . $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, str_replace(' ', '-', $path));
$id_field->options['alter']['replace_spaces'] = FALSE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString(urldecode($output), $path);
$id_field->options['alter']['external'] = TRUE;
$id_field->options['alter']['path'] = $path = 'www.drupal.org';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, 'http://www.drupal.org');
$id_field->options['alter']['external'] = FALSE;
$id_field->options['alter']['path'] = $path = 'www.drupal.org';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertNotSubString($output, 'http://www.drupal.org');
$id_field->options['alter']['path'] = $path = $this
->randomMachineName();
$id_field->options['alter']['path_case'] = 'none';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, $path);
$id_field->options['alter']['path_case'] = 'upper';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, strtoupper($path));
$id_field->options['alter']['path_case'] = 'lower';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, strtolower($path));
$id_field->options['alter']['path_case'] = 'ucfirst';
$id_field->options['alter']['path'] = 'drupal has a great community';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, UrlHelper::encodePath('Drupal has a great community'));
$id_field->options['alter']['path_case'] = 'ucwords';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$this
->assertSubString($output, UrlHelper::encodePath('Drupal Has A Great Community'));
unset($id_field->options['alter']['path_case']);
$id_field->options['alter']['link_class'] = $class = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$elements = $this
->xpathContent($output, '//a[contains(@class, :class)]', [
':class' => $class,
]);
$this
->assertNotEmpty($elements);
$id_field->options['alter']['link_class'] = '';
$id_field->options['alter']['alt'] = $rel = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$elements = $this
->xpathContent($output, '//a[contains(@title, :alt)]', [
':alt' => $rel,
]);
$this
->assertNotEmpty($elements);
$id_field->options['alter']['alt'] = '';
$id_field->options['alter']['rel'] = $rel = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$elements = $this
->xpathContent($output, '//a[contains(@rel, :rel)]', [
':rel' => $rel,
]);
$this
->assertNotEmpty($elements);
$id_field->options['alter']['rel'] = '';
$id_field->options['alter']['target'] = $target = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
return $id_field
->theme($row);
});
$elements = $this
->xpathContent($output, '//a[contains(@target, :target)]', [
':target' => $target,
]);
$this
->assertNotEmpty($elements);
unset($id_field->options['alter']['target']);
}
public function testFieldClasses() {
$renderer = $this->container
->get('renderer');
$view = Views::getView('test_field_classes');
$view
->initHandlers();
$id_field = $view->field['id'];
$id_field->options['element_default_classes'] = FALSE;
$id_field->options['label'] = $this
->randomMachineName();
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertEmpty($this
->xpathContent($output, '//div[contains(@class, :class)]', [
':class' => 'field-content',
]));
$this
->assertEmpty($this
->xpathContent($output, '//div[contains(@class, :class)]', [
':class' => 'field__label',
]));
$id_field->options['element_default_classes'] = TRUE;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertNotEmpty($this
->xpathContent($output, '//span[contains(@class, :class)]', [
':class' => 'field-content',
]));
$this
->assertNotEmpty($this
->xpathContent($output, '//span[contains(@class, :class)]', [
':class' => 'views-label',
]));
$this
->assertNotEmpty($this
->xpathContent($output, '//div[contains(@class, :class)]', [
':class' => 'views-field',
]));
$random_class = $this
->randomMachineName();
foreach ([
'h1',
'span',
'p',
'div',
] as $element_type) {
$id_field->options['element_wrapper_type'] = $element_type;
$id_field->options['element_wrapper_class'] = $random_class;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertNotEmpty($this
->xpathContent($output, "//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$id_field->options['element_wrapper_class'] = '';
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertEmpty($this
->xpathContent($output, "//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$this
->assertNotEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]/{$element_type}"));
}
foreach ([
'h1',
'span',
'p',
'div',
] as $element_type) {
$id_field->options['element_label_type'] = $element_type;
$id_field->options['element_label_class'] = $random_class;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertNotEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$id_field->options['element_label_class'] = '';
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$this
->assertNotEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}"));
}
foreach ([
'h1',
'span',
'p',
'div',
] as $element_type) {
$id_field->options['element_type'] = $element_type;
$id_field->options['element_class'] = $random_class;
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertNotEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$id_field->options['element_class'] = '';
$output = $view
->preview();
$output = $renderer
->renderRoot($output);
$this
->assertEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}[contains(@class, :class)]", [
':class' => $random_class,
]));
$this
->assertNotEmpty($this
->xpathContent($output, "//li[contains(@class, views-row)]//div[contains(@class, views-field)]//{$element_type}"));
}
$element_types = $id_field
->getElements();
$expected_elements = [
'',
0,
'div',
'span',
'h1',
'h2',
'h3',
'h4',
'h5',
'h6',
'p',
'strong',
'em',
'marquee',
];
$this
->assertEquals($expected_elements, array_keys($element_types));
}
public function testTextRendering() {
$renderer = \Drupal::service('renderer');
$view = Views::getView('test_field_output');
$view
->initHandlers();
$name_field = $view->field['name'];
$this
->executeView($view);
$random_text = $this
->randomMachineName();
$name_field->options['alter']['alter_text'] = TRUE;
$name_field->options['alter']['text'] = $html_text = '<div class="views-test">' . $random_text . '</div>';
$row = $view->result[0];
$name_field->options['alter']['strip_tags'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is enabled.');
$this
->assertNotSubString($output, $html_text, 'Find no text with the html if stripping of views field output is enabled.');
$name_field->options['alter']['preserve_tags'] = '<div>';
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is enabled but a div is allowed.');
$this
->assertSubString($output, $html_text, 'Find text with the html if stripping of views field output is enabled but a div is allowed.');
$name_field->options['alter']['strip_tags'] = FALSE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $random_text, 'Find text without html if stripping of views field output is disabled.');
$this
->assertSubString($output, $html_text, 'Find text with the html if stripping of views field output is disabled.');
$name_field->options['alter']['alter_text'] = FALSE;
$views_test_data_name = $row->views_test_data_name;
$row->views_test_data_name = ' ' . $views_test_data_name . ' ';
$name_field->options['alter']['trim_whitespace'] = TRUE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $views_test_data_name, 'Make sure the trimmed text can be found if trimming is enabled.');
$this
->assertNotSubString($output, $row->views_test_data_name, 'Make sure the untrimmed text can be found if trimming is enabled.');
$name_field->options['alter']['trim_whitespace'] = FALSE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $views_test_data_name, 'Make sure the trimmed text can be found if trimming is disabled.');
$this
->assertSubString($output, $row->views_test_data_name, 'Make sure the untrimmed text can be found if trimming is disabled.');
$name_field->options['alter']['trim'] = TRUE;
$name_field->options['alter']['word_boundary'] = FALSE;
$row->views_test_data_name = $this
->randomMachineName(8);
$name_field->options['alter']['max_length'] = 5;
$trimmed_name = mb_substr($row->views_test_data_name, 0, 5);
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $trimmed_name, new FormattableMarkup('Make sure the trimmed output (@trimmed) appears in the rendered output (@output).', [
'@trimmed' => $trimmed_name,
'@output' => $output,
]));
$this
->assertNotSubString($output, $row->views_test_data_name, new FormattableMarkup("Make sure the untrimmed value (@untrimmed) shouldn't appear in the rendered output (@output).", [
'@untrimmed' => $row->views_test_data_name,
'@output' => $output,
]));
$name_field->options['alter']['max_length'] = 9;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $trimmed_name, new FormattableMarkup('Make sure the untrimmed (@untrimmed) output appears in the rendered output (@output).', [
'@trimmed' => $trimmed_name,
'@output' => $output,
]));
$name_field->options['alter']['max_length'] = 5;
$name_field->options['alter']['word_boundary'] = TRUE;
$random_text_2 = $this
->randomMachineName(2);
$random_text_4 = $this
->randomMachineName(4);
$random_text_8 = $this
->randomMachineName(8);
$tuples = [
[
'value' => $random_text_8,
'trimmed_value' => '',
'trimmed' => TRUE,
],
[
'value' => $random_text_8 . ' ' . $random_text_8,
'trimmed_value' => '',
'trimmed' => TRUE,
],
[
'value' => $random_text_4 . ' ' . $random_text_8,
'trimmed_value' => $random_text_4,
'trimmed' => TRUE,
],
[
'value' => $random_text_2 . ' ' . $random_text_2,
'trimmed_value' => $random_text_2 . ' ' . $random_text_2,
'trimmed' => FALSE,
],
];
foreach ($tuples as $tuple) {
$row->views_test_data_name = $tuple['value'];
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
if ($tuple['trimmed']) {
$this
->assertNotSubString($output, $tuple['value'], new FormattableMarkup('The untrimmed value (@untrimmed) should not appear in the trimmed output (@output).', [
'@untrimmed' => $tuple['value'],
'@output' => $output,
]));
}
if (!empty($tuple['trimmed_value'])) {
$this
->assertSubString($output, $tuple['trimmed_value'], new FormattableMarkup('The trimmed value (@trimmed) should appear in the trimmed output (@output).', [
'@trimmed' => $tuple['trimmed_value'],
'@output' => $output,
]));
}
}
$row->views_test_data_name = $this
->randomMachineName(8);
$name_field->options['alter']['max_length'] = 5;
$name_field->options['alter']['more_link'] = TRUE;
$name_field->options['alter']['more_link_text'] = $more_text = $this
->randomMachineName();
$name_field->options['alter']['more_link_path'] = $more_path = $this
->randomMachineName();
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, $more_text, 'Make sure a read more text is displayed if the output got trimmed');
$this
->assertNotEmpty($this
->xpathContent($output, '//a[contains(@href, :path)]', [
':path' => $more_path,
]), 'Make sure the read more link points to the right destination.');
$name_field->options['alter']['more_link'] = FALSE;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertNotSubString($output, $more_text, 'Make sure no read more text appears.');
$this
->assertEmpty($this
->xpathContent($output, '//a[contains(@href, :path)]', [
':path' => $more_path,
]), 'Make sure no read more link appears.');
$row->views_test_data_name = $this
->randomMachineName(8);
$name_field->options['alter']['max_length'] = 5;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertSubString($output, '…', 'An ellipsis should appear if the output is trimmed');
$name_field->options['alter']['max_length'] = 10;
$output = $renderer
->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
return $name_field
->advancedRender($row);
});
$this
->assertNotSubString($output, '…', 'No ellipsis should appear if the output is not trimmed');
}
}