www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/views/tests/src/Functional/Plugin/PagerTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\views\Functional\Plugin;
   4
   5 use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
   6 use Drupal\Tests\views\Functional\ViewTestBase;
   7 use Drupal\views\Views;
   8 use Drupal\language\Entity\ConfigurableLanguage;
   9
  10 /**
  11  * Tests the pluggable pager system.
  12  *
  13  * @group views
  14  */
  15 class PagerTest extends ViewTestBase {
  16
  17   use AssertPageCacheContextsAndTagsTrait;
  18
  19   /**
  20    * Views used by this test.
  21    *
  22    * @var array
  23    */
  24   public static $testViews = ['test_store_pager_settings', 'test_pager_none', 'test_pager_some', 'test_pager_full', 'test_view_pager_full_zero_items_per_page', 'test_view', 'content'];
  25
  26   /**
  27    * Modules to enable.
  28    *
  29    * @var array
  30    */
  31   public static $modules = ['node', 'views_ui'];
  32
  33   /**
  34    * String translation storage object.
  35    *
  36    * @var \Drupal\locale\StringStorageInterface
  37    */
  38   protected $localeStorage;
  39
  40   /**
  41    * Pagers was sometimes not stored.
  42    *
  43    * @see https://www.drupal.org/node/652712
  44    */
  45   public function testStorePagerSettings() {
  46     // Show the master display so the override selection is shown.
  47     \Drupal::configFactory()->getEditable('views.settings')->set('ui.show.master_display', TRUE)->save();
  48
  49     $admin_user = $this->drupalCreateUser(['administer views', 'administer site configuration']);
  50     $this->drupalLogin($admin_user);
  51     // Test behavior described in
  52     //   https://www.drupal.org/node/652712#comment-2354918.
  53
  54     $this->drupalGet('admin/structure/views/view/test_view/edit');
  55
  56     $edit = [
  57       'pager[type]' => 'full',
  58     ];
  59     $this->drupalPostForm('admin/structure/views/nojs/display/test_view/default/pager', $edit, t('Apply'));
  60     $edit = [
  61       'pager_options[items_per_page]' => 20,
  62     ];
  63     $this->drupalPostForm('admin/structure/views/nojs/display/test_view/default/pager_options', $edit, t('Apply'));
  64     $this->assertText('20 items');
  65
  66     // Change type and check whether the type is new type is stored.
  67     $edit = [
  68       'pager[type]' => 'mini',
  69     ];
  70     $this->drupalPostForm('admin/structure/views/nojs/display/test_view/default/pager', $edit, t('Apply'));
  71     $this->drupalGet('admin/structure/views/view/test_view/edit');
  72     $this->assertText('Mini', 'Changed pager plugin, should change some text');
  73
  74     // Test behavior described in
  75     //   https://www.drupal.org/node/652712#comment-2354400.
  76     $view = Views::getView('test_store_pager_settings');
  77     // Make it editable in the admin interface.
  78     $view->save();
  79
  80     $this->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
  81
  82     $edit = [
  83       'pager[type]' => 'full',
  84     ];
  85     $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/default/pager', $edit, t('Apply'));
  86     $this->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
  87     $this->assertText('Full');
  88
  89     $edit = [
  90       'pager_options[items_per_page]' => 20,
  91     ];
  92     $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/default/pager_options', $edit, t('Apply'));
  93     $this->assertText('20 items');
  94
  95     // add new display and test the settings again, by override it.
  96     $edit = [];
  97     // Add a display and override the pager settings.
  98     $this->drupalPostForm('admin/structure/views/view/test_store_pager_settings/edit', $edit, t('Add Page'));
  99     $edit = [
 100       'override[dropdown]' => 'page_1',
 101     ];
 102     $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager', $edit, t('Apply'));
 103
 104     $edit = [
 105       'pager[type]' => 'mini',
 106     ];
 107     $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager', $edit, t('Apply'));
 108     $this->drupalGet('admin/structure/views/view/test_store_pager_settings/edit/page_1');
 109     $this->assertText('Mini', 'Changed pager plugin, should change some text');
 110
 111     $edit = [
 112       'pager_options[items_per_page]' => 10,
 113     ];
 114     $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/default/pager_options', $edit, t('Apply'));
 115     $this->assertText('10 items', 'The default value has been changed.');
 116     $this->drupalGet('admin/structure/views/view/test_store_pager_settings/edit/page_1');
 117     $this->assertText('20 items', 'The original value remains unchanged.');
 118
 119     // Test that the override element is only displayed on pager plugin selection form.
 120     $this->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager');
 121     $this->assertFieldByName('override[dropdown]', 'page_1', 'The override element is displayed on plugin selection form.');
 122     $this->drupalGet('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager_options');
 123     $this->assertNoFieldByName('override[dropdown]', NULL, 'The override element is not displayed on plugin settings form.');
 124   }
 125
 126   /**
 127    * Tests the none-pager-query.
 128    */
 129   public function testNoLimit() {
 130     // Create 11 nodes and make sure that everyone is returned.
 131     // We create 11 nodes, because the default pager plugin had 10 items per page.
 132     $this->drupalCreateContentType(['type' => 'page']);
 133     for ($i = 0; $i < 11; $i++) {
 134       $this->drupalCreateNode();
 135     }
 136     $view = Views::getView('test_pager_none');
 137     $this->executeView($view);
 138     $this->assertEqual(count($view->result), 11, 'Make sure that every item is returned in the result');
 139
 140     // Setup and test a offset.
 141     $view = Views::getView('test_pager_none');
 142     $view->setDisplay();
 143     $pager = [
 144       'type' => 'none',
 145       'options' => [
 146         'offset' => 3,
 147       ],
 148     ];
 149     $view->display_handler->setOption('pager', $pager);
 150     $this->executeView($view);
 151
 152     $this->assertEqual(count($view->result), 8, 'Make sure that every item beside the first three is returned in the result');
 153
 154     // Check some public functions.
 155     $this->assertFalse($view->pager->usePager());
 156     $this->assertFalse($view->pager->useCountQuery());
 157     $this->assertEqual($view->pager->getItemsPerPage(), 0);
 158   }
 159
 160   public function testViewTotalRowsWithoutPager() {
 161     $this->drupalCreateContentType(['type' => 'page']);
 162     for ($i = 0; $i < 23; $i++) {
 163       $this->drupalCreateNode();
 164     }
 165
 166     $view = Views::getView('test_pager_none');
 167     $view->get_total_rows = TRUE;
 168     $this->executeView($view);
 169
 170     $this->assertEqual($view->total_rows, 23, "'total_rows' is calculated when pager type is 'none' and 'get_total_rows' is TRUE.");
 171   }
 172
 173   /**
 174    * Tests the some pager plugin.
 175    */
 176   public function testLimit() {
 177     // Create 11 nodes and make sure that everyone is returned.
 178     // We create 11 nodes, because the default pager plugin had 10 items per page.
 179     $this->drupalCreateContentType(['type' => 'page']);
 180     for ($i = 0; $i < 11; $i++) {
 181       $this->drupalCreateNode();
 182     }
 183
 184     $view = Views::getView('test_pager_some');
 185     $this->executeView($view);
 186     $this->assertEqual(count($view->result), 5, 'Make sure that only a certain count of items is returned');
 187
 188     // Setup and test a offset.
 189     $view = Views::getView('test_pager_some');
 190     $view->setDisplay();
 191     $pager = [
 192       'type' => 'none',
 193       'options' => [
 194         'offset' => 8,
 195         'items_per_page' => 5,
 196       ],
 197     ];
 198     $view->display_handler->setOption('pager', $pager);
 199     $this->executeView($view);
 200     $this->assertEqual(count($view->result), 3, 'Make sure that only a certain count of items is returned');
 201
 202     // Check some public functions.
 203     $this->assertFalse($view->pager->usePager());
 204     $this->assertFalse($view->pager->useCountQuery());
 205   }
 206
 207   /**
 208    * Tests the normal pager.
 209    */
 210   public function testNormalPager() {
 211     // Create 11 nodes and make sure that everyone is returned.
 212     // We create 11 nodes, because the default pager plugin had 10 items per page.
 213     $this->drupalCreateContentType(['type' => 'page']);
 214     for ($i = 0; $i < 11; $i++) {
 215       $this->drupalCreateNode();
 216     }
 217
 218     $view = Views::getView('test_pager_full');
 219     $this->executeView($view);
 220     $this->assertEqual(count($view->result), 5, 'Make sure that only a certain count of items is returned');
 221
 222     // Setup and test a offset.
 223     $view = Views::getView('test_pager_full');
 224     $view->setDisplay();
 225     $pager = [
 226       'type' => 'full',
 227       'options' => [
 228         'offset' => 8,
 229         'items_per_page' => 5,
 230       ],
 231     ];
 232     $view->display_handler->setOption('pager', $pager);
 233     $this->executeView($view);
 234     $this->assertEqual(count($view->result), 3, 'Make sure that only a certain count of items is returned');
 235
 236     // Test items per page = 0
 237     $view = Views::getView('test_view_pager_full_zero_items_per_page');
 238     $this->executeView($view);
 239
 240     $this->assertEqual(count($view->result), 11, 'All items are return');
 241
 242     // TODO test number of pages.
 243
 244     // Test items per page = 0.
 245     // Setup and test a offset.
 246     $view = Views::getView('test_pager_full');
 247     $view->setDisplay();
 248     $pager = [
 249       'type' => 'full',
 250       'options' => [
 251         'offset' => 0,
 252         'items_per_page' => 0,
 253       ],
 254     ];
 255
 256     $view->display_handler->setOption('pager', $pager);
 257     $this->executeView($view);
 258     $this->assertEqual($view->pager->getItemsPerPage(), 0);
 259     $this->assertEqual(count($view->result), 11);
 260
 261     // Test pager cache contexts.
 262     $this->drupalGet('test_pager_full');
 263     $this->assertCacheContexts(['languages:language_interface', 'theme', 'timezone', 'url.query_args', 'user.node_grants:view']);
 264   }
 265
 266   /**
 267    * Tests rendering with NULL pager.
 268    */
 269   public function testRenderNullPager() {
 270     // Create 11 nodes and make sure that everyone is returned.
 271     // We create 11 nodes, because the default pager plugin had 10 items per page.
 272     $this->drupalCreateContentType(['type' => 'page']);
 273     for ($i = 0; $i < 11; $i++) {
 274       $this->drupalCreateNode();
 275     }
 276     $view = Views::getView('test_pager_full');
 277     $this->executeView($view);
 278     // Force the value again here.
 279     $view->setAjaxEnabled(TRUE);
 280     $view->pager = NULL;
 281     $output = $view->render();
 282     $output = \Drupal::service('renderer')->renderRoot($output);
 283     $this->assertEqual(preg_match('/<ul class="pager">/', $output), 0, 'The pager is not rendered.');
 284   }
 285
 286   /**
 287    * Test the api functions on the view object.
 288    */
 289   public function testPagerApi() {
 290     $view = Views::getView('test_pager_full');
 291     $view->setDisplay();
 292     // On the first round don't initialize the pager.
 293
 294     $this->assertEqual($view->getItemsPerPage(), NULL, 'If the pager is not initialized and no manual override there is no items per page.');
 295     $rand_number = rand(1, 5);
 296     $view->setItemsPerPage($rand_number);
 297     $this->assertEqual($view->getItemsPerPage(), $rand_number, 'Make sure getItemsPerPage uses the settings of setItemsPerPage.');
 298
 299     $this->assertEqual($view->getOffset(), NULL, 'If the pager is not initialized and no manual override there is no offset.');
 300     $rand_number = rand(1, 5);
 301     $view->setOffset($rand_number);
 302     $this->assertEqual($view->getOffset(), $rand_number, 'Make sure getOffset uses the settings of setOffset.');
 303
 304     $this->assertEqual($view->getCurrentPage(), NULL, 'If the pager is not initialized and no manual override there is no current page.');
 305     $rand_number = rand(1, 5);
 306     $view->setCurrentPage($rand_number);
 307     $this->assertEqual($view->getCurrentPage(), $rand_number, 'Make sure getCurrentPage uses the settings of set_current_page.');
 308
 309     $view->destroy();
 310
 311     // On this round enable the pager.
 312     $view->initDisplay();
 313     $view->initQuery();
 314     $view->initPager();
 315
 316     $this->assertEqual($view->getItemsPerPage(), 5, 'Per default the view has 5 items per page.');
 317     $rand_number = rand(1, 5);
 318     $view->setItemsPerPage($rand_number);
 319     $rand_number = rand(6, 11);
 320     $view->pager->setItemsPerPage($rand_number);
 321     $this->assertEqual($view->getItemsPerPage(), $rand_number, 'Make sure getItemsPerPage uses the settings of setItemsPerPage.');
 322
 323     $this->assertEqual($view->getOffset(), 0, 'Per default a view has a 0 offset.');
 324     $rand_number = rand(1, 5);
 325     $view->setOffset($rand_number);
 326     $rand_number = rand(6, 11);
 327     $view->pager->setOffset($rand_number);
 328     $this->assertEqual($view->getOffset(), $rand_number, 'Make sure getOffset uses the settings of setOffset.');
 329
 330     $this->assertEqual($view->getCurrentPage(), 0, 'Per default the current page is 0.');
 331     $rand_number = rand(1, 5);
 332     $view->setCurrentPage($rand_number);
 333     $rand_number = rand(6, 11);
 334     $view->pager->setCurrentPage($rand_number);
 335     $this->assertEqual($view->getCurrentPage(), $rand_number, 'Make sure getCurrentPage uses the settings of set_current_page.');
 336
 337     // Set an invalid page and make sure the method takes care about it.
 338     $view->setCurrentPage(-1);
 339     $this->assertEqual($view->getCurrentPage(), 0, 'Make sure setCurrentPage always sets a valid page number.');
 340   }
 341
 342   /**
 343    * Tests translating the pager using config_translation.
 344    */
 345   public function testPagerConfigTranslation() {
 346     $view = Views::getView('content');
 347     $display = &$view->storage->getDisplay('default');
 348     $display['display_options']['pager']['options']['items_per_page'] = 5;
 349     $view->save();
 350
 351     // Enable locale, config_translation and language module.
 352     $this->container->get('module_installer')->install(['locale', 'language', 'config_translation']);
 353     $this->resetAll();
 354
 355     $admin_user = $this->drupalCreateUser(['access content overview', 'administer nodes', 'bypass node access', 'translate configuration']);
 356     $this->drupalLogin($admin_user);
 357
 358     $langcode = 'nl';
 359
 360     // Add a default locale storage for this test.
 361     $this->localeStorage = $this->container->get('locale.storage');
 362
 363     // Add Dutch language programmatically.
 364     ConfigurableLanguage::createFromLangcode($langcode)->save();
 365
 366     $edit = [
 367       'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][first]' => '« Eerste',
 368       'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][previous]' => '‹ Vorige',
 369       'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][next]' => 'Volgende ›',
 370       'translation[config_names][views.view.content][display][default][display_options][pager][options][tags][last]' => 'Laatste »',
 371     ];
 372     $this->drupalPostForm('admin/structure/views/view/content/translate/nl/edit', $edit, t('Save translation'));
 373
 374     // We create 11 nodes, this will give us 3 pages.
 375     $this->drupalCreateContentType(['type' => 'page']);
 376     for ($i = 0; $i < 11; $i++) {
 377       $this->drupalCreateNode();
 378     }
 379
 380     // Go to the second page so we see both previous and next buttons.
 381     $this->drupalGet('nl/admin/content', ['query' => ['page' => 1]]);
 382     // Translation mapping..
 383     $labels = [
 384       '« First' => '« Eerste',
 385       '‹ Previous' => '‹ Vorige',
 386       'Next ›' => 'Volgende ›',
 387       'Last »' => 'Laatste »',
 388     ];
 389     foreach ($labels as $label => $translation) {
 390       // Check if we can find the translation.
 391       $this->assertRaw($translation);
 392     }
 393   }
 394
 395   /**
 396    * Tests translating the pager using locale.
 397    */
 398   public function testPagerLocale() {
 399     // Enable locale and language module.
 400     $this->container->get('module_installer')->install(['locale', 'language']);
 401     $this->resetAll();
 402     $langcode = 'nl';
 403
 404     // Add a default locale storage for this test.
 405     $this->localeStorage = $this->container->get('locale.storage');
 406
 407     // Add Dutch language programmatically.
 408     ConfigurableLanguage::createFromLangcode($langcode)->save();
 409
 410     // Labels that need translations.
 411     $labels = [
 412       '« First' => '« Eerste',
 413       '‹ Previous' => '‹ Vorige',
 414       'Next ›' => 'Volgende ›',
 415       'Last »' => 'Laatste »',
 416     ];
 417     foreach ($labels as $label => $translation) {
 418       // Create source string.
 419       $source = $this->localeStorage->createString(
 420         [
 421           'source' => $label
 422         ]
 423       );
 424       $source->save();
 425       $this->createTranslation($source, $translation, $langcode);
 426     }
 427
 428     // We create 11 nodes, this will give us 3 pages.
 429     $this->drupalCreateContentType(['type' => 'page']);
 430     for ($i = 0; $i < 11; $i++) {
 431       $this->drupalCreateNode();
 432     }
 433
 434     // Go to the second page so we see both previous and next buttons.
 435     $this->drupalGet('nl/test_pager_full', ['query' => ['page' => 1]]);
 436     foreach ($labels as $label => $translation) {
 437       // Check if we can find the translation.
 438       $this->assertRaw($translation);
 439     }
 440   }
 441
 442   /**
 443    * Creates single translation for source string.
 444    */
 445   protected function createTranslation($source, $translation, $langcode) {
 446     $values = [
 447       'lid' => $source->lid,
 448       'language' => $langcode,
 449       'translation' => $translation,
 450     ];
 451     return $this->localeStorage->createTranslation($values)->save();
 452   }
 453
 454 }