commerce_registration.rules.inc in Commerce Registration 7.2

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.'),
      ),
    ),
  );
  $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',
    ),
  );
  return $conditions;
}

/**
 * Implements hook_rules_action_info().
 */
function commerce_registration_rules_action_info() {
  $actions = array();
  $actions['commerce_registration_set_state'] = array(
    'label' => t('Set all Registrations to a specific state'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('All registrations on this order will have their state changed.'),
      ),
      'registration_state' => array(
        'type' => 'text',
        'label' => t('Registration State'),
        'description' => t('Registrations will be set to this state.'),
        'options list' => 'commerce_registration_get_states',
      ),
    ),
  );
  $actions['commerce_registration_delete_registrations'] = array(
    'label' => t('Delete all registrations on an Order'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('All registrations on this order will be deleted.'),
      ),
    ),
  );
  $actions['commerce_registration_add_author_uid'] = array(
    'label' => t('Add UID of User created during Checkout to Registration'),
    'group' => t('Commerce Registration'),
    'parameter' => array(
      'commerce_order' => array(
        'type' => 'commerce_order',
        'label' => t('Commerce Order'),
        'description' => t('The registration on this order that was set for "Myself" will have the User ID added as author.'),
      ),
    ),
  );
  $actions['commerce_registration_load_product_registrations'] = array(
    'label' => t('Load all registrations associated with a 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 for which to load all associated registrations.'),
      ),
    ),
    'provides' => array(
      'line_item_registrations' => array(
        'type' => 'list<registration>',
        'label' => t('Line item registrations'),
      ),
    ),
  );
  return $actions;
}

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

/**
 * Condition callback.
 *
 * Checks the commerce line item to see if the product is register enabled.
 *
 * @param CommerceLineItem $line_item
 *   The Commerce Line Item to check for a register enabled product.
 *
 * @return bool
 *   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);
  if (!in_array($line_item_wrapper->type
    ->value(), commerce_product_line_item_types())) {
    return FALSE;
  }
  $id = $line_item_wrapper->commerce_product->product_id
    ->value();
  $settings = registration_entity_settings('commerce_product', $id);
  return !empty($settings);
}

/**
 * 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 CommerceLineItem $line_item
 *   Commerce Line Item to check the product for registration capacity.
 *
 * @return bool
 *   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);
  if (!in_array($line_item_wrapper->type
    ->value(), commerce_product_line_item_types())) {
    return FALSE;
  }
  $id = $line_item_wrapper->commerce_product->product_id
    ->value();
  $settings = registration_entity_settings('commerce_product', $id);
  if (empty($settings)) {
    return FALSE;
  }
  $quantity = $line_item_wrapper->quantity
    ->value();
  return $settings['status'] && registration_has_room('commerce_product', $id, $quantity);
}

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

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

/**
 * Action callback.
 *
 * Sets all registrations on an order to a given state.
 */
function commerce_registration_set_state($order, $registration_state) {

  // The rules action specifies this parameter, but it can be a multiple
  // for some reason. The majority of the time it will be a single string
  if (is_array($registration_state)) {
    $registration_state = reset($registration_state);
  }
  $regs = db_select('registration', 'r')
    ->fields('r')
    ->condition('order_id', $order->order_id)
    ->execute();
  foreach ($regs as $row) {
    $registration = registration_load($row->registration_id);
    $registration->state = $registration_state;
    registration_save($registration);
  }
}

/**
 * Action callback.
 *
 * Deletes all registrations on an order.
 */
function commerce_registration_delete_registrations($order) {
  $regs = db_select('registration', 'r')
    ->fields('r')
    ->condition('order_id', $order->order_id)
    ->execute();
  $registration_ids = array();
  foreach ($regs as $row) {
    $registration_ids[] = $row->registration_id;
  }
  registration_delete_multiple($registration_ids);
  if (isset($order->data['register_entities'])) {
    unset($order->data['register_entities']);
  }
  commerce_order_save($order);
}

/**
 * Action callback.
 *
 * Deletes all registrations on an order for a given line item.
 */
function commerce_registration_delete_lineitem_registration($lineitem) {
  $wrapper = entity_metadata_wrapper('commerce_line_item', $lineitem);
  $order = $wrapper->commerce_order
    ->value();
  if (in_array($wrapper->type
    ->value(), commerce_product_line_item_types())) {
    $product = $wrapper->commerce_product
      ->value();
    $line_item_id = $wrapper->line_item_id
      ->value();
    $key = $line_item_id . 'prod-' . $product->sku
      ->value();
    if (isset($order->data['register_entities']) && isset($order->data['register_entities'][$key])) {
      unset($order->data['register_entities'][$key]);
    }
  }
  commerce_order_save($order);
}

/**
 * Action callback
 *
 * Adds a uid as the author_uid on a registration.
 */
function commerce_registration_add_author_uid($order) {

  // Get all registrations that are from this order id and have 0 for the author_id
  // and do not have an anon_mail set. This indicates that they selected "myself" as
  // the person the registration is for so they did not have the opportunity to set the anon_mail field value.
  $regs = db_select('registration', 'r')
    ->fields('r')
    ->condition('order_id', $order->order_id)
    ->condition('author_uid', 0)
    ->execute();

  // Set the author_uid to the uid on the order for the orders registrations.
  foreach ($regs as $row) {
    $registration = registration_load($row->registration_id);
    $registration->author_uid = $order->uid;

    // If the order's email is the same as this registration's email then associate the user to this registration.
    if ($registration->anon_mail == $order->mail) {
      $registration->user_uid = $order->uid;
    }
    registration_save($registration);
  }
}

/**
 * Action callback.
 *
 * Loads all registrations associated with a commerce line item's product.
 *
 * @param CommerceLineItem $line_item
 *   The Commerce Line Item for which to return all associated registrations.
 *
 * @return array
 *   A list of registrations.
 */
function commerce_registration_load_product_registrations($line_item) {
  $entities = array();
  $line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $line_item);
  if (in_array($line_item_wrapper->type
    ->value(), commerce_product_line_item_types())) {
    $product_id = $line_item_wrapper->commerce_product->product_id
      ->value();
    $query = new EntityFieldQuery();
    $result = $query
      ->entityCondition('entity_type', 'registration')
      ->propertyCondition('entity_type', 'commerce_product')
      ->propertyCondition('entity_id', $product_id)
      ->propertyCondition('order_id', $line_item->order_id)
      ->propertyOrderBy('registration_id', 'asc')
      ->execute();
    if (!empty($result['registration'])) {
      $entities = entity_load('registration', array_keys($result['registration']));
      if (!$entities) {
        throw new RulesEvaluationException('Unable to load registrations associated with line item "@id" on order "@oid"', array(
          '@id' => $line_item->line_item_id,
          '@oid' => $line_item->order_id,
        ));
      }
    }
  }
  return array(
    'line_item_registrations' => $entities ? array_values($entities) : array(),
  );
}

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

/**
 * Rules helper. Return options list of registration states.
 */
function commerce_registration_get_states() {
  $states = registration_states();
  foreach ($states as $state) {
    $options[$state->name] = $state->label;
  }
  return $options;
}

Functions

Name	Description
commerce_registration_add_author_uid	Action callback
commerce_registration_delete_lineitem_registration	Action callback.
commerce_registration_delete_registrations	Action callback.
commerce_registration_get_states	Rules helper. Return options list of registration states.
commerce_registration_item_can_register	Condition callback.
commerce_registration_load_product_registrations	Action callback.
commerce_registration_order_has_registration	Condition callback.
commerce_registration_rules_action_info	Implements hook_rules_action_info().
commerce_registration_rules_condition_info	Implements hook_rules_condition_info().
commerce_registration_set_state	Action callback.