function view::set_display

3.x view.inc	`view::set_display($display_id = NULL)`
2.x view.inc	`view::set_display($display_id = NULL)`

Set the display as current.

Parameters

$display_id: The id of the display to mark as current.

8 calls to view::set_display()

view::build in includes/view.inc: Build the query for the view.
view::execute_display in includes/view.inc: Execute the given display, with the given arguments. To be called externally by whatever mechanism invokes the view, such as a page callback, hook_block, etc.
view::execute_hook_block_list in includes/view.inc: Called to get hook_block information from the view and the named display handler.
view::execute_hook_menu in includes/view.inc: Called to get hook_menu() information from the view and the named display handler.
view::get_path in includes/view.inc: Get the base path used for this view.

... See full list

File

includes/view.inc, line 511: 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 set_display($display_id = NULL) {
  // If we have not already initialized the display, do so. But be careful.
  if (empty($this->current_display)) {
    $this->init_display();

    // If handlers were not initialized, and no argument was sent, set up
    // to the default display.
    if (empty($display_id)) {
      $display_id = 'default';
    }
  }

  $display_id = $this->choose_display($display_id);

  // If no display id sent in and one wasn't chosen above, we're finished.
  if (empty($display_id)) {
    return FALSE;
  }

  // Ensure the requested display exists.
  if (empty($this->display[$display_id])) {
    $display_id = 'default';
    if (empty($this->display[$display_id])) {
      vpr('set_display() called with invalid display id @display.', array('@display' => $display_id));
      return FALSE;
    }
  }

  // Set the current display.
  $this->current_display = $display_id;

  // Ensure requested display has a working handler.
  if (empty($this->display[$display_id]->handler)) {
    return FALSE;
  }

  // Set a shortcut
  $this->display_handler = &$this->display[$display_id]->handler;

  return TRUE;
}