function ViewStorageTest::displayMethodTests

Tests the display related functions like getDisplaysList().

File

core/modules/views/tests/src/Kernel/ViewStorageTest.php, line 182

Class

ViewStorageTest

Tests the CRUD functionality for a view.

Namespace

Code

protected function displayMethodTests() {
  $config['display'] = [
    'page_1' => [
      'display_options' => [
        'path' => 'test',
      ],
      'display_plugin' => 'page',
      'id' => 'page_2',
      'display_title' => 'Page 1',
      'position' => 1,
    ],
    'feed_1' => [
      'display_options' => [
        'path' => 'test.xml',
      ],
      'display_plugin' => 'feed',
      'id' => 'feed',
      'display_title' => 'Feed',
      'position' => 2,
    ],
    'page_2' => [
      'display_options' => [
        'path' => 'test/%/extra',
      ],
      'display_plugin' => 'page',
      'id' => 'page_2',
      'display_title' => 'Page 2',
      'position' => 3,
    ],
  ];
  $view = $this->controller
    ->create($config);
  // Tests Drupal\views\Entity\View::addDisplay()
  $view = $this->controller
    ->create([]);
  $random_title = $this->randomMachineName();
  $id = $view->addDisplay('page', $random_title);
  $this->assertEquals('page_1', $id, "Make sure the first display ({$id}) has the expected ID (page_1)");
  $display = $view->get('display');
  $this->assertEquals($random_title, $display[$id]['display_title']);
  $random_title = $this->randomMachineName();
  $id = $view->addDisplay('page', $random_title);
  $display = $view->get('display');
  $this->assertEquals('page_2', $id, "Make sure the second display ({$id}) has the expected ID (page_2)");
  $this->assertEquals($random_title, $display[$id]['display_title']);
  $id = $view->addDisplay('page');
  $display = $view->get('display');
  $this->assertEquals('Page 3', $display[$id]['display_title']);
  // Ensure the 'default' display always has position zero, regardless of when
  // it was set relative to other displays. Even if the 'default' display
  // exists, adding it again will overwrite it, which is asserted with the new
  // title.
  $view->addDisplay('default', $random_title);
  $displays = $view->get('display');
  $this->assertEquals($random_title, $displays['default']['display_title'], 'Default display is defined with the new title');
  $this->assertEquals(0, $displays['default']['position'], 'Default displays are always in position zero');
  // Tests Drupal\views\Entity\View::generateDisplayId(). Since
  // generateDisplayId() is protected, we have to use reflection to unit-test
  // it.
  $view = $this->controller
    ->create([]);
  $ref_generate_display_id = new \ReflectionMethod($view, 'generateDisplayId');
  $this->assertEquals('default', $ref_generate_display_id->invoke($view, 'default'), 'The plugin ID for default is always default.');
  $this->assertEquals('feed_1', $ref_generate_display_id->invoke($view, 'feed'), 'The generated ID for the first instance of a plugin type should have an suffix of _1.');
  $view->addDisplay('feed', 'feed title');
  $this->assertEquals('feed_2', $ref_generate_display_id->invoke($view, 'feed'), 'The generated ID for the first instance of a plugin type should have an suffix of _2.');
  // Tests item related methods().
  $view = $this->controller
    ->create([
    'base_table' => 'views_test_data',
  ]);
  $view->addDisplay('default');
  $view = $view->getExecutable();
  $display_id = 'default';
  $expected_items = [];
  // Tests addHandler with getItem.
  // Therefore add one item without any options and one item with some
  // options.
  $id1 = $view->addHandler($display_id, 'field', 'views_test_data', 'id');
  $item1 = $view->getHandler($display_id, 'field', 'id');
  $expected_items[$id1] = $expected_item = [
    'id' => 'id',
    'table' => 'views_test_data',
    'field' => 'id',
    'plugin_id' => 'numeric',
  ];
  $this->assertEquals($expected_item, $item1);
  $options = [
    'alter' => [
      'text' => $this->randomMachineName(),
    ],
  ];
  $id2 = $view->addHandler($display_id, 'field', 'views_test_data', 'name', $options);
  $item2 = $view->getHandler($display_id, 'field', 'name');
  $expected_items[$id2] = $expected_item = [
    'id' => 'name',
    'table' => 'views_test_data',
    'field' => 'name',
    'plugin_id' => 'standard',
  ] + $options;
  $this->assertEquals($expected_item, $item2);
  // Tests the expected fields from the previous additions.
  $this->assertEquals($expected_items, $view->getHandlers('field', $display_id));
  // Alter an existing item via setItem and check the result via getItem
  // and getItems.
  $item = [
    'alter' => [
      'text' => $this->randomMachineName(),
    ],
  ] + $item1;
  $expected_items[$id1] = $item;
  $view->setHandler($display_id, 'field', $id1, $item);
  $this->assertEquals($item, $view->getHandler($display_id, 'field', 'id'));
  $this->assertEquals($expected_items, $view->getHandlers('field', $display_id));
  // Test removeItem method.
  unset($expected_items[$id2]);
  $view->removeHandler($display_id, 'field', $id2);
  $this->assertEquals($expected_items, $view->getHandlers('field', $display_id));
}