commerce_registration.rules.inc in Commerce Registration 7

Commerce Registration rules file.

File

commerce_registration.rules.inc

<?php

/**
 * @file
 *   Commerce Registration rules file.
 */

/**
 * Implements hook_rules_condition_info().
 */
function commerce_registration_rules_condition_info() {
  $conditions = array();
  $conditions['commerce_registration_order_has_registration'] = array(
    'label' => t('Line Item product is register enabled.'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item that should be checked for a register enabled product.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_order_has_registration',
    ),
  );
  $conditions['commerce_registration_multiple_product_types_allowed'] = array(
    'label' => t('Order contains only specific product types.'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('The Commerce Order whose line items should be checked for allowed product types.'),
      ),
      'product_types' => array(
        'type' => 'list<text>',
        'label' => t('Product Types'),
        'description' => t('The product types to allow in the cart.'),
        'options list' => 'commerce_registration_product_types',
        'restriction' => 'input',
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_order_product_types_allowed',
    ),
  );
  $conditions['commerce_registration_item_has_registration_capacity'] = array(
    'label' => t('Product is available for registration'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item containing the product to check if registrations are available. Checks open date, closing date, and capacity.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_item_can_register',
    ),
  );
  $conditions['commerce_registration_line_item_is_waitlist'] = array(
    'label' => t('Line Item type is waitlist'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item to check the line item type.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_line_item_is_waitlist',
    ),
  );
  $conditions['commerce_registration_line_item_is_on_waitlist'] = array(
    'label' => t('Product is already on the waitlist'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item to check for an existing wait list line item.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_line_item_is_on_waitlist',
    ),
  );
  $conditions['commerce_registration_can_be_waitlisted'] = array(
    'label' => t('Product has a waitlist'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item to check if the product can be put on a waitlist.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_can_be_waitlisted',
    ),
  );
  return $conditions;
}

/**
 * Implements hook_rules_action_info().
 */
function commerce_registration_rules_action_info() {
  $actions = array();
  $actions['commerce_registration_mark_registrations_paid'] = array(
    'label' => t('Mark Commerce Registrations as paid'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('The Commerce Order to mark all attached registrations as paid.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_mark_paid',
    ),
  );
  $actions['commerce_registration_cancel_registrations'] = array(
    'label' => t('Cancel all Commerce Registrations'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('The Commerce Order to cancel all attached registrations'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_cancel_registrations',
    ),
  );

  // Waitlist actions
  $actions['commerce_registration_move_to_waitlist'] = array(
    'label' => t('Move product to waitlist'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item containing the product to add to the waitlist.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_move_to_waitlist',
    ),
  );
  $actions['commerce_registration_waitlist_to_cart'] = array(
    'label' => t('Move product from waitlist to cart'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item containing the waitlist product to move back to the cart.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_waitlist_to_cart',
    ),
  );
  $actions['commerce_registration_delete_line_item'] = array(
    'label' => t('Delete the line item'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_line_item' => array(
        'type' => 'commerce_line_item',
        'label' => t('Commerce Line Item'),
        'description' => t('The Commerce Line Item to delete.'),
      ),
    ),
    'callbacks' => array(
      'execute' => 'commerce_registration_delete_line_item',
    ),
  );
  return $actions;
}

/**
 * @defgroup commerce_registration_rules_conditions Commerce Registration Rules Conditions
 * @{
 * Condition callbacks for Commerce Registration rules.
 */

/**
 * Condition callback.
 *
 * Checks if the line item is a waitlist line item.
 */
function commerce_registration_line_item_is_waitlist($line_item) {
  return $line_item->type == 'waitlist' ? TRUE : FALSE;
}

/**
 * Condition callback.
 *
 * Checks the commerce line item to see if the product is register enabled.
 *
 * @param $line_item
 *   The Commerce Line Item to check for a register enabled product.
 * @return
 *   Boolean TRUE if the line item product is register enabled.
 */
function commerce_registration_order_has_registration($line_item) {
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $type = $line_item_wrapper->commerce_product->type
    ->value();
  $id = $line_item_wrapper->commerce_product->product_id
    ->value();
  $can_register = registration_entity_registration_status(array(
    'id' => $id,
    'type' => 'commerce_product',
    'bundle' => $type,
  ));
  if ($can_register == 1) {
    return TRUE;
  }
  return FALSE;
}

/**
 * Condition callback.
 *
 * Checks if the line item product has registration capacity left. Capacity is
 * only taken if an order is paid for in full.
 *
 * @param $line_item
 *   Commerce Line Item to check the product for registration capacity.
 *
 * @return
 *   Boolean TRUE if the product has registration capacity.
 */
function commerce_registration_item_can_register($line_item) {
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $entity = array(
    'id' => $line_item_wrapper->commerce_product->product_id
      ->value(),
    'type' => 'commerce_product',
    'bundle' => $line_item_wrapper->commerce_product->type
      ->value(),
  );
  $settings = registration_entity_settings($entity);
  if (!is_array($settings)) {
    $settings = unserialize($settings);
  }
  $capacity = $settings['settings']['capacity'];
  $startdate = $settings['settings']['open_date'];
  $enddate = $settings['settings']['close_date'];

  // $datesOk checks to make sure we are within the date range of registration.
  $datesOk = FALSE;

  // We first check to see if a date is even set for opening and closing
  // If not, then registrations are open always.
  if ($enddate == 0 && $startdate == 0) {
    $datesOk = TRUE;
  }
  else {
    if (REQUEST_TIME >= $startdate && REQUEST_TIME <= $enddate) {
      $datesOk = TRUE;
    }
  }

  // Next we see if we are within the opening and closing dates, or if they are
  // always open.
  if ($datesOk) {
    if ($capacity != 0) {
      $avail = registration_entity_slots_available($entity);
      if ($avail > 0) {

        // If there are slots available, we see if the quantity puts us beyond
        // the capacity.
        if ($line_item_wrapper->quantity
          ->value() > $avail) {

          // The quantity requested is greater than available slots.
          return FALSE;
        }

        // There are slots available for the requested quantity.
        return TRUE;
      }
      else {

        // There are no slots available.
        return FALSE;
      }
    }
    else {

      // No registration capacity set. Always allow.
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * Condition callback.
 *
 * Checks the commerce order to see if the line items have products that are in
 * the allowed products list.
 *
 * @param $order
 *   The Commerce Order whose line items will be reviewed.
 * @param $types
 *   Array of machine names of allowed product types.
 * @return
 *   Boolean FALSE if any product type is not in the allowed products list.
 */
function commerce_registration_order_product_types_allowed($order, $types) {
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
  foreach ($order_wrapper->commerce_line_items as $delta => $line_item_wrapper) {
    $type = $line_item_wrapper->commerce_product->type
      ->value();
    if (!in_array($type, $types)) {
      return FALSE;
    }
  }
  return TRUE;
}

/**
 * Condition callback.
 *
 * Checks for an existing line item of the same product.
 */
function commerce_registration_line_item_is_on_waitlist($line_item) {
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $order = commerce_order_load($line_item_wrapper->order_id
    ->value());
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
  foreach ($order_wrapper->commerce_line_items as $delta => $combine_line_item_wrapper) {

    // If this line item matches the product being added...
    if ($combine_line_item_wrapper->type
      ->value() == 'waitlist' && $combine_line_item_wrapper->commerce_product->product_id
      ->value() == $line_item_wrapper->commerce_product->product_id
      ->value()) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * Condition callback.
 *
 * Checks if the line item product can be put on a waitlist.
 */
function commerce_registration_can_be_waitlisted($line_item) {
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $info = array(
    'id' => $line_item_wrapper->commerce_product->product_id
      ->value(),
    'type' => 'commerce_product',
    'bundle' => $line_item_wrapper->commerce_product->type
      ->value(),
  );
  $settings = registration_entity_settings($info);
  return !empty($settings) && isset($settings['settings']) ? $settings['settings']['waitlist'] : FALSE;
}

/**
 * @} End of "defgroup commerce_registration_rules_conditions".
 */

/**
 * @defgroup commerce_registration_rules_actions Commerce Registration Rules Actions
 * @{
 * Action callbacks for Commerce Registration rules.
 */

/**
 * Action callback.
 *
 * Marks all registrations on a particular order as paid.
 *
 * @param $order
 *   The Commerce Order object to mark all attached registrations as paid.
 * @todo Custom status definitions.
 */
function commerce_registration_mark_paid($order) {
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
  foreach ($order_wrapper->commerce_line_items as $delta => $line_item_wrapper) {
    $type = $line_item_wrapper->commerce_product->type
      ->value();
    $id = $line_item_wrapper->commerce_product->product_id
      ->value();
    $can_register = registration_entity_registration_status(array(
      'id' => $id,
      'type' => 'commerce_product',
      'bundle' => $type,
    ));
    if ($can_register == 1) {
      $product = $line_item_wrapper->commerce_product;
      $quantity = (int) $line_item_wrapper->quantity
        ->value();
      for ($i = 0; $i < $quantity; $i++) {
        $entity = $order->data['register_entities']['prod-' . $product->sku
          ->value()][$i];

        // we set status to confirm for PAID and save the entity
        $entity->status = 'confirm';
        entity_save('registration', $entity);
      }
    }
  }
}

/**
 * Action callback.
 *
 * Cancels all registrations on a particular order.
 *
 * @param $order
 *   The Commerce Order object to cancel all attached registrations.
 */
function commerce_registration_cancel_registrations($order) {
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);
  foreach ($order_wrapper->commerce_line_items as $delta => $line_item_wrapper) {
    $type = $line_item_wrapper->commerce_product->type
      ->value();
    $id = $line_item_wrapper->commerce_product->product_id
      ->value();
    $can_register = registration_entity_registration_status(array(
      'id' => $id,
      'type' => 'commerce_product',
      'bundle' => $type,
    ));
    if ($can_register == 1) {
      $product = $line_item_wrapper->commerce_product;
      $quantity = (int) $line_item_wrapper->quantity
        ->value();
      for ($i = 0; $i < $quantity; $i++) {
        $entity = $order->data['register_entities']['prod-' . $product->sku
          ->value()][$i];

        // notify field api that the entity was deleted
        field_attach_delete('registration', $entity);
        entity_delete('registration', $entity->registration_id);
      }
    }
  }
}

/**
 * Action callback.
 *
 * Creates a new waitlist line item from an existing line item.
 *
 * Combines identical products on to a single line item.
 * @param $line_item
 *   Commerce Line Item that we are moving to a waitlist.
 */
function commerce_registration_move_to_waitlist($line_item) {
  if (!isset($line_item)) {
    return;
  }
  $line_item->type = 'waitlist';
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $order = commerce_order_load($line_item_wrapper->order_id
    ->value());
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);

  // We search for an existing line item of the same product to possibly
  // combine with.
  $combine_line_item = NULL;
  foreach ($order_wrapper->commerce_line_items as $delta => $combine_line_item_wrapper) {

    // If this line item matches the product being added...
    if (empty($combine_line_item) && $combine_line_item_wrapper->type
      ->value() == 'waitlist' && $combine_line_item_wrapper->commerce_product->product_id
      ->value() == $line_item_wrapper->commerce_product->product_id
      ->value()) {
      $combine_line_item = $combine_line_item_wrapper
        ->value();
    }
  }
  $new_line_item = clone $line_item;
  $new_line_item->type = 'waitlist';
  unset($new_line_item->line_item_id);
  if (!empty($combine_line_item)) {

    // Existing waitlist item, so we add it's quantity to our new line_item.
    $new_line_item->quantity += $combine_line_item->quantity;
  }

  // Save the new line_item and add it to our order.
  commerce_line_item_save($new_line_item);
  $order_wrapper->commerce_line_items[] = $new_line_item;
  if (!empty($combine_line_item)) {

    // Existing waitlist item, we delete it so we don't have two identical line
    // items.
    $order = commerce_cart_order_product_line_item_delete($order, $combine_line_item->line_item_id);
  }
  commerce_order_save($order);
  return $new_line_item;
}

/**
 * Action callback.
 *
 * Moves the product on the waitlist line item to a normal product line item.
 *
 * @param $line_item
 *   Commerce Line Item that we are moving to a normal product line item.
 */
function commerce_registration_waitlist_to_cart($line_item) {
  if (!isset($line_item)) {
    return;
  }
  $line_item->type = 'product';
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $order = commerce_order_load($line_item_wrapper->order_id
    ->value());
  $order_wrapper = entity_metadata_wrapper('commerce_order', $order);

  // We search for an existing line item of the same product to possibly
  // combine with.
  $combine_line_item = NULL;
  foreach ($order_wrapper->commerce_line_items as $delta => $combine_line_item_wrapper) {

    // If this line item matches the product being added...
    if (empty($combine_line_item) && $combine_line_item_wrapper->type
      ->value() == 'product' && $combine_line_item_wrapper->commerce_product->product_id
      ->value() == $line_item_wrapper->commerce_product->product_id
      ->value()) {
      $combine_line_item = $combine_line_item_wrapper
        ->value();
    }
  }
  $new_line_item = clone $line_item;
  unset($new_line_item->line_item_id);
  if (!empty($combine_line_item)) {

    // Existing waitlist item, so we add it's quantity to our new line_item.
    $new_line_item->quantity += $combine_line_item->quantity;
  }

  // Save the new line_item and add it to our order.
  commerce_line_item_save($new_line_item);
  $order_wrapper->commerce_line_items[] = $new_line_item;
  if (!empty($combine_line_item)) {

    // Existing waitlist item, we delete it so we don't have two identical line
    // items.
    $order = commerce_cart_order_product_line_item_delete($order, $combine_line_item->line_item_id);
    commerce_order_save($order);
  }
  return $new_line_item;
}

/**
 * Action callback.
 *
 * Removes the line item from the order.
 */
function commerce_registration_delete_line_item($line_item) {
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  $order = commerce_order_load($line_item_wrapper->order_id
    ->value());

  // Delete the old line_item.
  $order = commerce_cart_order_product_line_item_delete($order, $line_item->line_item_id);
  commerce_order_save($order);
}

/**
 * @} End of "defgroup commerce_registration_rules_actions".
 */

/**
 * Returns array of product types keyed by machine name.
 */
function commerce_registration_product_types() {
  $product_types = commerce_product_types();
  $types = array();
  foreach ($product_types as $key => $value) {
    $types[$key] = $value['name'];
  }
  return $types;
}

Functions

Name	Description
commerce_registration_cancel_registrations	Action callback.
commerce_registration_can_be_waitlisted	Condition callback.
commerce_registration_delete_line_item	Action callback.
commerce_registration_item_can_register	Condition callback.
commerce_registration_line_item_is_on_waitlist	Condition callback.
commerce_registration_line_item_is_waitlist	Condition callback.
commerce_registration_mark_paid	Action callback.
commerce_registration_move_to_waitlist	Action callback.
commerce_registration_order_has_registration	Condition callback.
commerce_registration_order_product_types_allowed	Condition callback.
commerce_registration_product_types	Returns array of product types keyed by machine name.
commerce_registration_rules_action_info	Implements hook_rules_action_info().
commerce_registration_rules_condition_info	Implements hook_rules_condition_info().
commerce_registration_waitlist_to_cart	Action callback.