class FunctionsTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Kernel/Theme/FunctionsTest.php \Drupal\Tests\system\Kernel\Theme\FunctionsTest
  2. 10 core/modules/system/tests/src/Kernel/Theme/FunctionsTest.php \Drupal\Tests\system\Kernel\Theme\FunctionsTest
  3. 11.x core/modules/system/tests/src/Kernel/Theme/FunctionsTest.php \Drupal\Tests\system\Kernel\Theme\FunctionsTest

Tests for common theme functions.

@group Theme

Hierarchy

Expanded class hierarchy of FunctionsTest

File

core/modules/system/tests/src/Kernel/Theme/FunctionsTest.php, line 18

Namespace

Drupal\Tests\system\Kernel\Theme
View source
class FunctionsTest extends KernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'router_test',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        // Enable the Classy theme.
        $this->container
            ->get('theme_installer')
            ->install([
            'classy',
        ]);
        $this->config('system.theme')
            ->set('default', 'classy')
            ->save();
    }
    
    /**
     * Tests item-list.html.twig.
     */
    public function testItemList() {
        // Verify that empty items produce no output.
        $variables = [];
        $expected = '';
        $this->assertThemeOutput('item_list', $variables, $expected, 'Empty %callback generates no output.');
        // Verify that empty items with title produce no output.
        $variables = [];
        $variables['title'] = 'Some title';
        $expected = '';
        $this->assertThemeOutput('item_list', $variables, $expected, 'Empty %callback with title generates no output.');
        // Verify that empty items produce the empty string.
        $variables = [];
        $variables['empty'] = 'No items found.';
        $expected = '<div class="item-list">No items found.</div>';
        $this->assertThemeOutput('item_list', $variables, $expected, 'Empty %callback generates empty string.');
        // Verify that empty items produce the empty string with title.
        $variables = [];
        $variables['title'] = 'Some title';
        $variables['empty'] = 'No items found.';
        $expected = '<div class="item-list"><h3>Some title</h3>No items found.</div>';
        $this->assertThemeOutput('item_list', $variables, $expected, 'Empty %callback generates empty string with title.');
        // Verify that title set to 0 is output.
        $variables = [];
        $variables['title'] = 0;
        $variables['empty'] = 'No items found.';
        $expected = '<div class="item-list"><h3>0</h3>No items found.</div>';
        $this->assertThemeOutput('item_list', $variables, $expected, '%callback with title set to 0 generates a title.');
        // Verify that title set to a render array is output.
        $variables = [];
        $variables['title'] = [
            '#markup' => '<span>Render array</span>',
        ];
        $variables['empty'] = 'No items found.';
        $expected = '<div class="item-list"><h3><span>Render array</span></h3>No items found.</div>';
        $this->assertThemeOutput('item_list', $variables, $expected, '%callback with title set to a render array generates a title.');
        // Verify that empty text is not displayed when there are list items.
        $variables = [];
        $variables['title'] = 'Some title';
        $variables['empty'] = 'No items found.';
        $variables['items'] = [
            'Un',
            'Deux',
            'Trois',
        ];
        $expected = '<div class="item-list"><h3>Some title</h3><ul><li>Un</li><li>Deux</li><li>Trois</li></ul></div>';
        $this->assertThemeOutput('item_list', $variables, $expected, '%callback does not print empty text when there are list items.');
        // Verify nested item lists.
        $variables = [];
        $variables['title'] = 'Some title';
        $variables['attributes'] = [
            'id' => 'parentlist',
        ];
        $variables['items'] = [
            // A plain string value forms an own item.
'a',
            // Items can be fully-fledged render arrays with their own attributes.
[
                '#wrapper_attributes' => [
                    'id' => 'item-id-b',
                ],
                '#markup' => 'b',
                'childlist' => [
                    '#theme' => 'item_list',
                    '#attributes' => [
                        'id' => 'blist',
                    ],
                    '#list_type' => 'ol',
                    '#items' => [
                        'ba',
                        [
                            '#markup' => 'bb',
                            '#wrapper_attributes' => [
                                'class' => [
                                    'item-class-bb',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
            // However, items can also be child #items.
[
                '#markup' => 'c',
                'childlist' => [
                    '#attributes' => [
                        'id' => 'clist',
                    ],
                    'ca',
                    [
                        '#markup' => 'cb',
                        '#wrapper_attributes' => [
                            'class' => [
                                'item-class-cb',
                            ],
                        ],
                        'children' => [
                            'cba',
                            'cbb',
                        ],
                    ],
                    'cc',
                ],
            ],
            // Use #markup to be able to specify #wrapper_attributes.
[
                '#markup' => 'd',
                '#wrapper_attributes' => [
                    'id' => 'item-id-d',
                ],
            ],
            // An empty item with attributes.
[
                '#wrapper_attributes' => [
                    'id' => 'item-id-e',
                ],
            ],
            // Lastly, another plain string item.
'f',
        ];
        $inner_b = '<div class="item-list"><ol id="blist">';
        $inner_b .= '<li>ba</li>';
        $inner_b .= '<li class="item-class-bb">bb</li>';
        $inner_b .= '</ol></div>';
        $inner_cb = '<div class="item-list"><ul>';
        $inner_cb .= '<li>cba</li>';
        $inner_cb .= '<li>cbb</li>';
        $inner_cb .= '</ul></div>';
        $inner_c = '<div class="item-list"><ul id="clist">';
        $inner_c .= '<li>ca</li>';
        $inner_c .= '<li class="item-class-cb">cb' . $inner_cb . '</li>';
        $inner_c .= '<li>cc</li>';
        $inner_c .= '</ul></div>';
        $expected = '<div class="item-list">';
        $expected .= '<h3>Some title</h3>';
        $expected .= '<ul id="parentlist">';
        $expected .= '<li>a</li>';
        $expected .= '<li id="item-id-b">b' . $inner_b . '</li>';
        $expected .= '<li>c' . $inner_c . '</li>';
        $expected .= '<li id="item-id-d">d</li>';
        $expected .= '<li id="item-id-e"></li>';
        $expected .= '<li>f</li>';
        $expected .= '</ul></div>';
        $this->assertThemeOutput('item_list', $variables, $expected);
    }
    
    /**
     * Tests links.html.twig.
     */
    public function testLinks() {
        // Turn off the query for the
        // \Drupal\Core\Utility\LinkGeneratorInterface::generate() method to compare
        // the active link correctly.
        $original_query = \Drupal::request()->query
            ->all();
        \Drupal::request()->query
            ->replace([]);
        // Verify that empty variables produce no output.
        $variables = [];
        $expected = '';
        $this->assertThemeOutput('links', $variables, $expected, 'Empty %callback generates no output.');
        $variables = [];
        $variables['heading'] = 'Some title';
        $expected = '';
        $this->assertThemeOutput('links', $variables, $expected, 'Empty %callback with heading generates no output.');
        // Verify that a list of links is properly rendered.
        $variables = [];
        $variables['attributes'] = [
            'id' => 'somelinks',
        ];
        $variables['links'] = [
            'a link' => [
                'title' => 'A <link>',
                'url' => Url::fromUri('base:a/link'),
            ],
            'plain text' => [
                'title' => 'Plain "text"',
            ],
            'html text' => [
                'title' => new FormattableMarkup('<span class="unescaped">@text</span>', [
                    '@text' => 'potentially unsafe text that <should> be escaped',
                ]),
            ],
            'front page' => [
                'title' => 'Front page',
                'url' => Url::fromRoute('<front>'),
            ],
            'router-test' => [
                'title' => 'Test route',
                'url' => Url::fromRoute('router_test.1'),
            ],
            'query-test' => [
                'title' => 'Query test route',
                'url' => Url::fromRoute('router_test.1'),
                'query' => [
                    'key' => 'value',
                ],
            ],
        ];
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li class="a-link"><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li class="plain-text">' . Html::escape('Plain "text"') . '</li>';
        $expected_links .= '<li class="html-text"><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li class="front-page"><a href="' . Url::fromRoute('<front>')->toString() . '">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li class="router-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $expected_links .= '<li class="query-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        // Verify that passing a string as heading works.
        $variables['heading'] = 'Links heading';
        $expected_heading = '<h2>Links heading</h2>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Restore the original request's query.
        \Drupal::request()->query
            ->replace($original_query);
        // Verify that passing an array as heading works (core support).
        $variables['heading'] = [
            'text' => 'Links heading',
            'level' => 'h3',
            'attributes' => [
                'class' => [
                    'heading',
                ],
            ],
        ];
        $expected_heading = '<h3 class="heading">Links heading</h3>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify that passing attributes for the heading works.
        $variables['heading'] = [
            'text' => 'Links heading',
            'level' => 'h3',
            'attributes' => [
                'id' => 'heading',
            ],
        ];
        $expected_heading = '<h3 id="heading">Links heading</h3>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify that passing attributes for the links work.
        $variables['links']['plain text']['attributes'] = [
            'class' => [
                'a/class',
            ],
        ];
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li class="a-link"><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li class="plain-text"><span class="a/class">' . Html::escape('Plain "text"') . '</span></li>';
        $expected_links .= '<li class="html-text"><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li class="front-page"><a href="' . Url::fromRoute('<front>')->toString() . '">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li class="router-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $expected_links .= '<li class="query-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify the data- attributes for setting the "active" class on links.
        \Drupal::currentUser()->setAccount(new UserSession([
            'uid' => 1,
        ]));
        $variables['set_active_class'] = TRUE;
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li class="a-link"><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li class="plain-text"><span class="a/class">' . Html::escape('Plain "text"') . '</span></li>';
        $expected_links .= '<li class="html-text"><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li data-drupal-link-system-path="&lt;front&gt;" class="front-page"><a href="' . Url::fromRoute('<front>')->toString() . '" data-drupal-link-system-path="&lt;front&gt;">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li data-drupal-link-system-path="router_test/test1" class="router-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '" data-drupal-link-system-path="router_test/test1">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $encoded_query = Html::escape(Json::encode($query));
        $expected_links .= '<li data-drupal-link-query="' . $encoded_query . '" data-drupal-link-system-path="router_test/test1" class="query-test"><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '" data-drupal-link-query="' . $encoded_query . '" data-drupal-link-system-path="router_test/test1">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
    }
    
    /**
     * Tests links.html.twig using links with indexed keys.
     */
    public function testIndexedKeyedLinks() {
        // Turn off the query for the
        // \Drupal\Core\Utility\LinkGeneratorInterface::generate() method to compare
        // the active link correctly.
        $original_query = \Drupal::request()->query
            ->all();
        \Drupal::request()->query
            ->replace([]);
        // Verify that empty variables produce no output.
        $variables = [];
        $expected = '';
        $this->assertThemeOutput('links', $variables, $expected, 'Empty %callback generates no output.');
        $variables = [];
        $variables['heading'] = 'Some title';
        $expected = '';
        $this->assertThemeOutput('links', $variables, $expected, 'Empty %callback with heading generates no output.');
        // Verify that a list of links is properly rendered.
        $variables = [];
        $variables['attributes'] = [
            'id' => 'somelinks',
        ];
        $variables['links'] = [
            [
                'title' => 'A <link>',
                'url' => Url::fromUri('base:a/link'),
            ],
            [
                'title' => 'Plain "text"',
            ],
            [
                'title' => new FormattableMarkup('<span class="unescaped">@text</span>', [
                    '@text' => 'potentially unsafe text that <should> be escaped',
                ]),
            ],
            [
                'title' => 'Front page',
                'url' => Url::fromRoute('<front>'),
            ],
            [
                'title' => 'Test route',
                'url' => Url::fromRoute('router_test.1'),
            ],
            [
                'title' => 'Query test route',
                'url' => Url::fromRoute('router_test.1'),
                'query' => [
                    'key' => 'value',
                ],
            ],
        ];
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li>' . Html::escape('Plain "text"') . '</li>';
        $expected_links .= '<li><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li><a href="' . Url::fromRoute('<front>')->toString() . '">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $expected_links .= '<li><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        // Verify that passing a string as heading works.
        $variables['heading'] = 'Links heading';
        $expected_heading = '<h2>Links heading</h2>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Restore the original request's query.
        \Drupal::request()->query
            ->replace($original_query);
        // Verify that passing an array as heading works (core support).
        $variables['heading'] = [
            'text' => 'Links heading',
            'level' => 'h3',
            'attributes' => [
                'class' => [
                    'heading',
                ],
            ],
        ];
        $expected_heading = '<h3 class="heading">Links heading</h3>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify that passing attributes for the heading works.
        $variables['heading'] = [
            'text' => 'Links heading',
            'level' => 'h3',
            'attributes' => [
                'id' => 'heading',
            ],
        ];
        $expected_heading = '<h3 id="heading">Links heading</h3>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify that passing attributes for the links work.
        $variables['links'][1]['attributes'] = [
            'class' => [
                'a/class',
            ],
        ];
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li><span class="a/class">' . Html::escape('Plain "text"') . '</span></li>';
        $expected_links .= '<li><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li><a href="' . Url::fromRoute('<front>')->toString() . '">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $expected_links .= '<li><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
        // Verify the data- attributes for setting the "active" class on links.
        \Drupal::currentUser()->setAccount(new UserSession([
            'uid' => 1,
        ]));
        $variables['set_active_class'] = TRUE;
        $expected_links = '';
        $expected_links .= '<ul id="somelinks">';
        $expected_links .= '<li><a href="' . Url::fromUri('base:a/link')->toString() . '">' . Html::escape('A <link>') . '</a></li>';
        $expected_links .= '<li><span class="a/class">' . Html::escape('Plain "text"') . '</span></li>';
        $expected_links .= '<li><span class="unescaped">' . Html::escape('potentially unsafe text that <should> be escaped') . '</span></li>';
        $expected_links .= '<li data-drupal-link-system-path="&lt;front&gt;"><a href="' . Url::fromRoute('<front>')->toString() . '" data-drupal-link-system-path="&lt;front&gt;">' . Html::escape('Front page') . '</a></li>';
        $expected_links .= '<li data-drupal-link-system-path="router_test/test1"><a href="' . \Drupal::urlGenerator()->generate('router_test.1') . '" data-drupal-link-system-path="router_test/test1">' . Html::escape('Test route') . '</a></li>';
        $query = [
            'key' => 'value',
        ];
        $encoded_query = Html::escape(Json::encode($query));
        $expected_links .= '<li data-drupal-link-query="' . $encoded_query . '" data-drupal-link-system-path="router_test/test1"><a href="' . \Drupal::urlGenerator()->generate('router_test.1', $query) . '" data-drupal-link-query="' . $encoded_query . '" data-drupal-link-system-path="router_test/test1">' . Html::escape('Query test route') . '</a></li>';
        $expected_links .= '</ul>';
        $expected = $expected_heading . $expected_links;
        $this->assertThemeOutput('links', $variables, $expected);
    }
    
    /**
     * Test the use of Link::preRenderLinks() on a nested array of links.
     *
     * @see \Drupal\Core\Render\Element\Link::preRenderLinks()
     */
    public function testDrupalPreRenderLinks() {
        // Define the base array to be rendered, containing a variety of different
        // kinds of links.
        $base_array = [
            '#theme' => 'links',
            '#pre_render' => [
                [
                    Link::class,
                    'preRenderLinks',
                ],
            ],
            '#links' => [
                'parent_link' => [
                    'title' => 'Parent link original',
                    'url' => Url::fromRoute('router_test.1'),
                ],
            ],
            'first_child' => [
                '#theme' => 'links',
                '#links' => [
                    // This should be rendered if 'first_child' is rendered separately,
                    // but ignored if the parent is being rendered (since it duplicates
                    // one of the parent's links).
'parent_link' => [
                        'title' => 'Parent link copy',
                        'url' => Url::fromRoute('router_test.6'),
                    ],
                    // This should always be rendered.
'first_child_link' => [
                        'title' => 'First child link',
                        'url' => Url::fromRoute('router_test.7'),
                    ],
                ],
            ],
            // This should always be rendered as part of the parent.
'second_child' => [
                '#theme' => 'links',
                '#links' => [
                    'second_child_link' => [
                        'title' => 'Second child link',
                        'url' => Url::fromRoute('router_test.8'),
                    ],
                ],
            ],
            // This should never be rendered, since the user does not have access to
            // it.
'third_child' => [
                '#theme' => 'links',
                '#links' => [
                    'third_child_link' => [
                        'title' => 'Third child link',
                        'url' => Url::fromRoute('router_test.9'),
                    ],
                ],
                '#access' => FALSE,
            ],
        ];
        // Start with a fresh copy of the base array, and try rendering the entire
        // thing. We expect a single <ul> with appropriate links contained within
        // it.
        $render_array = $base_array;
        $html = \Drupal::service('renderer')->renderRoot($render_array);
        $dom = new \DOMDocument();
        $dom->loadHTML($html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 3, 'Three "li" tags found in the rendered HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link original', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'First child link', 'Second expected link found.');
        $this->assertEqual($list_elements->item(2)->nodeValue, 'Second child link', 'Third expected link found.');
        $this->assertStringNotContainsString('Parent link copy', $html, '"Parent link copy" link not found.');
        $this->assertStringNotContainsString('Third child link', $html, '"Third child link" link not found.');
        // Now render 'first_child', followed by the rest of the links, and make
        // sure we get two separate <ul>'s with the appropriate links contained
        // within each.
        $render_array = $base_array;
        $child_html = \Drupal::service('renderer')->renderRoot($render_array['first_child']);
        $parent_html = \Drupal::service('renderer')->renderRoot($render_array);
        // First check the child HTML.
        $dom = new \DOMDocument();
        $dom->loadHTML($child_html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered child HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 2, 'Two "li" tags found in the rendered child HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link copy', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'First child link', 'Second expected link found.');
        // Then check the parent HTML.
        $dom = new \DOMDocument();
        $dom->loadHTML($parent_html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered parent HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 2, 'Two "li" tags found in the rendered parent HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link original', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'Second child link', 'Second expected link found.');
        $this->assertStringNotContainsString('First child link', $parent_html, '"First child link" link not found.');
        $this->assertStringNotContainsString('Third child link', $parent_html, '"Third child link" link not found.');
    }
    
    /**
     * Test the use of drupal_pre_render_links() on a nested array of links.
     *
     * @group legacy
     *
     * @expectedDeprecation Render #pre_render callbacks must be methods of a class that implements \Drupal\Core\Security\TrustedCallbackInterface or be an anonymous function. The callback was drupal_pre_render_links. Support for this callback implementation is deprecated in 8.8.0 and will be removed in Drupal 9.0.0. See https://www.drupal.org/node/2966725
     * @expectedDeprecation drupal_pre_render_links() is deprecated in Drupal 8.8.0 and will be removed before Drupal 9.0.0. Use \Drupal\Core\Render\Element\Link::preRenderLinks() instead. See https://www.drupal.org/node/2966725
     */
    public function testDrupalPreRenderLinksLegacy() {
        // Define the base array to be rendered, containing a variety of different
        // kinds of links.
        $base_array = [
            '#theme' => 'links',
            '#pre_render' => [
                'drupal_pre_render_links',
            ],
            '#links' => [
                'parent_link' => [
                    'title' => 'Parent link original',
                    'url' => Url::fromRoute('router_test.1'),
                ],
            ],
            'first_child' => [
                '#theme' => 'links',
                '#links' => [
                    // This should be rendered if 'first_child' is rendered separately,
                    // but ignored if the parent is being rendered (since it duplicates
                    // one of the parent's links).
'parent_link' => [
                        'title' => 'Parent link copy',
                        'url' => Url::fromRoute('router_test.6'),
                    ],
                    // This should always be rendered.
'first_child_link' => [
                        'title' => 'First child link',
                        'url' => Url::fromRoute('router_test.7'),
                    ],
                ],
            ],
            // This should always be rendered as part of the parent.
'second_child' => [
                '#theme' => 'links',
                '#links' => [
                    'second_child_link' => [
                        'title' => 'Second child link',
                        'url' => Url::fromRoute('router_test.8'),
                    ],
                ],
            ],
            // This should never be rendered, since the user does not have access to
            // it.
'third_child' => [
                '#theme' => 'links',
                '#links' => [
                    'third_child_link' => [
                        'title' => 'Third child link',
                        'url' => Url::fromRoute('router_test.9'),
                    ],
                ],
                '#access' => FALSE,
            ],
        ];
        // Start with a fresh copy of the base array, and try rendering the entire
        // thing. We expect a single <ul> with appropriate links contained within
        // it.
        $render_array = $base_array;
        $html = \Drupal::service('renderer')->renderRoot($render_array);
        $dom = new \DOMDocument();
        $dom->loadHTML($html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 3, 'Three "li" tags found in the rendered HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link original', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'First child link', 'Second expected link found.');
        $this->assertEqual($list_elements->item(2)->nodeValue, 'Second child link', 'Third expected link found.');
        $this->assertIdentical(strpos($html, 'Parent link copy'), FALSE, '"Parent link copy" link not found.');
        $this->assertIdentical(strpos($html, 'Third child link'), FALSE, '"Third child link" link not found.');
        // Now render 'first_child', followed by the rest of the links, and make
        // sure we get two separate <ul>'s with the appropriate links contained
        // within each.
        $render_array = $base_array;
        $child_html = \Drupal::service('renderer')->renderRoot($render_array['first_child']);
        $parent_html = \Drupal::service('renderer')->renderRoot($render_array);
        // First check the child HTML.
        $dom = new \DOMDocument();
        $dom->loadHTML($child_html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered child HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 2, 'Two "li" tags found in the rendered child HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link copy', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'First child link', 'Second expected link found.');
        // Then check the parent HTML.
        $dom = new \DOMDocument();
        $dom->loadHTML($parent_html);
        $this->assertEqual($dom->getElementsByTagName('ul')->length, 1, 'One "ul" tag found in the rendered parent HTML.');
        $list_elements = $dom->getElementsByTagName('li');
        $this->assertEqual($list_elements->length, 2, 'Two "li" tags found in the rendered parent HTML.');
        $this->assertEqual($list_elements->item(0)->nodeValue, 'Parent link original', 'First expected link found.');
        $this->assertEqual($list_elements->item(1)->nodeValue, 'Second child link', 'Second expected link found.');
        $this->assertIdentical(strpos($parent_html, 'First child link'), FALSE, '"First child link" link not found.');
        $this->assertIdentical(strpos($parent_html, 'Third child link'), FALSE, '"Third child link" link not found.');
    }
    
    /**
     * Tests theme_image().
     */
    public function testImage() {
        // Test that data URIs work with theme_image().
        $variables = [];
        $variables['uri'] = 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==';
        $variables['alt'] = 'Data URI image of a red dot';
        $expected = '<img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==" alt="Data URI image of a red dot" />' . "\n";
        $this->assertThemeOutput('image', $variables, $expected);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail
otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
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.
FunctionsTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
FunctionsTest::setUp protected function Overrides KernelTestBase::setUp
FunctionsTest::testDrupalPreRenderLinks public function Test the use of Link::preRenderLinks() on a nested array of links.
FunctionsTest::testDrupalPreRenderLinksLegacy public function Test the use of drupal_pre_render_links() on a nested array of links.
FunctionsTest::testImage public function Tests theme_image().
FunctionsTest::testIndexedKeyedLinks public function Tests links.html.twig using links with indexed keys.
FunctionsTest::testItemList public function Tests item-list.html.twig.
FunctionsTest::testLinks public function Tests links.html.twig.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess 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::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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