commerce_checkout.rules.inc in Commerce Core 7

Rules integration for the checkout process.

File

modules/checkout/commerce_checkout.rules.inc

<?php

/**
 * @file
 * Rules integration for the checkout process.
 *
 * @addtogroup rules
 * @{
 */

/**
 * Implements hook_rules_event_info().
 */
function commerce_checkout_rules_event_info() {
  $events = array();
  $events['commerce_checkout_complete'] = array(
    'label' => t('Completing the checkout process'),
    'group' => t('Commerce Checkout'),
    'variables' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Completed order', array(), array(
          'context' => 'a drupal commerce order',
        )),
      ),
    ),
    'access callback' => 'commerce_order_rules_access',
  );
  return $events;
}

/**
 * Implements hook_rules_action_info().
 */
function commerce_checkout_rules_action_info() {
  $actions = array();
  $actions['send_account_email'] = array(
    'label' => t('Send account e-mail'),
    'parameter' => array(
      'account' => array(
        'type' => 'user',
        'label' => t('Account'),
      ),
      'email_type' => array(
        'type' => 'text',
        'label' => t('E-mail type'),
        'description' => t("Select the e-mail based on your site's account settings to send to the user."),
        'options list' => 'commerce_checkout_account_email_options_list',
      ),
    ),
    'group' => t('User'),
    'base' => 'commerce_checkout_action_send_account_email',
    'access callback' => 'rules_system_integration_access',
  );
  $actions['commerce_checkout_complete'] = array(
    'label' => t('Complete checkout for an order'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Order in checkout'),
      ),
    ),
    'group' => t('Commerce Checkout'),
    'callbacks' => array(
      'execute' => 'commerce_checkout_rules_complete_checkout',
    ),
  );
  return $actions;
}

/**
 * Returns the account e-mail types from the User module.
 *
 * @see _user_mail_notify()
 */
function commerce_checkout_account_email_options_list() {
  return array(
    'register_admin_created' => t('Welcome (new user created by administrator)'),
    'register_no_approval_required' => t('Welcome (no approval required)'),
    'register_pending_approval' => t('Welcome (awaiting approval)'),
    'password_reset' => t('Password recovery'),
    'status_activated' => t('Account activation'),
    'status_blocked' => t('Account blocked'),
    'cancel_confirm' => t('Account cancellation confirmation'),
    'status_canceled' => t('Account canceled'),
  );
}

/**
 * Action callback: sends a selected account e-mail.
 */
function commerce_checkout_action_send_account_email($account, $email_type) {

  // If we received an authenticated user account...
  if (!empty($account)) {
    $types = commerce_checkout_account_email_options_list();

    // Attempt to send the account e-mail.
    $result = _user_mail_notify($email_type, $account);

    // Log the success or failure.
    if ($result) {
      watchdog('rules', '%type e-mail sent to %recipient.', array(
        '%type' => $types[$email_type],
        '%recipient' => $account->mail,
      ));
    }
    else {
      watchdog('rules', 'Failed to send %type e-mail to %recipient.', array(
        '%type' => $types[$email_type],
        '%recipient' => $account->mail,
      ));
    }
  }
}

/**
 * Action callback: completes checkout for the given order.
 */
function commerce_checkout_rules_complete_checkout($order) {
  commerce_checkout_complete($order);
}

/**
 * @}
 */

Functions

Name	Description
commerce_checkout_account_email_options_list	Returns the account e-mail types from the User module.
commerce_checkout_action_send_account_email	Action callback: sends a selected account e-mail.
commerce_checkout_rules_action_info	Implements hook_rules_action_info().
commerce_checkout_rules_complete_checkout	Action callback: completes checkout for the given order.
commerce_checkout_rules_event_info	Implements hook_rules_event_info().