'checkbox',
'#title' => t('Require a shipping service at all times, preventing checkout if none are available.'),
'#default_value' => variable_get('commerce_shipping_pane_require_service', FALSE),
);
$form['commerce_shipping_recalculate_services'] = array(
'#type' => 'checkbox',
'#title' => t('Calculate shipping rates via AJAX as addresses are updated on the checkout form.'),
'#description' => t('Calculation is only triggered when all required fields have been entered and the shipping services pane is visible on the page.'),
'#default_value' => variable_get('commerce_shipping_recalculate_services', TRUE),
);
return $form;
}
/**
* Checkout pane callback: builds a shipping quote selection form.
*/
function commerce_shipping_pane_checkout_form($form, &$form_state, $checkout_pane, $order) {
// Ensure this include file is loaded when the form is rebuilt from the cache.
$form_state['build_info']['files']['form'] = drupal_get_path('module', 'commerce_shipping') . '/includes/commerce_shipping.checkout_pane.inc';
$pane_form = array(
'#prefix' => '',
'#suffix' => '
',
);
$pane_form['shipping_rates'] = array(
'#type' => 'value',
'#value' => FALSE,
);
// TODO: integrate with Commerce Physical Product to ensure an order contains
// physical products before attempting to quote shipping rates.
// Collect shipping rates for the order.
commerce_shipping_collect_rates($order);
// Generate an array of shipping service rate options.
$options = commerce_shipping_service_rate_options($order);
// If at least one shipping option is available...
if (!empty($options)) {
// Store the shipping methods in the form for validation purposes.
$pane_form['shipping_rates'] = array(
'#type' => 'value',
'#value' => $order->shipping_rates,
);
// Add a radios element to let the customer select a shipping service.
$pane_form['shipping_service'] = array(
'#type' => 'radios',
'#options' => $options,
'#ajax' => array(
'callback' => 'commerce_shipping_pane_service_details_refresh',
'wrapper' => 'commerce-shipping-service-details',
),
);
foreach ($options as $key => $option) {
$pane_form['shipping_service'][$key] = array(
'#description' => $order->shipping_rates[$key]->data['shipping_service']['description'],
);
}
// Find the default shipping method using either the pre-selected value
// stored as a line item on the order or the first available method.
$pane_values = !empty($form_state['values'][$checkout_pane['pane_id']]) ? $form_state['values'][$checkout_pane['pane_id']] : array();
$pane_values['service_details'] = array();
// First check for a shipping service selection in the pane values.
if (!empty($pane_values['shipping_service']) && !empty($options[$pane_values['shipping_service']])) {
$default_value = $pane_values['shipping_service'];
}
else {
// Then look for one in a line item on the order already.
$order_wrapper = entity_metadata_wrapper('commerce_order', $order);
foreach ($order_wrapper->commerce_line_items as $delta => $line_item_wrapper) {
if ($line_item_wrapper->type->value() == 'shipping' && !empty($options[$line_item_wrapper->commerce_shipping_service->value()])) {
$default_value = $line_item_wrapper->commerce_shipping_service->value();
// If the service details value is empty, see if there are any values
// in the line item to merge into the array as defaults.
if (empty($pane_values['service_details']) && !empty($line_item_wrapper->value()->data['service_details'])) {
$pane_values['service_details'] = $line_item_wrapper->value()->data['service_details'];
}
break;
}
}
}
// If we still don't have a default value, use the first available and clear
// any related input from the form state.
if (empty($default_value) || empty($pane_form['shipping_service']['#options'][$default_value])) {
$default_value = key($options);
unset($form_state['input']['commerce_shipping']['shipping_service']);
}
// Set the default value for the shipping method radios.
$pane_form['shipping_service']['#default_value'] = $default_value;
$shipping_service = commerce_shipping_service_load($default_value);
$pane_form['service_details'] = array('#type' => 'container');
// If the service specifies a details form callback...
if ($callback = commerce_shipping_service_callback($shipping_service, 'details_form')) {
// Look for a form array from the callback.
$details_form = $callback($pane_form, $pane_values, $checkout_pane, $order, $shipping_service);
// If a details form array was actually returned...
if (!empty($details_form)) {
// Add it to the form now.
$pane_form['service_details'] += $details_form;
}
}
$pane_form['service_details']['#prefix'] = '';
$pane_form['service_details']['#suffix'] = '
';
}
else {
// Otherwise display a message indicating whether or not we need a shipping
// service to be selected to complete checkout.
if (variable_get('commerce_shipping_pane_require_service', FALSE)) {
$message = t('No valid shipping rates found for your order, and we require shipping service selection to complete checkout.') . '
' . t('Please verify you have supplied all required information or contact us to resolve the issue.') . '';
}
else {
// If live shipping rate recalculation is required, check if we can show shipping options.
if (commerce_shipping_recalculate_services($form, NULL, TRUE) && empty($form_state['recalculate'])) {
$message = t('Please supply all of the required information requested above to reveal your shipping options.');
}
else {
$message = t('No shipping rates found for your order. Please continue the checkout process.');
}
}
$pane_form['message'] = array(
'#markup' => '' . $message . '
',
'#weight' => -20,
);
}
return $pane_form;
}
/**
* Ajax callback: Returns the shipping details form elements that match the
* currently selected shipping service.
*/
function commerce_shipping_pane_service_details_refresh($form, $form_state) {
return $form['commerce_shipping']['service_details'];
}
/**
* Ajax callback: Returns recalculated shipping services.
*/
function commerce_shipping_recalculate_services_refresh($form, $form_state) {
return $form['commerce_shipping'];
}
/**
* Validate callback for recalculating shipping services.
*/
function commerce_shipping_recalculate_services_validate($form, &$form_state) {
// Call all validation callbacks.
$recalculate = commerce_shipping_recalculate_services($form, $form_state);
// Retrieve the form validation errors.
$errors = drupal_get_messages('error');
// If there were any errors, we clear them.
if (!empty($errors)) {
form_clear_error();
$recalculate = FALSE;
}
// If we previously validated, and now validation fails, then we need to
// rebuild the form.
if (!empty($form_state['recalculate']) && !$recalculate) {
$form_state['rebuild'] = TRUE;
}
// Store the validation result so that it can be examined in the submit handler.
$form_state['recalculate'] = $recalculate;
return TRUE;
}
/**
* Submit callback for recalculating shipping services.
*/
function commerce_shipping_recalculate_services_submit($form, &$form_state) {
$order = $form_state['order'];
$rebuild = FALSE;
// If recalculation shouldn't happen, halt the process in this submit handler
// as opposed to doing it in the validate step which would result in an empty
// validation error message.
if (empty($form_state['recalculate'])) {
return;
}
// If any customer profile pane exists on the form, process its input before
// recalculating shipping rates. This may mean submitting the checkout pane
// itself, but it may also involve copying the necessary data from another
// customer profile checkout pane.
foreach (commerce_customer_profile_types() as $type => $profile_type) {
$pane_id = 'customer_profile_' . $type;
// If this pane is actually present in the form...
if (!empty($form[$pane_id])) {
// If the profile copy button has been checked for this customer profile...
if (!empty($form_state['values'][$pane_id]['commerce_customer_profile_copy'])) {
$source_id = 'customer_profile_' . variable_get('commerce_' . $pane_id . '_profile_copy_source', '');
$info = array('commerce_customer_profile', $type, $pane_id);
// Try getting the source profile data from validated input in the form
// state's values array if it is present on the form.
if (isset($form_state['values'][$source_id])) {
commerce_customer_profile_copy_fields($info, $form_state['input'][$pane_id], $form_state['input'][$source_id], $form_state);
commerce_customer_profile_copy_fields($info, $form_state['values'][$pane_id], $form_state['values'][$source_id], $form_state);
}
else {
// Otherwise, attempt to get source profile from the order object.
$wrapper = entity_metadata_wrapper('commerce_order', $order);
$profile = NULL;
// Look first for a profile coming from a matching customer profile
// reference field.
if ($source_field_name = variable_get('commerce_' . $source_id . '_field', '')) {
$profile = $wrapper->{$source_field_name}->value();
}
elseif (!empty($form_state['order']->data['profiles'][$source_id])) {
// Otherwise fallback to the customer profile referenced in the order
// data array.
$profile = commerce_customer_profile_load($form_state['order']->data['profiles'][$source_id]);
}
// Assuming we found a source profile, use that to copy data into the
// form state for the current profile.
if (!empty($profile)) {
commerce_customer_profile_copy_fields($info, $form_state['input'][$pane_id], $profile, $form_state);
commerce_customer_profile_copy_fields($info, $form_state['values'][$pane_id], $profile, $form_state);
}
}
// Unset any cached addressfield data for this customer profile.
foreach ($form_state['addressfield'] as $key => $value) {
if (strpos($key, 'commerce_customer_profile|' . $type) === 0) {
unset($form_state['addressfield'][$key]);
}
}
}
// Now that we have data in the form state array for the copied address,
// go ahead and validate the data through the checkout pane's validation
// handler.
$checkout_pane = commerce_checkout_pane_load($pane_id);
// Submit the pane and save the customer profiles.
if ($callback = commerce_checkout_pane_callback($checkout_pane, 'checkout_form_submit')) {
$callback($form, $form_state, $checkout_pane, $order);
$rebuild = TRUE;
}
}
}
// Save the order and rebuild the form to reflect the updated customer data.
if ($rebuild) {
// Avoid overwriting an already updated order.
$stored_order = commerce_order_load($order->order_id);
if ($stored_order->changed < $order->changed) {
commerce_order_save($order);
}
$form_state['rebuild'] = TRUE;
}
}
/**
* Checkout pane callback: validate the shipping service selection and details.
*/
function commerce_shipping_pane_checkout_form_validate($form, &$form_state, $checkout_pane, $order) {
$pane_id = $checkout_pane['pane_id'];
// Only attempt validation if we actually had shipping services on the form.
if (!empty($form[$pane_id]) && !empty($form_state['values'][$pane_id])) {
$pane_form = $form[$pane_id];
$pane_values = $form_state['values'][$pane_id];
// Initialize the extra details if necessary.
if (empty($pane_values['service_details'])) {
$pane_values['service_details'] = array();
}
// Only attempt validation if there were shipping services available.
if (!empty($pane_values['shipping_rates'])) {
// If the selected shipping service was changed...
if ($pane_values['shipping_service'] != $pane_form['shipping_service']['#default_value']) {
// And the newly selected service has a valid details form callback...
if ($shipping_service = commerce_shipping_service_load($pane_values['shipping_service'])) {
if (commerce_shipping_service_callback($shipping_service, 'details_form')) {
// Fail validation so the form is rebuilt to include the shipping
// service specific form elements.
return FALSE;
}
}
}
// Allow the shipping service to validate the service details.
$shipping_service = commerce_shipping_service_load($pane_values['shipping_service']);
if ($callback = commerce_shipping_service_callback($shipping_service, 'details_form_validate')) {
$result = $callback($pane_form['service_details'], $pane_values['service_details'], $shipping_service, $order, array($checkout_pane['pane_id'], 'service_details'));
// To prevent payment method validation routines from having to return TRUE
// explicitly, only return FALSE if it was specifically returned. Otherwise
// default to TRUE.
return $result === FALSE ? FALSE : TRUE;
}
}
elseif (variable_get('commerce_shipping_pane_require_service', FALSE)) {
// But fail validation if no rates were returned and we require selection.
drupal_set_message(t('You cannot continue checkout without selecting a valid shipping service. Please verify your address information or contact us if an error is preventing you from seeing valid shipping rates for your order.'), 'error');
return FALSE;
}
}
// Nothing to validate.
return TRUE;
}
/**
* Checkout pane callback: submit the shipping checkout pane.
*/
function commerce_shipping_pane_checkout_form_submit($form, &$form_state, $checkout_pane, $order) {
$pane_id = $checkout_pane['pane_id'];
// Only attempt validation if we actually had payment methods on the form.
if (!empty($form[$pane_id]) && !empty($form_state['values'][$pane_id])) {
$pane_form = $form[$pane_id];
$pane_values = $form_state['values'][$pane_id];
// Initialize the extra details if necessary.
if (empty($pane_values['service_details'])) {
$pane_values['service_details'] = array();
}
// Only submit if there were shipping services available.
if (!empty($pane_values['shipping_rates'])) {
$shipping_service = commerce_shipping_service_load($pane_values['shipping_service']);
// Delete any existing shipping line items from the order.
commerce_shipping_delete_shipping_line_items($order, TRUE);
// Extract the unit price from the calculated rate.
$rate_line_item = $pane_values['shipping_rates'][$pane_values['shipping_service']];
$rate_line_item_wrapper = entity_metadata_wrapper('commerce_line_item', $rate_line_item);
$unit_price = $rate_line_item_wrapper->commerce_unit_price->value();
// Create a new shipping line item with the calculated rate from the form.
$line_item = commerce_shipping_line_item_new($pane_values['shipping_service'], $unit_price, $order->order_id, $rate_line_item->data, $rate_line_item->type);
// Add the service details to the line item's data array and the order.
$line_item->data['service_details'] = $pane_values['service_details'];
// Allow the details form submit handler to make any necessary updates to
// the line item before adding it to the order.
if ($callback = commerce_shipping_service_callback($shipping_service, 'details_form_submit')) {
$callback($pane_form['service_details'], $pane_values['service_details'], $line_item);
}
// Save and add the line item to the order.
commerce_shipping_add_shipping_line_item($line_item, $order, TRUE);
}
}
}
/**
* Checkout pane callback: show the selected shipping service on the review pane.
*/
function commerce_shipping_pane_review($form, $form_state, $checkout_pane, $order) {
$order_wrapper = entity_metadata_wrapper('commerce_order', $order);
// Loop over all the line items on the order.
foreach ($order_wrapper->commerce_line_items as $delta => $line_item_wrapper) {
// If the current line item is a shipping line item...
if ($line_item_wrapper->type->value() == 'shipping') {
// Return its label and formatted total price.
$total_price = $line_item_wrapper->commerce_total->value();
$rate = commerce_currency_format($total_price['amount'], $total_price['currency_code'], $line_item_wrapper->value());
return t('@service: @rate', array('@service' => $line_item_wrapper->line_item_label->value(), '@rate' => $rate));
}
}
}