messaging_simple.inc in Messaging 7

Drupal Messaging Framework - Send_Method class file

File

messaging_simple/messaging_simple.inc

<?php

/**
 * @file
 * Drupal Messaging Framework - Send_Method class file
 */

/**
 * Simple message instance
 */
class Messaging_Simple extends Messaging_Object {
  public $mgid;
  public $msid;
  public $uid;
  public $sender;
  public $subject;
  public $body;
  public $language;

  // Timestamps
  public $sent;
  public $timeread = 0;

  /**
   * Build from db object
   */
  public static function build_object($template) {
    return new Messaging_Simple($template);
  }

  /**
   * Build from user account and Messaging_Message
   */
  public static function build($user, $message) {
    $store = new Messaging_Simple();
    $store->uid = $user->uid;
    $store->msid = $message->msid;
    $store->sender = $message
      ->get_sender('uid');
    $store->language = $message
      ->get_language()->language;

    // Build message subject and content, may do token replacement
    $template = $message
      ->get_template();

    // As this is to be displayed on site we don't need greetings nor footer
    $store->subject = $template
      ->render('subject');
    $store->body = $template
      ->render('content');
    return $store;
  }

  /**
   * Save to db
   */
  public function save() {
    $this->sent = time();
    return drupal_write_record('messaging_simple', $this);
  }

  /**
   * Mark when read
   */
  public function read() {
    $this->timeread = time();
    db_update('messaging_simple')
      ->fields(array(
      'timeread' => $this->timeread,
    ))
      ->condition('mgid', $this->mgid)
      ->execute();
    return $this->timeread;
  }

  /**
   * Load from db
   */
  public static function load($mgid) {
    if ($message = db_query("SELECT * FROM {messaging_simple} WHERE mgid = :mgid", array(
      ':mgid' => $mgid,
    ))
      ->fetchObject()) {
      return self::build_object($message);
    }
  }

}

/**
 * Web sending method
 */
class Messaging_Simple_Method extends Messaging_Send_Method {

  // Default group and address type
  public $method = 'simple';
  public $type = 'web';
  public $anonymous = FALSE;
  public $format = MESSAGING_FORMAT_HTML;

  /**
   * Get address type
   */
  public static function address_type() {
    return 'user';
  }

  /**
   * It doesn't support anonymous destinations
   */
  function supports_anonymous() {
    return FALSE;
  }

  /**
   * Send message to address, use sending callback
   */
  function send_address($user, $message) {
    return $this
      ->send_user($user, $message);
  }

  /**
   * Send to user. Just store the message to be shown later.
   */
  function send_user($user, $message) {
    $user = messaging_user_object($user);
    $simple = Messaging_Simple::build($user, $message);
    return (bool) $simple
      ->save();
  }

}

Classes

Name	Description
Messaging_Simple	Simple message instance
Messaging_Simple_Method	Web sending method