You are here

Home » API reference » Entity API 7 » entity_views_plugin_row_entity_view.inc

class entity_views_plugin_row_entity_view in Entity API 7

Plugin class for displaying Views results with entity_view.

Hierarchy

Expanded class hierarchy of entity_views_plugin_row_entity_view

1 string reference to 'entity_views_plugin_row_entity_view'
entity_views_plugins in views/entity.views.inc
Implements hook_views_plugins().

File

views/plugins/entity_views_plugin_row_entity_view.inc, line 11
Row style plugin for displaying the results as entities.

View source 
class entity_views_plugin_row_entity_view extends views_plugin_row {
  protected $entity_type, $entities;
  public function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);

    // Initialize the entity-type used.
    $table_data = views_fetch_data($this->view->base_table);
    $this->entity_type = $table_data['table']['entity type'];

    // Set base table and field information as used by views_plugin_row to
    // select the entity id if used with default query class.
    $info = entity_get_info($this->entity_type);
    if (!empty($info['base table']) && $info['base table'] == $this->view->base_table) {
      $this->base_table = $info['base table'];
      $this->base_field = $info['entity keys']['id'];
    }
  }
  public function option_definition() {
    $options = parent::option_definition();
    $options['view_mode'] = array(
      'default' => 'full',
    );
    return $options;
  }
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $entity_info = entity_get_info($this->entity_type);
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    if (count($options) > 1) {
      $form['view_mode'] = array(
        '#type' => 'select',
        '#options' => $options,
        '#title' => t('View mode'),
        '#default_value' => $this->options['view_mode'],
      );
    }
    else {
      $form['view_mode_info'] = array(
        '#type' => 'item',
        '#title' => t('View mode'),
        '#description' => t('Only one view mode is available for this entity type.'),
        '#markup' => $options ? current($options) : t('Default'),
      );
      $form['view_mode'] = array(
        '#type' => 'value',
        '#value' => $options ? key($options) : 'default',
      );
    }
    return $form;
  }
  public function pre_render($values) {
    if (!empty($values)) {
      list($this->entity_type, $this->entities) = $this->view->query
        ->get_result_entities($values, !empty($this->relationship) ? $this->relationship : NULL, isset($this->field_alias) ? $this->field_alias : NULL);
    }

    // Render the entities.
    if ($this->entities) {
      $render = entity_view($this->entity_type, $this->entities, $this->options['view_mode']);

      // Remove the first level of the render array.
      $this->rendered_content = reset($render);
    }
  }

  /**
   * Overridden to return the entity object.
   */
  public function get_value($values, $field = NULL) {
    return isset($this->entities[$this->view->row_index]) ? $this->entities[$this->view->row_index] : FALSE;
  }
  public function render($values) {
    if ($entity = $this
      ->get_value($values)) {

      // Add the view object as views_plugin_row_node_view::render() would.
      // Otherwise the views theme suggestions won't work properly.
      $entity->view = $this->view;
      $render = $this->rendered_content[entity_id($this->entity_type, $entity)];
      return drupal_render($render);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
entity_views_plugin_row_entity_view::$entity_type protected property
entity_views_plugin_row_entity_view::get_value public function Overridden to return the entity object.
entity_views_plugin_row_entity_view::init public function Overrides views_plugin_row::init
entity_views_plugin_row_entity_view::options_form public function Provide a form for setting options. Overrides views_plugin_row::options_form
entity_views_plugin_row_entity_view::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
entity_views_plugin_row_entity_view::pre_render public function Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
entity_views_plugin_row_entity_view::render public function Render a row object. This usually passes through to a theme template of some form, but not always. Overrides views_plugin_row::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::destroy public function Destructor. 2
views_object::export_option public function 1
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::$view public property The top object of a view. Overrides views_object::$view 1
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::validate public function Validate that the plugin is correct and can be saved. 3
views_plugin_row::options_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. Overrides views_plugin::options_submit 1
views_plugin_row::options_validate public function Validate the options form. Overrides views_plugin::options_validate
views_plugin_row::query public function Add anything to the query that we might need to. Overrides views_plugin::query
views_plugin_row::uses_fields public function