annotate core/modules/views/tests/src/Kernel/ViewsHooksTest.php @ 19:fa3358dc1485 tip

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