StyleTest.php 9.82 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

10 11 12 13
use Drupal\views\Tests\ViewTestBase;
use Drupal\views_test_data\Plugin\views\row\RowTest;
use Drupal\views_test_data\Plugin\views\style\StyleTest as StyleTestPlugin;

merlinofchaos's avatar
merlinofchaos committed
14 15
/**
 * Tests some general style plugin related functionality.
16 17
 *
 * @see Drupal\views_test_data\Plugin\views\style\StyleTest.
merlinofchaos's avatar
merlinofchaos committed
18
 */
19 20
class StyleTest extends ViewTestBase {

21 22 23 24 25 26 27
  /**
   * Views used by this test.
   *
   * @var array
   */
  public static $testViews = array('test_view');

28 29 30 31 32 33
  /**
   * Stores the SimpleXML representation of the output.
   *
   * @var \SimpleXMLElement
   */
  protected $elements;
34

merlinofchaos's avatar
merlinofchaos committed
35 36
  public static function getInfo() {
    return array(
37
      'name' => 'Style: General',
merlinofchaos's avatar
merlinofchaos committed
38 39 40 41 42
      'description' => 'Test general style functionality.',
      'group' => 'Views Plugins',
    );
  }

43 44 45 46 47 48
  protected function setUp() {
    parent::setUp();

    $this->enableViewsTestModule();
  }

49 50 51 52
  /**
   * Tests the general renderering of styles.
   */
  public function testStyle() {
53 54
    $view = views_get_view('test_view');
    $view->setDisplay();
55 56 57
    $style = $view->display_handler->getOption('style');
    $style['type'] = 'test_style';
    $view->display_handler->setOption('style', $style);
58 59
    $view->initDisplay();
    $view->initStyle();
60
    $this->assertTrue($view->style_plugin instanceof StyleTestPlugin, 'Make sure the right style plugin class is loaded.');
61 62 63 64 65 66 67 68 69

    $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.
70 71
    $view = views_get_view('test_view');
    $view->setDisplay();
72 73 74 75 76 77
    $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);
78 79 80 81
    $view->initDisplay();
    $view->initStyle();
    $view->style_plugin->setUsesRowPlugin(TRUE);
    // Reinitialize the style as it supports row plugins now.
82
    $view->style_plugin->init($view, $view->display_handler);
83
    $this->assertTrue($view->rowPlugin instanceof RowTest, 'Make sure the right row plugin class is loaded.');
84 85

    $random_text = $this->randomName();
86
    $view->rowPlugin->setOutput($random_text);
87 88 89 90 91

    $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
92 93 94 95 96 97 98 99 100
  function testGrouping() {
    $this->_testGrouping(FALSE);
    $this->_testGrouping(TRUE);
  }

  /**
   * Tests the grouping features of styles.
   */
  function _testGrouping($stripped = FALSE) {
101 102
    $view = views_get_view('test_view');
    $view->setDisplay();
merlinofchaos's avatar
merlinofchaos committed
103
    // Setup grouping by the job and the age field.
104
    $view->initStyle();
merlinofchaos's avatar
merlinofchaos committed
105 106 107 108 109 110 111
    $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.
112
    $view->displayHandlers->get('default')->overrideOption('pager', array(
merlinofchaos's avatar
merlinofchaos committed
113 114 115 116 117
      'type' => 'some',
      'options' => array('items_per_page' => 3),
    ));

    // Add the job and age field.
118
    $view->displayHandlers->get('default')->overrideOption('fields', array(
merlinofchaos's avatar
merlinofchaos committed
119 120
      'name' => array(
        'id' => 'name',
121
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
122 123 124 125 126
        'field' => 'name',
        'relationship' => 'none',
      ),
      'job' => array(
        'id' => 'job',
127
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
128 129 130 131 132
        'field' => 'job',
        'relationship' => 'none',
      ),
      'age' => array(
        'id' => 'age',
133
        'table' => 'views_test_data',
merlinofchaos's avatar
merlinofchaos committed
134 135 136 137 138 139 140 141 142 143 144 145 146
        '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';
147
    $expected['Job: Singer']['rows']['Age: 25']['rows'][0] = new \stdClass();
148 149 150 151
    $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
152 153
    $expected['Job: Singer']['rows']['Age: 27'] = array();
    $expected['Job: Singer']['rows']['Age: 27']['group'] = 'Age: 27';
154
    $expected['Job: Singer']['rows']['Age: 27']['rows'][1] = new \stdClass();
155 156 157 158
    $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
159 160 161 162
    $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';
163
    $expected['Job: Drummer']['rows']['Age: 28']['rows'][2] = new \stdClass();
164 165 166 167
    $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
168 169 170 171 172 173 174


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

      // Add some html to the result and expected value.
      $rand = '<a data="' . $this->randomName() . '" />';
175 176
      $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
177 178
      $expected['Job: Singer']['group'] = 'Job: Singer';
      $rand = '<a data="' . $this->randomName() . '" />';
179 180
      $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
181
      $rand = '<a data="' . $this->randomName() . '" />';
182 183
      $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
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
      $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() {
220 221
    $view = views_get_view('test_view');
    $view->setDisplay();
merlinofchaos's avatar
merlinofchaos committed
222 223

    // Setup some random css class.
224
    $view->initStyle();
merlinofchaos's avatar
merlinofchaos committed
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
    $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++;
    }
  }
245

246 247 248 249 250 251 252 253 254 255 256 257 258
  /**
   * Stores a view output in the elements.
   */
  protected function storeViewPreview($output) {
    $htmlDom = new \DOMDocument();
    @$htmlDom->loadHTML($output);
    if ($htmlDom) {
      // It's much easier to work with simplexml than DOM, luckily enough
      // we can just simply import our DOM tree.
      $this->elements = simplexml_import_dom($htmlDom);
    }
  }

merlinofchaos's avatar
merlinofchaos committed
259
}