class entityreference_plugin_display in Entity reference 7

@file Handler for entityreference_plugin_display.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_display
    class \entityreference_plugin_display

Expanded class hierarchy of entityreference_plugin_display

1 string reference to 'entityreference_plugin_display'

entityreference_views_plugins in views/entityreference.views.inc: Implements hook_views_plugins().

File

views/entityreference_plugin_display.inc, line 7: Handler for entityreference_plugin_display.

View source

class entityreference_plugin_display extends views_plugin_display {
  function option_definition() {
    $options = parent::option_definition();

    // Force the style plugin to 'entityreference_style' and the row plugin to
    // 'fields'.
    $options['style_plugin']['default'] = 'entityreference_style';
    $options['defaults']['default']['style_plugin'] = FALSE;
    $options['defaults']['default']['style_options'] = FALSE;
    $options['row_plugin']['default'] = 'entityreference_fields';
    $options['defaults']['default']['row_plugin'] = FALSE;
    $options['defaults']['default']['row_options'] = FALSE;

    // Set the display title to an empty string (not used in this display type).
    $options['title']['default'] = '';
    $options['defaults']['default']['title'] = FALSE;
    return $options;
  }
  function get_style_type() {
    return 'entityreference';
  }
  function execute() {
    return $this->view
      ->render($this->display->id);
  }
  function render() {
    if (!empty($this->view->result) || !empty($this->view->style_plugin->definition['even empty'])) {
      return $this->view->style_plugin
        ->render($this->view->result);
    }
    return '';
  }
  function uses_exposed() {
    return FALSE;
  }
  function query() {
    $options = $this
      ->get_option('entityreference_options');

    // Play nice with Views UI 'preview' : if the view is not executed through
    // EntityReference_SelectionHandler_Views::getReferencableEntities(),
    // don't alter the query.
    if (empty($options)) {
      return;
    }

    // Make sure the id field is included in the results, and save its alias
    // so that references_plugin_style can retrieve it.
    $this->id_field_alias = $id_field = $this->view->query
      ->add_field($this->view->base_table, $this->view->base_field);
    if (strpos($id_field, '.') === FALSE) {
      $id_field = $this->view->base_table . '.' . $this->id_field_alias;
    }

    // Restrict the autocomplete options based on what's been typed already.
    if (isset($options['match'])) {
      $style_options = $this
        ->get_option('style_options');
      $value = db_like($options['match']) . '%';
      if ($options['match_operator'] != 'STARTS_WITH') {
        $value = '%' . $value;
      }

      // Multiple search fields are OR'd together
      $conditions = db_or();

      // Build the condition using the selected search fields
      foreach ($style_options['search_fields'] as $field_alias) {
        if (!empty($field_alias)) {

          // Get the table and field names for the checked field.
          if (empty($this->view->field[$field_alias]->field_info)) {
            $field = $this->view->query->fields[$this->view->field[$field_alias]->field_alias];
          }
          else {
            $field_table = $this->view->query
              ->ensure_table($this->view->field[$field_alias]->table, $this->view->field[$field_alias]->relationship);
            $this->view->query
              ->add_field($field_table, $this->view->field[$field_alias]->real_field, $this->view->field[$field_alias]->field, array());
            $field = $this->view->query->fields[$this->view->field[$field_alias]->field];
          }

          // Add an OR condition for the field
          $conditions
            ->condition($field['table'] . '.' . $field['field'], $value, 'LIKE');
        }
      }
      $this->view->query
        ->add_where(NULL, $conditions);
    }

    // Add an IN condition for validation.
    if (!empty($options['ids'])) {
      $this->view->query
        ->add_where(NULL, $id_field, $options['ids']);
    }
    $this->view
      ->set_items_per_page($options['limit']);
  }

  /**
   * Extend the default validation.
   */
  function validate() {
    $errors = parent::validate();

    // Verify that search fields are set up.
    $style_options = $this
      ->get_option('style_options');
    if (!isset($style_options['search_fields'])) {
      $errors[] = t('Display "@display" needs a selected search fields to work properly. See the settings for the Entity Reference list format.', array(
        '@display' => $this->display->display_title,
      ));
    }
    else {

      // Verify that the search fields used actually exist.

      //$fields = array_keys($this->view->get_items('field'));
      $fields = array_keys($this->handlers['field']);
      foreach ($style_options['search_fields'] as $field_alias => $enabled) {
        if ($enabled && !in_array($field_alias, $fields)) {
          $errors[] = t('Display "@display" uses field %field as search field, but the field is no longer present. See the settings for the Entity Reference list format.', array(
            '@display' => $this->display->display_title,
            '%field' => $field_alias,
          ));
        }
      }
    }
    return $errors;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
entityreference_plugin_display::execute		function	When used externally, this is how a view gets run and returns data in the format required. Overrides views_plugin_display::execute
entityreference_plugin_display::get_style_type		function	Displays can require a certain type of style plugin. Overrides views_plugin_display::get_style_type
entityreference_plugin_display::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_plugin_display::option_definition
entityreference_plugin_display::query		function	Inject anything into the query that the display handler needs. Overrides views_plugin_display::query
entityreference_plugin_display::render		function	Render this display. Overrides views_plugin_display::render
entityreference_plugin_display::uses_exposed		function	Does this display uses exposed filters? Overrides views_plugin_display::uses_exposed
entityreference_plugin_display::validate		function	Extend the default validation. Overrides views_plugin_display::validate
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_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_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_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::view_special_blocks	public	function	Render any special blocks provided for this display.

You are here

class entityreference_plugin_display in Entity reference 7

Hierarchy

File

Members

API Navigation