public function ViewExecutable::setDisplay

Sets the current display.

Parameters

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

Return value

bool TRUE if the display was correctly set, FALSE otherwise.

12 calls to ViewExecutable::setDisplay()
ViewExecutable::addItem in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
Adds an instance of a handler to the view.
ViewExecutable::build in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
Build the query for the view.
ViewExecutable::executeDisplay in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
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.
ViewExecutable::executeHookMenu in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
Called to get hook_menu() information from the view and the named display handler.
ViewExecutable::getItem in drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php
Gets the configuration of a handler instance on a given display.

... See full list

File

drupal/core/modules/views/lib/Drupal/views/ViewExecutable.php, line 646
Definition of Drupal\views\ViewExecutable.

Class

ViewExecutable
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.

Namespace

Drupal\views

Code

public function setDisplay($display_id = NULL) {

  // If we have not already initialized the display, do so.
  if (!isset($this->current_display)) {

    // This will set the default display and instantiate the default display
    // plugin.
    $this
      ->initDisplay();
  }

  // If no display ID is passed, we either have initialized the default or
  // already have a display set.
  if (!isset($display_id)) {
    return TRUE;
  }
  $display_id = $this
    ->chooseDisplay($display_id);

  // Ensure the requested display exists.
  if (!$this->displayHandlers
    ->has($display_id)) {
    debug(format_string('setDisplay() called with invalid display ID "@display".', array(
      '@display' => $display_id,
    )));
    return FALSE;
  }

  // Reset if the display has changed. It could be called multiple times for
  // the same display, especially in the UI.
  if ($this->current_display != $display_id) {

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

    // Reset the style and row plugins.
    $this->style_plugin = NULL;
    $this->plugin_name = NULL;
    $this->rowPlugin = NULL;
  }
  if ($display = $this->displayHandlers
    ->get($display_id)) {

    // Set a shortcut.
    $this->display_handler = $display;
    return TRUE;
  }
  return FALSE;
}