user_relationship_privatemsg_defaults.inc in User Relationships 5.2

File

plugins/user_relationship_privatemsg/user_relationship_privatemsg_defaults.inc

<?php

/**
 * Default subject lines
 */
define('USER_RELATIONSHIP_PRIVATEMSG_REQUEST_SUBJECT', "@requester_name believes they are a @relationship_name of yours");
define('USER_RELATIONSHIP_PRIVATEMSG_CANCEL_SUBJECT', "@requester_name has cancelled their request to be your @relationship_name");
define('USER_RELATIONSHIP_PRIVATEMSG_APPROVE_SUBJECT', "You are @requestee_name's newest @relationship_name");
define('USER_RELATIONSHIP_PRIVATEMSG_DISAPPROVE_SUBJECT', "@requestee_name did not approve your @relationship_name relationship with them");
define('USER_RELATIONSHIP_PRIVATEMSG_REMOVE_SUBJECT', "@relationship_name between @requester_name and @requestee_name has been removed");

/**
 * Replacements for mail messages
 */
function user_relationship_privatemsg_replacements(&$relationship) {
  $requester = $relationship->requester;
  $requestee = $relationship->requestee;
  $type = user_relationships_type_load($relationship->rtid);
  $replacements = array(
    '@site' => variable_get('site_name', 'Drupal'),
    '@site_url' => $GLOBALS['base_url'],
    '@requester_name' => $requester->name,
    '@requester_link' => theme('user_relationships_user_link', $requester->uid),
    '@requester_uid' => $requester->uid,
    '@requester_list_link' => url("user/{$requester->uid}/relationships/list", NULL, NULL, TRUE),
    '@requester_pending_link' => url("user/{$requester->uid}/relationships/requests", NULL, NULL, TRUE),
    '@requestee_name' => $requestee->name,
    '@requestee_link' => theme('user_relationships_user_link', $requestee->uid),
    '@requestee_uid' => $requestee->uid,
    '@requestee_list_link' => url("user/{$requestee->uid}/relationships/list", NULL, NULL, TRUE),
    '@requestee_pending_link' => url("user/{$requestee->uid}/relationships/requests", NULL, NULL, TRUE),
    '@relationship_name' => $type->name,
    '@relationship_plural_name' => $type->plural_name,
  );
  if ($deleted_by = $relationship->deleted_by) {
    $replacements['@deleted_by_name'] = $deleted_by->name;
    $replacements['@deleted_by_link'] = url("user/{$deleted_by->uid}", NULL, NULL, TRUE);
    $replacements['@deleted_by_uid'] = $deleted_by->uid;
  }
  return $replacements;
}

/**
 * Default request relationship message
 */
function user_relationship_privatemsg_request_default() {
  return <<<MESSAGE
Hi @requestee_name,

@requester_name believes they are a @relationship_name of yours.

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

To approve/disapprove this see your pending relationship requests at @requestee_pending_link.

Regards,
The @site team
MESSAGE;
}

/**
 * Default cancel request message
 */
function user_relationship_privatemsg_cancel_default() {
  return <<<MESSAGE
Hi @requestee_name,

@requester_name has cancelled their request to be a @relationship_name of yours.

Regards,
The @site team
MESSAGE;
}

/**
 * Default approve to relationship message
 */
function user_relationship_privatemsg_approve_default() {
  return <<<MESSAGE
Hi @requester_name,

@requestee_name has approved your request to create a @relationship_name relationship to them.

Here's a link to your relationships:
  @requester_list_link

Regards,
The @site team
MESSAGE;
}

/**
 * Default disapprove to relationship message
 */
function user_relationship_privatemsg_disapprove_default() {
  return <<<MESSAGE
Hi @requester_name,

@requestee_name did not approve your request to create a @relationship_name relationship with them.

Regards,
The @site team
MESSAGE;
}

/**
 * Default removed relationship message
 */
function user_relationship_privatemsg_remove_default() {
  return <<<MESSAGE
@requester_name's @relationship_name relationship to @requestee_name has been removed by @deleted_by_name.

Regards,
The @site team
MESSAGE;
}

Functions

Name	Description
user_relationship_privatemsg_approve_default	Default approve to relationship message
user_relationship_privatemsg_cancel_default	Default cancel request message
user_relationship_privatemsg_disapprove_default	Default disapprove to relationship message
user_relationship_privatemsg_remove_default	Default removed relationship message
user_relationship_privatemsg_replacements	Replacements for mail messages
user_relationship_privatemsg_request_default	Default request relationship message

Constants

Name	Description
USER_RELATIONSHIP_PRIVATEMSG_APPROVE_SUBJECT
USER_RELATIONSHIP_PRIVATEMSG_CANCEL_SUBJECT
USER_RELATIONSHIP_PRIVATEMSG_DISAPPROVE_SUBJECT
USER_RELATIONSHIP_PRIVATEMSG_REMOVE_SUBJECT
USER_RELATIONSHIP_PRIVATEMSG_REQUEST_SUBJECT	Default subject lines