AreaTest.php

Same filename in other branches
  1. 8.9.x core/modules/views/tests/src/Functional/Handler/AreaTest.php
  2. 10 core/modules/views/tests/src/Kernel/Handler/AreaTest.php
  3. 10 core/modules/views/tests/src/Functional/Handler/AreaTest.php
  4. 11.x core/modules/views/tests/src/Kernel/Handler/AreaTest.php
  5. 11.x core/modules/views/tests/src/Functional/Handler/AreaTest.php

Namespace

Drupal\Tests\views\Functional\Handler

File

core/modules/views/tests/src/Functional/Handler/AreaTest.php

View source
<?php

namespace Drupal\Tests\views\Functional\Handler;

use Drupal\Component\Utility\Xss;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Views;

/**
 * Tests the plugin base of the area handler.
 *
 * @group views
 * @see \Drupal\views\Plugin\views\area\AreaPluginBase
 * @see \Drupal\views_test\Plugin\views\area\TestExample
 */
class AreaTest extends ViewTestBase {
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_example_area',
        'test_example_area_access',
    ];
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'views_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->enableViewsTestModule();
    }
    protected function viewsData() {
        $data = parent::viewsData();
        $data['views']['test_example'] = [
            'title' => 'Test Example area',
            'help' => 'A area handler which just exists for tests.',
            'area' => [
                'id' => 'test_example',
            ],
        ];
        return $data;
    }
    
    /**
     * Tests the generic UI of an area handler.
     */
    public function testUI() {
        $admin_user = $this->drupalCreateUser([
            'administer views',
            'administer site configuration',
        ]);
        $this->drupalLogin($admin_user);
        $types = [
            'header',
            'footer',
            'empty',
        ];
        $labels = [];
        foreach ($types as $type) {
            $edit_path = 'admin/structure/views/nojs/handler/test_example_area/default/' . $type . '/test_example';
            // First setup an empty label.
            $this->drupalGet($edit_path);
            $this->submitForm([], 'Apply');
            $this->assertSession()
                ->pageTextContains('Test Example area');
            // Then setup a no empty label.
            $labels[$type] = $this->randomMachineName();
            $this->drupalGet($edit_path);
            $this->submitForm([
                'options[admin_label]' => $labels[$type],
            ], 'Apply');
            // Make sure that the new label appears on the site.
            $this->assertSession()
                ->pageTextContains($labels[$type]);
            // Test that the settings (empty/admin_label) are accessible.
            $this->drupalGet($edit_path);
            $this->assertSession()
                ->fieldExists('options[admin_label]');
            if ($type !== 'empty') {
                $this->assertSession()
                    ->fieldExists('options[empty]');
            }
        }
    }
    
    /**
     * Tests the rendering of an area.
     */
    public function testRenderArea() {
        $view = Views::getView('test_example_area');
        $view->initHandlers();
        // Insert a random string with XSS injection in the test area plugin.
        // Ensure that the string is rendered for the header, footer, and empty
        // text with the markup properly escaped.
        $header_string = '<script type="text/javascript">alert("boo");</script><p>' . $this->randomMachineName() . '</p>';
        $footer_string = '<script type="text/javascript">alert("boo");</script><p>' . $this->randomMachineName() . '</p>';
        $empty_string = '<script type="text/javascript">alert("boo");</script><p>' . $this->randomMachineName() . '</p>';
        $view->header['test_example']->options['string'] = $header_string;
        $view->header['test_example']->options['empty'] = TRUE;
        $view->footer['test_example']->options['string'] = $footer_string;
        $view->footer['test_example']->options['empty'] = TRUE;
        $view->empty['test_example']->options['string'] = $empty_string;
        // Check whether the strings exist in the output and are sanitized.
        $output = $view->preview();
        $output = $this->container
            ->get('renderer')
            ->renderRoot($output);
        $this->assertStringContainsString(Xss::filterAdmin($header_string), $output, 'Views header exists in the output and is sanitized');
        $this->assertStringContainsString(Xss::filterAdmin($footer_string), $output, 'Views footer exists in the output and is sanitized');
        $this->assertStringContainsString(Xss::filterAdmin($empty_string), $output, 'Views empty exists in the output and is sanitized');
        $this->assertStringNotContainsString('<script', $output, 'Script tags were escaped');
    }
    
    /**
     * Tests the access for an area.
     */
    public function testAreaAccess() {
        // Test with access denied for the area handler.
        $view = Views::getView('test_example_area_access');
        $view->initDisplay();
        $view->initHandlers();
        $handlers = $view->display_handler
            ->getHandlers('empty');
        $this->assertCount(0, $handlers);
        $output = $view->preview();
        $output = \Drupal::service('renderer')->renderRoot($output);
        // The area output should not be present since access was denied.
        $this->assertStringNotContainsString('a custom string', $output);
        $view->destroy();
        // Test with access granted for the area handler.
        $view = Views::getView('test_example_area_access');
        $view->initDisplay();
        $view->display_handler
            ->overrideOption('empty', [
            'test_example' => [
                'field' => 'test_example',
                'id' => 'test_example',
                'table' => 'views',
                'plugin_id' => 'test_example',
                'string' => 'a custom string',
                'custom_access' => TRUE,
            ],
        ]);
        $view->initHandlers();
        $handlers = $view->display_handler
            ->getHandlers('empty');
        $output = $view->preview();
        $output = \Drupal::service('renderer')->renderRoot($output);
        $this->assertStringContainsString('a custom string', $output);
        $this->assertCount(1, $handlers);
    }
    
    /**
     * Tests global tokens.
     */
    public function testRenderAreaToken() {
        $admin_user = $this->drupalCreateUser([
            'administer views',
            'administer site configuration',
        ]);
        $this->drupalLogin($admin_user);
        $view = Views::getView('test_example_area');
        $view->initHandlers();
        $this->drupalGet('admin/structure/views/nojs/handler/test_example_area/default/empty/test_example');
        // Test that the list is token present.
        $this->assertSession()
            ->elementExists('xpath', '//ul[@class="global-tokens"]');
        $empty_handler =& $view->empty['test_example'];
        // Test the list of available tokens.
        $available = $empty_handler->getAvailableGlobalTokens();
        foreach ([
            'site',
            'view',
        ] as $type) {
            $this->assertNotEmpty($available[$type]);
            $this->assertIsArray($available[$type]);
            // Test that each item exists in the list.
            foreach ($available[$type] as $token => $info) {
                $this->assertSession()
                    ->pageTextContains("[{$type}:{$token}]");
            }
        }
        // Test the rendered output of a token.
        $empty_handler->options['string'] = '[site:name]';
        // Test we have the site:name token in the output.
        $output = $view->preview();
        $output = $this->container
            ->get('renderer')
            ->renderRoot($output);
        $expected = \Drupal::token()->replace('[site:name]');
        $this->assertStringContainsString($expected, $output);
    }
    
    /**
     * Tests overriding the view title using the area title handler.
     */
    public function testTitleArea() {
        $view = Views::getView('frontpage');
        $view->initDisplay('page_1');
        // Add the title area handler to the empty area.
        $view->displayHandlers
            ->get('page_1')
            ->overrideOption('empty', [
            'title' => [
                'id' => 'title',
                'table' => 'views',
                'field' => 'title',
                'admin_label' => '',
                'empty' => '0',
                'title' => 'Overridden title',
                'plugin_id' => 'title',
            ],
        ]);
        $view->storage
            ->enable()
            ->save();
        $this->drupalGet('node');
        $this->assertSession()
            ->pageTextContains('Overridden title');
    }

}

Classes

Title Deprecated Summary
AreaTest Tests the plugin base of the area handler.

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