class eva_plugin_display_entity

  1. cis7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity
  2. cle7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity
  3. elmsmedia7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity
  4. icor7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity
  5. meedjum_blog7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity
  6. mooc7 sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc eva_plugin_display_entity

The plugin that handles entity-attached views.

Hierarchy

Expanded class hierarchy of eva_plugin_display_entity

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
eva_plugin_display_entity::execute function The display block handler returns the structure necessary for a block.
eva_plugin_display_entity::get_path function Specify the path of the entity.
eva_plugin_display_entity::options_form function Provide the default form for setting options.
eva_plugin_display_entity::options_submit function
eva_plugin_display_entity::options_summary function Provide the summary for page options in the views UI.
eva_plugin_display_entity::option_definition function
eva_plugin_display_entity::pre_execute function We have to run token replacement before the arguments are used.
eva_plugin_display_entity::validate function
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function
views_plugin::additional_theme_functions function Provide a list of additional theme functions for the theme information page
views_plugin::plugin_title function Return the human readable name of the display.
views_plugin::summary_title function Returns the summary of the settings in the display.
views_plugin::theme_functions function Provide a full list of possible theme templates used by this style.
views_plugin_display::accept_attachments function Can this display accept attachments?
views_plugin_display::access function Determine if the user has access to this display of the view.
views_plugin_display::attach_to function Allow displays to attach to other views.
views_plugin_display::defaultable_sections function Static member function to list which sections are defaultable and what items each section contains.
views_plugin_display::destroy function
views_plugin_display::displays_exposed function Determine if this display should display the exposed filters widgets, so the view will know whether or not to render them.
views_plugin_display::export_handler function Special method to export items that have handlers.
views_plugin_display::export_option function Override of export_option()
views_plugin_display::export_plugin function Special handling for plugin export
views_plugin_display::export_style function Special handling for the style export.
views_plugin_display::format_themes function Format a list of theme templates for output by the theme info helper.
views_plugin_display::get_arguments_tokens function Returns to tokens for arguments.
views_plugin_display::get_argument_text function Provide some helpful text for the arguments. The result should contain of an array with
views_plugin_display::get_field_labels function Retrieve a list of fields for the current display with the relationship associated if it exists.
views_plugin_display::get_handler function Get the handler object for a single handler.
views_plugin_display::get_handlers function Get a full array of handlers for $type. This caches them.
views_plugin_display::get_link_display function Check to see which display to use when creating links within a view using this display.
views_plugin_display::get_option function Intelligently get an option either from this display or from the default display, if directed to do so.
views_plugin_display::get_pager_text function Provide some helpful text for pagers.
views_plugin_display::get_plugin function Get the instance of a plugin, for example style or row.
views_plugin_display::get_special_blocks function Provide the block system with any exposed widget blocks for this display.
views_plugin_display::get_style_type function Displays can require a certain type of style plugin. By default, they will be 'normal'.
views_plugin_display::get_url function
views_plugin_display::has_path function Check to see if the display has a 'path' field.
views_plugin_display::hook_block_list function If this display creates a block, implement one of these.
views_plugin_display::hook_menu function If this display creates a page with a menu item, implement it here.
views_plugin_display::init function
views_plugin_display::is_defaulted function Determine if a given option is set to use the default display or the current display
views_plugin_display::is_default_display function Determine if this display is the 'default' display which contains fallback settings
views_plugin_display::is_identifier_unique function Check if the provided identifier is unique.
views_plugin_display::options_override function If override/revert was clicked, perform the proper toggle.
views_plugin_display::options_validate function Validate the options form.
views_plugin_display::option_link 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 function Set an option and force it to be an override.
views_plugin_display::preview function Fully render the display for the purposes of a live preview or some other AJAXy reason.
views_plugin_display::query function Inject anything into the query that the display handler needs.
views_plugin_display::render function Render this display.
views_plugin_display::render_area function
views_plugin_display::render_empty function
views_plugin_display::render_filters function Not all display plugins will support filtering
views_plugin_display::render_footer function Render the footer of the view.
views_plugin_display::render_header function Render the header of the view.
views_plugin_display::render_more_link function Render the 'more' link
views_plugin_display::render_pager function Not all display plugins will suppert pager rendering.
views_plugin_display::set_option function Intelligently set an option either from this display or from the default display, if directed to do so.
views_plugin_display::set_override function Flip the override setting for the given section.
views_plugin_display::unpack_handler function Special method to unpack items that have handlers.
views_plugin_display::unpack_plugin function Special handling for plugin unpacking.
views_plugin_display::unpack_style function
views_plugin_display::uses_breadcrumb function Check to see if the display needs a breadcrumb
views_plugin_display::uses_exposed function Determine if this display uses exposed filters, so the view will know whether or not to build them.
views_plugin_display::uses_exposed_form_in_block function Check to see if the display can put the exposed formin a block.
views_plugin_display::uses_fields function Determine if the display's style uses fields.
views_plugin_display::uses_link_display function Check to see if the display has some need to link to another display.
views_plugin_display::use_ajax function Does the display use AJAX?
views_plugin_display::use_group_by function Does the display have groupby enabled?
views_plugin_display::use_more function Does the display have a more link enabled?
views_plugin_display::use_more_always function Should the enabled display more link be shown when no more items?
views_plugin_display::use_more_text function Does the display have custom link text?
views_plugin_display::use_pager function Does the display have a pager enabled?
views_plugin_display::view_special_blocks function Render any special blocks provided for this display.

File

sites/all/modules/ulmus/eva/eva_plugin_display_entity.inc, line 6

View source
class eva_plugin_display_entity extends views_plugin_display {
  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;

    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('None') : implode(', ', $bundle_names),
    );

    $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'),
    );

    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':
        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':
        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"),
          '#options' => $options,
          '#default_value' => $this->get_option('bundles'),
        );
        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;
    }

  }

  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 '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;
    }
  }

  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));
    }

    $bundles = $this->get_option('bundles');
    if (empty($bundles)) {
      $errors[] = t('Display @display must have at least one bundle selected.', array('@display' => $this->display->display_title));
    }

    return $errors;
  }

  /**
   * We have to run token replacement before the arguments are used.
   */
  function pre_execute() {
    // Call the parent setup function so we do not lose data.
    parent::pre_execute();

    if (isset($this->view->current_entity)) {
      $entity = $this->view->current_entity;
      $entity_type = $this->view->display_handler->get_option('entity_type');
      $entity_info = entity_get_info($entity_type);

      $arg_mode = $this->view->display_handler->get_option('argument_mode');
      if ($arg_mode == 'token') {
        if ($token_string = $this->view->display_handler->get_option('default_argument')) {
          // Now do the token replacement.
          $token_values = eva_get_arguments_from_token_string($token_string, $entity_type, $entity);
          $new_args = array();
          // We have to be careful to only replace arguments that have tokens.
          foreach ($token_values as $key => $value) {
            $new_args[$key] = $value;
          }

          $this->view->args = $new_args;
        }
      }
      elseif ($arg_mode == 'id') {
        $this->view->args = array($entity->{$entity_info['entity keys']['id']});
      }
    }
  }

  /**
   * Specify the path of the entity.
   */
  function get_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']);
      }
    }
    return parent::get_path();
  }

  /**
   * 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;
    }
  }
}
1 string reference to 'eva_plugin_display_entity'
eva_views_plugins in sites/all/modules/ulmus/eva/eva.views.inc
Implements hook_views_plugins().
Error | ELMSLN API

Error

×

Error message

  • Warning: Cannot modify header information - headers already sent by (output started at /var/www/html/elmsln_community/api.elmsln.org/includes/common.inc:2791) in drupal_send_headers() (line 1499 of /var/www/html/elmsln_community/api.elmsln.org/includes/bootstrap.inc).
  • Error: Call to undefined function apc_delete() in DrupalAPCCache->clear() (line 289 of /var/www/html/elmsln_community/api.elmsln.org/sites/all/modules/apc/drupal_apc_cache.inc).
The website encountered an unexpected error. Please try again later.