user_relationship_mailer_defaults.inc in User Relationships 7

User Relationships Mailer implementation. Contains all default strings and action definitions.

File

user_relationship_mailer/user_relationship_mailer_defaults.inc

<?php

/**
 * @file
 * User Relationships Mailer implementation. Contains all default strings and
 * action definitions.
 */
global $_user_relationship_mailer_ops;
$_user_relationship_mailer_ops = array(
  'request',
  'cancel',
  'approve',
  'disapprove',
  'remove',
  'pre_approved',
);

/**
 * #515338 Translations of $_user_relationship_mailer_ops above, used on the admin settings form. Keep the two in sync when adding new operations.
 */
function _user_relationship_mailer_ops_translations() {
  return array(
    'request' => t('Request'),
    'send_request' => t('Notify user when a relationship request is made'),
    'cancel' => t('Cancel'),
    'send_cancel' => t('Notify user when a relationship request is cancelled'),
    'approve' => t('Approve'),
    'send_approve' => t('Notify requesting user when a relationship request is approved'),
    'disapprove' => t('Decline'),
    'send_disapprove' => t('Notify requesting user when a relationship request is declined'),
    'remove' => t('Delete'),
    'send_remove' => t('Notify user when an existing relationship is deleted by another user'),
    'pre_approved' => t('Pre-approved'),
    'send_pre_approved' => t('Notify user when a relationship request is pre-approved'),
  );
}

/**
 * Replacements for mail messages
 * @param relationship relationship object for which emails are being sent
 */
function user_relationship_mailer_replacements($relationship = NULL) {
  $requester = isset($relationship->requester) ? $relationship->requester : NULL;
  $requestee = isset($relationship->requestee) ? $relationship->requestee : NULL;

  //load relationship type, if necessary
  if (!isset($relationship->relationship_type) && isset($relationship->rtid)) {
    $relationship->relationship_type = user_relationships_type_load($relationship->rtid);
  }
  $replacements = array(
    '@site' => variable_get('site_name', 'Drupal'),
    '@site_url' => $GLOBALS['base_url'],
    '@requester_name' => isset($requester->name) ? format_username($requester) : '',
    '@requester_link' => isset($requester->uid) ? theme('user_relationships_user_link', array(
      'uid' => $requester->uid,
    )) : '',
    '@requester_uid' => isset($requester->uid) ? $requester->uid : '',
    '@requester_list_link' => isset($requester->uid) ? url("user/{$requester->uid}/relationships/list", array(
      'absolute' => TRUE,
    )) : '',
    '@requester_pending_link' => isset($requester->uid) ? url("user/{$requester->uid}/relationships/sent", array(
      'absolute' => TRUE,
    )) : '',
    '@requestee_name' => isset($requestee->name) ? format_username($requestee) : '',
    '@requestee_link' => isset($requestee->uid) ? theme('user_relationships_user_link', array(
      'uid' => $requestee->uid,
    )) : '',
    '@requestee_uid' => isset($requestee->uid) ? $requestee->uid : '',
    '@requestee_list_link' => isset($requestee->uid) ? url("user/{$requestee->uid}/relationships/list", array(
      'absolute' => TRUE,
    )) : '',
    '@requestee_pending_link' => isset($requestee->uid) ? url("user/{$requestee->uid}/relationships/received", array(
      'absolute' => TRUE,
    )) : '',
    '@relationship_name' => isset($relationship->relationship_type) ? $relationship->relationship_type->name : '',
    '@relationship_plural_name' => isset($relationship->relationship_type) ? $relationship->relationship_type->plural_name : '',
    '@elaboration' => isset($relationship->elaboration) ? $relationship->elaboration : '',
  );

  //'remove' action needs a few more variables for the template
  if (isset($relationship->deleted_by)) {
    $deleted_by = $relationship->deleted_by;
    $replacements['@deleted_by_name'] = $deleted_by->name;
    $replacements['@deleted_by_link'] = url("user/{$deleted_by->uid}", array(
      'absolute' => TRUE,
    ));
    $replacements['@deleted_by_uid'] = $deleted_by->uid;
  }
  return $replacements;
}

/**
 * Default request relationship message
 */
function user_relationship_mailer_request_default() {
  $subject = "[@site] @requester_name wants to be your @relationship_name";
  $message = <<<MESSAGE
Dear @requestee_name,

@requester_name wants to be your @relationship_name.

Here's a link to @requester_name's profile:
  @requester_link

To approve/disapprove this, log in to @site_url and see your pending relationship requests at @requestee_pending_link.

Regards,
The @site team
This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@requestee_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

/**
 * Default cancel request message
 */
function user_relationship_mailer_cancel_default() {
  $subject = "[@site] @requester_name has canceled their @relationship_name request";
  $message = <<<MESSAGE
Dear @requestee_name,

@requester_name has canceled their @relationship_name request.

Regards,
The @site team

This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@requestee_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

/**
 * Default approve to relationship message
 */
function user_relationship_mailer_approve_default() {
  $subject = "[@site] You are @requestee_name's newest @relationship_name";
  $message = <<<MESSAGE
Dear @requester_name,

@requestee_name has approved your request to be their @relationship_name.

Here's a link to your relationships:
  @requester_list_link

Regards,
The @site team

This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@requester_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

/**
 * Default disapprove to relationship message
 */
function user_relationship_mailer_disapprove_default() {
  $subject = "[@site] @requestee_name has declined your relationship request";
  $message = <<<MESSAGE
Dear @requester_name,

@requestee_name has declined your request to be their @relationship_name.

Regards,
The @site team

This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@requester_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

/**
 * Default removed relationship message
 */
function user_relationship_mailer_remove_default() {
  $subject = "[@site] @relationship_name relationship between @requester_name and @requestee_name has been deleted";
  $message = <<<MESSAGE
Dear @target_name,

@requester_name's @relationship_name relationship to @requestee_name has been deleted by @deleted_by_name.

Regards,
The @site team

This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@profile_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

/**
 * Default no approval request relationship message
 */
function user_relationship_mailer_pre_approved_default() {
  $subject = "[@site] New @relationship_name relationship between @requester_name and @requestee_name";
  $message = <<<MESSAGE
Dear @target_name,

We have just created a new @relationship_name relationship between @requester_name and @requestee_name.

Regards,
The @site team

This message was sent to you because you have user relationships email notifications turned on.
If you no longer wish to receive these emails, you can turn them off at @site_url/user/@profile_uid/edit.
MESSAGE;
  return array(
    'subject' => $subject,
    'message' => $message,
  );
}

Functions

Name	Description
user_relationship_mailer_approve_default	Default approve to relationship message
user_relationship_mailer_cancel_default	Default cancel request message
user_relationship_mailer_disapprove_default	Default disapprove to relationship message
user_relationship_mailer_pre_approved_default	Default no approval request relationship message
user_relationship_mailer_remove_default	Default removed relationship message
user_relationship_mailer_replacements	Replacements for mail messages
user_relationship_mailer_request_default	Default request relationship message
_user_relationship_mailer_ops_translations	#515338 Translations of $_user_relationship_mailer_ops above, used on the admin settings form. Keep the two in sync when adding new operations.

Globals

Name	Description
$_user_relationship_mailer_ops	@file User Relationships Mailer implementation. Contains all default strings and action definitions.