commerce_multicurrency.rules.inc in Commerce Multicurrency 7

Commerce Multicurrency rules integration.

File

commerce_multicurrency.rules.inc

<?php

/**
 * @file
 * Commerce Multicurrency rules integration.
 */

/**
 * Implements hook_rules_event_info().
 */
function commerce_multicurrency_rules_event_info() {
  $events = array();
  $events['commerce_multicurrency_user_currency_set'] = array(
    'label' => t('After the user currency has been set'),
    'group' => t('Commerce Multicurrency'),
    'variables' => array(
      'currency_code' => array(
        'type' => 'text',
        'label' => t('The currency code to use'),
      ),
      'old_currency_code' => array(
        'type' => 'text',
        'label' => t('The currency code used before'),
      ),
    ),
    'access callback' => 'commerce_order_rules_access',
  );
  $events['commerce_multicurrency_set_display_price'] = array(
    'label' => t('Set the display price'),
    'group' => t('Commerce Multicurrency'),
    'variables' => array(
      'commerce_line_item' => array(
        'label' => t('Product line item'),
        'type' => 'commerce_line_item',
        'skip save' => TRUE,
      ),
      'field_name' => array(
        'type' => 'text',
        'label' => t('The name of the handled price field.'),
        'skip save' => TRUE,
      ),
    ),
    'access callback' => 'commerce_order_rules_access',
  );
  return $events;
}

/**
 * Implements hook_rules_action_info().
 */
function commerce_multicurrency_rules_action_info() {
  $actions = array();

  // Register method to set currency code as rules action.
  $actions['commerce_multicurrency_set_user_currency_code'] = array(
    'label' => t('Set the user currency to use'),
    'parameter' => array(
      'currency_code' => array(
        'type' => 'text',
        'label' => t('The currency code to use'),
        'options list' => 'commerce_currency_code_options_list',
        'save' => FALSE,
      ),
      'overwrite_cookie' => array(
        'type' => 'boolean',
        'label' => t("Set currency even if it's defined in a cookie."),
        'optional' => TRUE,
        'default value' => TRUE,
        'save' => FALSE,
      ),
    ),
    'group' => t('Commerce Multicurrency'),
  );

  // Register method to make a simple currency conversion.
  $actions['commerce_multicurrency_currency_conversion'] = array(
    'label' => t('Convert price to another currency'),
    'parameter' => array(
      'commerce_price' => array(
        'type' => 'commerce_price',
        'label' => t('The commerce price to use'),
        'save' => FALSE,
      ),
      'currency' => array(
        'type' => 'text',
        'label' => t('The target currency'),
        'options list' => 'commerce_currency_code_options_list',
        'save' => FALSE,
      ),
    ),
    'provides' => array(
      'result' => array(
        'type' => 'commerce_price',
        'label' => t('Converted price'),
      ),
    ),
    'group' => t('Commerce Multicurrency'),
  );
  return $actions;
}

/**
 * Rules Action Callback: Convert price to another currency.
 */
function commerce_multicurrency_currency_conversion($commerce_price, $currency) {
  $commerce_price['amount'] = commerce_currency_convert($commerce_price['amount'], $commerce_price['currency_code'], $currency);
  $commerce_price['currency_code'] = $currency;
  return array(
    'result' => $commerce_price,
  );
}

Functions

Name	Description
commerce_multicurrency_currency_conversion	Rules Action Callback: Convert price to another currency.
commerce_multicurrency_rules_action_info	Implements hook_rules_action_info().
commerce_multicurrency_rules_event_info	Implements hook_rules_event_info().