Major work on heartbeat module file

include files to define stream objects and configurations
libraries file to help us make use of drupalSettings

heartbeat8.libraries.yml

@@ -0,0 +1,8 @@
+heartbeatAdditions:
+  version: 1.x
+
+  dependencies:
+    - core/jquery
+    - core/jquery.once
+    - core/drupal
+    - core/drupalSettings

heartbeat8.module

@@ -6,6 +6,11 @@
  */
 
 use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Heartbeat8\Entity\Heartbeat;
+use Drupal\Heartbeat8\Entity\HeartbeatType;
+
+//TODO add constants (HEARTBEAT_NONE, HEARTBEAT_PRIVATE, HEARTBEAT_PUBLIC_TO_ADDRESSEE, HEARTBEAT_PUBLIC_TO_ALL_CONNECTED, HEARTBEAT_PUBLIC_TO_ALL)
+//TODO include Streams (Entities already added with use statements on lines 9-10)
 
 /**
  * Implements hook_help().
@@ -57,3 +62,9 @@ function heartbeat8_theme_suggestions_heartbeat(array $variables) {
   $suggestions[] = 'heartbeat__' . $entity->id() . '__' . $sanitized_view_mode;
   return $suggestions;
 }
+
+
+
+//TODO Add heartbeat language to Javascript
+//TODO Determine necessity of polling
+//Add

heartbeatstream.inc

@@ -0,0 +1,149 @@
+<?php
+
+/**
+ * @file
+ *  HeartbeatStream object takes configuration parameters to create a stream of activity objects.
+ *  pre-query, query and post-query phases of the stream can be specified and manipulated here
+ */
+
+
+/**
+ * Abstract Class HeartbeatStream
+ *  Base class with template methods. HeartbeatStream is a state object given to the HeartbeatStreamBuilder
+ * to set access on current request
+ */
+abstract class HeartbeatStream
+{
+
+
+  // Query object for this stream.
+  protected $query = NULL;
+
+  // Configuration object for this stream.
+  public $config = NULL;
+
+  // Well-formed activity messages.
+  public $messages = array();
+
+  // String prefix on top of the stream.
+  public $prefix = '';
+
+  // String suffix under a stream.
+  public $suffix = '';
+
+  // Templates available to show.
+  public $templates = array();
+
+  // Contextual arguments.
+  public $contextual_arguments = array();
+
+  // Denied templates.
+  protected $templates_denied = array();
+
+  // Language at display time.
+  protected $language = LANGUAGE_NONE;
+
+  // exclude Og.
+  protected $exclude_og = FALSE;
+
+  // The stream owner or activity watcher.
+  protected $_uid = 0;
+
+  // Array of runtime notices, warnings and errors.
+  protected $_errors = array();
+
+  // Indicates if there are runtime errors.
+  protected $_has_errors = FALSE;
+
+  // Indicates whether the page has modal requirement.
+  protected $needsModal = TRUE;
+
+  // Time where activity starts.
+  protected $_offset_time = 0;
+
+  // Maximum time where activity must end.
+  protected $oldest_date = 604800;
+
+  // Maximum number of activity messages to show.
+  protected $messages_max = 0;
+
+  // Latest user activity id fetched.
+  protected $latest_activity_id = 0;
+
+  // Indicates if the stream is displayed on a page or not.
+  protected $_page = FALSE;
+
+  // Indicates if this is an ajax request.
+  protected $ajax = 0;
+
+  // Can page means if we can show more messages
+  protected $canPage = FALSE;
+
+  // User view type of the stream instance.
+  protected $_whoisuser_type = self::VIEWER;
+
+  // The user who is viewing the activity stream.
+  protected $viewer = null;
+
+  // The user who's activity stream is viewed.
+  protected $viewed = null;
+
+  // View mode to display message.
+  protected $view_mode = 'default';
+
+  protected $_whoisuser_types = array(
+    self::VIEWER => 'Viewing user',
+    self::VIEWED => 'Viewed user'
+  );
+
+  // User viewer types.
+  const VIEWER = 0;
+  const VIEWED = 1;
+
+
+  final public function __construct(HeartbeatStreamConfig $streamConfig, $page = FALSE, $account = NULL) {
+
+    $this->_page = $page;
+    $this->setConfig($streamConfig);
+    $this->setAjax();
+
+    if (empty($this->_offset_time)) {
+      $this->setOffsetTime();
+    }
+
+    $this->setViewer(\Drupal::currentUser());
+    $this->setViewed($account);
+
+    $this->setAvailableTemplates();
+
+    $this->construct();
+
+    $this->setContextualArguments();
+
+  }
+
+  /**
+   * Fake Constructor Method
+   */
+
+  public function construct() {
+
+  }
+
+  /**
+   *
+   */
+  protected function setContextualArguments() {
+    $contextualArguments = \Drupal::request()->query->get('contextualArguments');
+    if (!empty($contextualArguments) && isset($contextualArguments['uid_target'])) {
+      $this->contextual_arguments = $contextualArguments['uid_target'];
+    } elseif ($this->viewed->uid != $this->viewer->uid) {
+      $this->contextual_arguments['uid_target'] = $this->viewed->uid;
+    }
+
+    //TODO Figure out a way to attach $this->contextual_arguments to the drupalSettings object with an id of "heartbeatContextualArguments"
+    //see below for implementation in a page callback or form alter
+    //    $variables['#attached']['drupalSettings']['heartbeatContextualArguments'] = $this->contextual_arguments;
+
+  }
+}

includes/heartbeatstreamconfig.inc

@@ -0,0 +1,104 @@
+<?php
+
+/**
+ * @file
+ *   HeartbeatStream Configuration object
+ *   Parameter object given to HeartbeatStreamConfig objects
+ *   to create stream stream of activity objects.
+ */
+
+/**
+ * Class HeartbeatStreamConfig
+ *
+ * Changeable object with configurations for an activity stream
+ */
+class HeartbeatStreamConfig {
+
+  // Class name used.
+  public $name = '';
+
+  // Class to variable for ease of read/write.
+  public $class = '';
+
+  // Real class to load for cloned streams.
+  public $real_class = '';
+
+  // The path to the class.
+  public $path = '';
+
+  // Human readable name.
+  public $title = '';
+
+  // Module where query builder is located.
+  public $module = '';
+
+  // Extra variables.
+  //TODO variables might be put into config api
+  public $variables = array();
+
+  // Indicates whether this stream has a block display or not.
+  public $has_block = TRUE;
+
+  // Max number of items in block display.
+  public $block_items_max = 25;
+
+  // Number to indicate how a block-pager should be shown.
+  public $block_show_pager = 0;
+
+  // View mode for the block.
+  public $block_view_mode = 'default';
+
+  // Maximum number of items in the page display.
+  public $page_items_max = 50;
+
+  // Boolean to indicate of a page-pager should be shown.
+  public $page_show_pager = 0;
+
+  // Boolean to indicate if the pager is ajax-driven.
+  public $page_pager_ajax = 0;
+
+  // View mode for the page.
+  public $page_view_mode = 'default';
+
+  // Setting for the number of grouped items maximum.
+  public $show_message_times = 1;
+
+  // Setting for the number of grouped items maximum in a grouped message.
+  public $show_message_times_grouped = 0;
+
+  // Denied message templates.
+  public $messages_denied = array();
+
+  // Limit the number of messages by maximum messages to load.
+  public $num_load_max = 100;
+
+  // Limit the timespan to group messages.
+  public $grouping_seconds = 7200;
+
+  // Boolean for to skip the viewing user, defaults to false.
+  public $skip_active_user = FALSE;
+
+  // Timestamp used to poll for newer messages.
+  public $poll_messages = 0;
+
+  // How to notify there are newer messages.
+  public $poll_messages_type = 0;
+
+  // Stream path is the path to the stream page (optional).
+  public $stream_path = '';
+
+  // Stream user path is the path to a stream on the profile page (optional).
+  public $stream_profile_path = '';
+
+  // Settings variable
+  public $settings = array();
+
+  /**
+   * Constructor to load the type variable
+   */
+  public function __construct() {
+    //TODO replace variable_get with D8's state system
+//    $this->grouping_seconds = variable_get('heartbeat_activity_grouping_seconds', 7200);
+  }
+
+}