You are here

Home » API reference » EVA: Entity Views Attachment 7 » eva_plugin_display_entity.inc

class eva_plugin_display_entity in EVA: Entity Views Attachment 7

The plugin that handles entity-attached views.

Hierarchy

Expanded class hierarchy of eva_plugin_display_entity

1 string reference to 'eva_plugin_display_entity'
eva_views_plugins in ./eva.views.inc
Implements hook_views_plugins().

File

./eva_plugin_display_entity.inc, line 6

View source 
class eva_plugin_display_entity extends views_plugin_display {

  /**
   * {@inheritdoc}
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['entity_type'] = array(
      'default' => '',
    );
    $options['bundles'] = array(
      'default' => array(),
    );
    $options['argument_mode'] = array(
      'default' => 'id',
    );
    $options['default_argument'] = array(
      'default' => '',
    );
    $options['show_title'] = 0;
    $options['exposed_form_as_field'] = 0;
    $options['show_on'] = array(
      'default' => 'display',
    );
    return $options;
  }

  /**
   * Provide the summary for page options in the views UI.
   *
   * This output is returned as an array.
   */
  function options_summary(&$categories, &$options) {

    // It is very important to call the parent function here:
    parent::options_summary($categories, $options);
    $categories['entity_view'] = array(
      'title' => t('Entity content settings'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    if ($entity_type = $this
      ->get_option('entity_type')) {
      $entity_info = entity_get_info($entity_type);
      $type_name = $entity_info['label'];
      $bundle_names = array();
      foreach ($this
        ->get_option('bundles') as $bundle) {
        $bundle_names[] = $entity_info['bundles'][$bundle]['label'];
      }
    }
    $options['entity_type'] = array(
      'category' => 'entity_view',
      'title' => t('Entity type'),
      'value' => empty($type_name) ? t('None') : $type_name,
    );
    $options['bundles'] = array(
      'category' => 'entity_view',
      'title' => t('Bundles'),
      'value' => empty($bundle_names) ? t('All') : implode(', ', $bundle_names),
    );
    $options['show_on'] = array(
      'category' => 'entity_view',
      'title' => t('Show on'),
      'value' => $this
        ->get_option('show_on'),
    );
    $argument_mode = $this
      ->get_option('argument_mode');
    $options['arguments'] = array(
      'category' => 'entity_view',
      'title' => t('Arguments'),
      'value' => empty($argument_mode) ? t('None') : check_plain($argument_mode),
    );
    $options['show_title'] = array(
      'category' => 'entity_view',
      'title' => t('Show title'),
      'value' => $this
        ->get_option('show_title') ? t('Yes') : t('No'),
    );
    $options['exposed_form_as_field'] = array(
      'category' => 'entity_view',
      'title' => t('Exposed Form as Field'),
      'value' => $this
        ->get_option('exposed_form_as_field') ? t('Yes') : t('No'),
    );
    if (module_exists('token')) {

      // We must load token values here to show them on the options form.
      drupal_add_js(drupal_get_path('module', 'token') . '/token.js');
      drupal_add_css(drupal_get_path('module', 'token') . '/token.css');
      drupal_add_library('token', 'treeTable');
    }
  }

  /**
   * Provide the default form for setting options.
   */
  function options_form(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_form($form, $form_state);
    $entity_info = entity_get_info();
    $entity_type = $this
      ->get_option('entity_type');
    switch ($form_state['section']) {
      case 'entity_type':
        $entity_names = array();
        foreach ($entity_info as $type => $info) {
          if (!empty($info['view modes'])) {
            $entity_names[$type] = $info['label'];
          }
        }
        $form['#title'] .= t('Entity type');
        $form['entity_type'] = array(
          '#type' => 'radios',
          '#required' => TRUE,
          '#title' => t("Attach this display to the following entity type"),
          '#options' => $entity_names,
          '#default_value' => $this
            ->get_option('entity_type'),
        );
        break;
      case 'bundles':
        $options = array();
        foreach ($entity_info[$entity_type]['bundles'] as $bundle => $info) {
          $options[$bundle] = $info['label'];
        }
        $form['#title'] .= t('Bundles');
        $form['bundles'] = array(
          '#type' => 'checkboxes',
          '#title' => t("Attach this display to the following bundles.  If no bundles are selected, the display will be attached to all."),
          '#options' => $options,
          '#default_value' => $this
            ->get_option('bundles'),
        );
        break;
      case 'show_on':
        $form['#title'] .= t('Show on');
        $form['show_on'] = array(
          '#type' => 'select',
          '#title' => t('Where to show this view'),
          '#description' => t('This view can be used on either the entity display or on the entity form. When shown on a form, the exposed filters will be hidden.'),
          '#options' => array(
            'display' => t('Display'),
            'form' => t('Form'),
          ),
          '#required' => TRUE,
          '#default_value' => $this
            ->get_option('show_on'),
        );
        break;
      case 'arguments':
        $form['#title'] .= t('Arguments');
        $default = $this
          ->get_option('argument_mode');
        $options = array(
          'none' => t("No special handling"),
          'id' => t("Use the ID of the entity the view is attached to"),
          'token' => t("Use tokens from the entity the view is attached to"),
        );
        $form['argument_mode'] = array(
          '#type' => 'radios',
          '#title' => t("How should this display populate the view's arguments?"),
          '#options' => $options,
          '#default_value' => $default,
        );
        $form['token'] = array(
          '#type' => 'fieldset',
          '#title' => t('Token replacement'),
          '#collapsible' => TRUE,
          '#states' => array(
            'visible' => array(
              ':input[name=argument_mode]' => array(
                'value' => 'token',
              ),
            ),
          ),
        );
        $form['token']['default_argument'] = array(
          '#title' => t('Arguments'),
          '#type' => 'textfield',
          '#default_value' => $this
            ->get_option('default_argument'),
          '#description' => t('You may use token replacement to provide arguments based on the current entity. Separate arguments with "/".'),
        );
        if (module_exists('token')) {
          $form['token']['tokens'] = array(
            '#theme' => 'token_tree',
            '#token_types' => array(
              token_get_entity_mapping('entity', $entity_type),
            ),
          );
        }
        break;
      case 'show_title':
        $form['#title'] .= t('Show title');
        $form['show_title'] = array(
          '#type' => 'checkbox',
          '#title' => t('Show the title of the view above the attached view.'),
          '#default_value' => $this
            ->get_option('show_title'),
        );
        break;
      case 'exposed_form_as_field':
        $form['#title'] .= t('Exposed Form as Field');
        $form['exposed_form_as_field'] = array(
          '#type' => 'checkbox',
          '#title' => t('Split off Exposed Form as Separate Field'),
          '#default_value' => $this
            ->get_option('exposed_form_as_field'),
          '#description' => t('Check this box to have a separate field for this view\'s exposed form on the "Manage Display" tab. This is not available to EVAs attached to the form.'),
        );
    }
  }

  /**
   * {@inheritdoc}
   */
  function options_submit(&$form, &$form_state) {

    // It is very important to call the parent function here:
    parent::options_submit($form, $form_state);
    switch ($form_state['section']) {
      case 'entity_type':
        $new_entity = $form_state['values']['entity_type'];
        $old_entity = $this
          ->get_option('entity_type');
        $this
          ->set_option('entity_type', $new_entity);
        if ($new_entity != $old_entity) {

          // Each entity has its own list of bundles and view modes. If there's
          // only one on the new type, we can select it automatically. Otherwise
          // we need to wipe the options and start over.
          $new_entity_info = entity_get_info($new_entity);
          $new_bundle_keys = array_keys($new_entity_info['bundles']);
          $new_bundles = array();
          if (count($new_bundle_keys) == 1) {
            $new_bundles[] = $new_bundle_keys[0];
          }
          $this
            ->set_option('bundles', $new_bundles);
        }
        break;
      case 'bundles':
        $this
          ->set_option('bundles', array_values(array_filter($form_state['values']['bundles'])));
        break;
      case 'show_on':
        $this
          ->set_option('show_on', $form_state['values']['show_on']);
        break;
      case 'arguments':
        $this
          ->set_option('argument_mode', $form_state['values']['argument_mode']);
        if ($form_state['values']['argument_mode'] == 'token') {
          $this
            ->set_option('default_argument', $form_state['values']['default_argument']);
        }
        else {
          $this
            ->set_option('default_argument', NULL);
        }
        break;
      case 'show_title':
        $this
          ->set_option('show_title', $form_state['values']['show_title']);
        break;
      case 'exposed_form_as_field':
        $this
          ->set_option('exposed_form_as_field', $form_state['values']['exposed_form_as_field']);
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  function validate() {
    $errors = parent::validate();
    $entity_type = $this
      ->get_option('entity_type');
    if (empty($entity_type)) {
      $errors[] = t('Display @display must have an entity type selected.', array(
        '@display' => $this->display->display_title,
      ));
    }
    return $errors;
  }

  /**
   * Specify the path of the entity.
   */
  function get_path() {
    if ($path = parent::get_path()) {
      return $path;
    }
    if (isset($this->view->current_entity)) {
      $uri = entity_uri($this->view->display_handler
        ->get_option('entity_type'), $this->view->current_entity);
      if ($uri) {
        $uri['options']['absolute'] = TRUE;
        return url($uri['path'], $uri['options']);
      }
    }
  }

  /**
   * The display block handler returns the structure necessary for a block.
   */
  function execute() {

    // Prior to this being called, the $view should already be set to this
    // display, and arguments should be set on the view.
    if (!isset($this->view->override_path)) {
      $this->view->override_path = $_GET['q'];
    }
    $data = $this->view
      ->render();
    if (!empty($this->view->result) || $this
      ->get_option('empty') || !empty($this->view->style_plugin->definition['even empty'])) {
      return $data;
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
eva_plugin_display_entity::execute function The display block handler returns the structure necessary for a block. Overrides views_plugin_display::execute
eva_plugin_display_entity::get_path function Specify the path of the entity. Overrides views_plugin_display::get_path
eva_plugin_display_entity::options_form function Provide the default form for setting options. Overrides views_plugin_display::options_form
eva_plugin_display_entity::options_submit function Perform any necessary changes to the form values prior to storage. Overrides views_plugin_display::options_submit
eva_plugin_display_entity::options_summary function Provide the summary for page options in the views UI. Overrides views_plugin_display::options_summary
eva_plugin_display_entity::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_display::option_definition
eva_plugin_display_entity::validate function Make sure the display and all associated handlers are valid. 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_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_override public function If override/revert was clicked, perform the proper toggle.
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::query public function Inject anything into the query that the display handler needs. Overrides views_plugin::query
views_plugin_display::render public function Render this display. 1
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::view_special_blocks public function Render any special blocks provided for this display.