class finder_views_plugin_display_finder in Finder 7

Same name and namespace in other branches

6 modules/finder_views/includes/finder_views_plugin_display_finder.inc \finder_views_plugin_display_finder

@file Handler for 'finder_views' display.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_display
    class \finder_views_plugin_display_finder

Expanded class hierarchy of finder_views_plugin_display_finder

1 string reference to 'finder_views_plugin_display_finder'

finder_views_views_plugins in modules/finder_views/includes/finder_views.views.inc: Implements hook_views_plugins().

File

modules/finder_views/includes/finder_views_plugin_display_finder.inc, line 8: Handler for 'finder_views' display.

View source

class finder_views_plugin_display_finder extends views_plugin_display {
  function execute() {
    return $this->view
      ->render($this->display->id);
  }
  function render() {
    return !empty($this->view->result) || !empty($this->view->style_plugin->definition['even empty']) ? $this->view->style_plugin
      ->render($this->view->result) : '';
  }
  function query() {

    // Get variables passed through Views' "options" functionality.
    extract($this
      ->get_option('finder_views_options'));
    $field_info = $this->display->display_options['finder_views_field_info'];

    // Add relationships for choices fields.
    if ($mode == 'choices' && isset($finder->settings['views']['relationships'])) {
      $element =& finder_element($finder, $finder_element_id);
      $element_fields =& $element->settings['choices']['field'];
      foreach ($element_fields as $key => $field) {
        foreach ($finder->settings['views']['relationships'] as $rel_key => $rel_fields) {
          if (in_array($field, $rel_fields)) {
            $field_info[$finder_element_id][$key] = finder_split_field($field);
            $alias = finder_table_alias($feid, $field_info[$finder_element_id][$key]['table'], $field_info[$finder_element_id][$key]['field']);
            $relationship = $this->view->relationship[$rel_key]->alias;
            $join = NULL;
            $this->view->query
              ->add_table($field_info[$finder_element_id][$key]['table'], $relationship, $join, $alias);
          }
        }
      }
    }
    if (!empty($keywords)) {
      $placeholder_count = 0;

      // Create a where group called 'finder', for element combination.
      $element_combination = $finder->settings['advanced']['element_combination'] ? 'OR' : 'AND';
      $this->view->query
        ->set_where_group($element_combination, 'finder');

      // As we iterate through fields, collect their info and store it in $field_info.
      $field_info = array();
      foreach ($keywords as $feid => $keyword_array) {
        $element =& finder_element($finder, $feid);
        $element_fields =& $element->settings['choices']['field'];
        $field_combination = $element->settings['advanced']['field_combination'] ? 'AND' : 'OR';
        $value_combination = $element->settings['advanced']['value_combination'] ? 'AND' : 'OR';
        $nesting_order = $element->settings['advanced']['nesting_order'];
        $results_match = $element->settings['advanced']['match'];
        $match = $mode == 'results' ? $results_match : $match;
        if (!empty($keyword_array)) {
          $clauses = array();
          $clause_args = array();
          foreach ($element_fields as $key => $field) {
            $field_info[$feid][$key] = finder_split_field($field);
            foreach (array_values($keyword_array) as $keyword_position => $keyword) {

              // Get the info we need to add the table/field.
              $delta = $value_combination == 'AND' && count($keyword_array) > 1 ? $keyword_position : NULL;
              $alias = finder_table_alias($feid, $field_info[$feid][$key]['table'], $field_info[$feid][$key]['field'], $delta);
              $relationship = NULL;
              $join = NULL;
              if (isset($finder->settings['views']['relationships'])) {
                foreach ($finder->settings['views']['relationships'] as $rel_key => $rel_fields) {
                  if (in_array($field, $rel_fields)) {
                    $relationship = $this->view->relationship[$rel_key]->alias;

                    // This code is now handled below by the code that fixes the left join.

                    //$join = $this->view->query->get_join_data($field_info[$feid][$key]['table'], $this->view->relationship[$rel_key]->definition['base']);
                    break;
                  }
                }
              }

              // This chunk of code will fix the join directly to the left.  Should we actually be recursing through all the left tables right back to the base table?
              if (empty($relationship)) {
                $relationship = $this->view->query->base_table;
              }
              $join = $this->view->query
                ->get_join_data($field_info[$feid][$key]['table'], $this->view->query->relationships[$relationship]['base']);
              if (!empty($join)) {
                $join = $this->view->query
                  ->adjust_join($join, $relationship);
              }
              if (!empty($join->left_table)) {

                // Check for the long-chain join case that we probably screwed up, and plead for assistance.
                $left_table_join_data = $this->view->query
                  ->get_join_data($join->left_table, $this->view->query->relationships[$relationship]['base']);
                if (!empty($left_table_join_data->left_table) && $left_table_join_data->left_table != $this->view->query->base_table && user_access('administer finder')) {

                  // Purposefully not enclosed in t() because this is not a typical UI string.
                  drupal_set_message("Views join configuration not supported by finder.  Please post in the <a href=\"http://drupal.org/node/add/project-issue/finder\">finder issue queue</a> and attach an export of your finder, or explain what fields you are using.  We need your help to solve this problem.", 'error');
                }

                // Table name supplied here is a combo of the table joined here, and the table we ultimately want to join.
                $join_alias = finder_table_alias($feid, $field_info[$feid][$key]['table'] . "_" . $join->left_table, $field_info[$feid][$key]['field'], $delta);
                $join_alias = $this->view->query
                  ->add_table($join->left_table, NULL, NULL, $join_alias);

                // This line below actually seems to break stuff. Issue #1248608.
                // $join->left_table = $join_alias;
              }
              $alias = $this->view->query
                ->add_table($field_info[$feid][$key]['table'], $relationship, $join, $alias);
              $field_alias = finder_field_alias($feid, $field_info[$feid][$key]['table'], $field_info[$feid][$key]['field'], $delta);
              $join = $join ? $join : $this->view->query
                ->get_join_data($alias, $this->view->base_table);
              $table = isset($join->table) ? $join->table : $field_info[$feid][$key]['table'];
              if ($table == $this->view->base_table) {

                // This is KAOS.  Ve don't alias base table here.
                $alias = $this->view->base_table;
              }

              // Select the field.
              if ($mode == 'results' && $finder->settings['views']['results'] || $mode == 'choices' && $feid == $finder_element_id) {

                // If we're doing a custom results page or a choices list, grab the field value, and store the alias.
                $this->view->query
                  ->add_field($alias, $field_info[$feid][$key]['field'], $field_alias);
                $field_info[$feid][$key]['field_alias'][$delta] = $field_alias;

                // This if-statement also assumes that $feid == $finder_element id, but it is not needed to specify this because of the outer if-statement.
                if ($mode == 'choices') {
                  $this->view->query
                    ->add_where_expression('finder', $alias . '.' . $field_info[$feid][$key]['field'] . ' IS NOT NULL');
                }
              }

              // Add the field to where clauses.
              if ($keyword !== '' && $keyword !== NULL) {
                list($field_name, $value, $op) = array_values((array) finder_condition_args($alias . '.' . $field_info[$feid][$key]['field'], $keyword, $match));
                $outer_key = $nesting_order ? $key : $keyword_position;
                $placeholder = ':finder_keyword_' . $placeholder_count++;
                $clauses[$outer_key][] = $field_name . ' ' . $op . ' ' . $placeholder;
                $clause_args[$outer_key][$placeholder] = $value;
              }
            }
          }

          // Convert where clauses into sql strings and add to view with add_where().
          if (!empty($clauses)) {
            $inner_operator = $nesting_order ? $value_combination : $field_combination;
            $outer_operator = $nesting_order ? $field_combination : $value_combination;
            $inner_clauses = array();
            $inner_clause_args = array();
            foreach ($clauses as $clause) {
              $inner_clauses[] = '(' . implode(' ' . $inner_operator . ' ', $clause) . ')';
            }
            foreach ($clause_args as $clause_arg) {
              foreach ($clause_arg as $inner_clause_arg_key => $inner_clause_arg) {
                $inner_clause_args[$inner_clause_arg_key] = $inner_clause_arg;
              }
            }
            $this->view->query
              ->add_where_expression('finder', '(' . implode(' ' . $outer_operator . ' ', $inner_clauses) . ')', $inner_clause_args);
          }
        }
      }
    }

    // Save $field_info into the view, so we can use it in the style plugin.
    $this->view->display_handler
      ->set_option('finder_views_field_info', $field_info);

    // Add groups.
    foreach ($groups as $group) {
      $this->view->query
        ->add_groupby($group);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
finder_views_plugin_display_finder::execute		function	When used externally, this is how a view gets run and returns data in the format required. Overrides views_plugin_display::execute
finder_views_plugin_display_finder::query		function	Inject anything into the query that the display handler needs. Overrides views_plugin_display::query
finder_views_plugin_display_finder::render		function	Render this display. Overrides views_plugin_display::render
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_display::$extender	public	property	Stores all available display extenders.
views_plugin_display::$handlers	public	property	List of handlers for this display.
views_plugin_display::$view	public	property	The top object of a view. Overrides views_plugin::$view
views_plugin_display::accept_attachments	public	function	Can this display accept attachments?
views_plugin_display::access	public	function	Determine if the user has access to this display of the view.
views_plugin_display::attach_to	public	function	Allow displays to attach to other views.	2
views_plugin_display::defaultable_sections	public	function	List which sections are defaultable and what items each section contains.	1
views_plugin_display::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_display::displays_exposed	public	function	Determine if this display should display the exposed filters widgets.	1
views_plugin_display::export_handler	public	function	Special method to export items that have handlers.
views_plugin_display::export_option	public	function	Override of export_option() Overrides views_object::export_option
views_plugin_display::export_plugin	public	function	Special handling for plugin export.
views_plugin_display::export_style	public	function	Special handling for the style export.
views_plugin_display::format_themes	public	function	Format a list of theme templates for output by the theme info helper.
views_plugin_display::get_arguments_tokens	public	function	Returns to tokens for arguments.
views_plugin_display::get_argument_text	public	function	Provide some helpful text for the arguments.	1
views_plugin_display::get_field_labels	public	function	List of fields for the current display with the associated relationship.
views_plugin_display::get_handler	public	function	Get the handler object for a single handler.
views_plugin_display::get_handlers	public	function	Get a full array of handlers for $type. This caches them.
views_plugin_display::get_link_display	public	function	Check to see which display to use when creating links.
views_plugin_display::get_option	public	function	Intelligently get an option either from this or default display.
views_plugin_display::get_pager_text	public	function	Provide some helpful text for pagers.	1
views_plugin_display::get_path	public	function	Return the base path to use for this display.
views_plugin_display::get_plugin	public	function	Get the instance of a plugin, for example style or row.
views_plugin_display::get_special_blocks	public	function	Provide the block system with any exposed widget blocks for this display.
views_plugin_display::get_style_type	public	function	Displays can require a certain type of style plugin.	1
views_plugin_display::get_url	public	function
views_plugin_display::has_path	public	function	Check to see if the display has a 'path' field.	1
views_plugin_display::hook_block_list	public	function	If this display creates a block, implement one of these.
views_plugin_display::hook_menu	public	function	If this display creates a page with a menu item, implement it here.
views_plugin_display::init	public	function		1
views_plugin_display::is_defaulted	public	function	Determine if a given option is set to use the default or current display.
views_plugin_display::is_default_display	public	function	If this display is the 'default' display which contains fallback settings.	1
views_plugin_display::is_identifier_unique	public	function	Check if the provided identifier is unique.
views_plugin_display::options_form	public	function	Provide the default form for setting options. Overrides views_plugin::options_form	3
views_plugin_display::options_override	public	function	If override/revert was clicked, perform the proper toggle.
views_plugin_display::options_submit	public	function	Perform any necessary changes to the form values prior to storage. Overrides views_plugin::options_submit	3
views_plugin_display::options_summary	public	function	Provide the default summary for options in the views UI.	3
views_plugin_display::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate	1
views_plugin_display::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition	3
views_plugin_display::option_link	public	function	Because forms may be split up into sections, this provides an easy URL to exactly the right section. Don't override this.
views_plugin_display::override_option	public	function	Set an option and force it to be an override.
views_plugin_display::preview	public	function	Fully render the display.	1
views_plugin_display::pre_execute	public	function	Set up any variables on the view prior to execution.
views_plugin_display::render_area	public	function
views_plugin_display::render_empty	public	function
views_plugin_display::render_filters	public	function	Not all display plugins will support filtering.
views_plugin_display::render_footer	public	function	Render the footer of the view.
views_plugin_display::render_header	public	function	Render the header of the view.
views_plugin_display::render_more_link	public	function	Render the 'more' link.
views_plugin_display::render_pager	public	function	Not all display plugins will suppert pager rendering.	1
views_plugin_display::set_option	public	function	Intelligently set an option either from this display or from the default display, if directed to do so.
views_plugin_display::set_override	public	function	Flip the override setting for the given section.
views_plugin_display::unpack_handler	public	function	Special method to unpack items that have handlers.
views_plugin_display::unpack_plugin	public	function	Special handling for plugin unpacking.
views_plugin_display::unpack_style	public	function
views_plugin_display::uses_breadcrumb	public	function	Check to see if the display needs a breadcrumb.	1
views_plugin_display::uses_exposed	public	function	Does this display uses exposed filters?	2
views_plugin_display::uses_exposed_form_in_block	public	function	Check to see if the display can put the exposed form in a block.
views_plugin_display::uses_fields	public	function	Determine if the display's style uses fields.
views_plugin_display::uses_link_display	public	function	Check to see if the display has some need to link to another display.	1
views_plugin_display::use_ajax	public	function	Does the display use AJAX?
views_plugin_display::use_group_by	public	function	Does the display have groupby enabled?
views_plugin_display::use_more	public	function	Does the display have a more link enabled?
views_plugin_display::use_more_always	public	function	Should the enabled display more link be shown when no more items?
views_plugin_display::use_more_open_new_window	public	function	Should the enabled display more link being opened in an new window?
views_plugin_display::use_more_text	public	function	Does the display have custom link text?
views_plugin_display::use_pager	public	function	Does the display have a pager enabled?	1
views_plugin_display::validate	public	function	Make sure the display and all associated handlers are valid. Overrides views_plugin::validate	1
views_plugin_display::view_special_blocks	public	function	Render any special blocks provided for this display.

You are here

class finder_views_plugin_display_finder in Finder 7

Hierarchy

File

Members

API Navigation