class FieldWebTest

Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/Handler/FieldWebTest.php \Drupal\Tests\views\Functional\Handler\FieldWebTest
  2. 8.9.x core/modules/views/tests/src/Functional/Handler/FieldWebTest.php \Drupal\Tests\views\Functional\Handler\FieldWebTest
  3. 11.x core/modules/views/tests/src/Functional/Handler/FieldWebTest.php \Drupal\Tests\views\Functional\Handler\FieldWebTest

Tests fields from within a UI.

@group views

Hierarchy

Expanded class hierarchy of FieldWebTest

See also

\Drupal\views\Plugin\views\field\FieldPluginBase

File

core/modules/views/tests/src/Functional/Handler/FieldWebTest.php, line 22

Namespace

Drupal\Tests\views\Functional\Handler
View source
class FieldWebTest extends ViewTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view',
        'test_field_classes',
        'test_field_output',
        'test_click_sort',
        'test_distinct_click_sorting',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'language',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Maps between the key in the expected result and the query result.
     *
     * @var array
     */
    protected $columnMap = [
        'views_test_data_name' => 'name',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->enableViewsTestModule();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function viewsData() {
        $data = parent::viewsData();
        $data['views_test_data']['job']['field']['id'] = 'test_field';
        return $data;
    }
    
    /**
     * Tests the click sorting functionality.
     */
    public function testClickSorting() : void {
        $this->drupalGet('test_click_sort');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Only the id and name should be click sortable, but not the name.
        $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());
        // Check that the view returns the click sorting cache contexts.
        $expected_contexts = [
            'languages:language_interface',
            'theme',
            'url.query_args',
        ];
        $this->assertCacheContexts($expected_contexts);
        // Clicking a click sort should change the order.
        $this->clickLink('ID');
        $href = Url::fromRoute('<none>', [], [
            'query' => [
                'order' => 'id',
                'sort' => 'desc',
            ],
        ])->toString();
        $this->assertSession()
            ->linkByHrefExists($href);
        // Check that the output has the expected order (asc).
        $ids = $this->clickSortLoadIdsFromOutput();
        $this->assertEquals(range(1, 5), $ids);
        // Check that the rel attribute has the correct value.
        $this->assertSession()
            ->elementAttributeContains('xpath', "//a[@href='{$href}']", 'rel', 'nofollow');
        $this->clickLink('ID Sort descending');
        // Check that the output has the expected order (desc).
        $ids = $this->clickSortLoadIdsFromOutput();
        $this->assertEquals(range(5, 1, -1), $ids);
    }
    
    /**
     * Tests the default click sorting functionality with distinct.
     */
    public function testClickSortingDistinct() : void {
        ConfigurableLanguage::createFromLangcode('es')->save();
        $node = $this->drupalCreateNode();
        $this->drupalGet('test_distinct_click_sorting');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check that the results are ordered by id in ascending order and that the
        // title click filter is for descending.
        $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());
    }
    
    /**
     * Small helper function to get all ids in the output.
     *
     * @return array
     *   A list of beatle ids.
     */
    protected function clickSortLoadIdsFromOutput() {
        $fields = $this->xpath("//td[contains(@class, 'views-field-id')]");
        $ids = [];
        foreach ($fields as $field) {
            $ids[] = (int) $field->getText();
        }
        return $ids;
    }
    
    /**
     * Assertion helper which checks whether 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
     *   The message to display along with the assertion.
     *
     * @internal
     */
    protected function assertSubString(string $haystack, string $needle, string $message = '') : void {
        $this->assertStringContainsString($needle, $haystack, $message);
    }
    
    /**
     * Assertion helper which checks whether 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
     *   The message to display along with the assertion.
     *
     * @internal
     */
    protected function assertNotSubString(string $haystack, string $needle, string $message = '') : void {
        $this->assertStringNotContainsString($needle, $haystack, $message);
    }
    
    /**
     * Parse a content and return the html element.
     *
     * @param string $content
     *   The html to parse.
     *
     * @return array
     *   An array containing simplexml objects.
     */
    protected function parseContent($content) {
        $htmlDom = Html::load($content);
        $elements = simplexml_import_dom($htmlDom);
        return $elements;
    }
    
    /**
     * Performs an xpath search on a certain content.
     *
     * The search is relative to the root element of the $content variable.
     *
     * @param string $content
     *   The html to parse.
     * @param string $xpath
     *   The xpath string to use in the search.
     * @param array $arguments
     *   Some arguments for the xpath.
     *
     * @return array|false
     *   The return value of the xpath search. For details on the xpath string
     *   format and return values see the SimpleXML documentation,
     *   http://php.net/manual/function.simplexml-element-xpath.php.
     */
    protected function xpathContent($content, $xpath, array $arguments = []) {
        if ($elements = $this->parseContent($content)) {
            $xpath = $this->assertSession()
                ->buildXPathQuery($xpath, $arguments);
            $result = $elements->xpath($xpath);
            // Some combinations of PHP / libxml versions return an empty array
            // instead of the documented FALSE. Forcefully convert any falsish values
            // to an empty array to allow foreach(...) constructions.
            return $result ? $result : [];
        }
        else {
            return FALSE;
        }
    }
    
    /**
     * Tests rewriting the output to a link.
     */
    public function testAlterUrl() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $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'];
        // Setup the general settings required to build a link.
        $id_field->options['alter']['make_link'] = TRUE;
        $id_field->options['alter']['path'] = $path = $this->randomMachineName();
        // Tests that the suffix/prefix appears on the output.
        $id_field->options['alter']['prefix'] = $prefix = $this->randomMachineName();
        $id_field->options['alter']['suffix'] = $suffix = $this->randomMachineName();
        $output = (string) $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 = (string) $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');
        // Some generic test code adapted from the UrlTest class, which tests
        // mostly the different options for the path.
        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 = (string) $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 = (string) $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 = (string) $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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString(Html::decodeEntities($result), Html::decodeEntities($expected_result));
            // @todo The route-based URL generator strips out NULL attributes.
            // $expected_result = Url::fromRoute('entity.node.canonical', ['node' => '123'], ['query' => ['foo' => NULL], 'fragment' => 'bar', 'absolute' => $absolute])->toString();
            $expected_result = Url::fromUserInput('/node/123', [
                'query' => [
                    'foo' => NULL,
                ],
                'fragment' => 'bar',
                'absolute' => $absolute,
            ])->toString();
            $alter['path'] = 'node/123?foo#bar';
            $result = (string) $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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
                return $id_field->theme($row);
            });
            $this->assertSubString($result, $expected_result);
        }
        // Tests the replace spaces with dashes feature.
        $id_field->options['alter']['replace_spaces'] = TRUE;
        $id_field->options['alter']['path'] = $path = $this->randomMachineName() . ' ' . $this->randomMachineName();
        $output = (string) $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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        // The URL has a space in it, so to check we have to decode the URL output.
        $this->assertSubString(urldecode($output), $path);
        // Tests the external flag.
        // Switch on the external flag should output an external URL as well.
        $id_field->options['alter']['external'] = TRUE;
        $id_field->options['alter']['path'] = $path = 'www.example.com';
        $output = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, 'http://www.example.com');
        // Setup a not external URL, which shouldn't lead to an external URL.
        $id_field->options['alter']['external'] = FALSE;
        $id_field->options['alter']['path'] = $path = 'www.example.com';
        $output = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertNotSubString($output, 'http://www.example.com');
        // Tests the transforming of the case setting.
        $id_field->options['alter']['path'] = $path = $this->randomMachineName();
        $id_field->options['alter']['path_case'] = 'none';
        $output = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, $path);
        // Switch to uppercase and lowercase.
        $id_field->options['alter']['path_case'] = 'upper';
        $output = (string) $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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($id_field, $row) {
            return $id_field->theme($row);
        });
        $this->assertSubString($output, strtolower($path));
        // Switch to ucfirst and ucwords.
        $id_field->options['alter']['path_case'] = 'ucfirst';
        $id_field->options['alter']['path'] = 'drupal has a great community';
        $output = (string) $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 = (string) $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']);
        // Tests the link_class setting and see whether it actually exists in the
        // output.
        $id_field->options['alter']['link_class'] = $class = $this->randomMachineName();
        $output = (string) $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);
        // @fixme link_class, alt, rel cannot be unset, which should be fixed.
        $id_field->options['alter']['link_class'] = '';
        // Tests the alt setting.
        $id_field->options['alter']['alt'] = $rel = $this->randomMachineName();
        $output = (string) $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'] = '';
        // Tests the rel setting.
        $id_field->options['alter']['rel'] = $rel = $this->randomMachineName();
        $output = (string) $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'] = '';
        // Tests the target setting.
        $id_field->options['alter']['target'] = $target = $this->randomMachineName();
        $output = (string) $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']);
    }
    
    /**
     * Tests the field/label/wrapper classes.
     */
    public function testFieldClasses() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = $this->container
            ->get('renderer');
        $view = Views::getView('test_field_classes');
        $view->initHandlers();
        // Tests whether the default field classes are added.
        $id_field = $view->field['id'];
        $id_field->options['element_default_classes'] = FALSE;
        // Setup some kind of label by default.
        $id_field->options['label'] = $this->randomMachineName();
        $output = $view->preview();
        $output = (string) $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 = (string) $renderer->renderRoot($output);
        // Per default the label and the element of the field are spans.
        $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',
        ]));
        // Tests the element wrapper classes/element.
        $random_class = $this->randomMachineName();
        // Set some common wrapper element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_wrapper_type'] = $element_type;
            // Set a custom wrapper element css class.
            $id_field->options['element_wrapper_class'] = $random_class;
            $output = $view->preview();
            $output = (string) $renderer->renderRoot($output);
            $this->assertNotEmpty($this->xpathContent($output, "//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            // Set no custom css class.
            $id_field->options['element_wrapper_class'] = '';
            $output = $view->preview();
            $output = (string) $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}"));
        }
        // Tests the label class/element.
        // Set some common label element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_label_type'] = $element_type;
            // Set a custom label element css class.
            $id_field->options['element_label_class'] = $random_class;
            $output = $view->preview();
            $output = (string) $renderer->renderRoot($output);
            $this->assertNotEmpty($this->xpathContent($output, "//li[contains(@class, views-row)]//{$element_type}[contains(@class, :class)]", [
                ':class' => $random_class,
            ]));
            // Set no custom css class.
            $id_field->options['element_label_class'] = '';
            $output = $view->preview();
            $output = (string) $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}"));
        }
        // Tests the element classes/element.
        // Set some common element types and see whether they appear with and without a custom class set.
        foreach ([
            'h1',
            'span',
            'p',
            'div',
        ] as $element_type) {
            $id_field->options['element_type'] = $element_type;
            // Set a custom label element css class.
            $id_field->options['element_class'] = $random_class;
            $output = $view->preview();
            $output = (string) $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,
            ]));
            // Set no custom css class.
            $id_field->options['element_class'] = '';
            $output = $view->preview();
            $output = (string) $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}"));
        }
        // Tests the available html elements.
        $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));
    }
    
    /**
     * Tests trimming/read-more/ellipses.
     */
    public function testTextRendering() : void {
        
        /** @var \Drupal\Core\Render\RendererInterface $renderer */
        $renderer = \Drupal::service('renderer');
        $view = Views::getView('test_field_output');
        $view->initHandlers();
        $name_field = $view->field['name'];
        // Tests stripping of html elements.
        $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 = (string) $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.');
        // Tests preserving of html tags.
        $name_field->options['alter']['preserve_tags'] = '<div>';
        $output = (string) $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 = (string) $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.');
        // Tests for removing whitespace and the beginning and the end.
        $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 = (string) $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 = (string) $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.');
        // Tests for trimming to a maximum length.
        $name_field->options['alter']['trim'] = TRUE;
        $name_field->options['alter']['word_boundary'] = FALSE;
        // Tests for simple trimming by string length.
        $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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $trimmed_name, "Make sure the trimmed output ({$trimmed_name}) appears in the rendered output ({$output}).");
        $this->assertNotSubString($output, $row->views_test_data_name, "Make sure the untrimmed value ({$row->views_test_data_name}) shouldn't appear in the rendered output ({$output}).");
        $name_field->options['alter']['max_length'] = 9;
        $output = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
            return $name_field->advancedRender($row);
        });
        $this->assertSubString($output, $trimmed_name, "Make sure the untrimmed ({$trimmed_name}) output appears in the rendered output  ({$output}).");
        // Take word_boundary into account for the tests.
        $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 = [
            // Create one string which doesn't fit at all into the limit.
[
                'value' => $random_text_8,
                'trimmed_value' => '',
                'trimmed' => TRUE,
            ],
            // Create one string with two words which doesn't fit both into the limit.
[
                'value' => $random_text_8 . ' ' . $random_text_8,
                'trimmed_value' => '',
                'trimmed' => TRUE,
            ],
            // Create one string which contains of two words, of which only the first
            // fits into the limit.
[
                'value' => $random_text_4 . ' ' . $random_text_8,
                'trimmed_value' => $random_text_4,
                'trimmed' => TRUE,
            ],
            // Create one string which contains of two words, of which both fits into
            // the limit.
[
                '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 = (string) $renderer->executeInRenderContext(new RenderContext(), function () use ($name_field, $row) {
                return $name_field->advancedRender($row);
            });
            if ($tuple['trimmed']) {
                $this->assertNotSubString($output, $tuple['value'], "The untrimmed value ({$tuple['value']}) should not appear in the trimmed output ({$output}).");
            }
            if (!empty($tuple['trimmed_value'])) {
                $this->assertSubString($output, $tuple['trimmed_value'], "The trimmed value ({$tuple['trimmed_value']}) should appear in the trimmed output ({$output}).");
            }
        }
        // Tests for displaying a readmore link when the output got trimmed.
        $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 = (string) $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 = (string) $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.');
        // Check for the ellipses.
        $row->views_test_data_name = $this->randomMachineName(8);
        $name_field->options['alter']['max_length'] = 5;
        $output = (string) $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 = (string) $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');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldWebTest::$columnMap protected property Maps between the key in the expected result and the query result.
FieldWebTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FieldWebTest::$modules protected static property Modules to install. Overrides ViewTestBase::$modules
FieldWebTest::$testViews public static property Views used by this test.
FieldWebTest::assertNotSubString protected function Assertion helper which checks whether a string is not part of another string.
FieldWebTest::assertSubString protected function Assertion helper which checks whether a string is part of another string.
FieldWebTest::clickSortLoadIdsFromOutput protected function Small helper function to get all ids in the output.
FieldWebTest::parseContent protected function Parse a content and return the html element.
FieldWebTest::setUp protected function Sets up the test. Overrides ViewTestBase::setUp
FieldWebTest::testAlterUrl public function Tests rewriting the output to a link.
FieldWebTest::testClickSorting public function Tests the click sorting functionality.
FieldWebTest::testClickSortingDistinct public function Tests the default click sorting functionality with distinct.
FieldWebTest::testFieldClasses public function Tests the field/label/wrapper classes.
FieldWebTest::testTextRendering public function Tests trimming/read-more/ellipses.
FieldWebTest::viewsData protected function Returns the views data definition. Overrides ViewTestBase::viewsData
FieldWebTest::xpathContent protected function Performs an xpath search on a certain content.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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