function _workflow_notify in Workflow 7.2

Calls drupal_mail() to notify users.

Parameters

$new_state:

$entity:

string $entity_type:

string $field_name:

null $transition:

null $user:

Throws

EntityMalformedException

2 calls to _workflow_notify()

workflow_notify_workflow in workflow_notify/workflow_notify.module

Implements hook_workflow(). Calls drupal_mail via _workflow_notify() for Workflow Field;

_workflow_notify_entity_update in workflow_notify/workflow_notify.module

Calls drupal_mail via _workflow_notify() for Workflow Field;

1 string reference to '_workflow_notify'

workflow_notify_settings_form in workflow_notify/workflow_notify.pages.inc

Settings form.

File

workflow_notify/workflow_notify.module, line 215

Notify roles for Workflow state transitions.

Code

function _workflow_notify($new_state, $entity, $entity_type = '', $field_name = '', $transition = NULL, $user = NULL) {
  global $user;

  // See if this is a state that we notify for.
  $notify = variable_get('workflow_notify_roles', array());
  if (!isset($notify[$new_state])) {
    return;
  }

  // The name of the person making the change.
  $changer = format_username($user);
  $changer_mail = $user->mail;

  // Okay, we are notifying someone of this change.
  // So let's get the workflow object.
  $entity_uri = entity_uri($entity_type, $entity);
  list($entity_id, , $entity_bundle) = entity_extract_ids($entity_type, $entity);

  /* @var $workflow Workflow */
  $workflow = workflow_get_workflows_by_type($entity_bundle, $entity_type);
  $wid = $workflow
    ->getWorkflowId();

  // And all the states.
  $states = $workflow
    ->getStates(TRUE);

  // Get the specific roles to notify.
  $notify = $notify[$new_state];

  // See if we want to notify the author too?
  $notify_author = in_array(-1, $notify);
  unset($notify[-1]);

  // There could be no roles set.
  if ($notify) {

    // Get all the user accounts in those roles.
    $query = "SELECT DISTINCT ur.uid " . "FROM {users_roles} ur " . "INNER JOIN {users} u ON u.uid = ur.uid " . "WHERE ur.rid IN (:rids) " . "AND u.status = 1 ";
    $users = db_query($query, array(
      ':rids' => $notify,
    ))
      ->fetchCol();
  }
  else {
    $users = array();
  }

  // Some entities (like Term) have no Author.
  if ($notify_author && isset($entity->uid)) {
    $users[] = $entity->uid;
  }

  // Load all the user entities, making sure there are no duplicates.
  $accounts = entity_load('user', array_unique($users, SORT_NUMERIC));

  // Call all modules that want to limit the list.
  $args = array(
    'users' => $accounts,
    'entity_type' => $entity_type,
    'state' => $new_state,
    'roles' => $notify,
    'workflow' => $workflow,
  );

  // Preparing for entities, keeping backward compatibility.
  $args += $entity_type == 'node' ? array(
    'node' => $entity,
  ) : array(
    'entity' => $entity,
  );
  foreach (module_implements('workflow_notify') as $module) {
    $function = $module . '_workflow_notify';
    $function('users', $args);
  }

  // Retrieve the remaining list without duplicates.
  $accounts = $args['users'];

  // Just quit if there are no users.
  if (empty($accounts)) {
    watchdog('workflow_notify', 'No recipients - email skipped.', array(), WATCHDOG_DEBUG, l(t('view'), $entity_uri['path']));
    return;
  }
  $addr_list = array();
  foreach ($accounts as $uid => $account) {
    $addr_list[] = format_username($account) . ' <' . $account->mail . '>';
  }

  // The to-parameter to drupal_mail is a string, not an array, separated by commas.
  $to = implode(', ', $addr_list);

  // Retrieve the params parameter for drupal_mail.
  $params = array(
    'clear' => TRUE,
    'sanitize' => FALSE,
    'data' => array(
      'user' => $user,
      'entity_type' => $entity_type,
    ),
    'filter' => variable_get('workflow_notify_filter_format_' . $wid, 'filtered_html'),
  );

  // Preparing for entities, keeping backward compatibility.
  $params['data'] += $entity_type == 'node' ? array(
    'node' => $entity,
  ) : array(
    'entity' => $entity,
  );

  // Build the subject and body of the mail.
  // Token replacement occurs in hook_mail().
  // @todo: Currently no translation occurs.
  $params['context']['subject'] = variable_get("workflow_notify_subject_{$new_state}", '[node:title] is now "[workflow:workflow-current-state-name]"');
  $params['context']['body'] = variable_get("workflow_notify_body_{$new_state}", '<a href="[node:url:absolute]">[node:title]</a> is now "@state".');

  // Retrieve the from-address.
  switch (variable_get('workflow_notify_from_address_' . $wid, 'site')) {
    case 'site':
      $from = variable_get('site_mail', ini_get('sendmail_from'));
      break;
    case 'changer':
      $from = $user->mail;
      break;
  }

  // Send the mail, and check for success. Note that this does not guarantee
  // message delivery; only that there were no PHP-related issues encountered
  // while sending.
  $module = 'workflow_notify';
  $key = 'workflow_notify';
  $language = language_default();

  // https://api.drupal.org/api/drupal/includes!mail.inc/function/drupal_mail/7.x
  $result = drupal_mail($module, $key, $to, $language, $params, $from);

  /*
    if ($result['result'] == TRUE) {
   drupal_set_message(t('Your message has been sent.'));
    }
    else {
   drupal_set_message(t('There was a problem sending your message and it was not sent.'), 'error');
    }
  */
}