class HeartbeatOgPlugin in Heartbeat 7

Class HeartbeatOgPlugin.

Hierarchy

• class \HeartbeatBasePlugin
  • class \HeartbeatOgPlugin implements iHeartbeatPlugin

File

modules/heartbeat_og/plugins/og.inc, line 10

class HeartbeatOgPlugin extends HeartbeatBasePlugin implements iHeartbeatPlugin {

  /**
   * loadAttachments().
   * Loads extra attachments onto a heartbeat activity message.
   */
  public function loadAttachments(HeartbeatActivity &$heartbeatActivity, $name = NULL) {
  }

  /**
   * hasContent().
   * True if a plugin provides attachments.
   */
  public function hasContent() {
    return FALSE;
  }

  /**
   * hasAttachmentsContent().
   * True if the message has attachments content.
   */
  public function hasAttachmentsContent() {
    return FALSE;
  }

  /**
   * renderAttachmentsContent().
   */
  public function renderAttachmentsContent(HeartbeatActivity $heartbeatActivity) {
    return '';
  }

  /**
   * hasButtons().
   * True if a plugin provides attachments.
   */
  public function hasButtons() {
    return FALSE;
  }

  /**
   * hasAttachmentsButtons().
   * True if a message has attachment buttons.
   */
  public function hasAttachmentsButtons() {
    return FALSE;
  }

  /**
   * renderButtons().
   */
  public function renderButtons(HeartbeatActivity $heartbeatActivity) {
    return '';
  }

  /**
   * isStreamAdaptor().
   */
  public function isStreamAdaptor() {
    return TRUE;
  }

  /**
   * adaptsStream().
   */
  public function adaptsStream() {
    return TRUE;
  }

  /**
   * streamLoaded().
   */
  public function streamLoaded(HeartbeatStream $heartbeatStream) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
HeartbeatBasePlugin::$label	protected	property
HeartbeatBasePlugin::$settings	protected	property
HeartbeatBasePlugin::$stream	protected	property
HeartbeatBasePlugin::activityRemoved	public	function	activityRemoved().	1
HeartbeatBasePlugin::addSettings	public	function	addSettings().
HeartbeatBasePlugin::getAttachments	public	function	getAttachments().	2
HeartbeatBasePlugin::getLabel	public	function	getLabel().
HeartbeatBasePlugin::getMenuItems	public	function	getMenuItems().	1
HeartbeatBasePlugin::getSettings	public	function	getSettings().
HeartbeatBasePlugin::pluginAttachmentForm	public	function	pluginAttachmentForm(). The form to add attachments to templates.	2
HeartbeatBasePlugin::pluginStreamForm	public	function	pluginStreamForm().	2
HeartbeatBasePlugin::pluginUIForm	public	function	pluginUIForm().	2
HeartbeatBasePlugin::setLabel	public	function	setLabel().
HeartbeatBasePlugin::setStream	final public	function	setStream().
HeartbeatBasePlugin::__construct	public	function	__construct().	1
HeartbeatOgPlugin::adaptsStream	public	function	adaptsStream(). Overrides iHeartbeatPlugin::adaptsStream
HeartbeatOgPlugin::hasAttachmentsButtons	public	function	hasAttachmentsButtons(). True if a message has attachment buttons. Overrides iHeartbeatPlugin::hasAttachmentsButtons
HeartbeatOgPlugin::hasAttachmentsContent	public	function	hasAttachmentsContent(). True if the message has attachments content. Overrides iHeartbeatPlugin::hasAttachmentsContent
HeartbeatOgPlugin::hasButtons	public	function	hasButtons(). True if a plugin provides attachments. Overrides iHeartbeatPlugin::hasButtons
HeartbeatOgPlugin::hasContent	public	function	hasContent(). True if a plugin provides attachments. Overrides iHeartbeatPlugin::hasContent
HeartbeatOgPlugin::isStreamAdaptor	public	function	isStreamAdaptor(). Overrides iHeartbeatPlugin::isStreamAdaptor
HeartbeatOgPlugin::loadAttachments	public	function	loadAttachments(). Loads extra attachments onto a heartbeat activity message. Overrides iHeartbeatPlugin::loadAttachments
HeartbeatOgPlugin::renderAttachmentsContent	public	function	renderAttachmentsContent(). Overrides iHeartbeatPlugin::renderAttachmentsContent
HeartbeatOgPlugin::renderButtons	public	function	renderButtons(). Overrides iHeartbeatPlugin::renderButtons
HeartbeatOgPlugin::streamLoaded	public	function	streamLoaded(). Overrides iHeartbeatPlugin::streamLoaded