class views_plugin_row_heartbeat_view in Heartbeat 7

Plugin which performs a heartbeat_activity_view on the resulting object.

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

Hierarchy

• class \views_object
  • class \views_plugin
    • class \views_plugin_row
      • class \views_plugin_row_heartbeat_view

1 string reference to 'views_plugin_row_heartbeat_view'

heartbeat_views_plugins in ./heartbeat.views.inc

Implements hook_views_plugins().

File

views/views_plugin_row_heartbeat_view.inc, line 12

Contains the heartbeat activity view row style plugin.

class views_plugin_row_heartbeat_view extends views_plugin_row {

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

  // Properties for internal storage.
  public $activities = array();
  public $stream = NULL;

  /**
   * Implements init(&$view, &$display, $options).
   */
  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'];
    }
  }

  /**
   * Implements option_definition().
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['view_mode'] = array(
      'default' => 'full',
    );
    $options['links'] = array(
      'default' => TRUE,
    );
    $options['comments'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Implements options_form(&$form, &$form_state).
   *
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = $this
      ->options_form_summary_options();
    $form['view_mode'] = array(
      '#type' => 'select',
      '#options' => $options,
      '#title' => t('View mode'),
      '#default_value' => $this->options['view_mode'],
    );
    $form['links'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display links'),
      '#default_value' => $this->options['links'],
    );
    $form['comments'] = array(
      '#type' => 'checkbox',
      '#title' => t('Display comments'),
      '#default_value' => $this->options['comments'],
    );
  }

  /**
   * Implements options_form_summary_options().
   *
   * Return the main options, which are shown in the summary title.
   */
  function options_form_summary_options() {
    $entity_info = entity_get_info('heartbeat_activity');
    $options = array();
    if (!empty($entity_info['view modes'])) {
      foreach ($entity_info['view modes'] as $mode => $settings) {
        $options[$mode] = $settings['label'];
      }
    }
    if (empty($options)) {
      $options = array(
        'full' => t('Full content'),
      );
    }
    return $options;
  }
  function summary_title() {
    $options = $this
      ->options_form_summary_options();
    return check_plain($options[$this->options['view_mode']]);
  }

  /**
   * Implements pre_render($values).
   *
   * Here the stream is build, but letting users create the stream custom.
   * If they do so, the default access checks which heartbeat normally does
   * in the query will not be executed.
   * If they configured the stream to behave like a heartbeat stream, then
   * Heartbeat will take over the base query.
   */
  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'])) {
      $heartbeatStream->rowPlugin = TRUE;

      // Use the views limit instead of heartbeats stream setting.
      if (isset($this->view->query->limit)) {
        $heartbeatStream->config->num_load_max = $this->view->query->limit;
      }

      // Load activities by using the heartbeat loader.
      $this->activities = heartbeat_stream_views_build($heartbeatStream, $uaids);

      // Store the stream for later usage.
      $this->stream = $heartbeatStream;
      if ($heartbeatStream
        ->hasErrors()) {
        drupal_set_message(implode('<br />', $heartbeatStream
          ->getErrors()));
      }
    }
  }

  /**
   * Implements render($row).
   *
   */
  function render($row) {
    $uaid = isset($row->uaid) ? $row->uaid : (isset($row->heartbeat_activity_uaid) ? $row->heartbeat_activity_uaid : 0);
    if ($uaid) {
      $activity = heartbeat_activity_load($uaid);
      $build = heartbeat_activity_view($activity);
      return render($build);
    }
    return '';
  }

}

Members

Name	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_view::$activities	public	property
views_plugin_row_heartbeat_view::$base_field	public	property
views_plugin_row_heartbeat_view::$base_table	public	property
views_plugin_row_heartbeat_view::$stream	public	property
views_plugin_row_heartbeat_view::init		function	Implements init(&$view, &$display, $options). Overrides views_plugin_row::init
views_plugin_row_heartbeat_view::options_form		function	Implements options_form(&$form, &$form_state). Overrides views_plugin_row::options_form
views_plugin_row_heartbeat_view::options_form_summary_options		function	Implements options_form_summary_options().
views_plugin_row_heartbeat_view::option_definition		function	Implements option_definition(). Overrides views_plugin_row::option_definition
views_plugin_row_heartbeat_view::pre_render		function	Implements pre_render($values). Overrides views_plugin_row::pre_render
views_plugin_row_heartbeat_view::render		function	Implements render($row). Overrides views_plugin_row::render
views_plugin_row_heartbeat_view::summary_title		function	Returns the summary of the settings in the display. Overrides views_plugin::summary_title