You are here

Home » API reference » Heartbeat 7 » views_plugin_row_heartbeat_rss.inc

class views_plugin_row_heartbeat_rss in Heartbeat 7

Same name and namespace in other branches
  1. 6.4 views/views_plugin_row_heartbeat_rss.inc \views_plugin_row_heartbeat_rss

Plugin which performs a heartbeat_activity_view on the resulting object.

Most of the code on this object is in the theme function.

Hierarchy

Expanded class hierarchy of views_plugin_row_heartbeat_rss

1 string reference to 'views_plugin_row_heartbeat_rss'
heartbeat_views_plugins in ./heartbeat.views.inc
Implements hook_views_plugins().

File

views/views_plugin_row_heartbeat_rss.inc, line 12
Contains the heartbeat activity view row style plugin.

View source 
class views_plugin_row_heartbeat_rss extends views_plugin_row {

  // Basic properties that let the row style follow relationships.
  public $base_table = 'heartbeat_activity';
  public $base_field = 'uaid';

  // Stores the $activities loaded with pre_render.
  public $activities = array();
  public $stream = NULL;
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);

    // Handle existing views which has used build_mode instead of view_mode.
    if (isset($this->options['build_mode'])) {
      $this->options['view_mode'] = $this->options['build_mode'];
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['item_length'] = array(
      'default' => 'default',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['item_length'] = array(
      '#type' => 'select',
      '#title' => t('Display type'),
      '#options' => $this
        ->options_form_summary_options(),
      '#default_value' => $this->options['item_length'],
    );
  }

  /**
   * Return the main options, which are shown in the summary title.
   */
  function options_form_summary_options() {
    return array(
      //'full' => t('Full text'),
      'default' => t('Use default RSS settings'),
    );
  }
  function summary_title() {
    $options = $this
      ->options_form_summary_options();
    return check_plain($options[$this->options['item_length']]);
  }
  function pre_render($values) {
    $uaids = array();
    foreach ($values as $row) {
      $uaids[] = $row->{$this->field_alias};
    }

    // We create a stream, however the query does not need to run since
    // views took care of that part. By creating a stream we can provide
    // the general flow to display everything.
    if ($heartbeatStream = heartbeat_stream('viewsactivity', $this->display->display_plugin == 'page', $GLOBALS['user'])) {
      if (isset($this->view->query->limit)) {
        $heartbeatStream->config->num_load_max = $this->view->query->limit;
      }
      $this->activities = heartbeat_stream_views_build($heartbeatStream, $uaids);
      $this->stream = $heartbeatStream;
    }
  }
  function render($row) {

    // For the most part, this code is taken from node_feed() in node.module
    global $base_url;
    $uaid = $row->{$this->field_alias};
    if (!is_numeric($uaid)) {
      return;
    }
    $item_length = $this->options['item_length'];

    // Load the specified activity:
    if (!isset($this->activities[$uaid])) {
      return;
    }
    $activity = $this->activities[$uaid];
    $item_text = '';
    $activity->rss_namespaces = array(
      'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
    );
    $activity->rss_elements = array(
      array(
        'key' => 'pubDate',
        'value' => gmdate('r', $activity->timestamp),
      ),
      array(
        'key' => 'dc:creator',
        'value' => $activity->actor->name,
      ),
      array(
        'key' => 'guid',
        'value' => $activity->uaid . ' at ' . $base_url,
        'attributes' => array(
          'isPermaLink' => 'false',
        ),
      ),
    );

    // The node gets built and modules add to or modify $node->rss_elements
    // and $node->rss_namespaces.
    // Remove previously built content, if exists.
    $activity->content = array();
    $view_mode = 'default';

    // Build fields content.
    field_attach_prepare_view('heartbeat_activity', array(
      $activity->uaid => $activity,
    ), $view_mode);
    entity_prepare_view('heartbeat_activity', array(
      $activity->uaid => $activity,
    ));
    $activity->content += field_attach_view('heartbeat_activity', $activity, $view_mode, $activity->language);

    // Populate $message->content with a render() array.
    $hook = 'heartbeat_activity_view';
    foreach (module_implements($hook) as $module) {
      $function = $module . '_' . $hook;
      if (function_exists($function)) {
        $result = $function($activity, $activity->view_mode, $activity->language);
      }
    }
    $this->view->style_plugin->namespaces = array_merge($this->view->style_plugin->namespaces, $activity->rss_namespaces);

    // Unset the attachements and buttons.
    unset($activity->content['attachments']);
    unset($activity->content['buttons']);
    if (!empty($activity->message)) {
      $item_text .= drupal_render($activity->content);
    }
    $item = new stdClass();
    $item->description = $item_text;
    $item->title = '';
    $item->link = url("heartbeat/message/{$activity->uaid}", array(
      'absolute' => TRUE,
    ));
    $item->elements = $activity->rss_elements;
    $item->uaid = $activity->uaid;
    return theme($this
      ->theme_functions(), array(
      'view' => $this->view,
      'options' => $this->options,
      'row' => $item,
    ));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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
views_plugin_row_heartbeat_rss::$activities public property
views_plugin_row_heartbeat_rss::$base_field public property
views_plugin_row_heartbeat_rss::$base_table public property
views_plugin_row_heartbeat_rss::$stream public property
views_plugin_row_heartbeat_rss::init function Overrides views_plugin_row::init
views_plugin_row_heartbeat_rss::options_form function Provide a form for setting options. Overrides views_plugin_row::options_form
views_plugin_row_heartbeat_rss::options_form_summary_options function Return the main options, which are shown in the summary title.
views_plugin_row_heartbeat_rss::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_row::option_definition
views_plugin_row_heartbeat_rss::pre_render function Allow the style to do stuff before each row is rendered. Overrides views_plugin_row::pre_render
views_plugin_row_heartbeat_rss::render 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_plugin_row_heartbeat_rss::summary_title function Returns the summary of the settings in the display. Overrides views_plugin::summary_title