uc_coupon.api.php in Ubercart Discount Coupons 7.3

Ubercart Discount Coupon module api/hooks. Version 7.x-2.x

File

uc_coupon.api.php

<?php

/**
 * @file
 * 
 * Ubercart Discount Coupon module api/hooks.
 * Version 7.x-2.x
 */

/**
 * hook_uc_coupon_usage_alter().
 * 
 * Allow modules to alter the usage count for a coupon.
 * 
 * @param $usage
 * 		An associative array consiting of the following keys:
 * 		- 'user' => The number of times this coupon has been used by the specified user.
 * 		- 'codes' => An associative array listing the total number of uses for each code (for all users).
 * @param $cid
 * 		The coupon-id of the coupon in question.
 * @param $uid
 * 		The user-id whose usage is to be checked.
 */
function hook_uc_coupon_usage_alter(&$usage, $cid, $uid) {

  // See if this coupon has been used in our table.
  $rows = db_query('SELECT code, uses FROM {extra_coupon_usage} WHERE cid = :cid', array(
    ':cid' => $cid,
  ));
  foreach ($rows as $row) {
    if (isset($usage[$row->code])) {
      $usage[$row->code] += $row->uses;
    }
    else {
      $usage[$row->code] = $row->uses;
    }
  }
}

/**
 * hook_uc_coupon_actions().
 * 
 * Allows modules to add to the list of actions available when coupons are listed in a table.
 * 
 * @param $coupon
 * 		The coupon being displayed.
 * @return 
 * 		An associative array describing the actions available. Must contain the followoing keys:
 * 		- 'url': The url where the action is processed.
 * 		- 'icon': The icon to display for this action.
 * 		- 'title': The text to display as a title for the action (usually as hover text over the icon).
 */
function hook_uc_coupon_actions($coupon) {
  $actions = array();

  // Provide a "mark coupon as used" action.
  if (user_access('mark coupon as used')) {
    $actions[] = array(
      'url' => 'admin/store/coupons/mark-as-used/' . $coupon->cid,
      'icon' => drupal_get_path('module', 'mymodule') . 'mark_as_used.gif',
      'title' => t('Mark coupon: @name as used', array(
        '@name' => $coupon->name,
      )),
    );
  }
  return $actions;
}

/**
 * hook_uc_coupon_revalidate().
 * 
 * Invoked whenever the coupons added to the current session are about to be validated. 
 * 
 * Modules implementing this hook may add or remove coupon codes from the session via calls to
 * uc_coupon_session_add() or uc_coupon_session_clear().
 * 
 * @param $order
 *   The order against which the coupon will be validated.
 */
function hook_uc_coupon_revalidate($order) {

  // Add a code if there are both a widget and a doohickey in the cart.
  $gotwidget = FALSE;
  $gotdoohickey = FALSE;
  foreach ($order->products as $product) {
    $node = node_load($product->nid);
    if ($node) {
      if ($node->type == 'widget') {
        $gotwidget = TRUE;
      }
      elseif ($node->type == 'doohickey') {
        $gotdoohickey = TRUE;
      }
      if ($gotwidget && $gotdoohickey) {
        uc_coupon_session_add('JACKPOT', 'auto');
        return;
      }
    }
  }
}

/**
 * hook_uc_coupon_apply().
 * 
 * Invoked whenever a valid coupon is applied to an order.  May be invoked than once for the same 
 * coupon if it becomes invalid due to change in cart contents.
 * 
 * Note that you should not do anything in your hoook implementation which causes the
 * current cart contents to be rebuilt.  This includes calls to uc_cart_add_item() without
 * explicitly setting the $rebuild argument to false.  And, since coupons may be submitted
 * on the checkout page after the cart contents are frozen, updates to the cart contents
 * may fail under some circumstances anyway.
 * 
 * @param $coupon
 * 		The fully validated coupon which was applied.
 */
function hook_uc_coupon_apply($coupon) {

  // Grant a role to the active user when a particular coupon is applied.
  // This could be used in conjunction with a node access module to expose products
  // only when certain coupon codes are entered.
  global $user;
  if ($coupon->cid == 99 && $user->uid != 0) {
    $roles = $user->roles + array(
      99 => 'My Special Role',
    );
    user_save($user, array(
      'roles' => $roles,
    ));
  }
}

/**
 * hook_uc_coupon_remove().
 * 
 * Invoked whenever a previously valid coupon is removed.
 * 
 * Note that you should not do anything in your hoook implementation which causes the
 * current cart contents to be rebuilt.  This includes calls to uc_cart_add_item() without
 * explicitly setting the $rebuild argument to false.  And, since coupons may be submitted
 * on the checkout page after the cart contents are frozen, updates to the cart contents
 * may fail under some circumstances anyway.
 * 
 * @param $coupon
 * 		The coupon which was removed.
 */
function hook_uc_coupon_remove($coupon) {

  // Revoke a role for the active user when a particular coupon is removed.
  global $user;
  if ($coupon->cid == 99 && $user->uid != 0) {
    $roles = $user->roles;
    $key = array_search('My Special Role', $roles);
    if ($key !== FALSE) {
      unset($roles[$key]);
      user_save($user, array(
        'roles' => $roles,
      ));
    }
  }
}

/**
 * Add extra validation to a coupon.
 * 
 * @param $coupon
 *   The coupon object to validate, with special fields set as follows:
 *   - $coupon->code: The specific code to be applied (even for bulk coupons).
 *   - $coupon->amount: If $order !== FALSE, the discount that should be applied.
 *   - $coupon->usage: Coupon usage data from uc_coupon_count_usage().
 * @param $order
 *   The order against which this coupon is to be applied, or FALSE to bypass order validation.
 * @param $account
 *   The account of the user trying to use the coupon, or FALSE to bypass user validation.
 *
 * @return
 *   TRUE if the coupon should be accepted.
 *   NULL to allow other modules to determine validation.
 *   Otherwise, a string describing the reason for failure.
 */
function hook_uc_coupon_validate(&$coupon, $order, $account) {

  // Check for allowed combinations.
  if (!empty($order->data['coupons'])) {
    foreach (array_keys($order->data['coupons']) as $code) {
      $other = uc_coupon_find($code);
      $other_listed = !empty($coupon->data['combinations']) && in_array($other->cid, $coupon->data['combinations']);
      $this_ok = (isset($coupon->data['negate_combinations']) xor $other_listed);
      $this_listed = !empty($other->data['combinations']) && in_array($coupon->cid, $other->data['combinations']);
      $other_ok = (isset($other->data['negate_combinations']) xor $this_listed);
      if (!$this_ok || !$other_ok) {
        return t('This coupon combination is not allowed.');
      }
    }
  }

  // Check maximum usage per code.
  if ($coupon->max_uses > 0 && !empty($coupon->usage['codes'][$coupon->code]) && $coupon->usage['codes'][$coupon->code] >= $coupon->max_uses) {
    return t('This coupon has reached the maximum redemption limit.');
  }

  // Check maximum usage per user.
  if ($account && isset($coupon->data['max_uses_per_user']) && $coupon->usage['user'] >= $coupon->data['max_uses_per_user']) {
    return t('This coupon has reached the maximum redemption limit.');
  }

  // Check user ID.
  if ($account && isset($coupon->data['users'])) {
    if (in_array("{$account->uid}", $coupon->data['users'], TRUE) xor !isset($coupon->data['negate_users'])) {
      return t('Your user ID is not allowed to use this coupon.');
    }
  }

  // Check roles.
  if ($account && isset($coupon->data['roles'])) {
    $role_found = FALSE;
    foreach ($coupon->data['roles'] as $role) {
      if (in_array($role, $account->roles)) {
        $role_found = TRUE;
        break;
      }
    }
    if ($role_found xor !isset($coupon->data['negate_roles'])) {
      return t('You do not have the correct permission to use this coupon.');
    }
  }
}

Functions

Name	Description
hook_uc_coupon_actions	hook_uc_coupon_actions().
hook_uc_coupon_apply	hook_uc_coupon_apply().
hook_uc_coupon_remove	hook_uc_coupon_remove().
hook_uc_coupon_revalidate	hook_uc_coupon_revalidate().
hook_uc_coupon_usage_alter	hook_uc_coupon_usage_alter().
hook_uc_coupon_validate	Add extra validation to a coupon.