class NodeActivity in Heartbeat 7

Class NodeActivity Stream with all activity related to nodes.

Hierarchy

• class \HeartbeatStream
  • class \NodeActivity

File

modules/heartbeat_defaults/streams/nodeactivity.inc, line 11

class NodeActivity extends HeartbeatStream {

  // Contains the Node ID for which should be filtered.
  protected $nid = 0;

  /**
   * getNid().
   *
   * Function to retrieve the node id
   */
  public function getNid() {
    return $this->nid;
  }

  /**
   * setNid().
   */
  public function setNid($nid) {
    $this->nid = $nid;

    // Add the node ID to the contextual arguments.
    $this->contextual_arguments['nid'] = $this->nid;
  }

  /**
   * Implements construct().
   */
  public function construct() {

    // First check the contextual arguments that could have been sent along
    // with ajax posts to get the context of the current node.
    if (!empty($_GET['contextualArguments']) && isset($_GET['contextualArguments']['nid'])) {
      $this
        ->setNid($_GET['contextualArguments']['nid']);
    }
    elseif (arg(0) == "node" && is_numeric(arg(1))) {
      $this
        ->setNid(arg(1));
    }
  }

  /**
   * modifyActivityMessage().
   * This will make sure the nid is saved when a message is logged.
   * E.g. ActivityStatus plugin with a shout in node context.
   */
  public function modifyActivityMessage(HeartbeatActivity $heartbeatActivity) {

    // Add the content node context.
    $heartbeatActivity->nid = $this->nid;
  }

  /**
   * Implements queryAlter().
   */
  protected function queryAlter() {
    $this->query
      ->condition('ha.access', 0, '>')
      ->condition(db_or()
      ->condition('ha.nid', $this->nid)
      ->condition('ha.nid_target', $this->nid));
  }

  /**
   * Function to add a part of a sql to a query built by views UI
   *
   * @param object $view
   *   The  view handler by reference to add our part to the query.
   */
  public function viewsQueryAlter(&$view) {
    $views->query
      ->condition('ha.access', 0, '>')
      ->condition(db_or()
      ->condition('ha.nid', $this->nid)
      ->condition('ha.nid_target', $this->nid));
  }

}

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::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
NodeActivity::$nid	protected	property
NodeActivity::construct	public	function	Implements construct(). Overrides HeartbeatStream::construct
NodeActivity::getNid	public	function	getNid().
NodeActivity::modifyActivityMessage	public	function	modifyActivityMessage(). This will make sure the nid is saved when a message is logged. E.g. ActivityStatus plugin with a shout in node context. Overrides HeartbeatStream::modifyActivityMessage
NodeActivity::queryAlter	protected	function	Implements queryAlter(). Overrides HeartbeatStream::queryAlter
NodeActivity::setNid	public	function	setNid().
NodeActivity::viewsQueryAlter	public	function	Function to add a part of a sql to a query built by views UI Overrides HeartbeatStream::viewsQueryAlter