Drupal example source code file (uc_attribute.ca.inc)

This example Drupal source code file (uc_attribute.ca.inc) is included in the DevDaily.com "Drupal Source Code Warehouse" project. The intent of this project is to help you "Learn Drupal by Example".

PHP - Drupal tags/keywords

array, as, attributes, function, if, isset, option, options, order, php, product, result, return, title

The uc_attribute.ca.inc Drupal example source code

<?php
// $Id: uc_attribute.ca.inc,v 1.1.2.2 2009/07/21 14:37:21 islandusurper Exp $

/**
 * @file
 * Conditional Actions file for Ubercart attributes.
 */

/**
 * Implementation of hook_ca_condition().
 */
function uc_attribute_ca_condition() {
  $conditions = array();

  $conditions['uc_attribute_ordered_product_option'] = array(
    '#title' => t('Order has a product with a particular attribute option'),
    '#description' => t('Search the products of an order for a particular option.'),
    '#category' => t('Order: Product'),
    '#callback' => 'uc_attribute_condition_ordered_product_option',
    '#arguments' => array(
      'order' => array('#entity' => 'uc_order', '#title' => t('Order')),
    ),
  );

  return $conditions;
}

/**
 * Return TRUE if a product in the given order has the selected option.
 *
 * @see uc_attribute_condition_ordered_product_option_form()
 */
function uc_attribute_condition_ordered_product_option($order, $settings) {
  $result = FALSE;

  $match = unserialize($settings['attribute_option']);

  foreach ($order->products as $product) {
    if (!isset($product->data['attributes'])) {
      continue;
    }

    $attributes = $product->data['attributes'];

    // Once the order is made, the attribute data is changed to just the names.
    // If we can't find it by ID, check the names.
    if (is_int(key($attributes))) {
      if (in_array($settings['attribute_option'], $attributes)) {
        $result = TRUE;
        break;
      }
    }
    else {
      // Load the attribute data once, only if we need it.
      if (!isset($option)) {
        if ($option = uc_attribute_option_load($settings['attribute_option'])) {
          $attribute = uc_attribute_load($option->aid);
        }
      }

      if ($attribute) {
        if (isset($attributes[$attribute->name]) && $attributes[$attribute->name] == $option->name) {
          $result = TRUE;
          break;
        }
      }
    }
  }

  return $result;
}

/**
 * @see uc_attribute_condition_ordered_product_option()
 */
function uc_attribute_condition_ordered_product_option_form($form_state, $settings = array()) {
  $form = array();

  $options = array();
  $result = db_query("SELECT a.aid, a.name AS attr_name, a.ordering, o.oid, o.name AS opt_name, o.ordering FROM {uc_attributes} AS a JOIN {uc_attribute_options} AS o ON a.aid = o.aid ORDER BY a.ordering, o.ordering");
  while ($option = db_fetch_object($result)) {
    $options[$option->attr_name][$option->oid] = $option->opt_name;
  }

  $form['attribute_option'] = array(
    '#type' => 'select',
    '#title' => t('Attribute option'),
    '#default_value' => $settings['attribute_option'],
    '#options' => $options,
  );

  return $form;
}