';
$output .= '
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 $form['#id'] == 'node-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($node_id, $format = 'product') {
$output = '';
$product = node_load($node_id);
if (!module_exists('imagecache') || !($field = variable_get('uc_image_'. $product->type, ''))) {
return '';
}
// Get the current product image widget.
$image_widget = uc_product_get_image_widget();
if (isset($product->$field)) {
$image = $product->{$field}[0];
$path = $image['filepath'];
if (file_exists($path)) {
$img = theme('imagecache', $format, $path, $image['data']['alt'], $image['data']['title']);
if ($format == 'product') {
if ($image_widget) {
$image_widget_func = $image_widget['callback'];
$output .= '';
}
$output .= $img;
if ($image_widget) {
$output .= '';
}
}
else {
$output = l($img, 'node/'. $product->nid, array('html' => TRUE));
}
}
}
return $output;
}
/**
* 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_product_description() and modules
* wanting to alter the output before rendering can do so by implementing
* hook_product_description_alter(). By default, all descriptions supplied by
* modules via hook_product_description() are concatenated together.
*
* NOTE: hook_product_description() supercedes the deprecated
* hook_cart_item_description().
*
* @param $product
* Product object.
*
* @return
* HTML rendered product description.
*/
function uc_product_get_description($product) {
// Run through implementations of hook_product_description()
$description = module_invoke_all('product_description', $product);
// Now allow alterations via hook_product_description_alter()
drupal_alter('product_description', $description, $product);
return drupal_render($description);
}
/**
* Loads a product class, or all classes.
*/
function uc_product_class_load($class_id = NULL, $reset = FALSE) {
static $classes;
if ($reset || !isset($classes)) {
// Load classes from database.
$classes = array();
$result = db_query("SELECT * FROM {uc_product_classes}");
while ($class = db_fetch_object($result)) {
$classes[$class->pcid] = $class;
}
// Merge any module-defined classes.
foreach (module_invoke_all('uc_product_default_classes') as $pcid => $class) {
// The default class can be overridden by a module if needed,
// but is not treated as a real class elsewhere.
if ($pcid == 'product') {
continue;
}
$class += array(
'pcid' => $pcid,
'name' => $pcid,
'description' => '',
);
if (isset($classes[$pcid])) {
// Merge defaults with the existing database info.
$classes[$pcid] = (object) array_merge($class, (array) $classes[$pcid]);
}
else {
// Ensure the class info is saved in the database.
drupal_write_record('uc_product_classes', $class);
$classes[$pcid] = (object) $class;
}
// Module-defined classes cannot be deleted.
$classes[$pcid]->locked = TRUE;
}
}
return is_null($class_id) ? $classes : $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('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) {
if (!isset($form['nid'])) {
$form['nid'] = array(
'#type' => 'hidden',
'#value' => intval(arg(1)),
);
}
if (!isset($form['pfid'])) {
$form['pfid'] = array(
'#type' => 'hidden',
'#value' => intval(arg(5)),
);
}
$form['submit'] = array(
'#type' => 'submit',
'#value' => t('Save feature'),
);
$form['cancel'] = array(
'#value' => l(t('Cancel'), 'node/'. intval(arg(1)) .'/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));
}
}
if(!empty($data['pfid']) && db_result(db_query("SELECT COUNT(*) FROM {uc_product_features} WHERE pfid = %d", intval($data['pfid'])))) {
// First attempt to update an existing row.
db_query("UPDATE {uc_product_features} SET description = '%s' WHERE pfid = %d", $data['description'], intval($data['pfid']));
drupal_set_message(t('The product feature has been updated.'));
}
else {
// Otherwise insert this feature as a new row.
db_query("INSERT INTO {uc_product_features} (nid, fid, description) VALUES (%d, '%s', '%s')",
$data['nid'], $data['fid'], $data['description']);
drupal_set_message(t('The product feature has been added.'));
}
return 'node/'. $data['nid'] .'/edit/features';
}
/**
* Loads all product feature for a node.
*
* @param $nid
* The product node ID.
*
* @return
* The array of all product features object.
*/
function uc_product_feature_load_multiple($nid) {
$result = db_query("SELECT * FROM {uc_product_features} WHERE nid = %d ORDER BY pfid ASC", $nid);
$features = array();
while ($feature = db_fetch_object($result)) {
$features[$feature->pfid] = $feature;
}
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.
*
* @return
* The product feature object.
*/
function uc_product_feature_load($pfid, $fid = NULL) {
if (isset($fid)) {
$feature = db_fetch_array(db_query("SELECT * FROM {uc_product_features} WHERE pfid = %d AND fid = '%s'", $pfid, $fid));
}
else {
$feature = db_fetch_array(db_query("SELECT * FROM {uc_product_features} WHERE pfid = %d", $pfid));
}
return $feature;
}
/**
* Deletes a product feature object.
*
* @param $pfid
* The product feature ID.
*
* @return
* 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_query("DELETE FROM {uc_product_features} WHERE pfid = %d", $pfid);
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) {
module_load_include('inc', 'imagefield', 'imagefield_widget');
module_load_include('inc', 'filefield', 'filefield_widget');
module_load_include('inc', 'content', 'includes/content.crud');
$label = t('Image');
$field = array(
'label' => $label,
'type' => 'filefield',
'widget_type' => 'imagefield_widget',
'weight' => -2,
'file_extensions' => 'gif jpg png',
'custom_alt' => 1,
'custom_title' => 1,
'description' => '',
'required' => 0,
'multiple' => '1',
'list_field' => '0',
'list_default' => 1,
'description_field' => '0',
'module' => 'filefield',
'widget_module' => 'imagefield',
'columns' => array(
'fid' => array(
'type' => 'int',
'not null' => FALSE,
),
'list' => array(
'type' => 'int',
'size' => 'tiny',
'not null' => FALSE,
),
'data' => array(
'type' => 'text',
'serialize' => TRUE,
),
),
'display_settings' => array(
'label' => array(
'format' => 'hidden',
),
'teaser' => array(
'format' => 'hidden',
),
'full' => array(
'format' => 'hidden',
),
4 => array(
'format' => 'hidden',
),
),
);
if (module_exists('imagefield_tokens')) {
$field['alt'] = '[title]';
$field['title'] = '[title]';
}
if ($type) {
// Accept single or multiple types as input.
$types = (array) $type;
}
else {
$types = uc_product_types();
}
foreach ($types as $type) {
$field['type_name'] = $type;
$field_name = variable_get('uc_image_'. $type, '');
if (empty($field_name)) {
$field_name = 'field_image_cache';
}
$field['field_name'] = $field_name;
$instances = content_field_instance_read(array('field_name' => $field_name, 'type_name' => $type));
if (count($instances) < 1) {
// Only add the field if it doesn't exist. Don't overwrite any changes.
content_field_instance_create($field);
variable_set('uc_image_'. $type, $field_name);
}
}
}
/**
* Implements hook_imagecache_default_presets().
*/
function uc_product_imagecache_default_presets() {
$presets = array();
$presets['product'] = array(
'presetname' => 'product',
'actions' => array(
array(
'weight' => '0',
'module' => 'uc_product',
'action' => 'imagecache_scale',
'data' => array(
'width' => '250',
'height' => '250',
'upscale' => 0,
),
),
),
);
$presets['product_full'] = array(
'presetname' => 'product_full',
'actions' => array(),
);
$presets['product_list'] = array(
'presetname' => 'product_list',
'actions' => array(
array(
'weight' => '0',
'module' => 'uc_product',
'action' => 'imagecache_scale',
'data' => array(
'width' => '100',
'height' => '100',
'upscale' => 0,
),
),
),
);
$presets['uc_thumbnail'] = array(
'presetname' => 'uc_thumbnail',
'actions' => array(
array(
'weight' => '0',
'module' => 'uc_product',
'action' => 'imagecache_scale',
'data' => array(
'width' => '35',
'height' => '35',
'upscale' => 0,
),
),
),
);
return $presets;
}
/**
* Implements hook_views_api().
*/
function uc_product_views_api() {
return array(
'api' => '2.0',
'path' => drupal_get_path('module', 'uc_product') .'/views',
);
}
/**
* Implements hook_features_api().
*/
function uc_product_features_api() {
return array(
'uc_product_classes' => array(
'name' => t('Ubercart product classes'),
'feature_source' => TRUE,
'default_hook' => 'uc_product_default_classes',
'file' => drupal_get_path('module', 'uc_product') .'/uc_product.features.inc',
),
);
}