';
$output .= t('SKU: @sku', array('@sku' => $variables['model']));
$output .= '
';
return $output;
}
/**
* Format a product's body.
*
* @ingroup themeable
*/
function theme_uc_product_body($variables) {
$output = '.
*
* @ingroup themeable
*/
function theme_uc_product_add_to_cart($variables) {
$node = $variables['node'];
$output = '
';
if ($node->nid) {
$form = drupal_get_form('uc_product_add_to_cart_form_' . $node->nid, $node);
}
else {
$form = drupal_get_form('uc_product_add_to_cart_form', $node);
}
$output .= drupal_render($form);
$output .= '
';
return $output;
}
/**
* Form to add the $node product to the cart.
*
* @param $node
* A product node.
*
* @see uc_product_forms()
* @see uc_product_add_to_cart_form_validate()
* @see uc_product_add_to_cart_form_submit()
* @ingroup forms
*/
function uc_product_add_to_cart_form($form, &$form_state, $node) {
$form['nid'] = array('#type' => 'value', '#value' => $node->nid);
if ($node->default_qty > 0 && variable_get('uc_product_add_to_cart_qty', FALSE)) {
$form['qty'] = array('#type' => 'textfield',
'#title' => t('Quantity'),
'#default_value' => $node->default_qty,
'#size' => 5,
'#maxlength' => 6,
);
}
else {
$form['qty'] = array('#type' => 'hidden', '#value' => 1);
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => variable_get('uc_product_add_to_cart_text', t('Add to cart')),
'#id' => 'edit-submit-' . $node->nid,
'#attributes' => array(
'class' => array('node-add-to-cart'),
),
);
$form['node'] = array(
'#type' => 'value',
'#value' => $node,
);
uc_form_alter($form, $form_state, __FUNCTION__);
return $form;
}
/**
* Allows only positive, numeric quantities.
*
* @see uc_product_add_to_cart_form()
*/
function uc_product_add_to_cart_form_validate($form, &$form_state) {
if (!is_numeric($form_state['values']['qty']) || intval($form_state['values']['qty']) <= 0) {
form_set_error('qty', t('You have entered an invalid quantity.'));
}
}
/**
* Form submission handler for uc_product_add_to_cart_form().
*
* @see uc_product_add_to_cart_form()
*/
function uc_product_add_to_cart_form_submit($form, &$form_state) {
$form_state['redirect'] = uc_cart_add_item($form_state['values']['nid'], $form_state['values']['qty'], module_invoke_all('uc_add_to_cart_data', $form_state['values']), NULL, variable_get('uc_cart_add_item_msg', TRUE));
}
/**
* Formats a product's price.
*
* @param $variables
* A render element where: 'element' => array(), and has the following keys:
* - #value: Price to be formated.
* - #attributes: (optional) Array of attributes to apply to enclosing DIV.
* - #title: (optional) Title to be used as label.
*
* @ingroup themeable
*/
function theme_uc_product_price($variables) {
$element = $variables['element'];
$price = $element['#value'];
$attributes = isset($element['#attributes']) ? $element['#attributes'] : array();
$label = isset($element['#title']) ? $element['#title'] : '';
if (isset($attributes['class'])) {
array_unshift($attributes['class'], 'product-info');
}
else {
$attributes['class'] = array('product-info');
}
$output = '
';
if ($label) {
$output .= '' . $label . ' ';
}
$output .= theme('uc_price', array('price' => $price));
$output .= drupal_render_children($element);
$output .= '
';
return $output;
}
/**
* Formats a product's weight.
*
* @ingroup themeable
*/
function theme_uc_product_weight($variables) {
$amount = $variables['amount'];
$units = $variables['units'];
$output = '
';
$output .= t('Weight: !weight', array('!weight' => uc_weight_format($amount, $units)));
$output .= '
';
return $output;
}
/**
* Formats a product's length, width, and height.
*
* @ingroup themeable
*/
function theme_uc_product_dimensions($variables) {
$length = $variables['length'];
$width = $variables['width'];
$height = $variables['height'];
$units = $variables['units'];
$output = '
';
$output .= t('Dimensions: !length × !width × !height', array('!length' => uc_length_format($length, $units), '!width' => uc_length_format($width, $units), '!height' => uc_length_format($height, $units)));
$output .= '
';
return $output;
}
/**
* Formats a product's images with imagecache and an image widget
* (Colorbox, Thickbox, or Lightbox2).
*
* @ingroup themeable
*/
function theme_uc_product_image($variables) {
static $rel_count = 0;
$images = $variables['images'];
// Get the current product image widget.
$image_widget = uc_product_get_image_widget();
$first = array_shift($images);
$output = '
';
$rel_count++;
return $output;
}
/**
* Returns an array of product node types.
*/
function uc_product_types() {
return module_invoke_all('uc_product_types');
}
/**
* Returns an associative array of product node type names keyed by ID.
*/
function uc_product_type_names() {
$names = array();
// Get all the node meta data.
$node_info = module_invoke_all('node_info');
// Loop through each product node type.
foreach (uc_product_types() as $type) {
$names[$type] = $node_info[$type]['name'];
}
return $names;
}
/**
* Determines whether or not a given node or node type is a product.
*
* @param $node
* Either a full node object/array, a node ID, or a node type.
*
* @return
* TRUE or FALSE indicating whether or not a node type is a product node type.
*/
function uc_product_is_product($node) {
// Load the node object if we received an integer as an argument.
if (is_int($node)) {
$node = node_load($node);
}
// Determine the node type based on the data type of $node.
if (is_object($node)) {
$type = $node->type;
}
elseif (is_array($node)) {
$type = $node['type'];
}
elseif (is_string($node)) {
$type = $node;
}
// If no node type was found, go ahead and return FALSE.
if (!$type) {
return FALSE;
}
// Return TRUE or FALSE depending on whether or not the node type is in the
// product types array.
return in_array($type, uc_product_types());
}
/**
* Determines whether or not a given form array is a product node form.
*
* @param $form
* The form array to examine.
*
* @return
* TRUE or FALSE indicating whether or not the form is a product node form.
*/
function uc_product_is_product_form($form) {
return !empty($form['#node_edit_form']) && uc_product_is_product($form['#node']);
}
/**
* Gets all models of a product (node).
*
* Gathers any modules' models on this node, then add the node's SKU and the
* optional 'Any' option.
*
* @param $nid
* The node ID of the product.
* @param $add_blank
* String to use for the initial blank entry. If not desired, set to NULL
* or FALSE. Make sure to localize the string first. Defaults to '- Any -'.
*
* @return
* An associative array of model numbers. The key for '- Any -' is the empty
* string.
*/
function uc_product_get_models($node, $add_blank = TRUE) {
// Get any modules' SKUs on this node.
$models = module_invoke_all('uc_product_models', $node);
// Add the base SKU of the node.
$models[] = $node->model;
// Now we map the SKUs to the keys, for form handling, etc.
$models = drupal_map_assoc($models);
// Sort the SKUs
asort($models);
// And finally, we prepend 'Any' so it's the first option.
if (!empty($add_blank) || $add_blank === '') {
if ($add_blank === TRUE) {
$add_blank = t('- Any -');
}
return array('' => $add_blank) + $models;
}
return $models;
}
/**
* Gets the cost of a product node.
*
* @param $node_id
* nid of the selected node
*
* @return
* float - cost
*/
function uc_product_get_cost($node_id) {
$product = node_load($node_id);
return $product->cost;
}
/**
* Returns an HTML img tag based on a node's attached image.
*
* @param $node_id
* The node's id.
* @param $format
* The imagecache preset used to format the image. 'product' by default.
*
* @return
* An HTML img. When $format is not 'product', the image is a link to the
* 'product_full' preset if a JavaScript display widget is available
* (Colorbox, Thickbox, and Lightbox2 are possible). For other values
* of $format, the image links to the node page.
*/
function uc_product_get_picture($nid, $style = 'uc_product') {
$product = node_load($nid);
return field_view_field('node', $product, 'uc_product_image', array(
'label' => 'hidden',
'type' => 'image',
'settings' => array(
'image_link' => 'content',
'image_style' => $style,
),
), $product->language);
}
/**
* Finds the JavaScript image display module to use on product pages.
*/
function uc_product_get_image_widget() {
static $got_widget = FALSE, $image_widget = array();
// Get the current image widget. (if any)
if (!$got_widget) {
// Invoke hook to find widgets
$image_widgets = uc_store_get_image_widgets();
// Find widget preference, if any
$widget_name = variable_get('uc_product_image_widget', NULL);
if ($widget_name != NULL) {
// Widget to use has been set in admin menu
$image_widget = $image_widgets[$widget_name];
}
else {
// Widget to use has not been chosen, so default to
// first element of array, if any
$keys = array_keys($image_widgets);
if ($keys) {
$image_widget = $image_widgets[$keys[0]];
variable_set('uc_product_image_widget', $keys[0]);
}
}
$got_widget = TRUE;
}
return $image_widget;
}
/**
* Returns HTML for the product description.
*
* Modules adding information use hook_uc_product_description() and modules
* wanting to alter the output before rendering can do so by implementing
* hook_uc_product_description_alter(). By default, all descriptions supplied
* by modules via hook_uc_product_description() are concatenated together.
*
* NOTE: hook_uc_product_description() supercedes the deprecated
* hook_cart_item_description().
*
* @param $product
* Product.
*
* @return
* HTML rendered product description.
*/
function uc_product_get_description($product) {
// Run through implementations of hook_uc_product_description()
$description = module_invoke_all('uc_product_description', $product);
// Now allow alterations via hook_uc_product_description_alter()
drupal_alter('uc_product_description', $description, $product);
return drupal_render($description);
}
/**
* Loads a product class.
*/
function uc_product_class_load($class_id) {
static $classes = array();
if (empty($classes[$class_id])) {
$class = db_query("SELECT * FROM {uc_product_classes} WHERE pcid = :pcid", array(':pcid' => $class_id))->fetchObject();
$classes[$class_id] = $class;
}
return $classes[$class_id];
}
/**
* Returns a bit of data from a product feature array based on the feature ID
* and array key.
*
* @param $fid
* The string ID of the product feature you want to get data from.
* @param $key
* The key in the product feature array you want: title, callback, delete,
* settings.
*
* @return
* The value of the key you specify.
*/
function uc_product_feature_data($fid, $key) {
static $features;
if (empty($features)) {
foreach (module_invoke_all('uc_product_feature') as $feature) {
$features[$feature['id']] = $feature;
}
}
return $features[$fid][$key];
}
/**
* Returns a form array with some default hidden values and submit button.
*
* @param $form
* The form array you wish to add the elements to.
*
* @return
* The form array with elements added for the nid, pfid, submit button, and
* cancel link.
*
* @ingroup forms
*/
function uc_product_feature_form($form, &$form_state, $node, $feature) {
$form['nid'] = array(
'#type' => 'hidden',
'#value' => $node->nid,
);
// Forms to add a feature are only given an empty array.
if (!empty($feature)) {
$form['pfid'] = array(
'#type' => 'hidden',
'#value' => $feature['pfid'],
);
}
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array(
'#type' => 'submit',
'#value' => t('Save feature'),
);
$form['actions']['cancel'] = array(
'#markup' => l(t('Cancel'), 'node/' . $node->nid . '/edit/features'),
);
return $form;
}
/**
* Saves a product feature to a product node.
*
* @param $data
* An array consisting of the following keys:
* - pfid: The numeric ID of the product feature when editing an existing one.
* - nid: The numeric ID of the product node.
* - fid: The string ID of the feature type.
* - description: The string description of the feature for the overview table.
*/
function uc_product_feature_save(&$data) {
if (empty($data['nid']) && arg(0) == 'node' && intval(arg(1)) > 0) {
$data['nid'] = intval(arg(1));
}
if (empty($data['pfid'])) {
if (arg(0) == 'node' && arg(3) == 'features' && intval(arg(5)) > 0) {
$data['pfid'] = intval(arg(5));
}
}
// First attempt to update an existing row.
$result = drupal_write_record('uc_product_features', $data, !empty($data['pfid']) ? 'pfid' : array());
// Otherwise insert this feature as a new row.
if ($result == SAVED_NEW) {
drupal_set_message(t('The product feature has been added.'));
}
elseif ($result == SAVED_UPDATED) {
drupal_set_message(t('The product feature has been updated.'));
}
else {
drupal_set_message(t('The product feature was unable to be saved.'));
}
return 'node/' . $data['nid'] . '/edit/features';
}
/**
* Loads all product feature for a node.
*
* @param $nid
* The product node ID.
*
* @returns
* The array of all product features object.
*/
function uc_product_feature_load_multiple($nid) {
$features = db_query("SELECT * FROM {uc_product_features} WHERE nid = :nid ORDER BY pfid ASC", array(':nid' => $nid))->fetchAllAssoc('pfid');
return $features;
}
/**
* Loads a product feature object.
*
* @todo: should return an object instead of array.
*
* @param $pfid
* The product feature ID.
* @param $fid
* Optional. Specify a specific feature id.
*
* @returns
* The product feature array.
*/
function uc_product_feature_load($pfid) {
$feature = db_query("SELECT * FROM {uc_product_features} WHERE pfid = :pfid", array(':pfid' => $pfid))->fetchAssoc();
return $feature;
}
/**
* Deletes a product feature object.
*
* @param $pfid
* The product feature ID.
*
* @returns
* The product feature object.
*/
function uc_product_feature_delete($pfid) {
$feature = uc_product_feature_load($pfid);
// Call the delete function for this product feature if it exists.
$func = uc_product_feature_data($feature['fid'], 'delete');
if (function_exists($func)) {
$func($feature);
}
db_delete('uc_product_features')
->condition('pfid', $pfid)
->execute();
return SAVED_DELETED;
}
/**
* Creates a file field with an image field widget, and attach it to products.
*
* This field is used by default on the product page, as well as on the cart
* and catalog pages to represent the products they list. Instances are added
* to new product classes, and other node types that claim product-ness should
* call this function for themselves.
*
* @param $type
* The content type to which the image field is to be attached. This may be a
* a single type as a string, or an array of types. If NULL, all product
* types get an instance of the field.
*/
function uc_product_add_default_image_field($type = NULL) {
$field = field_info_field('uc_product_image');
// Set up field if it doesn't exist.
if (!$field) {
$field = array(
'field_name' => 'uc_product_image',
'type' => 'image',
'cardinality' => FIELD_CARDINALITY_UNLIMITED,
);
field_create_field($field);
// Initialize this because field_info_field() would have set it.
$field['bundles'] = array();
}
$label = t('Image');
$new_instance = array(
'entity_type' => 'node',
'label' => $label,
'weight' => -2,
'widget' => array(
'type' => 'image_image',
),
'display' => array(
'full' => array(
'label' => 'hidden',
'type' => 'uc_product_image',
),
'teaser' => array(
'label' => 'hidden',
'type' => 'uc_product_image',
),
),
);
if ($type) {
// Accept single or multiple types as input.
$types = (array) $type;
}
else {
$types = uc_product_types();
}
foreach ($types as $type) {
$new_instance['bundle'] = $type;
$field_name = variable_get('uc_image_' . $type, '');
if (empty($field_name)) {
$field_name = 'uc_product_image';
}
$new_instance['field_name'] = $field_name;
$instance = field_info_instance('node', $field_name, $type);
// Only add the instance if it doesn't exist. Don't overwrite any changes.
if (!$instance) {
field_create_instance($new_instance);
variable_set('uc_image_' . $type, $field_name);
}
}
}
/**
* Implements hook_image_default_styles().
*/
function uc_product_image_default_styles() {
$styles = array();
$styles['uc_product'] = array(
'effects' => array(
array(
'name' => 'image_scale',
'data' => array(
'width' => '100',
'height' => '100',
'upscale' => 0,
),
'weight' => '0',
),
),
);
$styles['uc_product_full'] = array(
'effects' => array(),
);
$styles['uc_product_list'] = array(
'effects' => array(
array(
'name' => 'image_scale',
'data' => array(
'width' => '100',
'height' => '100',
'upscale' => 0,
),
'weight' => '0',
),
),
);
$styles['uc_thumbnail'] = array(
'effects' => array(
array(
'name' => 'image_scale',
'data' => array(
'width' => '35',
'height' => '35',
'upscale' => 0,
),
'weight' => '0',
),
),
);
return $styles;
}
/**
* Implements hook_views_api().
*/
function uc_product_views_api() {
return array(
'api' => '2.0',
'path' => drupal_get_path('module', 'uc_product') . '/views',
);
}