StyleTest.php 13 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1 2 3 4
<?php

/**
 * @file
5
 * Definition of Drupal\views\Tests\Plugin\StyleTest.
merlinofchaos's avatar
merlinofchaos committed
6 7
 */

8
namespace Drupal\views\Tests\Plugin;
9

merlinofchaos's avatar
merlinofchaos committed
10 11
/**
 * Tests some general style plugin related functionality.
12 13
 *
 * @see Drupal\views_test_data\Plugin\views\style\StyleTest.
merlinofchaos's avatar
merlinofchaos committed
14
 */
15
class StyleTest extends StyleTestBase {
16

merlinofchaos's avatar
merlinofchaos committed
17 18
  public static function getInfo() {
    return array(
19
      'name' => 'Style: General',
merlinofchaos's avatar
merlinofchaos committed
20 21 22 23 24
      'description' => 'Test general style functionality.',
      'group' => 'Views Plugins',
    );
  }

25 26 27 28 29
  /**
   * Tests the general renderering of styles.
   */
  public function testStyle() {
    $view = $this->getView();
30 31 32
    $style = $view->display_handler->getOption('style');
    $style['type'] = 'test_style';
    $view->display_handler->setOption('style', $style);
33 34 35 36 37 38 39 40 41 42 43 44 45
    $view->initDisplay();
    $view->initStyle();
    $this->assertTrue($view->style_plugin instanceof \Drupal\views_test_data\Plugin\views\style\StyleTest, 'Make sure the right style plugin class is loaded.');

    $random_text = $this->randomName();
    // Set some custom text to the output and make sure that this value is
    // rendered.
    $view->style_plugin->setOutput($random_text);
    $output = $view->preview();
    $this->assertTrue(strpos($output, $random_text) !== FALSE, 'Take sure that the rendering of the style plugin appears in the output of the view.');

    // This run use the test row plugin and render with it.
    $view = $this->getView();
46 47 48 49 50 51
    $style = $view->display_handler->getOption('style');
    $style['type'] = 'test_style';
    $view->display_handler->setOption('style', $style);
    $row = $view->display_handler->getOption('row');
    $row['type'] = 'test_row';
    $view->display_handler->setOption('row', $row);
52 53 54 55
    $view->initDisplay();
    $view->initStyle();
    $view->style_plugin->setUsesRowPlugin(TRUE);
    // Reinitialize the style as it supports row plugins now.
56
    $view->style_plugin->init($view, $view->display_handler, array());
57 58 59 60 61 62 63 64 65
    $this->assertTrue($view->style_plugin->row_plugin instanceof \Drupal\views_test_data\Plugin\views\row\RowTest, 'Make sure the right row plugin class is loaded.');

    $random_text = $this->randomName();
    $view->style_plugin->row_plugin->setOutput($random_text);

    $output = $view->preview();
    $this->assertTrue(strpos($output, $random_text) !== FALSE, 'Take sure that the rendering of the row plugin appears in the output of the view.');
  }

merlinofchaos's avatar
merlinofchaos committed
66 67 68 69
  /**
   * Tests the grouping legacy features of styles.
   */
  function testGroupingLegacy() {
70
    $view = $this->view->cloneView();
merlinofchaos's avatar
merlinofchaos committed
71
    // Setup grouping by the job.
72 73
    $view->initDisplay();
    $view->initStyle();
merlinofchaos's avatar
merlinofchaos committed
74 75 76 77
    $view->style_plugin->options['grouping'] = 'job';

    // Reduce the amount of items to make the test a bit easier.
    // Set up the pager.
78
    $view->displayHandlers['default']->overrideOption('pager', array(
merlinofchaos's avatar
merlinofchaos committed
79 80 81 82 83
      'type' => 'some',
      'options' => array('items_per_page' => 3),
    ));

    // Add the job field .
84
    $view->displayHandlers['default']->overrideOption('fields', array(
merlinofchaos's avatar
merlinofchaos committed
85 86
      'name' => array(
        'id' => 'name',
87
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
88 89 90 91 92
        'field' => 'name',
        'relationship' => 'none',
      ),
      'job' => array(
        'id' => 'job',
93
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107
        'field' => 'job',
        'relationship' => 'none',
      ),
    ));

    // Now run the query and groupby the result.
    $this->executeView($view);

    // This is the old way to call it.
    $sets = $view->style_plugin->render_grouping($view->result, $view->style_plugin->options['grouping']);

    $expected = array();
    // Use Job: as label, so be sure that the label is used for groupby as well.
    $expected['Job: Singer'] = array();
108
    $expected['Job: Singer'][0] = new \stdClass();
109 110 111
    $expected['Job: Singer'][0]->views_test_data_name = 'John';
    $expected['Job: Singer'][0]->views_test_data_job = 'Singer';
    $expected['Job: Singer'][0]->views_test_data_id = '1';
112
    $expected['Job: Singer'][1] = new \stdClass();
113 114 115
    $expected['Job: Singer'][1]->views_test_data_name = 'George';
    $expected['Job: Singer'][1]->views_test_data_job = 'Singer';
    $expected['Job: Singer'][1]->views_test_data_id = '2';
merlinofchaos's avatar
merlinofchaos committed
116
    $expected['Job: Drummer'] = array();
117
    $expected['Job: Drummer'][2] = new \stdClass();
118 119 120
    $expected['Job: Drummer'][2]->views_test_data_name = 'Ringo';
    $expected['Job: Drummer'][2]->views_test_data_job = 'Drummer';
    $expected['Job: Drummer'][2]->views_test_data_id = '3';
merlinofchaos's avatar
merlinofchaos committed
121 122 123 124 125 126

    $this->assertEqual($sets, $expected, t('The style plugin should proper group the results with grouping by the rendered output.'));

    $expected = array();
    $expected['Job: Singer'] = array();
    $expected['Job: Singer']['group'] = 'Job: Singer';
127
    $expected['Job: Singer']['rows'][0] = new \stdClass();
128 129 130
    $expected['Job: Singer']['rows'][0]->views_test_data_name = 'John';
    $expected['Job: Singer']['rows'][0]->views_test_data_job = 'Singer';
    $expected['Job: Singer']['rows'][0]->views_test_data_id = '1';
131
    $expected['Job: Singer']['rows'][1] = new \stdClass();
132 133 134
    $expected['Job: Singer']['rows'][1]->views_test_data_name = 'George';
    $expected['Job: Singer']['rows'][1]->views_test_data_job = 'Singer';
    $expected['Job: Singer']['rows'][1]->views_test_data_id = '2';
merlinofchaos's avatar
merlinofchaos committed
135 136
    $expected['Job: Drummer'] = array();
    $expected['Job: Drummer']['group'] = 'Job: Drummer';
137
    $expected['Job: Drummer']['rows'][2] = new \stdClass();
138 139 140
    $expected['Job: Drummer']['rows'][2]->views_test_data_name = 'Ringo';
    $expected['Job: Drummer']['rows'][2]->views_test_data_job = 'Drummer';
    $expected['Job: Drummer']['rows'][2]->views_test_data_id = '3';
merlinofchaos's avatar
merlinofchaos committed
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

    // The newer api passes the value of the grouping as well.
    $sets_new_rendered = $view->style_plugin->render_grouping($view->result, $view->style_plugin->options['grouping'], TRUE);
    $sets_new_value = $view->style_plugin->render_grouping($view->result, $view->style_plugin->options['grouping'], FALSE);

    $this->assertEqual($sets_new_rendered, $expected, t('The style plugins should proper group the results with grouping by the rendered output.'));

    // Reorder the group structure to group by value.
    $expected['Singer'] = $expected['Job: Singer'];
    $expected['Drummer'] = $expected['Job: Drummer'];
    unset($expected['Job: Singer']);
    unset($expected['Job: Drummer']);

    $this->assertEqual($sets_new_value, $expected, t('The style plugins should proper group the results with grouping by the value.'));
  }

  function testGrouping() {
    $this->_testGrouping(FALSE);
    $this->_testGrouping(TRUE);
  }

  /**
   * Tests the grouping features of styles.
   */
  function _testGrouping($stripped = FALSE) {
166
    $view = $this->getView();
merlinofchaos's avatar
merlinofchaos committed
167
    // Setup grouping by the job and the age field.
168 169
    $view->initDisplay();
    $view->initStyle();
merlinofchaos's avatar
merlinofchaos committed
170 171 172 173 174 175 176
    $view->style_plugin->options['grouping'] = array(
      array('field' => 'job'),
      array('field' => 'age'),
    );

    // Reduce the amount of items to make the test a bit easier.
    // Set up the pager.
177
    $view->displayHandlers['default']->overrideOption('pager', array(
merlinofchaos's avatar
merlinofchaos committed
178 179 180 181 182
      'type' => 'some',
      'options' => array('items_per_page' => 3),
    ));

    // Add the job and age field.
183
    $view->displayHandlers['default']->overrideOption('fields', array(
merlinofchaos's avatar
merlinofchaos committed
184 185
      'name' => array(
        'id' => 'name',
186
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
187 188 189 190 191
        'field' => 'name',
        'relationship' => 'none',
      ),
      'job' => array(
        'id' => 'job',
192
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
193 194 195 196 197
        'field' => 'job',
        'relationship' => 'none',
      ),
      'age' => array(
        'id' => 'age',
198
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
199 200 201 202 203 204 205 206 207 208 209 210 211
        'field' => 'age',
        'relationship' => 'none',
      ),
    ));

    // Now run the query and groupby the result.
    $this->executeView($view);

    $expected = array();
    $expected['Job: Singer'] = array();
    $expected['Job: Singer']['group'] = 'Job: Singer';
    $expected['Job: Singer']['rows']['Age: 25'] = array();
    $expected['Job: Singer']['rows']['Age: 25']['group'] = 'Age: 25';
212
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0] = new \stdClass();
213 214 215 216
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0]->views_test_data_name = 'John';
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0]->views_test_data_job = 'Singer';
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0]->views_test_data_age = '25';
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0]->views_test_data_id = '1';
merlinofchaos's avatar
merlinofchaos committed
217 218
    $expected['Job: Singer']['rows']['Age: 27'] = array();
    $expected['Job: Singer']['rows']['Age: 27']['group'] = 'Age: 27';
219
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1] = new \stdClass();
220 221 222 223
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1]->views_test_data_name = 'George';
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1]->views_test_data_job = 'Singer';
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1]->views_test_data_age = '27';
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1]->views_test_data_id = '2';
merlinofchaos's avatar
merlinofchaos committed
224 225 226 227
    $expected['Job: Drummer'] = array();
    $expected['Job: Drummer']['group'] = 'Job: Drummer';
    $expected['Job: Drummer']['rows']['Age: 28'] = array();
    $expected['Job: Drummer']['rows']['Age: 28']['group'] = 'Age: 28';
228
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2] = new \stdClass();
229 230 231 232
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2]->views_test_data_name = 'Ringo';
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2]->views_test_data_job = 'Drummer';
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2]->views_test_data_age = '28';
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2]->views_test_data_id = '3';
merlinofchaos's avatar
merlinofchaos committed
233 234 235 236 237 238 239


    // Alter the results to support the stripped case.
    if ($stripped) {

      // Add some html to the result and expected value.
      $rand = '<a data="' . $this->randomName() . '" />';
240 241
      $view->result[0]->views_test_data_job .= $rand;
      $expected['Job: Singer']['rows']['Age: 25']['rows'][0]->views_test_data_job = 'Singer' . $rand;
merlinofchaos's avatar
merlinofchaos committed
242 243
      $expected['Job: Singer']['group'] = 'Job: Singer';
      $rand = '<a data="' . $this->randomName() . '" />';
244 245
      $view->result[1]->views_test_data_job .= $rand;
      $expected['Job: Singer']['rows']['Age: 27']['rows'][1]->views_test_data_job = 'Singer' . $rand;
merlinofchaos's avatar
merlinofchaos committed
246
      $rand = '<a data="' . $this->randomName() . '" />';
247 248
      $view->result[2]->views_test_data_job .= $rand;
      $expected['Job: Drummer']['rows']['Age: 28']['rows'][2]->views_test_data_job = 'Drummer' . $rand;
merlinofchaos's avatar
merlinofchaos committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
      $expected['Job: Drummer']['group'] = 'Job: Drummer';

      $view->style_plugin->options['grouping'][0] = array('field' => 'job', 'rendered' => TRUE, 'rendered_strip' => TRUE);
      $view->style_plugin->options['grouping'][1] = array('field' => 'age', 'rendered' => TRUE, 'rendered_strip' => TRUE);
    }


    // The newer api passes the value of the grouping as well.
    $sets_new_rendered = $view->style_plugin->render_grouping($view->result, $view->style_plugin->options['grouping'], TRUE);

    $this->assertEqual($sets_new_rendered, $expected, t('The style plugins should proper group the results with grouping by the rendered output.'));

    // Don't test stripped case, because the actual value is not stripped.
    if (!$stripped) {
      $sets_new_value = $view->style_plugin->render_grouping($view->result, $view->style_plugin->options['grouping'], FALSE);

      // Reorder the group structure to grouping by value.
      $expected['Singer'] = $expected['Job: Singer'];
      $expected['Singer']['rows']['25'] = $expected['Job: Singer']['rows']['Age: 25'];
      $expected['Singer']['rows']['27'] = $expected['Job: Singer']['rows']['Age: 27'];
      $expected['Drummer'] = $expected['Job: Drummer'];
      $expected['Drummer']['rows']['28'] = $expected['Job: Drummer']['rows']['Age: 28'];
      unset($expected['Job: Singer']);
      unset($expected['Singer']['rows']['Age: 25']);
      unset($expected['Singer']['rows']['Age: 27']);
      unset($expected['Job: Drummer']);
      unset($expected['Drummer']['rows']['Age: 28']);

      $this->assertEqual($sets_new_value, $expected, t('The style plugins should proper group the results with grouping by the value.'));
    }
  }

  /**
   * Tests custom css classes.
   */
  function testCustomRowClasses() {
285
    $view = $this->view->cloneView();
merlinofchaos's avatar
merlinofchaos committed
286 287

    // Setup some random css class.
288 289
    $view->initDisplay();
    $view->initStyle();
merlinofchaos's avatar
merlinofchaos committed
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    $random_name = $this->randomName();
    $view->style_plugin->options['row_class'] = $random_name . " test-token-[name]";

    $rendered_output = $view->preview();
    $this->storeViewPreview($rendered_output);

    $rows = $this->elements->body->div->div->div;
    $count = 0;
    foreach ($rows as $row) {
      $attributes = $row->attributes();
      $class = (string) $attributes['class'][0];
      $this->assertTrue(strpos($class, $random_name) !== FALSE, 'Take sure that a custom css class is added to the output.');

      // Check token replacement.
      $name = $view->field['name']->get_value($view->result[$count]);
      $this->assertTrue(strpos($class, "test-token-$name") !== FALSE, 'Take sure that a token in custom css class is replaced.');

      $count++;
    }
  }
310

merlinofchaos's avatar
merlinofchaos committed
311
}