care-8.x-1.x-dev/care_user/care_user.rules.inc

<?php

/**
 * @file
 * Integration with Rules.
 */

/**
 * Implements hook_rules_action_info().
 */
function care_user_rules_action_info() {
  $actions = [
    'care_user_fetch_all' => [
      'label' => t('Fetch all user data from CARE.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to update with CARE data.'),
        ],
      ],
    ],
    'care_user_fetch_memberships' => [
      'label' => t('Fetch user’s membership data from CARE.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to update with CARE data.'),
        ],
      ],
    ],
    'care_user_display_membership_status' => [
      'label' => t('Display user’s membership status.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to display membership status for.'),
        ],
      ],
    ],
    'care_user_save_all' => [
      'label' => t('Save changed user data to CARE.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to save CARE data from.'),
        ],
      ],
    ],
    'care_user_find_existing' => [
      'label' => t('Find any existing contacts in CARE.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to match CARE contacts with.'),
        ],
      ],
    ],
    'care_user_merge_drupal_mail_into_emails_field' => [
      'label' => t('Merge/copy Drupal user account email into CARE emails field'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to save CARE data from.'),
        ],
      ],
    ],
    'care_user_care_email_field_to_drupal_mail' => [
      'label' => t('Copy CARE default email to Drupal account mail.'),
      'group' => t('CARE User'),
      'parameter' => [
        'account' => [
          'type' => 'user',
          'label' => t('User account to save CARE data from.'),
        ],
      ],
    ],
  ];
  return $actions;
}

/**
 * Rules action to fetch all data from CARE into account.
 */
function care_user_fetch_all($account) {
  if ($account->uid) {
    $care_user = new CareUser($account);
    $care_user->fetchFromCare();
  }
}

/**
 * Rules action to fetch membership data from CARE into account.
 */
function care_user_fetch_memberships($account) {
  if ($account->uid) {
    $care_user = new CareUser($account);
    $care_user->fetchMembershipDetails();
  }
}

/**
 * Rules action to save all data to CARE from account.
 */
function care_user_save_all($account) {
  if ($account->uid) {
    $care_user = new CareUser($account);
    $care_user->saveToCare();
  }
}

/**
 * Rules action to display membership status for account.
 */
function care_user_display_membership_status($account) {
  if ($account->uid) {
    $care_user = new CareUser($account);
    $memberships_field = $care_user->getMembershipsField();
    if ($memberships_field && $care_user->getMembershipNumber()) {
      // Refresh membership info from CARE.
      $care_user->fetchMembershipDetails();
      foreach ($memberships_field as $membership) {
        $renewal_date = DateTime::createFromFormat('Y-m-d', $membership->renewal_date->value());
        if ($renewal_date) {
          $token_values = [
            '@type' => $membership->membership_type->value(),
            '@date' => format_date($renewal_date->getTimestamp(), variable_get('care_user_message_date_format', 'short')),
          ];
          if ($membership->balance->value() > 0) {
            if ($membership->renewal_date->value() < time()) {
              drupal_set_message(t('Your membership of type @type is overdue for renewal as of @date', $token_values));
            }
            else {
              drupal_set_message(t('Your membership of type @type is due for renewal before @date', $token_values));
            }
          }
          else {
            drupal_set_message(t('Your membership of type @type is current, renewal will be due before @date.', $token_values));
          }
        }
        if ($membership->payment_method->value() == 'DD') {
          drupal_set_message(t('You are paying this membership by Direct Debit, so it will be renewed automatically.'));
        }
      }
    }
    else {
      drupal_set_message(t('You are not a member, or your website account is missing your membership number.'));
    }
  }
}

/**
 * Rule action to copy Drupal account mail into CARE email field.
 */
function care_user_merge_drupal_mail_into_emails_field($account) {
  watchdog('care_user', 'care_user_merge_drupal_mail_into_emails_field for %user', [
    '%user' => $account->name,
  ]);
  if ($account->uid) {
    $care_user = new CareUser($account);
    $drupal_email = $account->mail;
    $email_field = $care_user->getEmailField();
    $field_name = variable_get('care_user_email_field', '');
    $field_info = field_info_field($field_name);
    $field_instance = field_info_instance('user', $field_name, 'user');
    $multiple_value_field = ($field_info['cardinality'] == '-1');
    $device_strings = (array) preg_split('/\|/', variable_get('care_fields_email_devices', "EM|Home email\nEW|Work email"));
    $device_code_default = $device_strings[0];

    $existing = [];
    if ($multiple_value_field) {
      // Copy across if not already in the list.
      foreach ($email_field->getIterator() as $fred) {
        $existing[] = $fred->email->value();
      }
      if (in_array($drupal_email, $existing)) {
        // Make existing email that matches the new default, if not already.
        $existing_emails = $email_field->value();
        if ($existing_emails[0]['email'] != $drupal_email) {
          foreach ($existing_emails as $index => $existing) {
            if ($existing['email'] == $drupal_email) {
              $default = $existing;
              $default['device_default'] = 1;
              unset($existing_emails[$index]);
              break;
            }
          }
          array_unshift($existing_emails, $default);
          $email_field->set($existing_emails);
          // Save fields without saving the parent user.
          if ($account->uid != 0) {
            field_attach_update('user', $account);
          }
          if (variable_get('care_user_rules_messages', TRUE)) {
            drupal_set_message(t('Website account email address %address set as new %field field default.', [
              '%address' => $drupal_email,
              '%field' => $field_instance['label'],
            ]));
          }
        }
      }
      else {
        $existing_emails = $email_field->value();
        // Add this as the first value, so it's the default.
        array_unshift($existing_emails, [
          'communication_number' => 0,
          'email' => $drupal_email,
          'device_code' => $device_code_default,
          'device_default' => 1,
          'local_unsent_changes' => CARE_FIELDS_CHANGED,
        ]);
        $email_field->set($existing_emails);
        // Save fields without saving the parent user.
        if ($account->uid != 0) {
          field_attach_update('user', $account);
        }
        if (variable_get('care_user_rules_messages', TRUE)) {
          drupal_set_message(t('Website account email address %address added to %field field as new default.', [
            '%address' => $drupal_email,
            '%field' => $field_instance['label'],
          ]));
        }
      }
    }
    else {
      if ($email_field->value()) {
        // Copy across if existing not the same.
        $current_care = $email_field->email->value();
        if ($current_care != $drupal_email) {
          $email_field->email->set($drupal_email);
          $email_field->local_unsent_changes = CARE_FIELDS_CHANGED;
          $email_field->device_default = 1;
          // Save fields without saving the parent user.
          if ($account->uid != 0) {
            field_attach_update('user', $account);
          }
          if (variable_get('care_user_rules_messages', TRUE)) {
            drupal_set_message(t('Updated %field from %from to the website email address %to.', [
              '%field' => $field_instance['label'],
              '%from' => $current_care,
              '%to' => $drupal_email,
            ]));
          }
        }
      }
      else {
        // Copy across as new value if no existing value.
        $data = [
          'communication_number' => 0,
          'email' => $drupal_email,
          'device_code' => $device_code_default,
          'device_default' => 1,
          'local_unsent_changes' => CARE_FIELDS_CHANGED,
        ];
        $email_field->set($data);
        // Save fields without saving the parent user.
        if ($account->uid != 0) {
          field_attach_update('user', $account);
        }
        if (variable_get('care_user_rules_messages', TRUE)) {
          drupal_set_message(t('Updated %field to the website email address %to.', [
            '%field' => $field_instance['label'],
            '%to' => $drupal_email,
          ]));
        }
      }
    }
  }
}

/**
 * Rule action to copy CARE email into Drupal mail for account.
 */
function care_user_care_email_field_to_drupal_mail($account) {
  watchdog('care_user', 'care_user_care_email_field_to_drupal_mail for %user', [
    '%user' => $account->name,
  ]);
  if ($account->uid) {
    $care_user = new CareUser($account);
    $email_field = $care_user->getEmailField();
    if ($email_field && $email_field->value()) {
      $drupal_email = $account->mail;
      $field_info = field_info_field(variable_get('care_user_email_field', ''));
      $multiple_value_field = ($field_info['cardinality'] == '-1');
      if ($multiple_value_field) {
        // Copy first entry to Drupal mail.
        $care_email = $email_field[0]->email->value();
        if ($care_email != $drupal_email) {
          $account->mail = $care_email;
          // Update database without calling save hooks.
          drupal_write_record('users', $account, 'uid');
          // Clear the static loading cache.
          entity_get_controller('user')->resetCache([
            $account->uid,
          ]);
          if (variable_get('care_user_rules_messages', TRUE)) {
            drupal_set_message(t('Website account email address updated from %from to %to', [
              '%from' => $drupal_email,
              '%to' => $care_email,
            ]));
          }
        }
      }
      else {
        // Copy to Drupal mail.
        $care_email = $email_field->email->value();
        if ($care_email != $drupal_email) {
          $account->mail = $care_email;
          // Update database without calling save hooks.
          drupal_write_record('users', $account, 'uid');
          // Clear the static loading cache.
          entity_get_controller('user')->resetCache([
            $account->uid,
          ]);
          if (variable_get('care_user_rules_messages', TRUE)) {
            drupal_set_message(t('Website account email address updated from %from to %to', [
              '%from' => $drupal_email,
              '%to' => $care_email,
            ]));
          }
        }
      }
    }
  }
}