3 namespace Drupal\Tests\views\Functional\Plugin;
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;
11 * Tests the pluggable pager system.
15 class PagerTest extends ViewTestBase {
17 use AssertPageCacheContextsAndTagsTrait;
20 * Views used by this test.
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'];
31 public static $modules = ['node', 'views_ui'];
34 * String translation storage object.
36 * @var \Drupal\locale\StringStorageInterface
38 protected $localeStorage;
41 * Pagers was sometimes not stored.
43 * @see https://www.drupal.org/node/652712
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();
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.
54 $this->drupalGet('admin/structure/views/view/test_view/edit');
57 'pager[type]' => 'full',
59 $this->drupalPostForm('admin/structure/views/nojs/display/test_view/default/pager', $edit, t('Apply'));
61 'pager_options[items_per_page]' => 20,
63 $this->drupalPostForm('admin/structure/views/nojs/display/test_view/default/pager_options', $edit, t('Apply'));
64 $this->assertText('20 items');
66 // Change type and check whether the type is new type is stored.
68 'pager[type]' => 'mini',
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');
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.
80 $this->drupalGet('admin/structure/views/view/test_store_pager_settings/edit');
83 'pager[type]' => 'full',
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');
90 'pager_options[items_per_page]' => 20,
92 $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/default/pager_options', $edit, t('Apply'));
93 $this->assertText('20 items');
95 // add new display and test the settings again, by override it.
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'));
100 'override[dropdown]' => 'page_1',
102 $this->drupalPostForm('admin/structure/views/nojs/display/test_store_pager_settings/page_1/pager', $edit, t('Apply'));
105 'pager[type]' => 'mini',
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');
112 'pager_options[items_per_page]' => 10,
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.');
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.');
127 * Tests the none-pager-query.
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();
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');
140 // Setup and test a offset.
141 $view = Views::getView('test_pager_none');
149 $view->display_handler->setOption('pager', $pager);
150 $this->executeView($view);
152 $this->assertEqual(count($view->result), 8, 'Make sure that every item beside the first three is returned in the result');
154 // Check some public functions.
155 $this->assertFalse($view->pager->usePager());
156 $this->assertFalse($view->pager->useCountQuery());
157 $this->assertEqual($view->pager->getItemsPerPage(), 0);
160 public function testViewTotalRowsWithoutPager() {
161 $this->drupalCreateContentType(['type' => 'page']);
162 for ($i = 0; $i < 23; $i++) {
163 $this->drupalCreateNode();
166 $view = Views::getView('test_pager_none');
167 $view->get_total_rows = TRUE;
168 $this->executeView($view);
170 $this->assertEqual($view->total_rows, 23, "'total_rows' is calculated when pager type is 'none' and 'get_total_rows' is TRUE.");
174 * Tests the some pager plugin.
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();
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');
188 // Setup and test a offset.
189 $view = Views::getView('test_pager_some');
195 'items_per_page' => 5,
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');
202 // Check some public functions.
203 $this->assertFalse($view->pager->usePager());
204 $this->assertFalse($view->pager->useCountQuery());
208 * Tests the normal pager.
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();
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');
222 // Setup and test a offset.
223 $view = Views::getView('test_pager_full');
229 'items_per_page' => 5,
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');
236 // Test items per page = 0
237 $view = Views::getView('test_view_pager_full_zero_items_per_page');
238 $this->executeView($view);
240 $this->assertEqual(count($view->result), 11, 'All items are return');
242 // TODO test number of pages.
244 // Test items per page = 0.
245 // Setup and test a offset.
246 $view = Views::getView('test_pager_full');
252 'items_per_page' => 0,
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);
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']);
267 * Tests rendering with NULL pager.
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();
276 $view = Views::getView('test_pager_full');
277 $this->executeView($view);
278 // Force the value again here.
279 $view->setAjaxEnabled(TRUE);
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.');
287 * Test the api functions on the view object.
289 public function testPagerApi() {
290 $view = Views::getView('test_pager_full');
292 // On the first round don't initialize the pager.
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.');
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.');
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.');
311 // On this round enable the pager.
312 $view->initDisplay();
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.');
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.');
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.');
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.');
343 * Tests translating the pager using config_translation.
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;
351 // Enable locale, config_translation and language module.
352 $this->container->get('module_installer')->install(['locale', 'language', 'config_translation']);
355 $admin_user = $this->drupalCreateUser(['access content overview', 'administer nodes', 'bypass node access', 'translate configuration']);
356 $this->drupalLogin($admin_user);
360 // Add a default locale storage for this test.
361 $this->localeStorage = $this->container->get('locale.storage');
363 // Add Dutch language programmatically.
364 ConfigurableLanguage::createFromLangcode($langcode)->save();
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 »',
372 $this->drupalPostForm('admin/structure/views/view/content/translate/nl/edit', $edit, t('Save translation'));
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();
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..
384 '« First' => '« Eerste',
385 '‹ Previous' => '‹ Vorige',
386 'Next ›' => 'Volgende ›',
387 'Last »' => 'Laatste »',
389 foreach ($labels as $label => $translation) {
390 // Check if we can find the translation.
391 $this->assertRaw($translation);
396 * Tests translating the pager using locale.
398 public function testPagerLocale() {
399 // Enable locale and language module.
400 $this->container->get('module_installer')->install(['locale', 'language']);
404 // Add a default locale storage for this test.
405 $this->localeStorage = $this->container->get('locale.storage');
407 // Add Dutch language programmatically.
408 ConfigurableLanguage::createFromLangcode($langcode)->save();
410 // Labels that need translations.
412 '« First' => '« Eerste',
413 '‹ Previous' => '‹ Vorige',
414 'Next ›' => 'Volgende ›',
415 'Last »' => 'Laatste »',
417 foreach ($labels as $label => $translation) {
418 // Create source string.
419 $source = $this->localeStorage->createString(
425 $this->createTranslation($source, $translation, $langcode);
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();
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);
443 * Creates single translation for source string.
445 protected function createTranslation($source, $translation, $langcode) {
447 'lid' => $source->lid,
448 'language' => $langcode,
449 'translation' => $translation,
451 return $this->localeStorage->createTranslation($values)->save();