uc_taxes.ca.inc in Ubercart 6.2

This file contains the Conditional Action hooks and functions necessary to make the tax related entity, conditions, events, and actions work.

File

uc_taxes/uc_taxes.ca.inc

<?php

/**
 * @file
 * This file contains the Conditional Action hooks and functions necessary to
 * make the tax related entity, conditions, events, and actions work.
 */

/******************************************************************************
 * Conditional Action Hooks                                                   *
 ******************************************************************************/

/**
 * Implements hook_ca_entity().
 */
function uc_taxes_ca_entity() {
  $entities['tax'] = array(
    '#title' => t('Tax rule'),
    '#type' => 'object',
  );
  return $entities;
}

/**
 * Implements hook_ca_trigger().
 *
 * Registers an event for each tax rule in {uc_taxes}.
 */
function uc_taxes_ca_trigger() {
  $triggers = array();
  $triggers['calculate_taxes'] = array(
    '#title' => t('Calculate taxes'),
    '#category' => t('Taxes'),
    '#arguments' => array(
      'order' => array(
        '#entity' => 'uc_order',
        '#title' => t('Order'),
      ),
      'tax' => array(
        '#entity' => 'tax',
        '#title' => t('Tax rule'),
      ),
      'account' => array(
        '#entity' => 'user',
        '#title' => t('User account'),
      ),
    ),
  );
  return $triggers;
}

/**
 * Implements hook_action_info().
 */
function uc_taxes_ca_action() {
  $actions = array();

  // Loop through all the defined tax rates.
  foreach (uc_taxes_rate_load() as $rate) {
    $actions['uc_taxes_action_apply_tax_' . $rate->id] = array(
      '#title' => t('Apply !name', array(
        '!name' => $rate->name,
      )),
      '#category' => t('Taxes'),
      '#callback' => 'uc_taxes_action_apply_tax',
      '#arguments' => array(
        'order' => array(
          '#entity' => 'uc_order',
          '#title' => t('Order'),
        ),
        'tax' => array(
          '#entity' => 'tax',
          '#title' => t('Tax'),
        ),
      ),
    );
  }
  return $actions;
}

/**
 * Action callback to calculate a tax.
 *
 * @param $order
 *   The order object being considered.
 * @param $tax
 *   The tax rule calculating the amount.
 * @return
 *   The line item array representing the amount of tax.
 */
function uc_taxes_action_apply_tax($order, $tax) {
  return uc_taxes_apply_tax($order, $tax);
}

/**
 * Implements hook_ca_predicate().
 *
 * Create a predicate for each event corresponding to a tax rule.
 */
function uc_taxes_ca_predicate() {
  $predicates = array();

  // Loop through all the defined tax rates.
  foreach (uc_taxes_rate_load() as $rate) {
    $predicates['uc_taxes_' . $rate->id] = array(
      '#title' => $rate->name,
      '#class' => 'taxes',
      '#trigger' => 'calculate_taxes',
      '#status' => 1,
      '#actions' => array(
        array(
          '#name' => 'uc_taxes_action_apply_tax_' . $rate->id,
          '#title' => t('Apply !name', array(
            '!name' => $rate->name,
          )),
          '#argument_map' => array(
            'order' => 'order',
            'tax' => 'tax',
          ),
        ),
      ),
    );
  }
  return $predicates;
}

Functions

Name	Description
uc_taxes_action_apply_tax	Action callback to calculate a tax.
uc_taxes_ca_action	Implements hook_action_info().
uc_taxes_ca_entity	Implements hook_ca_entity().
uc_taxes_ca_predicate	Implements hook_ca_predicate().
uc_taxes_ca_trigger	Implements hook_ca_trigger().