Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\views\Kernel;
Chris@0: 
Chris@0: use Drupal\Core\Render\RenderContext;
Chris@0: use Drupal\views\Views;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests that views hooks are registered when defined in $module.views.inc.
Chris@0:  *
Chris@0:  * @group views
Chris@0:  * @see views_hook_info().
Chris@0:  * @see field_hook_info().
Chris@0:  */
Chris@0: class ViewsHooksTest extends ViewsKernelTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Views used by this test.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $testViews = ['test_view'];
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of available views hooks to test.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected static $hooks = [
Chris@0:     'views_data' => 'all',
Chris@0:     'views_data_alter' => 'alter',
Chris@0:     'views_query_substitutions' => 'view',
Chris@0:     'views_form_substitutions' => 'view',
Chris@0:     'views_analyze' => 'view',
Chris@0:     'views_pre_view' => 'view',
Chris@0:     'views_pre_build' => 'view',
Chris@0:     'views_post_build' => 'view',
Chris@0:     'views_pre_execute' => 'view',
Chris@0:     'views_post_execute' => 'view',
Chris@0:     'views_pre_render' => 'view',
Chris@0:     'views_post_render' => 'view',
Chris@0:     'views_query_alter'  => 'view',
Chris@0:     'views_invalidate_cache' => 'all',
Chris@0:   ];
Chris@0: 
Chris@0:   /**
Chris@0:    * The module handler to use for invoking hooks.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Extension\ModuleHandlerInterface
Chris@0:    */
Chris@0:   protected $moduleHandler;
Chris@0: 
Chris@0:   protected function setUp($import_test_views = TRUE) {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     $this->moduleHandler = $this->container->get('module_handler');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the hooks.
Chris@0:    */
Chris@0:   public function testHooks() {
Chris@0:     $view = Views::getView('test_view');
Chris@0:     $view->setDisplay();
Chris@0: 
Chris@0:     // Test each hook is found in the implementations array and is invoked.
Chris@0:     foreach (static::$hooks as $hook => $type) {
Chris@0:       $this->assertTrue($this->moduleHandler->implementsHook('views_test_data', $hook), format_string('The hook @hook was registered.', ['@hook' => $hook]));
Chris@0: 
Chris@0:       if ($hook == 'views_post_render') {
Chris@0:         $this->moduleHandler->invoke('views_test_data', $hook, [$view, &$view->display_handler->output, $view->display_handler->getPlugin('cache')]);
Chris@0:         continue;
Chris@0:       }
Chris@0: 
Chris@0:       switch ($type) {
Chris@0:         case 'view':
Chris@0:           $this->moduleHandler->invoke('views_test_data', $hook, [$view]);
Chris@0:           break;
Chris@0: 
Chris@0:         case 'alter':
Chris@0:           $data = [];
Chris@0:           $this->moduleHandler->invoke('views_test_data', $hook, [$data]);
Chris@0:           break;
Chris@0: 
Chris@0:         default:
Chris@0:           $this->moduleHandler->invoke('views_test_data', $hook);
Chris@0:       }
Chris@0: 
Chris@0:       $this->assertTrue($this->container->get('state')->get('views_hook_test_' . $hook), format_string('The %hook hook was invoked.', ['%hook' => $hook]));
Chris@0:       // Reset the module implementations cache, so we ensure that the
Chris@0:       // .views.inc file is loaded actively.
Chris@0:       $this->moduleHandler->resetImplementations();
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests how hook_views_form_substitutions() makes substitutions.
Chris@0:    *
Chris@0:    * @see views_test_data_views_form_substitutions()
Chris@0:    * @see views_pre_render_views_form_views_form()
Chris@0:    */
Chris@0:   public function testViewsPreRenderViewsFormViewsForm() {
Chris@0:     $element = [
Chris@0:       'output' => [
Chris@0:         '#plain_text' => '<!--will-be-escaped--><!--will-be-not-escaped-->',
Chris@0:       ],
Chris@0:       '#substitutions' => ['#value' => []],
Chris@0:     ];
Chris@0:     $element = \Drupal::service('renderer')->executeInRenderContext(new RenderContext(), function () use ($element) {
Chris@0:       return views_pre_render_views_form_views_form($element);
Chris@0:     });
Chris@0:     $this->setRawContent((string) $element['output']['#markup']);
Chris@0:     $this->assertEscaped('<em>escaped</em>');
Chris@0:     $this->assertRaw('<em>unescaped</em>');
Chris@0:   }
Chris@0: 
Chris@0: }