class RelationsActivity in Heartbeat 7

Class RelationsActivity Concrete class to build a stream with activity messages for all users that are connected to the viewed user.

Hierarchy

• class \HeartbeatStream
  • class \RelationsActivity

File

modules/heartbeat_defaults/streams/relationsactivity.inc, line 13

User relations activity object.

class RelationsActivity extends HeartbeatStream {

  /**
   * Fake constructor to hook this method instead of the constructor.
   */
  public function construct() {

    // Add the relations to the viewed user object.
    $this->viewer->relations = heartbeat_related_uids($this->viewer->uid);

    // This stream needs the viewed relations as well. Load them if different.
    if ($this->viewed->uid != $this->viewer->uid) {
      $this->viewed->relations = heartbeat_related_uids($this->viewed->uid);
    }
    else {
      $this->viewed->relations = $this->viewer->relations;
    }
  }

  /**
   * Implementation of queryAlter().
   */
  protected function queryAlter() {

    // This stream is limited to the messages owned by the "viewed" user
    // and his/her relations (friends, fans, ...).
    $this->query
      ->condition('ha.access', HEARTBEAT_PUBLIC_TO_ADDRESSEE, '>=');
    $this->query
      ->condition('ha.uid', $this->viewed->relations, 'IN');
  }

  /**
   * 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 viewsQueryAlter(&$view) {

    // This stream is limited to the messages owned by the "viewed" user
    // and his/her relations (friends, fans, ...).
    $query = $view->query;
    $query
      ->add_where(0, "access", HEARTBEAT_PUBLIC_TO_ADDRESSEE, ">=");
    $query
      ->add_where(0, "uid", $this->viewed->relations, 'IN');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HeartbeatStream::$ajax	protected	property
HeartbeatStream::$canPage	protected	property
HeartbeatStream::$config	public	property
HeartbeatStream::$contextual_arguments	public	property
HeartbeatStream::$exclude_og	protected	property
HeartbeatStream::$language	protected	property
HeartbeatStream::$latest_activity_id	protected	property
HeartbeatStream::$messages	public	property
HeartbeatStream::$messages_max	protected	property
HeartbeatStream::$needsModal	protected	property
HeartbeatStream::$oldest_date	protected	property
HeartbeatStream::$prefix	public	property
HeartbeatStream::$query	protected	property
HeartbeatStream::$suffix	public	property
HeartbeatStream::$templates	public	property
HeartbeatStream::$templates_denied	protected	property
HeartbeatStream::$viewed	protected	property
HeartbeatStream::$viewer	protected	property
HeartbeatStream::$view_mode	protected	property
HeartbeatStream::$_errors	protected	property
HeartbeatStream::$_has_errors	protected	property
HeartbeatStream::$_offset_time	protected	property
HeartbeatStream::$_page	protected	property
HeartbeatStream::$_uid	protected	property
HeartbeatStream::$_whoisuser_type	protected	property
HeartbeatStream::$_whoisuser_types	protected	property
HeartbeatStream::addError	public	function	addError
HeartbeatStream::canPostActivityStatuses	public	function	canPostActivityStatuses(). TODO Remove this here. The stream plugins should be stored in the stream object. This kind of access will become much easier to implement.
HeartbeatStream::checkAccess	protected	function	Function to check access on messages This behaviour is set by a heartbeat message configuration to overrule the chosen display access type
HeartbeatStream::createQuery	protected	function	createQuery().	1
HeartbeatStream::excludeOg	public	function	excludeOg().
HeartbeatStream::execute	public	function	Function that reorganizes a query result of messages into a stream of heartbeat activity objects.
HeartbeatStream::executeQuery	protected	function	executeQuery
HeartbeatStream::executeViews	public	function	executeViews().
HeartbeatStream::getAjax	public	function	getAjax().
HeartbeatStream::getConfig	public	function	getConfig().
HeartbeatStream::getCurrentLanguages	public	function	getCurrentLanguages().
HeartbeatStream::getErrors	public	function
HeartbeatStream::getLatestActivityId	public	function	getLatestActivityId()
HeartbeatStream::getMessages	public	function	Get the messages.
HeartbeatStream::getOffsetTime	final public	function	getOffsetTime
HeartbeatStream::getTemplate	final public	function	getTemplate().
HeartbeatStream::getViewed	public	function	getViewed().
HeartbeatStream::getViewedId	public	function	getViewedId().
HeartbeatStream::getViewer	public	function	getViewer().
HeartbeatStream::hasAccess	public	function	hasAccess	4
HeartbeatStream::hasErrors	public	function	hasErrors
HeartbeatStream::hasMoreMessages	public	function	Function to check if more/older messages can be loaded
HeartbeatStream::isAjax	public	function	isAjax().
HeartbeatStream::isPage	public	function	isPage().
HeartbeatStream::modifyActivityMessage	public	function	modifyActivityMessage()	4
HeartbeatStream::needsModal	public	function	needsModal(). Returns a boolean to indicate whether modal window is needed on the page.
HeartbeatStream::numberOfMessages	public	function	numberOfMessages().
HeartbeatStream::parseMessages	public	function	Create the well-formed activity messages from a result. HeartbeatParser will do most of the work here.
HeartbeatStream::render	public	function	Render().
HeartbeatStream::result	public	function	result Prepares a query, makes it available to alter it and finally executes it.
HeartbeatStream::setAjax	public	function	setAjax().
HeartbeatStream::setAvailableTemplates	protected	function	setAvailableTemplates()
HeartbeatStream::setConfig	public	function	setConfig().
HeartbeatStream::setContextualArguments	protected	function	setContextualArguments().
HeartbeatStream::setError	protected	function	setError Alias for addError.
HeartbeatStream::setIsPage	public	function	setIsPage().
HeartbeatStream::setItemsMax	public	function	Set the maximum number of items to fetch.
HeartbeatStream::setLanguage	public	function	setLanguage().
HeartbeatStream::setLatestActivityId	public	function	setLatestActivityId().
HeartbeatStream::setOffsetTime	final public	function	setOffsetTime
HeartbeatStream::setViewed	public	function	setViewed().
HeartbeatStream::setViewer	public	function	setViewer().
HeartbeatStream::setViewMode	public	function	setViewMode().
HeartbeatStream::skipActiveUser	public	function	skipActiveUser().
HeartbeatStream::VIEWED		constant
HeartbeatStream::VIEWER		constant
HeartbeatStream::__construct	final public	function	Constructor
RelationsActivity::construct	public	function	Fake constructor to hook this method instead of the constructor. Overrides HeartbeatStream::construct
RelationsActivity::queryAlter	protected	function	Implementation of queryAlter(). Overrides HeartbeatStream::queryAlter
RelationsActivity::viewsQueryAlter	public	function	Function to add a part of a sql to a query built by views. Overrides HeartbeatStream::viewsQueryAlter