You are here

function view::preview in Views (for Drupal 7) 6.3

Same name and namespace in other branches
  1. 6.2 includes/view.inc \view::preview()
  2. 7.3 includes/view.inc \view::preview()

Preview the given display, with the given arguments.

To be called externally, probably by an AJAX handler of some flavor. Can also be called when views are embedded, as this guarantees normalized output.

File

includes/view.inc, line 1158
view.inc Provides the view object type and associated methods.

Class

view
An object to contain all of the data to generate a view, plus the member functions to build the view query, execute the query and render the output.

Code

function preview($display_id = NULL, $args = array()) {
  $timer_id = 'preview' . $display_id;
  timer_start($timer_id);
  if (empty($this->current_display) || !empty($display_id) && $this->current_display != $display_id) {
    if (!$this
      ->set_display($display_id)) {
      return FALSE;
    }
  }
  $this->preview = TRUE;
  $this
    ->pre_execute($args);

  // Preview the view.
  $output = $this->display_handler
    ->preview();
  $this
    ->post_execute();
  vpr("{$this->name} execute time: " . timer_read($timer_id) . " ms");
  timer_stop($timer_id);
  return $output;
}