class SiteActivity in Heartbeat 6.4

Class SiteActivity Concrete class to prepare messages for whole site, to be customized UI wise

Hierarchy

• class \HeartbeatAccess
  • class \SiteActivity

1 string reference to 'SiteActivity'

heartbeat_example_heartbeat_register_access_types in modules/heartbeat_example/heartbeat_example.module

Implementation of hook_heartbeat_register_access_types().

File

modules/heartbeat_example/siteactivity.inc, line 16

class SiteActivity extends HeartbeatAccess {
  protected function hasAccess() {
    return TRUE;
  }

  /**
   * Implementation of dressUpMessages().
   *
   * @param object HeartbeatParser $heartbeat
   *   The heartbeat parser object
   * @return object HeartbeatParser $heartbeat
   */
  public function dressUpMessages(HeartbeatParser $heartbeat) {
    $sql = " AND ua.access > 0 ";
    $heartbeat->raw_messages = $this
      ->resultSql($sql);
    return $heartbeat;
  }

  /**
   * Function to add a part of a sql to a query built by views
   *
   * @param object $view The view handler object by reference to add our part to the query
   */
  public function addViewQuery(&$view) {

    // Make the sql limited to the access
    $field = "{$view->table_alias}.{$view->real_field}";
    $view->query
      ->add_where('andgroup', "{$field} > %d  AND {$view->table_alias}.access > 0", 0);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HeartbeatAccess::$stream	public	property
HeartbeatAccess::$_actor	protected	property
HeartbeatAccess::$_errors	protected	property
HeartbeatAccess::$_has_errors	protected	property
HeartbeatAccess::$_offset_sql	protected	property
HeartbeatAccess::$_page	protected	property
HeartbeatAccess::$_uid	protected	property
HeartbeatAccess::$_whoisuser_type	protected	property
HeartbeatAccess::$_whoisuser_types	protected	property
HeartbeatAccess::checkDeniedMessages	protected	function	Check denied messages
HeartbeatAccess::configurationForm	public	function	ConfigurationForm Basic configuration form for streams.
HeartbeatAccess::construct	public	function	Fake constructor to hook this method instead of the constructor.	2
HeartbeatAccess::createHeartbeatParser	protected	function	createHeartbeatParser
HeartbeatAccess::fetchMessages	public	function
HeartbeatAccess::finishMessages	protected	function	finishMessages
HeartbeatAccess::getAccess	final public	function	getAccess
HeartbeatAccess::getActiveUser	public	function	Function to retrieve the active user.
HeartbeatAccess::getErrors	public	function
HeartbeatAccess::getOffsetSql	final public	function	getOffsetSql
HeartbeatAccess::getStream	public	function	Get HeartbeatStream object with all configurations
HeartbeatAccess::hasErrors	public	function	hasErrors
HeartbeatAccess::isPage	public	function	Getter function for heartbeat page/blocks
HeartbeatAccess::prepareStream	protected	function	prepareStream	2
HeartbeatAccess::resultSql	protected	function	resultSql	1
HeartbeatAccess::setError	protected	function	setError
HeartbeatAccess::setOffsetSql	final public	function	setOffsetSql
HeartbeatAccess::skipActiveUser	public	function	Skip active user. Return whether you want to skip the active user (being the logged-in user and NOT the displayed user) from display. Typical private will not skip this one ofcourse where most other will skip active user since you don't want to…	5
HeartbeatAccess::TYPE_ACTOR		constant
HeartbeatAccess::TYPE_USER_PROFILE		constant
HeartbeatAccess::whoIsActor	protected	function	proctected fuinction whoIsActor Calculate the user of whom we want to see activity for. Set the actor of the stream.	1
HeartbeatAccess::__construct	public	function	Constructor
SiteActivity::addViewQuery	public	function	Function to add a part of a sql to a query built by views Overrides HeartbeatAccess::addViewQuery
SiteActivity::dressUpMessages	public	function	Implementation of dressUpMessages(). Overrides HeartbeatAccess::dressUpMessages
SiteActivity::hasAccess	protected	function	hasAccess Overrides HeartbeatAccess::hasAccess