/drupal7/sites/all/modules/views/includes/view.inc - Club Drupal - Forge Centrale Marseille

root / drupal7 / sites / all / modules / views / includes / view.inc @ 4003efde

       <?php
       /**
        * @file
        * @defgroup views_objects Objects that represent a View or part of a view
        * @{
        * These objects are the core of Views do the bulk of the direction and
        * storing of data. All database activity is in these objects.
        */
       /**
        * An object to contain all of the data to generate a view.
+       *
        * Also includes the member functions to build the view query, execute the
        * query and render the output.
        */
       class view extends views_db_object {
         /**
+         *
          */
         public $db_table = 'views_view';
         /**
+         *
          */
         public $base_table = 'node';
         /**
+         *
          */
         public $base_field = 'nid';
         /**
          * The name of the view.
+         *
          * @var string
          */
         public $name = "";
         /**
          * The id of the view, which is used only for views in the database.
+         *
          * @var number
          */
         public $vid;
         /**
          * The description of the view, which is used only in the interface.
+         *
          * @var string
          */
         public $description;
         /**
          * The "tags" of a view.
          * The tags are stored as a single string, though it is used as multiple tags
          * for example in the views overview.
+         *
          * @var string
          */
         public $tag;
         /**
          * The human readable name of the view.
+         *
          * @var string
          */
         public $human_name;
         /**
          * The core version the view was created for.
+         *
          * @var int
          */
         public $core;
         /**
          * The views-api version this view was created by.
+         *
          * Some examples of the variable are 3.0 or 3.0-alpha1
+         *
          * @var string
          */
         public $api_version;
         /**
          * Is the view disabled.
+         *
          * This value is used for exported view, to provide some default views which
          * aren't enabled.
+         *
          * @var bool
          */
         public $disabled;
         /**
          * State variable.
          */
         public $built = FALSE;
         /**
          * State variable.
          */
         public $executed = FALSE;
         /**
          * State variable.
          */
         public $editing = FALSE;
         /**
+         *
          */
         public $args = array();
         /**
+         *
          */
         public $build_info = array();
         /**
+         *
          */
         public $use_ajax = FALSE;
         /**
          * Where the results of a query will go.
+         *
          * The array must use a numeric index starting at 0.
+         *
          * @var array
          */
         public $result = array();
         // May be used to override the current pager info.
         public $current_page = NULL;
         public $items_per_page = NULL;
         public $offset = NULL;
         public $total_rows = NULL;
         // Places to put attached renderings.
         public $attachment_before = '';
         public $attachment_after = '';
         // Exposed widget input.
         public $exposed_data = array();
         public $exposed_input = array();
         // Exposed widget input directly from the $form_state['values'].
         public $exposed_raw_input = array();
         // Used to store views that were previously running if we recurse.
         public $old_view = array();
         // To avoid recursion in views embedded into areas.
         public $parent_views = array();
         // Is the current stored view runned as an attachment to another view.
         public $is_attachment = NULL;
         // Stores the next steps of form items to handle.
         // It's an array of stack items, which contain the form id, the type of form,
         // the view, the display and some additional arguments.
         // @see views_ui_add_form_to_stack()
         // var $stack;
         /**
          * Identifier of the current display.
+         *
          * @var string
          */
         public $current_display;
         /**
          * Where the $query object will reside:.
+         *
          * @var views_plugin_query
          */
         public $query = NULL;
         /**
          * The current used display plugin.
+         *
          * @var views_plugin_display
          */
         public $display_handler;
         /**
          * Stores all display handlers of this view.
+         *
          * @var array[views_display]
          */
         public $display;
         /**
          * The current used style plugin.
+         *
          * @var views_plugin_style
          */
         public $style_plugin;
         /**
          * Stored the changed options of the style plugin.
+         *
          * @deprecated Better use $view->style_plugin->options
+         *
          * @var array
          */
         public $style_options;
         /**
          * Stores the current active row while rendering.
+         *
          * @var int
          */
         public $row_index;
         /**
          * Allow to override the url of the current view.
+         *
          * @var string
          */
         public $override_url = NULL;
         /**
          * Allow to override the path used for generated urls.
+         *
          * @var string
          */
         public $override_path = NULL;
         /**
          * Allow to override the used database which is used for this query.
          */
         public $base_database = NULL;
         /**
          * Here comes a list of the possible handler which are active on this view.
          */
         /**
          * Stores the field handlers which are initialized on this view.
+         *
          * @var array[views_handler_field]
          */
         public $field;
         /**
          * Stores the argument handlers which are initialized on this view.
+         *
          * @var array[views_handler_argument]
          */
         public $argument;
         /**
          * Stores the sort handlers which are initialized on this view.
+         *
          * @var array[views_handler_sort]
          */
         public $sort;
         /**
          * Stores the filter handlers which are initialized on this view.
+         *
          * @var array[views_handler_filter]
          */
         public $filter;
         /**
          * Stores the relationship handlers which are initialized on this view.
+         *
          * @var array[views_handler_relationship]
          */
         public $relationship;
         /**
          * Stores the area handlers for the header which are initialized on this view.
+         *
          * @var array[views_handler_area]
          */
         public $header;
         /**
          * Stores the area handlers for the footer which are initialized on this view.
+         *
          * @var array[views_handler_area]
          */
         public $footer;
         /**
          * The area handlers for the empty text which are initialized on this view.
+         *
          * @var array[views_handler_area]
          */
         public $empty;
         /**
          * Standard PHP constructor.
          */
         public function __construct() {
           parent::init();
           // Make sure all of the sub objects are arrays.
           foreach ($this->db_objects() as $object) {
             $this->$object = array();
+          }
+        }
         /**
          * Perform automatic updates when loading or importing a view.
+         *
          * Over time, some things about Views or Drupal data has changed. this
          * attempts to do some automatic updates that must happen to ensure older
          * views will at least try to work.
          */
         public function update() {
           // When views are converted automatically the base_table should be renamed
           // to have a working query.
           $this->base_table = views_move_table($this->base_table);
+        }
         /**
          * Returns a list of the sub-object types used by this view. These types are
          * stored on the display, and are used in the build process.
          */
         public function display_objects() {
           return array('argument', 'field', 'sort', 'filter', 'relationship', 'header', 'footer', 'empty');
+        }
         /**
          * Returns the complete list of dependent objects in a view, for the purpose
          * of initialization and loading/saving to/from the database.
          */
         static function db_objects() {
           return array('display');
+        }
         /**
          * Set the arguments that come to this view. Usually from the URL
          * but possibly from elsewhere.
          */
         public function set_arguments($args) {
           $this->args = $args;
+        }
         /**
          * Change/Set the current page for the pager.
          */
         public function set_current_page($page) {
           $this->current_page = $page;
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             return $this->query->pager->set_current_page($page);
+          }
+        }
         /**
          * Get the current page from the pager.
          */
         public function get_current_page() {
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             return $this->query->pager->get_current_page();
+          }
           if (isset($this->current_page)) {
             return $this->current_page;
+          }
+        }
         /**
          * Get the items per page from the pager.
          */
         public function get_items_per_page() {
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             return $this->query->pager->get_items_per_page();
+          }
           if (isset($this->items_per_page)) {
             return $this->items_per_page;
+          }
+        }
         /**
          * Set the items per page on the pager.
          */
         public function set_items_per_page($items_per_page) {
           $this->items_per_page = $items_per_page;
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             $this->query->pager->set_items_per_page($items_per_page);
+          }
+        }
         /**
          * Get the pager offset from the pager.
          */
         public function get_offset() {
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             return $this->query->pager->get_offset();
+          }
           if (isset($this->offset)) {
             return $this->offset;
+          }
+        }
         /**
          * Set the offset on the pager.
          */
         public function set_offset($offset) {
           $this->offset = $offset;
           // If the pager is already initialized, pass it through to the pager.
           if (!empty($this->query->pager)) {
             $this->query->pager->set_offset($offset);
+          }
+        }
         /**
          * Determine if the pager actually uses a pager.
          */
         public function use_pager() {
           if (!empty($this->query->pager)) {
             return $this->query->pager->use_pager();
+          }
+        }
         /**
          * Whether or not AJAX should be used. If AJAX is used, paging,
          * tablesorting and exposed filters will be fetched via an AJAX call
          * rather than a page refresh.
          */
         public function set_use_ajax($use_ajax) {
           $this->use_ajax = $use_ajax;
+        }
         /**
          * Set the exposed filters input to an array. If unset they will be taken
          * from $_GET when the time comes.
          */
         public function set_exposed_input($filters) {
           $this->exposed_input = $filters;
+        }
         /**
          * Figure out what the exposed input for this view is.
          */
         public function get_exposed_input() {
           if (empty($this->exposed_input)) {
             $this->exposed_input = array();
             // If filters are not overridden, store the 'remember' settings on the
             // default display. If they are, store them on this display. This way,
             // multiple displays in the same view can share the same filters and
             // remember settings.
             $display_id = ($this->display_handler->is_defaulted('filters')) ? 'default' : $this->current_display;
             // Start with remembered input via session.
             if (!empty($_SESSION['views'][$this->name][$display_id])) {
               $this->exposed_input = $_SESSION['views'][$this->name][$display_id];
+            }
             // Fetch exposed input values from $_GET. Overwrite if clashing.
             foreach ($_GET as $key => $value) {
               if (!in_array($key, array('page', 'q'))) {
                 $this->exposed_input[$key] = $value;
+              }
+            }
+          }
           return $this->exposed_input;
+        }
         /**
          * Set the display for this view and initialize the display handler.
          */
         public function init_display($reset = FALSE) {
           // The default display is always the first one in the list.
           if (isset($this->current_display)) {
             return TRUE;
+          }
           // Instantiate all displays.
           foreach (array_keys($this->display) as $id) {
             // Correct for shallow cloning
             // Often we'll have a cloned view so we don't mess up each other's
             // displays, but the clone is pretty shallow and doesn't necessarily
             // clone the displays. We can tell this by looking to see if a handler
             // has already been set; if it has, but $this->current_display is not
             // set, then something is dreadfully wrong.
             if (!empty($this->display[$id]->handler)) {
               $this->display[$id] = clone $this->display[$id];
               unset($this->display[$id]->handler);
+            }
             $this->display[$id]->handler = views_get_plugin('display', $this->display[$id]->display_plugin);
             if (!empty($this->display[$id]->handler)) {
               $this->display[$id]->handler->localization_keys = array($id);
               // Initialize the new display handler with data.
               $this->display[$id]->handler->init($this, $this->display[$id]);
               // If this is NOT the default display handler, let it know which is
               // since it may well utilize some data from the default.
               // This assumes that the 'default' handler is always first. It always
               // is. Make sure of it.
               if ($id != 'default') {
                 $this->display[$id]->handler->default_display = &$this->display['default']->handler;
+              }
+            }
+          }
           $this->current_display = 'default';
           $this->display_handler = &$this->display['default']->handler;
           return TRUE;
+        }
         /**
          * Get the first display that is accessible to the user.
+         *
          * @param string|array $displays
          *   Either a single display id or an array of display ids.
          */
         public function choose_display($displays) {
           if (!is_array($displays)) {
             return $displays;
+          }
           $this->init_display();
           foreach ($displays as $display_id) {
             if ($this->display[$display_id]->handler->access()) {
               return $display_id;
+            }
+          }
           return 'default';
+        }
         /**
          * Set the display as current.
+         *
          * @param string $display_id
          *   The id of the display to mark as current.
          */
         public 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;
+        }
         /**
          * Find and initialize the style plugin.
+         *
          * Note that arguments may have changed which style plugin we use, so
          * check the view object first, then ask the display handler.
          */
         public function init_style() {
           if (isset($this->style_plugin)) {
             return is_object($this->style_plugin);
+          }
           if (!isset($this->plugin_name)) {
             $this->plugin_name = $this->display_handler->get_option('style_plugin');
             $this->style_options = $this->display_handler->get_option('style_options');
+          }
           $this->style_plugin = views_get_plugin('style', $this->plugin_name);
           if (empty($this->style_plugin)) {
             return FALSE;
+          }
           // Init the new style handler with data..
           $this->style_plugin->init($this, $this->display[$this->current_display], $this->style_options);
           return TRUE;
+        }
         /**
          * Attempt to discover if the view has handlers missing relationships.
+         *
          * This will try to add relationships automatically if it can, and will
          * remove the handlers if it cannot.
          */
         public function fix_missing_relationships() {
           if (isset($this->relationships_fixed)) {
             return;
+          }
           $this->relationships_fixed = TRUE;
           // Go through all of our handler types and test them to see if they
           // are missing relationships. Missing relationships can cause fatally
           // broken Views.
           $base_tables = array(
             $this->base_table => TRUE,
             '#global' => TRUE,
           );
           // For each relationship we have, make sure we mark the base it provides as
           // available.
           foreach ($this->display_handler->get_option('relationships') as $id => $options) {
             $options['table'] = views_move_table($options['table']);
             $data = views_fetch_data($options['table'], FALSE);
             if (isset($data[$options['field']]['relationship']['base'])) {
               $base_tables[$data[$options['field']]['relationship']['base']] = TRUE;
+            }
+          }
           $base_tables = array_keys($base_tables);
           $missing_base_tables = array();
           $types = views_object_types();
           foreach ($types as $key => $info) {
             foreach ($this->display_handler->get_option($info['plural']) as $id => $options) {
               $options['table'] = views_move_table($options['table']);
               $data = views_fetch_data($options['table'], FALSE);
               $valid_bases = array($options['table']);
               if (isset($data['table']['join'])) {
                 $valid_bases = array_merge($valid_bases, array_keys($data['table']['join']));
+              }
               // If the base table is missing, record it so we can try to fix it.
               if (!array_intersect($valid_bases, $base_tables)) {
                 $missing_base_tables[$options['table']][] = array('type' => $key, 'id' => $id);
+              }
+            }
+          }
           if (!empty($missing_base_tables)) {
             // This will change handlers, so make sure any existing handlers get
             // tossed.
             $this->display_handler->handlers = array();
             $this->relationships_changed = TRUE;
             $this->changed = TRUE;
             // Try to fix it.
             foreach ($missing_base_tables as $table => $handlers) {
               $data = views_fetch_data($table);
               $relationship = NULL;
               // Does the missing base table have a default relationship we can
               // throw in?
               if (isset($data['table']['default_relationship'][$this->base_table])) {
                 // Create the relationship.
                 $info = $data['table']['default_relationship'][$this->base_table];
                 $relationship_options = isset($info['options']) ? $info['options'] : array();
                 $relationship = $this->add_item($this->current_display, 'relationship', $info['table'], $info['field'], $relationship_options);
+              }
               foreach ($handlers as $handler) {
                 $options = $this->display_handler->get_option($types[$handler['type']]['plural']);
                 if ($relationship) {
                   $options[$handler['id']]['relationship'] = $relationship;
+                }
                 else {
                   unset($options[$handler['id']]);
+                }
                 $this->display_handler->set_option($types[$handler['type']]['plural'], $options);
+              }
+            }
+          }
+        }
         /**
          * Acquire and attach all of the handlers.
          */
         public function init_handlers() {
           if (empty($this->inited)) {
             $this->fix_missing_relationships();
             foreach (views_object_types() as $key => $info) {
               $this->_init_handler($key, $info);
+            }
             $this->inited = TRUE;
+          }
+        }
         /**
          * Initialize the pager.
+         *
          * Like style initialization, pager initialization is held until late
          * to allow for overrides.
          */
         public function init_pager() {
           if (empty($this->query->pager)) {
             // If the query doesn't exist, initialize it.
             if (empty($this->query)) {
               $this->init_query();
+            }
             $this->query->pager = $this->display_handler->get_plugin('pager');
             if ($this->query->pager->use_pager()) {
               $this->query->pager->set_current_page($this->current_page);
+            }
             // These overrides may have been set earlier via $view->set_*
             // functions.
             if (isset($this->items_per_page)) {
               $this->query->pager->set_items_per_page($this->items_per_page);
+            }
             if (isset($this->offset)) {
               $this->query->pager->set_offset($this->offset);
+            }
+          }
+        }
         /**
          * Create a list of base tables eligible for this view. Used primarily
          * for the UI. Display must be already initialized.
          */
         public function get_base_tables() {
           $base_tables = array(
             $this->base_table => TRUE,
             '#global' => TRUE,
           );
           foreach ($this->display_handler->get_handlers('relationship') as $handler) {
             $base_tables[$handler->definition['base']] = TRUE;
+          }
           return $base_tables;
+        }
         /**
          * Run the pre_query() on all active handlers.
          */
         public function _pre_query() {
           foreach (views_object_types() as $key => $info) {
             $handlers = &$this->$key;
             $position = 0;
             foreach ($handlers as $id => $handler) {
               $handlers[$id]->position = $position;
               $handlers[$id]->pre_query();
               $position++;
+            }
+          }
+        }
         /**
          * Run the post_execute() on all active handlers.
          */
         public function _post_execute() {
           foreach (views_object_types() as $key => $info) {
             $handlers = &$this->$key;
             foreach ($handlers as $id => $handler) {
               $handlers[$id]->post_execute($this->result);
+            }
+          }
+        }
         /**
          * Attach all of the handlers for each type.
+         *
          * @param string $key
          *   One of 'argument', 'field', 'sort', 'filter', 'relationship'.
          * @param array $info
          *   The $info from views_object_types for this object.
          */
         public function _init_handler($key, $info) {
           // Load the requested items from the display onto the object.
           $this->$key = &$this->display_handler->get_handlers($key);
           // This reference deals with difficult PHP indirection.
           $handlers = &$this->$key;
           // Run through and test for accessibility.
           foreach ($handlers as $id => $handler) {
             if (!$handler->access()) {
               unset($handlers[$id]);
+            }
+          }
+        }
         /**
          * Build all the arguments.
          */
         public function _build_arguments() {
           // Initially, we want to build sorts and fields. This can change, though,
           // if we get a summary view.
           if (empty($this->argument)) {
             return TRUE;
+          }
           // build arguments.
           $position = -1;
           // Create a title for use in the breadcrumb trail.
           $title = $this->display_handler->get_option('title');
           $this->build_info['breadcrumb'] = array();
           $breadcrumb_args = array();
           $substitutions = array();
           $status = TRUE;
           // Iterate through each argument and process.
           foreach ($this->argument as $id => $arg) {
             $position++;
             $argument = &$this->argument[$id];
             if ($argument->broken()) {
               continue;
+            }
             $argument->set_relationship();
             $arg = NULL;
             if (isset($this->args[$position]) && $this->args[$position] !== '') {
               $arg = $this->args[$position];
+            }
             $argument->position = $position;
             if (isset($arg) || $argument->has_default_argument()) {
               if (!isset($arg)) {
                 $arg = $argument->get_default_argument();
                 // make sure default args get put back.
                 if (isset($arg)) {
                   $this->args[$position] = $arg;
+                }
+              }
               // Set the argument, which will also validate that the argument can be
               // set.
               if (!$argument->set_argument($arg)) {
                 $status = $argument->validate_fail($arg);
                 break;
+              }
               if ($argument->is_exception()) {
                 $arg_title = $argument->exception_title();
+              }
               else {
                 $arg_title = $argument->get_title();
                 $argument->query($this->display_handler->use_group_by());
+              }
               // Add this argument's substitution.
               $substitutions['%' . ($position + 1)] = $arg_title;
               $substitutions['!' . ($position + 1)] = strip_tags(decode_entities($arg));
               // Since we're really generating the breadcrumb for the item above us,
               // check the default action of this argument.
               if ($this->display_handler->uses_breadcrumb() && $argument->uses_breadcrumb()) {
                 $path = $this->get_url($breadcrumb_args);
                 if (strpos($path, '%') === FALSE) {
                   if (!empty($argument->options['breadcrumb_enable']) && !empty($argument->options['breadcrumb'])) {
                     $breadcrumb = $argument->options['breadcrumb'];
+                  }
                   else {
                     $breadcrumb = $title;
+                  }
                   $this->build_info['breadcrumb'][$path] = str_replace(array_keys($substitutions), $substitutions, $breadcrumb);
+                }
+              }
               // Allow the argument to muck with this breadcrumb.
               $argument->set_breadcrumb($this->build_info['breadcrumb']);
               // Test to see if we should use this argument's title.
               if (!empty($argument->options['title_enable']) && !empty($argument->options['title'])) {
                 $title = $argument->options['title'];
+              }
               $breadcrumb_args[] = $arg;
+            }
             else {
               // determine default condition and handle.
               $status = $argument->default_action();
               break;
+            }
             // Be safe with references and loops.
             unset($argument);
+          }
           // set the title in the build info.
           if (!empty($title)) {
             $this->build_info['title'] = $title;
+          }
           // Store the arguments for later use.
           $this->build_info['substitutions'] = $substitutions;
           return $status;
+        }
         /**
          * Do some common building initialization.
          */
         public function init_query() {
           if (!empty($this->query)) {
             $class = get_class($this->query);
             if ($class && $class != 'stdClass') {
               // return if query is already initialized.
               return TRUE;
+            }
+          }
           // Create and initialize the query object.
           $views_data = views_fetch_data($this->base_table);
           $this->base_field = !empty($views_data['table']['base']['field']) ? $views_data['table']['base']['field'] : '';
           if (!empty($views_data['table']['base']['database'])) {
             $this->base_database = $views_data['table']['base']['database'];
+          }
           // Load the options.
           $query_options = $this->display_handler->get_option('query');
           // Create and initialize the query object.
           $plugin = !empty($views_data['table']['base']['query class']) ? $views_data['table']['base']['query class'] : 'views_query';
           $this->query = views_get_plugin('query', $plugin);
           if (empty($this->query)) {
             return FALSE;
+          }
           $this->query->init($this->base_table, $this->base_field, $query_options['options']);
           return TRUE;
+        }
         /**
          * Build the query for the view.
          */
         public function build($display_id = NULL) {
           if (!empty($this->built)) {
             return;
+          }
           if (empty($this->current_display) || $display_id) {
             if (!$this->set_display($display_id)) {
               return FALSE;
+            }
+          }
           // Let modules modify the view just prior to building it.
           foreach (module_implements('views_pre_build') as $module) {
             $function = $module . '_views_pre_build';
             $function($this);
+          }
           // Attempt to load from cache.
           // @todo Load a build_info from cache.
           $start = microtime(TRUE);
           // If that fails, let's build!
           $this->build_info = array(
             'query' => '',
             'count_query' => '',
             'query_args' => array(),
           );
           $this->init_query();
           // Call a module hook and see if it wants to present us with a
           // pre-built query or instruct us not to build the query for
           // some reason.
           // @todo Implement this. Use the same mechanism Panels uses.
           // Run through our handlers and ensure they have necessary information.
           $this->init_handlers();
           // Let the handlers interact with each other if they really want.
           $this->_pre_query();
           $exposed_form = FALSE;
           if ($this->display_handler->uses_exposed()) {
             $exposed_form = $this->display_handler->get_plugin('exposed_form');
             // (1) Record the errors before rendering the exposed form widgets.
             $errors_before = form_set_error();
             $this->exposed_widgets = $exposed_form->render_exposed_form();
             // (2) Record the errors after rendering the exposed form widgets.
             $errors_after = form_set_error();
             // Find out if the validation of any of the elements in the exposed form
             // has failed by comparing (1) and (2) above. Don't mess with the view
             // otherwise.
             $exposed_errors = count($errors_after) > count($errors_before);
             if ($exposed_errors || !empty($this->build_info['abort'])) {
               $this->built = TRUE;
               // Don't execute the query, but rendering will still be executed to
               // display the empty text.
               $this->executed = TRUE;
               return empty($this->build_info['fail']);
+            }
+          }
           // Build all the relationships first thing.
           $this->_build('relationship');
           // Set the filtering groups.
           if (!empty($this->filter)) {
             $filter_groups = $this->display_handler->get_option('filter_groups');
             if ($filter_groups) {
               $this->query->set_group_operator($filter_groups['operator']);
               foreach ($filter_groups['groups'] as $id => $operator) {
                 $this->query->set_where_group($operator, $id);
+              }
+            }
+          }
           // Build all the filters.
           $this->_build('filter');
           $this->build_sort = TRUE;
           // Arguments can, in fact, cause this whole thing to abort.
           if (!$this->_build_arguments()) {
             $this->build_time = microtime(TRUE) - $start;
             $this->attach_displays();
             return $this->built;
+          }
           // Initialize the style; arguments may have changed which style we use,
           // so waiting as long as possible is important. But we need to know
           // about the style when we go to build fields.
           if (!$this->init_style()) {
             $this->build_info['fail'] = TRUE;
             return FALSE;
+          }
           if ($this->style_plugin->uses_fields()) {
             $this->_build('field');
+          }
           // Build our sort criteria if we were instructed to do so.
           if (!empty($this->build_sort)) {
             // Allow the style handler to deal with sorting.
             if ($this->style_plugin->build_sort()) {
               $this->_build('sort');
+            }
             // allow the plugin to build second sorts as well.
             $this->style_plugin->build_sort_post();
+          }
           // Allow area handlers to affect the query.
           $this->_build('header');
           $this->_build('footer');
           $this->_build('empty');
           // Allow display handler to affect the query.
           $this->display_handler->query($this->display_handler->use_group_by());
           // Allow style handler to affect the query.
           $this->style_plugin->query($this->display_handler->use_group_by());
           // Allow exposed form to affect the query.
           if ($exposed_form) {
             $exposed_form->query();
+          }
           if (variable_get('views_sql_signature', FALSE)) {
             $this->query->add_signature($this);
+          }
           // Let modules modify the query just prior to finalizing it.
           $this->query->alter($this);
           // Only build the query if we weren't interrupted.
           if (empty($this->built)) {
             // Build the necessary info to execute the query.
             $this->query->build($this);
+          }
           $this->built = TRUE;
           $this->build_time = microtime(TRUE) - $start;
           // Attach displays.
           $this->attach_displays();
           // Let modules modify the view just after building it.
           foreach (module_implements('views_post_build') as $module) {
             $function = $module . '_views_post_build';
             $function($this);
+          }
           return TRUE;
+        }
         /**
          * Internal method to build an individual set of handlers.
+         *
          * @param string $key
          *    The type of handlers (filter etc.) which should be iterated over to
          *    build the relationship and query information.
          */
         public function _build($key) {
           $handlers = &$this->$key;
           foreach ($handlers as $id => $data) {
             if (!empty($handlers[$id]) && is_object($handlers[$id])) {
               $multiple_exposed_input = array(0 => NULL);
               if ($handlers[$id]->multiple_exposed_input()) {
                 $multiple_exposed_input = $handlers[$id]->group_multiple_exposed_input($this->exposed_data);
+              }
               foreach ($multiple_exposed_input as $group_id) {
                 // Give this handler access to the exposed filter input.
                 if (!empty($this->exposed_data)) {
                   $converted = FALSE;
                   if ($handlers[$id]->is_a_group()) {
                     $converted = $handlers[$id]->convert_exposed_input($this->exposed_data, $group_id);
                     $handlers[$id]->store_group_input($this->exposed_data, $converted);
                     if (!$converted) {
                       continue;
+                    }
+                  }
                   $rc = $handlers[$id]->accept_exposed_input($this->exposed_data);
                   $handlers[$id]->store_exposed_input($this->exposed_input, $rc);
                   if (!$rc) {
                     continue;
+                  }
+                }
                 $handlers[$id]->set_relationship();
                 $handlers[$id]->query($this->display_handler->use_group_by());
+              }
+            }
+          }
+        }
         /**
          * Execute the view's query.
+         *
          * @param string $display_id
          *   The machine name of the display, which should be executed.
+         *
          * @return bool
          *   Return whether the executing was successful, for example an argument
          *   could stop the process.
          */
         public function execute($display_id = NULL) {
           if (empty($this->built)) {
             if (!$this->build($display_id)) {
               return FALSE;
+            }
+          }
           if (!empty($this->executed)) {
             return TRUE;
+          }
           // Don't allow to use deactivated displays, but display them on the live
           // preview.
           if (!$this->display[$this->current_display]->handler->get_option('enabled') && empty($this->live_preview)) {
             $this->build_info['fail'] = TRUE;
             return FALSE;
+          }
           // Let modules modify the view just prior to executing it.
           foreach (module_implements('views_pre_execute') as $module) {
             $function = $module . '_views_pre_execute';
             $function($this);
+          }
           // Check for already-cached results.
           if (!empty($this->live_preview)) {
             $cache = FALSE;
+          }
           else {
             $cache = $this->display_handler->get_plugin('cache');
+          }
           if ($cache && $cache->cache_get('results')) {
             if ($this->query->pager->use_pager() || !empty($this->get_total_rows)) {
               $this->query->pager->total_items = $this->total_rows;
               $this->query->pager->update_page_info();
+            }
             vpr('Used cached results');
+          }
           else {
             $this->query->execute($this);
             // Enforce the array key rule as documented in
             // views_plugin_query::execute().
             $this->result = array_values($this->result);
             $this->_post_execute();
             if ($cache) {
               $cache->cache_set('results');
+            }
+          }
           // Let modules modify the view just after executing it.
           foreach (module_implements('views_post_execute') as $module) {
             $function = $module . '_views_post_execute';
             $function($this);
+          }
           $this->executed = TRUE;
+        }
         /**
          * Render this view for a certain display.
+         *
          * Note: You should better use just the preview function if you want to
          * render a view.
+         *
          * @param string $display_id
          *   The machine name of the display, which should be rendered.
+         *
          * @return string|NULL
          *   Return the output of the rendered view or NULL if something failed in the
          *   process.
          */
         public function render($display_id = NULL) {
           $this->execute($display_id);
           // Check to see if the build failed.
           if (!empty($this->build_info['fail'])) {
             return;
+          }
           if (!empty($this->build_info['denied'])) {
             return;
+          }
           drupal_theme_initialize();
           $start = microtime(TRUE);
           if (!empty($this->live_preview) && variable_get('views_show_additional_queries', FALSE)) {
             $this->start_query_capture();
+          }
           $exposed_form = $this->display_handler->get_plugin('exposed_form');
           $exposed_form->pre_render($this->result);
           // Check for already-cached output.
           if (!empty($this->live_preview)) {
             $cache = FALSE;
+          }
           else {
             $cache = $this->display_handler->get_plugin('cache');
+          }
           if ($cache && $cache->cache_get('output')) {
+          }
           else {
             if ($cache) {
               $cache->cache_start();
+            }
             // Run pre_render for the pager as it might change the result.
             if (!empty($this->query->pager)) {
               $this->query->pager->pre_render($this->result);
+            }
             // Initialize the style plugin.
             $this->init_style();
             // Give field handlers the opportunity to perform additional queries
             // using the entire resultset prior to rendering.
             if ($this->style_plugin->uses_fields()) {
               foreach ($this->field as $id => $handler) {
                 if (!empty($this->field[$id])) {
                   $this->field[$id]->pre_render($this->result);
+                }
+              }
+            }
             $this->style_plugin->pre_render($this->result);
             // Let modules modify the view just prior to rendering it.
             foreach (module_implements('views_pre_render') as $module) {
               $function = $module . '_views_pre_render';
               $function($this);
+            }
             // Let the themes play too, because pre render is a very themey thing.
             foreach ($GLOBALS['base_theme_info'] as $base) {
               $function = $base->name . '_views_pre_render';
               if (function_exists($function)) {
                 $function($this);
+              }
+            }
             $function = $GLOBALS['theme'] . '_views_pre_render';
             if (function_exists($function)) {
               $function($this);
+            }
             $this->display_handler->output = $this->display_handler->render();
             if ($cache) {
               $cache->cache_set('output');
+            }
+          }
           $this->render_time = microtime(TRUE) - $start;
           $exposed_form->post_render($this->display_handler->output);
           if ($cache) {
             $cache->post_render($this->display_handler->output);
+          }
           // Let modules modify the view output after it is rendered.
           foreach (module_implements('views_post_render') as $module) {
             $function = $module . '_views_post_render';
             $function($this, $this->display_handler->output, $cache);
+          }
           // Let the themes play too, because post render is a very themey thing.
           foreach ($GLOBALS['base_theme_info'] as $base) {
             $function = $base->name . '_views_post_render';
             if (function_exists($function)) {
               $function($this, $this->display_handler->output, $cache);
+            }
+          }
           $function = $GLOBALS['theme'] . '_views_post_render';
           if (function_exists($function)) {
             $function($this, $this->display_handler->output, $cache);
+          }
           if (!empty($this->live_preview) && variable_get('views_show_additional_queries', FALSE)) {
             $this->end_query_capture();
+          }
           return $this->display_handler->output;
+        }
         /**
          * Render a specific field via the field ID and the row #.
+         *
          * Note: You might want to use views_plugin_style::render_fields as it
          * caches the output for you.
+         *
          * @param string $field
          *   The id of the field to be rendered.
          * @param int $row
          *   The row number in the $view->result which is used for the rendering.
+         *
          * @return string
          *   The rendered output of the field.
          */
         public function render_field($field, $row) {
           if (isset($this->field[$field]) && isset($this->result[$row])) {
             return $this->field[$field]->advanced_render($this->result[$row]);
+          }
+        }
         /**
          * 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.
+         *
          * This function should NOT be used by anything external as this
          * returns data in the format specified by the display. It can also
          * have other side effects that are only intended for the 'proper'
          * use of the display, such as setting page titles and breadcrumbs.
+         *
          * If you simply want to view the display, use view::preview() instead.
          */
         public function execute_display($display_id = NULL, $args = array()) {
           if (empty($this->current_display) || $this->current_display != $this->choose_display($display_id)) {
             if (!$this->set_display($display_id)) {
               return FALSE;
+            }
+          }
           $this->pre_execute($args);
           // Execute the view.
           $output = $this->display_handler->execute();
           $this->post_execute();
           return $output;
+        }
         /**
          * 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.
          */
         public function preview($display_id = NULL, $args = array()) {
           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();
           return $output;
+        }
         /**
          * Run attachments and let the display do what it needs to do prior
          * to running.
          */
         public function pre_execute($args = array()) {
           $this->old_view[] = views_get_current_view();
           views_set_current_view($this);
           $display_id = $this->current_display;
           // Prepare the view with the information we have, but only if we were
           // passed arguments, as they may have been set previously.
           if ($args) {
             $this->set_arguments($args);
+          }
           // Trigger hook_views_pre_view(). Allow other modules to modify the view
           // just prior to executing the preview.
           foreach (module_implements('views_pre_view') as $module) {
             $function = $module . '_views_pre_view';
             $function($this, $display_id, $this->args);
+          }
           // Allow hook_views_pre_view() to set the dom_id, then ensure it is set.
           $this->dom_id = !empty($this->dom_id) ? $this->dom_id : md5($this->name . REQUEST_TIME . rand());
           // Allow the display handler to set up for execution.
           $this->display_handler->pre_execute();
+        }
         /**
          * Unset the current view, mostly.
          */
         public function post_execute() {
           // unset current view so we can be properly destructed later on.
           // Return the previous value in case we're an attachment.
           if ($this->old_view) {
             $old_view = array_pop($this->old_view);
+          }
           views_set_current_view(isset($old_view) ? $old_view : FALSE);
+        }
         /**
          * Run attachment displays for the view.
          */
         public function attach_displays() {
           if (!empty($this->is_attachment)) {
             return;
+          }
           if (!$this->display_handler->accept_attachments()) {
             return;
+          }
           $this->is_attachment = TRUE;
           // Give other displays an opportunity to attach to the view.
           foreach ($this->display as $id => $display) {
             if (!empty($this->display[$id]->handler)) {
               $this->display[$id]->handler->attach_to($this->current_display);
+            }
+          }
           $this->is_attachment = FALSE;
+        }
         /**
          * Called to get hook_menu() info from the view and the named display handler.
+         *
          * @param string $display_id
          *   A display id.
          * @param array $callbacks
          *   A menu callback array passed from views_menu_alter().
          */
         public function execute_hook_menu($display_id = NULL, &$callbacks = array()) {
           // Prepare the view with the information we have.
           // This was probably already called, but it's good to be safe.
           if (!$this->set_display($display_id)) {
             return FALSE;
+          }
           // Execute the view.
           if (isset($this->display_handler)) {
             return $this->display_handler->execute_hook_menu($callbacks);
+          }
+        }
         /**
          * Called to get hook_block information from the view and the
          * named display handler.
          */
         public function execute_hook_block_list($display_id = NULL) {
           // Prepare the view with the information we have.
           // This was probably already called, but it's good to be safe.
           if (!$this->set_display($display_id)) {
             return FALSE;
+          }
           // Execute the view.
           if (isset($this->display_handler)) {
             return $this->display_handler->execute_hook_block_list();
+          }
+        }
         /**
          * Determine if the given user has access to the view.
+         *
          * Note that this sets the display handler if it hasn't been.
          */
         public function access($displays = NULL, $account = NULL) {
           // No one should have access to disabled views.
           if (!empty($this->disabled)) {
             return FALSE;
+          }
           if (!isset($this->current_display)) {
             $this->init_display();
+          }
           if (!$account) {
             $account = $GLOBALS['user'];
+          }
           // We can't use choose_display() here because that function calls this one.
           $displays = (array) $displays;
           foreach ($displays as $display_id) {
             if (!empty($this->display[$display_id]->handler)) {
               if ($this->display[$display_id]->handler->access($account)) {
                 return TRUE;
+              }
+            }
+          }
           return FALSE;
+        }
         /**
          * Get the view's current title.
+         *
          * This can change depending upon how it was built.
          */
         public function get_title() {
           if (empty($this->display_handler)) {
             if (!$this->set_display('default')) {
               return FALSE;
+            }
+          }
           // During building, we might find a title override. If so, use it.
           if (!empty($this->build_info['title'])) {
             $title = $this->build_info['title'];
+          }
           else {
             $title = $this->display_handler->get_option('title');
+          }
           // Allow substitutions from the first row.
           if ($this->init_style()) {
             $title = $this->style_plugin->tokenize_value($title, 0);
+          }
           return $title;
+        }
         /**
          * Override the view's current title.
+         *
          * The tokens in the title get replaced before rendering.
          */
         public function set_title($title) {
           $this->build_info['title'] = $title;
           return TRUE;
+        }
         /**
          * Return the human readable name for a view.
+         *
          * When a certain view doesn't have a human readable name return the machine
          * readable name.
          */
         public function get_human_name() {
           if (!empty($this->human_name)) {
             $human_name = $this->human_name;
+          }
           else {
             $human_name = $this->name;
+          }
           return $human_name;
+        }
         /**
          * Force the view to build a title.
          */
         public function build_title() {
           $this->init_display();
           if (empty($this->built)) {
             $this->init_query();
+          }
           $this->init_handlers();
           $this->_build_arguments();
+        }
         /**
          * Get the URL for the current view.
+         *
          * This URL will be adjusted for arguments.
          */
         public function get_url($args = NULL, $path = NULL) {
           if (!empty($this->override_url)) {
             return $this->override_url;
+          }
           if (!isset($path)) {
             $path = $this->get_path();
+          }
           if (!isset($args)) {
             $args = $this->args;
             // Exclude arguments that were computed, not passed on the URL.
             $position = 0;
             if (!empty($this->argument)) {
               foreach ($this->argument as $argument_id => $argument) {
                 if (!empty($argument->options['default_argument_skip_url'])) {
                   unset($args[$position]);
+                }
                 $position++;
+              }
+            }
+          }
           // Don't bother working if there's nothing to do.
           if (empty($path) || (empty($args) && strpos($path, '%') === FALSE)) {
             return $path;
+          }
           $pieces = array();
           $argument_keys = isset($this->argument) ? array_keys($this->argument) : array();
           $id = current($argument_keys);
           foreach (explode('/', $path) as $piece) {
             if ($piece != '%') {
               $pieces[] = $piece;
+            }
             else {
               if (empty($args)) {
                 // Try to never put % in a url; use the wildcard instead.
                 if ($id && !empty($this->argument[$id]->options['exception']['value'])) {
                   $pieces[] = $this->argument[$id]->options['exception']['value'];
+                }
                 else {
                   $pieces[] = '*';
                   // @todo Gotta put something if there just isn't one.
+                }
+              }
               else {
                 $pieces[] = array_shift($args);
+              }
               if ($id) {
                 $id = next($argument_keys);
+              }
+            }
+          }
           if (!empty($args)) {
             $pieces = array_merge($pieces, $args);
+          }
           return implode('/', $pieces);
+        }
         /**
          * Get the base path used for this view.
          */
         public function get_path() {
           if (!empty($this->override_path)) {
             return $this->override_path;
+          }
           if (empty($this->display_handler)) {
             if (!$this->set_display('default')) {
               return FALSE;
+            }
+          }
           return $this->display_handler->get_path();
+        }
         /**
          * Get the breadcrumb used for this view.
+         *
          * @param bool $set
          *   If true, use drupal_set_breadcrumb() to install the breadcrumb.
          */
         public function get_breadcrumb($set = FALSE) {
           // Now that we've built the view, extract the breadcrumb.
           $base = TRUE;
           $breadcrumb = array();
           if (!empty($this->build_info['breadcrumb'])) {
             foreach ($this->build_info['breadcrumb'] as $path => $title) {
               // Check to see if the frontpage is in the breadcrumb trail; if it
               // is, we'll remove that from the actual breadcrumb later.
               if ($path == variable_get('site_frontpage', 'node')) {
                 $base = FALSE;
                 $title = t('Home');
+              }
               if ($title) {
                 $breadcrumb[] = l($title, $path, array('html' => TRUE));
+              }
+            }
             if ($set) {
               if ($base) {
                 $breadcrumb = array_merge(drupal_get_breadcrumb(), $breadcrumb);
+              }
               drupal_set_breadcrumb($breadcrumb);
+            }
+          }
           return $breadcrumb;
+        }
         /**
          * Is this view cacheable?.
          */
         public function is_cacheable() {
           return $this->is_cacheable;
+        }
         /**
          * Set up query capturing.
+         *
          * Db_query() stores the queries that it runs in global $queries, bit only if
          * dev_query is set to true. In this case, we want to temporarily override
          * that setting if it's not and we can do that without forcing a db rewrite by
          * just manipulating $conf. This is kind of evil but it works.
          */
         public function start_query_capture() {
           global $conf, $queries;
           if (empty($conf['dev_query'])) {
             $this->fix_dev_query = TRUE;
             $conf['dev_query'] = TRUE;
+          }
           // Record the last query key used; anything already run isn't a query that
           // we are interested in.
           $this->last_query_key = NULL;
           if (!empty($queries)) {
             $keys = array_keys($queries);
             $this->last_query_key = array_pop($keys);
+          }
+        }
         /**
          * Add the list of queries run during render to buildinfo.
+         *
          * @see view::start_query_capture()
          */
         public function end_query_capture() {
           global $conf, $queries;
           if (!empty($this->fix_dev_query)) {
             $conf['dev_query'] = FALSE;
+          }
           // Make a copy of the array so we can manipulate it with array_splice.
           $temp = $queries;
           // Scroll through the queries until we get to our last query key.
           // Unset anything in our temp array.
           if (isset($this->last_query_key)) {
             foreach ($queries as $id => $query) {
               if ($id == $this->last_query_key) {
                 break;
+              }
               unset($temp[$id]);
+            }
+          }
           $this->additional_queries = $temp;
+        }
         /**
          * Static factory method to load a list of views based upon a $where clause.
+         *
          * Although this method could be implemented to simply iterate over
          * views::load(), that would be very slow.  Buiding the views externally from
          * unified queries is much faster.
          */
         static function load_views() {
           $result = db_query("SELECT DISTINCT v.* FROM {views_view} v");
           $views = array();
           // Load all the views.
           foreach ($result as $data) {
             $view = new view();
             $view->load_row($data);
             $view->loaded = TRUE;
             $view->type = t('Normal');
             $views[$view->name] = $view;
             $names[$view->vid] = $view->name;
+          }
           // Stop if we didn't get any views.
           if (!$views) {
             return array();
+          }
           // Now load all the subtables.
           foreach (view::db_objects() as $key) {
             $object_name = "views_$key";
             $result = db_query("SELECT * FROM {{$object_name}} WHERE vid IN (:vids) ORDER BY vid, position",
               array(':vids' => array_keys($names)));
             foreach ($result as $data) {
               $object = new $object_name(FALSE);
               $object->load_row($data);
               // Because it can get complicated with this much indirection, make a
               // shortcut reference.
               $location = &$views[$names[$object->vid]]->$key;
               // If we have a basic id field, load the item onto the view based on
               // this ID, otherwise push it on.
               if (!empty($object->id)) {
                 $location[$object->id] = $object;
+              }
               else {
                 $location[] = $object;
+              }
+            }
+          }
           return $views;
+        }
         /**
          * Save the view to the database.
+         *
          * If the view does not already exist a vid will be assigned to the view and
          * also returned from this function.
          */
         public function save() {
           if ($this->vid == 'new') {
             $this->vid = NULL;
+          }
           // If there is no vid, check if a view with this machine name already
           // exists.
           elseif (empty($this->vid)) {
             $vid = db_query("SELECT vid from {views_view} WHERE name = :name", array(':name' => $this->name))->fetchField();
             $this->vid = $vid ? $vid : NULL;
+          }
           // Let modules modify the view just prior to saving it.
           module_invoke_all('views_view_presave', $this);
           $transaction = db_transaction();
           try {
             // If we have no vid or our vid is a string, this is a new view.
             if (!empty($this->vid)) {
               // remove existing table entries.
               foreach ($this->db_objects() as $key) {
                 db_delete('views_' . $key)
                   ->condition('vid', $this->vid)
                   ->execute();
+              }
+            }
             $this->save_row(!empty($this->vid) ? 'vid' : FALSE);
             // Save all of our subtables.
             foreach ($this->db_objects() as $key) {
               $this->_save_rows($key);
+            }
+          }
           catch (Exception $e) {
             $transaction->rollback();
             watchdog_exception('views', $e);
             throw $e;
+          }
           $this->save_locale_strings();
           // Clear the relevant caches.
           cache_clear_all('views_block_items:', 'cache_views', TRUE);
           views_invalidate_cache('ctools_export:views_view:' . $this->name);
           // Notify modules that this view has been saved.
           module_invoke_all('views_view_save', $this);
+        }
         /**
          * Save a row to the database for the given key.
+         *
          * i.e. one of the keys from view::db_objects().
          */
         public function _save_rows($key) {
           $count = 0;
           foreach ($this->$key as $position => $object) {
             $object->position = ++$count;
             $object->vid = $this->vid;
             $object->save_row();
+          }
+        }
         /**
          * Delete the view from the database.
          */
         public function delete($clear = TRUE) {
           if (empty($this->vid)) {
             return;
+          }
           db_delete('views_view')
             ->condition('vid', $this->vid)
             ->execute();
           // Delete from all of our subtables as well.
           foreach ($this->db_objects() as $key) {
             db_delete('views_' . $key)
               ->condition('vid', $this->vid)
               ->execute();
+          }
           cache_clear_all('views_query:' . $this->name, 'cache_views');
           if ($clear) {
             // Clear caches.
             cache_clear_all('views_block_items:', 'cache_views', TRUE);
             views_invalidate_cache('ctools_export:views_view:' . $this->name);
+          }
           // Notify modules that this view has been deleted.
           module_invoke_all('views_view_delete', $this);
+        }
         /**
          * Export a view as PHP code.
          */
         public function export($indent = '') {
           $this->init_display();
           $this->init_query();
           $output = '';
           $output .= $this->export_row('view', $indent);
           // Set the API version.
           $output .= $indent . '$view->api_version = \'' . views_api_version() . "';\n";
           $output .= $indent . '$view->disabled = FALSE; /* Edit this to true to make a default view disabled initially */' . "\n";
           foreach ($this->display as $id => $display) {
             $output .= "\n" . $indent . "/* Display: $display->display_title */\n";
             $output .= $indent . '$handler = $view->new_display(' . ctools_var_export($display->display_plugin, $indent) . ', ' . ctools_var_export($display->display_title, $indent) . ', \'' . $id . "');\n";
             if (empty($display->handler)) {
               // @todo Probably need a method of exporting broken displays as they
               // may simply be broken because a module is not installed. That does
               // not invalidate the display.
               continue;
+            }
             $output .= $display->handler->export_options($indent, '$handler->options');
+          }
           // Give the localization system a chance to export translatables to code.
           if ($this->init_localization()) {
             $this->export_locale_strings('export');
             $translatables = $this->localization_plugin->export_render($indent);
             if (!empty($translatables)) {
               $output .= $translatables;
+            }
+          }
           return $output;
+        }
         /**
          * Make a copy of this view with IDs, handlers sanitized
+         *
          * I'd call this clone() but it's reserved.
          */
         public function copy() {
           $code = $this->export();
           eval($code);
           return $view;
+        }
         /**
          * Safely clone a view.
+         *
          * Because views are complicated objects within objects, and PHP loves to do
          * references to everything, if a View is not properly and safely cloned it
          * will still have references to the original view, and can actually cause the
          * original view to point to objects in the cloned view. This gets ugly fast.
+         *
          * This will completely wipe a view clean so it can be considered fresh.
+         *
          * @return view
          *    The cloned view.
          */
         public function clone_view() {
           $clone = clone $this;
           $keys = array('current_display', 'display_handler', 'build_info', 'built', 'executed', 'attachment_before', 'attachment_after', 'field', 'argument', 'filter', 'sort', 'relationship', 'header', 'footer', 'empty', 'query', 'inited', 'style_plugin', 'plugin_name', 'exposed_data', 'exposed_input', 'exposed_widgets', 'many_to_one_aliases', 'many_to_one_tables', 'feed_icon');
           foreach ($keys as $key) {
             if (isset($clone->{$key})) {
               unset($clone->{$key});
+            }
+          }
           $clone->built = $clone->executed = FALSE;
           $clone->build_info = array();
           $clone->attachment_before = '';
           $clone->attachment_after = '';
           $clone->result = array();
           // Shallow cloning means that all the display objects *were not cloned*. We
           // must clone them ourselves.
           $displays = array();
           foreach ($clone->display as $id => $display) {
             $displays[$id] = clone $display;
             if (isset($displays[$id]->handler)) {
               unset($displays[$id]->handler);
+            }
+          }
           $clone->display = $displays;
           return $clone;
+        }
         /**
          * Unset references so that a $view object may be properly garbage collected.
          */
         public function destroy() {
           foreach (array_keys($this->display) as $display_id) {
             if (isset($this->display[$display_id]->handler) && is_object($this->display[$display_id]->handler)) {
               $this->display[$display_id]->handler->destroy();
               unset($this->display[$display_id]->handler);
+            }
+          }
           foreach (views_object_types() as $type => $info) {
             if (isset($this->$type)) {
               $handlers = &$this->$type;
               foreach ($handlers as $id => $item) {
                 $handlers[$id]->destroy();
+              }
               unset($handlers);
+            }
+          }
           if (isset($this->style_plugin)) {
             $this->style_plugin->destroy();
             unset($this->style_plugin);
+          }
           // Clear these to make sure the view can be processed/used again.
           if (isset($this->display_handler)) {
             unset($this->display_handler);
+          }
           if (isset($this->current_display)) {
             unset($this->current_display);
+          }
           if (isset($this->query)) {
             unset($this->query);
+          }
           $keys = array('current_display', 'display_handler', 'build_info', 'built', 'executed', 'attachment_before', 'attachment_after', 'field', 'argument', 'filter', 'sort', 'relationship', 'header', 'footer', 'empty', 'query', 'result', 'inited', 'style_plugin', 'plugin_name', 'exposed_data', 'exposed_input', 'many_to_one_tables');
           foreach ($keys as $key) {
             if (isset($this->$key)) {
               unset($this->$key);
+            }
+          }
           // These keys are checked by the next init, so instead of unsetting them,
           // just set the default values.
           $keys = array('items_per_page', 'offset', 'current_page');
           foreach ($keys as $key) {
             if (isset($this->$key)) {
               $this->$key = NULL;
+            }
+          }
           $this->built = $this->executed = FALSE;
           $this->build_info = array();
           $this->attachment_before = '';
           $this->attachment_after = '';
+        }
         /**
          * Make sure the view is completely valid.
+         *
          * @return bool
          *   TRUE if the view is valid; an array of error strings if it is not.
          */
         public function validate() {
           $this->init_display();
           $errors = array();
           $this->display_errors = NULL;
           $current_display = $this->current_display;
           foreach ($this->display as $id => $display) {
             if ($display->handler) {
               if (!empty($display->deleted)) {
                 continue;
+              }
               $result = $this->display[$id]->handler->validate();
               if (!empty($result) && is_array($result)) {
                 $errors = array_merge($errors, $result);
                 // Mark this display as having validation errors.
                 $this->display_errors[$id] = TRUE;
+              }
+            }
+          }
           $this->set_display($current_display);
           return $errors ? $errors : TRUE;
+        }
         /**
          * Find and initialize the localization plugin.
          */
         public function init_localization() {
           // If the translate attribute isn't set, init the localization plugin.
           if (!isset($this->localization_plugin->translate)) {
             $this->localization_plugin = views_get_plugin('localization', views_get_localization_plugin());
             // If the plugin is still not set, turn off all localization by using the
             // views_plugin_localization_none plugin. This plugin has the translate
             // property set to FALSE, signifying localization should not occur.
             if (empty($this->localization_plugin)) {
               $this->localization_plugin = views_get_plugin('localization', 'none');
+            }
             // Init the plugin.
             $this->localization_plugin->init($this);
+          }
           // Return the value of the translate property. This is set to FALSE if
           // localization is off.
           return $this->localization_plugin->translate;
+        }
         /**
          * Determine whether a view supports admin string translation.
          */
         public function is_translatable() {
           // Use translation no matter what type of view.
           if (variable_get('views_localize_all', FALSE)) {
             return TRUE;
+          }
           // If the view is normal or overridden, use admin string translation.
           // A newly created view won't have a type. Accept this.
           return (!isset($this->type) || in_array($this->type, array(t('Normal'), t('Overridden')))) ? TRUE : FALSE;
+        }
         /**
          * Send strings for localization.
          */
         public function save_locale_strings() {
           $this->process_locale_strings('save');
+        }
         /**
          * Delete localized strings.
          */
         public function delete_locale_strings() {
           $this->process_locale_strings('delete');
+        }
         /**
          * Export localized strings.
          */
         public function export_locale_strings() {
           $this->process_locale_strings('export');
+        }
         /**
          * Process strings for localization, deletion or export to code.
          */
         public function process_locale_strings($op) {
           // Ensure this view supports translation, we have a display, and we
           // have a localization plugin.
           // @todo Export does not init every handler.
           if (($this->is_translatable() || $op == 'export') && $this->init_display() && $this->init_localization()) {
             $this->localization_plugin->process_locale_strings($op);
+          }
+        }
+      }
       /**
        * Base class for views' database objects.
        */
       class views_db_object {
         public $db_table;
         /**
          * Initialize this object, setting values from schema defaults.
+         *
          * @param array|bool $init
          *   If an array, this is a set of values from db_fetch_object to
          *   load. Otherwse, if TRUE values will be filled in from schema
          *   defaults.
          */
         public function init($init = TRUE) {
           if (is_array($init)) {
             return $this->load_row($init);
+          }
           if (!$init) {
             return;
+          }
           $schema = drupal_get_schema($this->db_table);
           if (!$schema) {
             return;
+          }
           // Go through our schema and build correlations.
           foreach ($schema['fields'] as $field => $info) {
             if ($info['type'] == 'serial') {
               $this->$field = NULL;
+            }
             if (!isset($this->$field)) {
               if (!empty($info['serialize']) && isset($info['serialized default'])) {
                 $this->$field = unserialize($info['serialized default']);
+              }
               elseif (isset($info['default'])) {
                 $this->$field = $info['default'];
+              }
               else {
                 $this->$field = '';
+              }
+            }
+          }
+        }
         /**
          * Write the row to the database.
+         *
          * @param bool $update
          *   If true this will be an UPDATE query. Otherwise it will be an INSERT.
          */
         public function save_row($update = NULL) {
           $fields = $defs = $values = $serials = array();
           $schema = drupal_get_schema($this->db_table);
           // Go through our schema and build correlations.
           foreach ($schema['fields'] as $field => $info) {
             // Special case - skip serial types if we are updating.
             if ($info['type'] == 'serial') {
               $serials[] = $field;
               continue;
+            }
             elseif ($info['type'] == 'int') {
               $this->$field = (int) $this->$field;
+            }
             $fields[$field] = empty($info['serialize']) ? $this->$field : serialize($this->$field);
+          }
           if (!$update) {
             $query = db_insert($this->db_table);
+          }
           else {
             $query = db_update($this->db_table)
               ->condition($update, $this->$update);
+          }
           $return = $query
             ->fields($fields)
             ->execute();
           if ($serials && !$update) {
             // Get last insert ids and fill them in. Well, one ID.
             foreach ($serials as $field) {
               $this->$field = $return;
+            }
+          }
+        }
         /**
          * Load the object with a row from the database.
+         *
          * This method is separate from the constructor in order to give us more
          * flexibility in terms of how the view object is built in different contexts.
+         *
          * @param object $data
          *   An object from db_fetch_object. It should contain all of the fields
          *   that are in the schema.
          */
         public function load_row($data) {
           $schema = drupal_get_schema($this->db_table);
           // Go through our schema and build correlations.
           foreach ($schema['fields'] as $field => $info) {
             $this->$field = empty($info['serialize']) ? $data->$field : unserialize($data->$field);
+          }
+        }
         /**
          * Export a loaded row.
+         *
          * Might be an argument, field or the view itself to PHP code.
+         *
          * @param string $identifier
          *   The variable to assign the PHP code for this object to.
          * @param int $indent
          *   An optional indentation for prettifying nested code.
          */
         public function export_row($identifier = NULL, $indent = '') {
           ctools_include('export');
           if (!$identifier) {
             $identifier = $this->db_table;
+          }
           $schema = drupal_get_schema($this->db_table);
           $output = $indent . '$' . $identifier . ' = new ' . get_class($this) . "();\n";
           // Go through our schema and build correlations.
           foreach ($schema['fields'] as $field => $info) {
             if (!empty($info['no export'])) {
               continue;
+            }
             if (!isset($this->$field)) {
               if (isset($info['default'])) {
                 $this->$field = $info['default'];
+              }
               else {
                 $this->$field = '';
+              }
               // Serialized defaults must be set as serialized.
               if (isset($info['serialize'])) {
                 $this->$field = unserialize($this->$field);
+              }
+            }
             $value = $this->$field;
             if ($info['type'] == 'int') {
               if (isset($info['size']) && $info['size'] == 'tiny') {
                 $value = (bool) $value;
+              }
               else {
                 $value = (int) $value;
+              }
+            }
             $output .= $indent . '$' . $identifier . '->' . $field . ' = ' . ctools_var_export($value, $indent) . ";\n";
+          }
           return $output;
+        }
         /**
          * Add a new display handler to the view, automatically creating an id.
+         *
          * @param string $type
          *   The plugin type from the views plugin data. Defaults to 'page'.
          * @param string $title
          *   The title of the display; optional, may be filled in from default.
          * @param int $id
          *   The id to use.
+         *
          * @return string
          *   The key to the display in $view->display, so that the new display can be
          *   easily located.
          */
         public function add_display($type = 'page', $title = NULL, $id = NULL) {
           if (empty($type)) {
             return FALSE;
+          }
           $plugin = views_fetch_plugin_data('display', $type);
           if (empty($plugin)) {
             $plugin['title'] = t('Broken');
+          }
           if (empty($id)) {
             $id = $this->generate_display_id($type);
             if ($id !== 'default') {
               preg_match("/[0-9]+/", $id, $count);
               $count = $count[0];
+            }
             else {
               $count = '';
+            }
             if (empty($title)) {
               if ($count > 1) {
                 $title = $plugin['title'] . ' ' . $count;
+              }
               else {
                 $title = $plugin['title'];
+              }
+            }
+          }
           // Create the new display object.
           $display = new views_display();
           $display->options($type, $id, $title);
           // Add the new display object to the view.
           $this->display[$id] = $display;
           return $id;
+        }
         /**
          * Generate a display id of a certain plugin type.
+         *
          * @param string $type
          *   Which plugin should be used for the new display id.
          */
         public function generate_display_id($type) {
           // 'default' is singular and is unique, so just go with 'default'
           // for it. For all others, start counting.
           if ($type == 'default') {
             return 'default';
+          }
           // Initial id.
           $id = $type . '_1';
           $count = 1;
           // Loop through IDs based upon our style plugin name until we find one that
           // is unused.
           while (!empty($this->display[$id])) {
             $id = $type . '_' . ++$count;
+          }
           return $id;
+        }
         /**
          * Generates a unique ID for an item.
+         *
          * These items are typically fields, filters, sort criteria, or arguments.
+         *
          * @param int $requested_id
          *   The requested ID for the item.
          * @param array $existing_items
          *   An array of existing items, keyed by their IDs.
+         *
          * @return string
          *   A unique ID. This will be equal to $requested_id if no item with that ID
          *   already exists. Otherwise, it will be appended with an integer to make
          *   it unique, e.g. "{$requested_id}_1", "{$requested_id}_2", etc.
          */
         public static function generate_item_id($requested_id, $existing_items) {
           $count = 0;
           $id = $requested_id;
           while (!empty($existing_items[$id])) {
             $id = $requested_id . '_' . ++$count;
+          }
           return $id;
+        }
         /**
          * Create a new display and a display handler for it.
+         *
          * @param string $type
          *   The plugin type from the views plugin data. Defaults to 'page'.
          * @param string $title
          *   The title of the display; optional, may be filled in from default.
          * @param int $id
          *   The id to use.
+         *
          * @return views_plugin_display
          *   A reference to the new handler object.
          */
         public function &new_display($type = 'page', $title = NULL, $id = NULL) {
           $id = $this->add_display($type, $title, $id);
           // Create a handler.
           $this->display[$id]->handler = views_get_plugin('display', $this->display[$id]->display_plugin);
           if (empty($this->display[$id]->handler)) {
             // Provide a 'default' handler as an emergency. This won't work well but
             // it will keep things from crashing.
             $this->display[$id]->handler = views_get_plugin('display', 'default');
+          }
           if (!empty($this->display[$id]->handler)) {
             // Initialize the new display handler with data.
             $this->display[$id]->handler->init($this, $this->display[$id]);
             // If this is NOT the default display handler, let it know which is.
             if ($id != 'default') {
               $this->display[$id]->handler->default_display = &$this->display['default']->handler;
+            }
+          }
           return $this->display[$id]->handler;
+        }
         /**
          * Add an item with a handler to the view.
+         *
          * These items may be fields, filters, sort criteria, or arguments.
          */
         public function add_item($display_id, $type, $table, $field, $options = array(), $id = NULL) {
           $types = views_object_types();
           $this->set_display($display_id);
           $fields = $this->display[$display_id]->handler->get_option($types[$type]['plural']);
           if (empty($id)) {
             $id = $this->generate_item_id($field, $fields);
+          }
           $new_item = array(
             'id' => $id,
             'table' => $table,
             'field' => $field,
           ) + $options;
           if (!empty($types[$type]['type'])) {
             $handler_type = $types[$type]['type'];
+          }
           else {
             $handler_type = $type;
+          }
           $handler = views_get_handler($table, $field, $handler_type);
           $fields[$id] = $new_item;
           $this->display[$display_id]->handler->set_option($types[$type]['plural'], $fields);
           return $id;
+        }
         /**
          * Get an array of items for the current display.
          */
         public function get_items($type, $display_id = NULL) {
           $this->set_display($display_id);
           if (!isset($display_id)) {
             $display_id = $this->current_display;
+          }
           // Get info about the types so we can get the right data.
           $types = views_object_types();
           return $this->display[$display_id]->handler->get_option($types[$type]['plural']);
+        }
         /**
          * Get the config of an item (field/sort/filter/etc) on a given display.
          */
         public function get_item($display_id, $type, $id) {
           // Get info about the types so we can get the right data.
           $types = views_object_types();
           // Initialize the display.
           $this->set_display($display_id);
           // Get the existing configuration.
           $fields = $this->display[$display_id]->handler->get_option($types[$type]['plural']);
           return isset($fields[$id]) ? $fields[$id] : NULL;
+        }
         /**
          * Set the config of an item (field/sort/filter/etc) on a given display.
+         *
          * Pass in NULL for the $item to remove an item.
          */
         public function set_item($display_id, $type, $id, $item) {
           // Get info about the types so we can get the right data.
           $types = views_object_types();
           // Initialize the display.
           $this->set_display($display_id);
           // Get the existing configuration.
           $fields = $this->display[$display_id]->handler->get_option($types[$type]['plural']);
           if (isset($item)) {
             $fields[$id] = $item;
+          }
           else {
             unset($fields[$id]);
+          }
           // Store.
           $this->display[$display_id]->handler->set_option($types[$type]['plural'], $fields);
+        }
         /**
          * Set an option on an item.
+         *
          * Use this only if you have just 1 or 2 options to set; if you have many,
          * consider getting the item, adding the options and doing set_item yourself.
          */
         public function set_item_option($display_id, $type, $id, $option, $value) {
           $item = $this->get_item($display_id, $type, $id);
           $item[$option] = $value;
           $this->set_item($display_id, $type, $id, $item);
+        }
+      }
       /**
        * A display type in a view.
+       *
        * This is just the database storage mechanism, and isn't terribly important
        * to the behavior of the display at all.
        */
       class views_display extends views_db_object {
         /**
          * The display handler itself, which has all the methods.
+         *
          * @var views_plugin_display
          */
         public $handler;
         /**
          * Stores all options of the display, like fields, filters etc.
+         *
          * @var array
          */
         public $display_options;
         public $db_table = 'views_display';
         public function __construct($init = TRUE) {
           parent::init($init);
+        }
         /**
          * {@inheritdoc}
          */
         public function options($type, $id, $title) {
           $this->display_plugin = $type;
           $this->id = $id;
           $this->display_title = $title;
+        }
+      }
       /**
        * Provide a list of object types used in a view, with some info about them.
        */
       function views_object_types() {
         static $retval = NULL;
         // Statically cache this so t() doesn't run a bajillion times.
         if (!isset($retval)) {
           $retval = array(
             'field' => array(
               // Title.
               'title' => t('Fields'),
               // Lowercase title for mid-sentence.
               'ltitle' => t('fields'),
               // Singular title.
               'stitle' => t('Field'),
               // Lingular lowercase title for mid sentence.
               'lstitle' => t('field'),
               'plural' => 'fields',
             ),
             'argument' => array(
               'title' => t('Contextual filters'),
               'ltitle' => t('contextual filters'),
               'stitle' => t('Contextual filter'),
               'lstitle' => t('contextual filter'),
               'plural' => 'arguments',
             ),
             'sort' => array(
               'title' => t('Sort criteria'),
               'ltitle' => t('sort criteria'),
               'stitle' => t('Sort criterion'),
               'lstitle' => t('sort criterion'),
               'plural' => 'sorts',
             ),
             'filter' => array(
               'title' => t('Filter criteria'),
               'ltitle' => t('filter criteria'),
               'stitle' => t('Filter criterion'),
               'lstitle' => t('filter criterion'),
               'plural' => 'filters',
             ),
             'relationship' => array(
               'title' => t('Relationships'),
               'ltitle' => t('relationships'),
               'stitle' => t('Relationship'),
               'lstitle' => t('Relationship'),
               'plural' => 'relationships',
             ),
             'header' => array(
               'title' => t('Header'),
               'ltitle' => t('header'),
               'stitle' => t('Header'),
               'lstitle' => t('Header'),
               'plural' => 'header',
               'type' => 'area',
             ),
             'footer' => array(
               'title' => t('Footer'),
               'ltitle' => t('footer'),
               'stitle' => t('Footer'),
               'lstitle' => t('Footer'),
               'plural' => 'footer',
               'type' => 'area',
             ),
             'empty' => array(
               'title' => t('No results behavior'),
               'ltitle' => t('no results behavior'),
               'stitle' => t('No results behavior'),
               'lstitle' => t('No results behavior'),
               'plural' => 'empty',
               'type' => 'area',
             ),
           );
+        }
         return $retval;
+      }
       /**
        * @}
        */

Project

General

Profile

Club Drupal

root / drupal7 / sites / all / modules / views / includes / view.inc @ 4003efde