www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/tests/src/Kernel/ViewsHooksTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\views\Kernel;
   4
   5 use Drupal\Core\Render\RenderContext;
   6 use Drupal\views\Views;
   7
   8 /**
   9  * Tests that views hooks are registered when defined in $module.views.inc.
  10  *
  11  * @group views
  12  * @see views_hook_info().
  13  * @see field_hook_info().
  14  */
  15 class ViewsHooksTest extends ViewsKernelTestBase {
  16
  17   /**
  18    * Views used by this test.
  19    *
  20    * @var array
  21    */
  22   public static $testViews = ['test_view'];
  23
  24   /**
  25    * An array of available views hooks to test.
  26    *
  27    * @var array
  28    */
  29   protected static $hooks = [
  30     'views_data' => 'all',
  31     'views_data_alter' => 'alter',
  32     'views_query_substitutions' => 'view',
  33     'views_form_substitutions' => 'view',
  34     'views_analyze' => 'view',
  35     'views_pre_view' => 'view',
  36     'views_pre_build' => 'view',
  37     'views_post_build' => 'view',
  38     'views_pre_execute' => 'view',
  39     'views_post_execute' => 'view',
  40     'views_pre_render' => 'view',
  41     'views_post_render' => 'view',
  42     'views_query_alter'  => 'view',
  43     'views_invalidate_cache' => 'all',
  44   ];
  45
  46   /**
  47    * The module handler to use for invoking hooks.
  48    *
  49    * @var \Drupal\Core\Extension\ModuleHandlerInterface
  50    */
  51   protected $moduleHandler;
  52
  53   protected function setUp($import_test_views = TRUE) {
  54     parent::setUp();
  55
  56     $this->moduleHandler = $this->container->get('module_handler');
  57   }
  58
  59   /**
  60    * Tests the hooks.
  61    */
  62   public function testHooks() {
  63     $view = Views::getView('test_view');
  64     $view->setDisplay();
  65
  66     // Test each hook is found in the implementations array and is invoked.
  67     foreach (static::$hooks as $hook => $type) {
  68       $this->assertTrue($this->moduleHandler->implementsHook('views_test_data', $hook), format_string('The hook @hook was registered.', ['@hook' => $hook]));
  69
  70       if ($hook == 'views_post_render') {
  71         $this->moduleHandler->invoke('views_test_data', $hook, [$view, &$view->display_handler->output, $view->display_handler->getPlugin('cache')]);
  72         continue;
  73       }
  74
  75       switch ($type) {
  76         case 'view':
  77           $this->moduleHandler->invoke('views_test_data', $hook, [$view]);
  78           break;
  79
  80         case 'alter':
  81           $data = [];
  82           $this->moduleHandler->invoke('views_test_data', $hook, [$data]);
  83           break;
  84
  85         default:
  86           $this->moduleHandler->invoke('views_test_data', $hook);
  87       }
  88
  89       $this->assertTrue($this->container->get('state')->get('views_hook_test_' . $hook), format_string('The %hook hook was invoked.', ['%hook' => $hook]));
  90       // Reset the module implementations cache, so we ensure that the
  91       // .views.inc file is loaded actively.
  92       $this->moduleHandler->resetImplementations();
  93     }
  94   }
  95
  96   /**
  97    * Tests how hook_views_form_substitutions() makes substitutions.
  98    *
  99    * @see views_test_data_views_form_substitutions()
 100    * @see views_pre_render_views_form_views_form()
 101    */
 102   public function testViewsPreRenderViewsFormViewsForm() {
 103     $element = [
 104       'output' => [
 105         '#plain_text' => '<!--will-be-escaped--><!--will-be-not-escaped-->',
 106       ],
 107       '#substitutions' => ['#value' => []],
 108     ];
 109     $element = \Drupal::service('renderer')->executeInRenderContext(new RenderContext(), function() use ($element) {
 110       return views_pre_render_views_form_views_form($element);
 111     });
 112     $this->setRawContent((string) $element['output']['#markup']);
 113     $this->assertEscaped('<em>escaped</em>');
 114     $this->assertRaw('<em>unescaped</em>');
 115   }
 116
 117 }