[Summary view] [Print] [Text view]

   1  <?php
   2  // $Id: views_plugin_display_default.inc,v 1.1 2008/09/03 19:21:30 merlinofchaos Exp $
   3  /**
   4   * @file
   5   * Contains the default display plugin.
   6   */
   7  
   8  /**
   9   * A plugin to handle defaults on a view.
  10   *
  11   * @ingroup views_display_plugins
  12   */
  13  class views_plugin_display_default extends views_plugin_display {
  14    /**
  15     * Determine if this display is the 'default' display which contains
  16     * fallback settings
  17     */
  18    function is_default_display() { return TRUE; }
  19  
  20    /**
  21     * The default execute handler fully renders the view.
  22     *
  23     * For the simplest use:
  24     * @code
  25     *   $output = $view->execute_display('default', $args);
  26     * @endcode
  27     *
  28     * For more complex usages, a view can be partially built:
  29     * @code
  30     *   $view->set_arguments($args);
  31     *   $view->build('default'); // Build the query
  32     *   $view->execute(); // Run the query
  33     *   $output = $view->render(); // Render the view
  34     * @endcode
  35     *
  36     * If short circuited at any point, look in $view->build_info for
  37     * information about the query. After execute, look in $view->result
  38     * for the array of objects returned from db_query.
  39     *
  40     * You can also do:
  41     * @code
  42     *   $view->set_arguments($args);
  43     *   $output = $view->render('default'); // Render the view
  44     * @endcode
  45     *
  46     * This illustrates that render is smart enough to call build and execute
  47     * if these items have not already been accomplished.
  48     *
  49     * Note that execute also must accomplish other tasks, such
  50     * as setting page titles, breadcrumbs, and generating exposed filter
  51     * data if necessary.
  52     */
  53    function execute() {
  54      return $this->view->render($this->display->id);
  55    }
  56  }