uc_cart_checkout_pane.inc in Ubercart 6.2
Same filename and directory in other branches
Callbacks for the default Ubercart checkout panes and their corresponding helper functions.
Checkout panes are defined using hook_checkout_pane() and use a callback to handle the different processes involved in completing the checkout form. The default checkout panes are defined in uc_cart_checkout_pane() in uc_cart.module.
File
uc_cart/uc_cart_checkout_pane.incView source
<?php
/**
* @file
* Callbacks for the default Ubercart checkout panes and their corresponding helper functions.
*
* Checkout panes are defined using hook_checkout_pane() and use a callback to
* handle the different processes involved in completing the checkout form. The
* default checkout panes are defined in uc_cart_checkout_pane() in
* uc_cart.module.
*/
/**
* Displays the cart contents for review during checkout.
*/
function uc_checkout_pane_cart($op) {
switch ($op) {
case 'view':
$contents['cart_review_table'] = array(
'#value' => theme('cart_review_table'),
'#weight' => variable_get('uc_pane_cart_field_cart_weight', 2),
);
return array(
'contents' => $contents,
'next-button' => FALSE,
);
case 'review':
$items = uc_cart_get_contents();
$review[] = theme('uc_checkout_pane_cart_review', $items);
return $review;
}
}
/**
* Gets the user's email address for login.
*/
function uc_checkout_pane_customer($op, &$arg1, $arg2) {
global $user;
switch ($op) {
case 'view':
if ($user->uid) {
$email = $user->mail;
$description = t('Order information will be sent to your account e-mail listed below.');
// . '<br />'
$contents['primary_email'] = array(
'#type' => 'hidden',
'#value' => $email,
);
$contents['email_text'] = array(
'#value' => '<div>' . t('<b>E-mail address:</b> @email (<a href="!url">edit</a>)', array(
'@email' => $email,
'!url' => url('user/' . $user->uid . '/edit', array(
'query' => drupal_get_destination(),
)),
)) . '</div>',
);
}
else {
$email = $arg1->primary_email;
$description = t('Enter a valid email address for this order or <a href="!url">click here</a> to login with an existing account and return to checkout.', array(
'!url' => url('user/login', array(
'query' => drupal_get_destination(),
)),
));
$contents['primary_email'] = uc_textfield(t('E-mail address'), $email, TRUE, NULL, 64);
}
if (variable_get('uc_cart_email_validation', FALSE) && !$user->uid) {
$contents['primary_email_confirm'] = uc_textfield(t('Confirm e-mail address'), $_SESSION['email_match'] === FALSE ? '' : $email, TRUE, NULL, 64);
if ($_SESSION['email_match'] === FALSE) {
$contents['primary_email_confirm']['#attributes'] = array(
'class' => 'error',
);
unset($_SESSION['email_match']);
}
}
if ($user->uid == 0) {
$contents['new_account'] = array();
if (variable_get('uc_cart_new_account_name', FALSE)) {
$contents['new_account']['name'] = array(
'#type' => 'textfield',
'#title' => t('Username'),
'#default_value' => isset($arg1->data['new_user']['name']) ? $arg1->data['new_user']['name'] : '',
'#maxlength' => 60,
'#size' => 32,
);
}
if (variable_get('uc_cart_new_account_password', FALSE)) {
$contents['new_account']['pass'] = array(
'#type' => 'password',
'#title' => t('Password'),
'#maxlength' => 32,
'#size' => 32,
);
$contents['new_account']['pass_confirm'] = array(
'#type' => 'password',
'#title' => t('Confirm password'),
'#description' => t('Passwords must match to proceed.'),
'#maxlength' => 32,
'#size' => 32,
);
}
if (!empty($contents['new_account'])) {
$array = array(
'#type' => 'fieldset',
'#title' => t('New account details'),
'#description' => variable_get('uc_cart_new_account_details', t('<b>Optional.</b> New customers may supply custom account details.<br />We will create these for you if no values are entered.')),
'#collapsible' => FALSE,
);
$contents['new_account'] = array_merge($array, $contents['new_account']);
}
}
return array(
'description' => $description,
'contents' => $contents,
);
case 'process':
if (!empty($arg2['primary_email']) && !valid_email_address($arg2['primary_email'])) {
form_set_error('panes][customer][primary_email', t('You must enter a valid e-mail address.'));
}
$arg1->primary_email = $arg2['primary_email'];
if (variable_get('uc_cart_email_validation', FALSE) && !$user->uid && $arg2['primary_email'] !== $arg2['primary_email_confirm']) {
form_set_error('panes][customer][primary_email_confirm', t('The e-mail address did not match.'));
$_SESSION['email_match'] = FALSE;
}
unset($_SESSION['email_match']);
// Invalidate if an account already exists for this e-mail address, and the user is not logged into that account
if (!variable_get('uc_cart_mail_existing', TRUE) && $user->uid == 0 && !empty($arg2['primary_email'])) {
if (db_result(db_query("SELECT uid FROM {users} WHERE LOWER(mail) = LOWER('%s')", $arg2['primary_email'])) > 0) {
form_set_error('panes][customer][primary_email', t('An account already exists for your e-mail address. You will either need to login with this e-mail address or use a different e-mail address.'));
}
}
// If new users can specify names or passwords then...
if ((variable_get('uc_cart_new_account_name', FALSE) || variable_get('uc_cart_new_account_password', FALSE)) && $user->uid == 0) {
// Skip if an account already exists for this e-mail address.
if (variable_get('uc_cart_mail_existing', TRUE) && db_result(db_query("SELECT uid FROM {users} WHERE LOWER(mail) = LOWER('%s')", $arg2['primary_email'])) > 0) {
drupal_set_message(t('An account already exists for your e-mail address. The new account details you entered will be disregarded.'));
}
else {
// Validate the username.
if (variable_get('uc_cart_new_account_name', FALSE) && !empty($arg2['new_account']['name'])) {
$message = user_validate_name($arg2['new_account']['name']);
if (!empty($message)) {
form_set_error('panes][customer][new_account][name', $message);
}
elseif (db_fetch_object(db_query("SELECT uid FROM {users} WHERE LOWER(name) = LOWER('%s')", $arg2['new_account']['name']))) {
form_set_error('panes][customer][new_account][name', t('The username %name is already taken. Please enter a different name or leave the field blank for your username to be your e-mail address.', array(
'%name' => $arg2['new_account']['name'],
)));
}
else {
$arg1->data['new_user']['name'] = $arg2['new_account']['name'];
}
}
// Validate the password.
if (variable_get('uc_cart_new_account_password', FALSE)) {
if (strcmp($arg2['new_account']['pass'], $arg2['new_account']['pass_confirm'])) {
form_set_error('panes][customer][new_account][pass_confirm', t('The passwords you entered did not match. Please try again.'));
}
if (!empty($arg2['new_account']['pass'])) {
$arg1->data['new_user']['hash'] = md5(trim($arg2['new_account']['pass']));
}
}
}
}
if ($user->uid) {
$arg1->uid = $user->uid;
}
return TRUE;
case 'review':
$review[] = array(
'title' => t('E-mail'),
'data' => check_plain($arg1->primary_email),
);
return $review;
case 'settings':
$form['uc_cart_mail_existing'] = array(
'#type' => 'checkbox',
'#title' => t("Allow anonymous customers to use an existing account's email address."),
'#default_value' => variable_get('uc_cart_mail_existing', TRUE),
'#description' => t('If enabled, orders will be attached to the account matching the email address. If disabled, anonymous users using a registered email address must log in or use a different email address.'),
);
$form['uc_cart_email_validation'] = array(
'#type' => 'checkbox',
'#title' => t('Require e-mail confirmation in checkout for anonymous customers.'),
'#default_value' => variable_get('uc_cart_email_validation', FALSE),
);
$form['uc_cart_new_account_name'] = array(
'#type' => 'checkbox',
'#title' => t('Allow anonymous customers to specify a new user account name.'),
'#default_value' => variable_get('uc_cart_new_account_name', FALSE),
);
$form['uc_cart_new_account_password'] = array(
'#type' => 'checkbox',
'#title' => t('Allow anonymous customers to specify a new user account password.'),
'#default_value' => variable_get('uc_cart_new_account_password', FALSE),
);
$form['uc_cart_new_account_details'] = array(
'#type' => 'textarea',
'#title' => t('New account details help message'),
'#description' => t('Enter the help message displayed in the new account details fieldset when shown.'),
'#default_value' => variable_get('uc_cart_new_account_details', t('<b>Optional.</b> New customers may supply custom account details.<br />We will create these for you if no values are entered.')),
);
return $form;
}
}
/**
* Gets the delivery information.
*/
function uc_checkout_pane_delivery($op, &$arg1, $arg2) {
global $user;
switch ($op) {
case 'view':
$description = t('Enter your delivery address and information here.');
if ((uc_cart_is_shippable() || !variable_get('uc_cart_delivery_not_shippable', TRUE)) && _checkout_pane_data('billing', 'weight') < _checkout_pane_data('delivery', 'weight') && _checkout_pane_data('billing', 'enabled')) {
$contents['copy_address'] = array(
'#type' => 'checkbox',
'#title' => t('My delivery information is the same as my billing information.'),
'#attributes' => array(
'onclick' => "uc_cart_copy_address(this.checked, 'billing', 'delivery');",
),
);
}
if ($user->uid) {
$addresses = uc_select_address($user->uid, 'delivery', 'apply_address(\'delivery\', this.value);', t('Saved addresses'), TRUE);
if (!empty($addresses)) {
$contents['delivery_address_select'] = $addresses;
}
}
if (uc_address_field_enabled('first_name')) {
$delivery_first_name = $arg1 ? $arg1->delivery_first_name : '';
$contents['delivery_first_name'] = uc_textfield(uc_get_field_name('first_name'), $delivery_first_name, uc_address_field_required('first_name'));
}
if (uc_address_field_enabled('last_name')) {
$delivery_last_name = $arg1 ? $arg1->delivery_last_name : '';
$contents['delivery_last_name'] = uc_textfield(uc_get_field_name('last_name'), $delivery_last_name, uc_address_field_required('last_name'));
}
if (uc_address_field_enabled('company')) {
$delivery_company = $arg1 ? $arg1->delivery_company : '';
$contents['delivery_company'] = uc_textfield(uc_get_field_name('company'), $delivery_company, uc_address_field_required('company'), NULL, 64);
}
if (uc_address_field_enabled('street1')) {
$delivery_street1 = $arg1 ? $arg1->delivery_street1 : '';
$contents['delivery_street1'] = uc_textfield(uc_get_field_name('street1'), $delivery_street1, uc_address_field_required('street1'), NULL, 64);
}
if (uc_address_field_enabled('street2')) {
$delivery_street2 = $arg1 ? $arg1->delivery_street2 : '';
$contents['delivery_street2'] = uc_textfield(uc_get_field_name('street2'), $delivery_street2, uc_address_field_required('street2'), NULL, 64);
}
if (uc_address_field_enabled('city')) {
$delivery_city = $arg1 ? $arg1->delivery_city : '';
$contents['delivery_city'] = uc_textfield(uc_get_field_name('city'), $delivery_city, uc_address_field_required('city'));
}
if (uc_address_field_enabled('country')) {
$delivery_country = $arg1 ? $arg1->delivery_country : NULL;
$contents['delivery_country'] = uc_country_select(uc_get_field_name('country'), $delivery_country, NULL, 'name', uc_address_field_required('country'));
}
if (uc_address_field_enabled('zone')) {
if (isset($_POST['panes']['delivery']['delivery_country'])) {
$country_id = intval($_POST['panes']['delivery']['delivery_country']);
}
else {
$country_id = $delivery_country;
}
$delivery_zone = $arg1 ? $arg1->delivery_zone : NULL;
$contents['delivery_zone'] = uc_zone_select(uc_get_field_name('zone'), $delivery_zone, NULL, $country_id, 'name', uc_address_field_required('zone'));
if (isset($_POST['panes']) && count($contents['delivery_zone']['#options']) == 1) {
$contents['delivery_zone']['#required'] = FALSE;
}
}
if (uc_address_field_enabled('postal_code')) {
$delivery_postal_code = $arg1 ? $arg1->delivery_postal_code : '';
$contents['delivery_postal_code'] = uc_textfield(uc_get_field_name('postal_code'), $delivery_postal_code, uc_address_field_required('postal_code'), NULL, 10, 10);
}
if (uc_address_field_enabled('phone')) {
$delivery_phone = $arg1 ? $arg1->delivery_phone : '';
$contents['delivery_phone'] = uc_textfield(uc_get_field_name('phone'), $delivery_phone, uc_address_field_required('phone'), NULL, 32, 16);
}
return array(
'description' => $description,
'contents' => $contents,
'theme' => 'address_pane',
);
case 'process':
$arg1->delivery_first_name = $arg2['delivery_first_name'];
$arg1->delivery_last_name = $arg2['delivery_last_name'];
$arg1->delivery_company = $arg2['delivery_company'];
$arg1->delivery_street1 = $arg2['delivery_street1'];
$arg1->delivery_street2 = $arg2['delivery_street2'];
$arg1->delivery_city = $arg2['delivery_city'];
$arg1->delivery_zone = $arg2['delivery_zone'];
$arg1->delivery_postal_code = $arg2['delivery_postal_code'];
$arg1->delivery_country = $arg2['delivery_country'];
$arg1->delivery_phone = $arg2['delivery_phone'];
return TRUE;
case 'review':
$review[] = array(
'title' => t('Address'),
'data' => uc_order_address($arg1, 'delivery', FALSE),
);
if (uc_address_field_enabled('phone') && !empty($arg1->delivery_phone)) {
$review[] = array(
'title' => t('Phone'),
'data' => check_plain($arg1->delivery_phone),
);
}
return $review;
}
}
/**
* Gets the billing information.
*/
function uc_checkout_pane_billing($op, &$arg1, $arg2) {
global $user;
switch ($op) {
case 'view':
$description = t('Enter your billing address and information here.');
if ((uc_cart_is_shippable() || !variable_get('uc_cart_delivery_not_shippable', TRUE)) && _checkout_pane_data('delivery', 'weight') < _checkout_pane_data('billing', 'weight') && _checkout_pane_data('delivery', 'enabled')) {
$contents['copy_address'] = array(
'#type' => 'checkbox',
'#title' => t('My billing information is the same as my delivery information.'),
'#attributes' => array(
'onclick' => "uc_cart_copy_address(this.checked, 'delivery', 'billing');",
),
);
}
if ($user->uid) {
$addresses = uc_select_address($user->uid, 'billing', 'apply_address(\'billing\', this.value);', t('Saved addresses'), TRUE);
if (!empty($addresses)) {
$contents['billing_address_select'] = $addresses;
}
}
if (uc_address_field_enabled('first_name')) {
$billing_first_name = $arg1 ? $arg1->billing_first_name : '';
$contents['billing_first_name'] = uc_textfield(uc_get_field_name('first_name'), $billing_first_name, uc_address_field_required('first_name'));
}
if (uc_address_field_enabled('last_name')) {
$billing_last_name = $arg1 ? $arg1->billing_last_name : '';
$contents['billing_last_name'] = uc_textfield(uc_get_field_name('last_name'), $billing_last_name, uc_address_field_required('last_name'));
}
if (uc_address_field_enabled('company')) {
$billing_company = $arg1 ? $arg1->billing_company : '';
$contents['billing_company'] = uc_textfield(uc_get_field_name('company'), $billing_company, uc_address_field_required('company'), NULL, 64);
}
if (uc_address_field_enabled('street1')) {
$billing_street1 = $arg1 ? $arg1->billing_street1 : '';
$contents['billing_street1'] = uc_textfield(uc_get_field_name('street1'), $billing_street1, uc_address_field_required('street1'), NULL, 64);
}
if (uc_address_field_enabled('street2')) {
$billing_street2 = $arg1 ? $arg1->billing_street2 : '';
$contents['billing_street2'] = uc_textfield(uc_get_field_name('street2'), $billing_street2, uc_address_field_required('street2'), NULL, 64);
}
if (uc_address_field_enabled('city')) {
$billing_city = $arg1 ? $arg1->billing_city : '';
$contents['billing_city'] = uc_textfield(uc_get_field_name('city'), $billing_city, uc_address_field_required('city'));
}
if (uc_address_field_enabled('country')) {
$billing_country = $arg1 ? $arg1->billing_country : NULL;
$contents['billing_country'] = uc_country_select(uc_get_field_name('country'), $billing_country, NULL, 'name', uc_address_field_required('country'));
}
if (uc_address_field_enabled('zone')) {
if (isset($_POST['panes']['billing']['billing_country'])) {
$country_id = intval($_POST['panes']['billing']['billing_country']);
}
else {
$country_id = $billing_country;
}
$billing_zone = $arg1 ? $arg1->billing_zone : NULL;
$contents['billing_zone'] = uc_zone_select(uc_get_field_name('zone'), $billing_zone, NULL, $country_id, 'name', uc_address_field_required('zone'));
if (isset($_POST['panes']) && count($contents['billing_zone']['#options']) == 1) {
$contents['billing_zone']['#required'] = FALSE;
}
}
if (uc_address_field_enabled('postal_code')) {
$billing_postal_code = $arg1 ? $arg1->billing_postal_code : '';
$contents['billing_postal_code'] = uc_textfield(uc_get_field_name('postal_code'), $billing_postal_code, uc_address_field_required('postal_code'), NULL, 10, 10);
}
if (uc_address_field_enabled('phone')) {
$billing_phone = $arg1 ? $arg1->billing_phone : '';
$contents['billing_phone'] = uc_textfield(uc_get_field_name('phone'), $billing_phone, uc_address_field_required('phone'), NULL, 32, 16);
}
return array(
'description' => $description,
'contents' => $contents,
'theme' => 'address_pane',
);
case 'process':
$arg1->billing_first_name = isset($arg2['billing_first_name']) ? $arg2['billing_first_name'] : NULL;
$arg1->billing_last_name = isset($arg2['billing_last_name']) ? $arg2['billing_last_name'] : NULL;
$arg1->billing_company = isset($arg2['billing_company']) ? $arg2['billing_company'] : NULL;
$arg1->billing_street1 = isset($arg2['billing_street1']) ? $arg2['billing_street1'] : NULL;
$arg1->billing_street2 = isset($arg2['billing_street2']) ? $arg2['billing_street2'] : NULL;
$arg1->billing_city = isset($arg2['billing_city']) ? $arg2['billing_city'] : NULL;
$arg1->billing_zone = isset($arg2['billing_zone']) ? $arg2['billing_zone'] : NULL;
$arg1->billing_postal_code = isset($arg2['billing_postal_code']) ? $arg2['billing_postal_code'] : NULL;
$arg1->billing_country = isset($arg2['billing_country']) ? $arg2['billing_country'] : NULL;
$arg1->billing_phone = isset($arg2['billing_phone']) ? $arg2['billing_phone'] : NULL;
return TRUE;
case 'review':
$review[] = array(
'title' => t('Address'),
'data' => uc_order_address($arg1, 'billing', FALSE),
);
if (uc_address_field_enabled('phone') && !empty($arg1->billing_phone)) {
$review[] = array(
'title' => t('Phone'),
'data' => check_plain($arg1->billing_phone),
);
}
return $review;
}
}
/**
* Allows a customer to make comments on the order.
*/
function uc_checkout_pane_comments($op, &$arg1, $arg2) {
switch ($op) {
case 'view':
$description = t('Use this area for special instructions or questions regarding your order.');
if (!empty($arg1->order_id)) {
$default = db_result(db_query("SELECT message FROM {uc_order_comments} WHERE order_id = %d", $arg1->order_id));
}
else {
$default = NULL;
}
$contents['comments'] = array(
'#type' => 'textarea',
'#title' => t('Order comments'),
'#default_value' => $default,
'#wysiwyg' => FALSE,
);
return array(
'description' => $description,
'contents' => $contents,
);
case 'process':
db_query("DELETE FROM {uc_order_comments} WHERE order_id = %d", $arg1->order_id);
if (strlen($arg2['comments']) > 0) {
uc_order_comment_save($arg1->order_id, 0, $arg2['comments'], 'order', uc_order_state_default('post_checkout'), TRUE);
}
return TRUE;
case 'review':
$review = NULL;
$result = db_query("SELECT message FROM {uc_order_comments} WHERE order_id = %d", $arg1->order_id);
if ($comment = db_fetch_object($result)) {
$review[] = array(
'title' => t('Comment'),
'data' => check_plain($comment->message),
);
}
return $review;
}
}
/**
* Themes the delivery/billing address forms in tables.
*
* @see uc_checkout_pane_delivery()
* @see uc_checkout_pane_billing()
* @ingroup themeable
*/
function theme_address_pane($form) {
$output = '';
$req = '<span class="form-required">*</span>';
if (isset($form['copy_address'])) {
$output .= drupal_render($form['copy_address']);
}
$output .= '<div class="address-pane-table"><table>';
foreach (element_children($form) as $field) {
if (substr($field, 0, 9) == 'delivery_' || substr($field, 0, 8) == 'billing_') {
$title = $form[$field]['#title'] . ':';
unset($form[$field]['#title']);
if (substr($field, -7) == 'street1') {
$title = uc_get_field_name('street') . ':';
}
elseif (substr($field, -7) == 'street2') {
$title = ' ';
}
$output .= '<tr><td class="field-label">';
$output .= '<label for="' . $form[$field]['#id'] . '">';
if ($form[$field]['#required']) {
$output .= $req;
}
$output .= $title . '</label></td>';
$output .= '<td>' . drupal_render($form[$field]) . '</td></tr>';
}
}
$output .= '</table></div>';
foreach (element_children($form) as $element) {
$output .= drupal_render($form[$element]);
}
return $output;
}
/**
* Finds the collapsible pane displayed above the pane with an ID of $pane_id.
*/
function _uc_cart_checkout_prev_pane($panes, $pane_id = NULL) {
if (is_null($pane_id)) {
return FALSE;
}
$prev = FALSE;
foreach ($panes as $target) {
if ($target['id'] == $pane_id) {
return $prev;
}
if ($target['collapsible'] && $target['enabled']) {
$prev = $target['id'];
}
}
return FALSE;
}
/**
* Finds the pane that displays below the pane with an ID of $pane_id.
*/
function _uc_cart_checkout_next_pane($panes, $pane_id = NULL) {
if (is_null($pane_id)) {
return FALSE;
}
$next = FALSE;
foreach ($panes as $target) {
if ($next) {
if ($target['collapsible'] && $target['enabled']) {
return $target['id'];
}
}
if ($target['id'] == $pane_id) {
$next = TRUE;
}
}
return FALSE;
}
/**
* Builds a list of checkout panes defined in the enabled modules.
*/
function _checkout_pane_list($action = NULL) {
static $panes;
if (count($panes) > 0 && $action !== 'rebuild') {
return $panes;
}
$panes = module_invoke_all('checkout_pane', NULL);
// Set the global default values first
foreach ($panes as $i => $value) {
$panes[$i]['enabled'] = variable_get('uc_pane_' . $panes[$i]['id'] . '_enabled', !isset($panes[$i]['enabled']) ? TRUE : $panes[$i]['enabled']);
$panes[$i]['weight'] = variable_get('uc_pane_' . $panes[$i]['id'] . '_weight', !isset($panes[$i]['weight']) ? 0 : $panes[$i]['weight']);
}
// Allow other modules to alter the panes.
drupal_alter('checkout_pane', $panes);
// Make sure that all the required attributes are set
foreach ($panes as $i => $value) {
$panes[$i]['enabled'] = !isset($panes[$i]['enabled']) ? TRUE : $panes[$i]['enabled'];
$panes[$i]['weight'] = !isset($panes[$i]['weight']) ? 0 : $panes[$i]['weight'];
$panes[$i]['review'] = !isset($panes[$i]['review']) ? TRUE : $panes[$i]['review'];
$panes[$i]['process'] = !isset($panes[$i]['process']) ? TRUE : $panes[$i]['process'];
$panes[$i]['collapsible'] = !isset($panes[$i]['collapsible']) ? TRUE : $panes[$i]['collapsible'];
}
usort($panes, 'uc_weight_sort');
return $panes;
}
/**
* Returns data from a checkout pane by pane ID and the array key.
*/
function _checkout_pane_data($pane_id, $key) {
$panes = _checkout_pane_list();
foreach ($panes as $pane) {
if ($pane['id'] == $pane_id) {
return $pane[$key];
}
}
}
/**
* Formats the cart contents table on the checkout page.
*
* @param $show_subtotal
* TRUE or FALSE indicating if you want a subtotal row displayed in the table.
*
* @return
* The HTML output for the cart review table.
*
* @ingroup themeable
*/
function theme_cart_review_table($show_subtotal = TRUE) {
$subtotal = 0;
// Set up table header.
$header = array(
array(
'data' => t('Qty'),
'class' => 'qty',
),
array(
'data' => t('Products'),
'class' => 'products',
),
array(
'data' => t('Price'),
'class' => 'price',
),
);
$context = array();
// Set up table rows.
$contents = uc_cart_get_contents();
foreach ($contents as $item) {
$price_info = array(
'price' => $item->price,
'qty' => $item->qty,
);
$context['revision'] = 'altered';
$context['type'] = 'cart_item';
$context['subject'] = array(
'cart' => $contents,
'cart_item' => $item,
'node' => node_load($item->nid),
);
$total = uc_price($price_info, $context);
$subtotal += $total;
$description = check_plain($item->title) . uc_product_get_description($item);
// Remove node from context to prevent the price from being altered.
$context['revision'] = 'themed-original';
$context['type'] = 'amount';
unset($context['subject']);
$rows[] = array(
array(
'data' => t('@qty×', array(
'@qty' => $item->qty,
)),
'class' => 'qty',
),
array(
'data' => $description,
'class' => 'products',
),
array(
'data' => uc_price($total, $context),
'class' => 'price',
),
);
}
// Add the subtotal as the final row.
if ($show_subtotal) {
$context = array(
'revision' => 'themed-original',
'type' => 'amount',
);
$rows[] = array(
'data' => array(
array(
'data' => '<span id="subtotal-title">' . t('Subtotal:') . '</span> ' . uc_price($subtotal, $context),
'colspan' => 3,
'class' => 'subtotal',
),
),
'class' => 'subtotal',
);
}
return theme('table', $header, $rows, array(
'class' => 'cart-review',
));
}
/**
* Themes cart items on the checkout review order page.
*
* @param $items
* An associative array containing cart items, with keys:
* - qty: Quantity in cart.
* - title: Item title.
* - price: Item price.
* - desc: Item description.
*
* @return
* A string of HTML for the page contents.
*
* @ingroup themeable
*/
function theme_uc_checkout_pane_cart_review($items) {
$context = array(
'revision' => 'themed',
'type' => 'cart_item',
'subject' => array(),
);
$rows = array();
foreach ($items as $item) {
$price_info = array(
'price' => $item->price,
'qty' => $item->qty,
);
$context['subject'] = array(
'cart' => $items,
'cart_item' => $item,
'node' => node_load($item->nid),
);
$rows[] = array(
array(
'data' => $item->qty . '×',
'class' => 'qty',
),
array(
'data' => check_plain($item->title) . uc_product_get_description($item),
'class' => 'products',
),
array(
'data' => uc_price($price_info, $context),
'class' => 'price',
),
);
}
return theme('table', NULL, $rows, array(
'class' => 'cart-review',
));
}Functions
Name |
Description |
|---|---|
| theme_address_pane | Themes the delivery/billing address forms in tables. |
| theme_cart_review_table | Formats the cart contents table on the checkout page. |
| theme_uc_checkout_pane_cart_review | Themes cart items on the checkout review order page. |
| uc_checkout_pane_billing | Gets the billing information. |
| uc_checkout_pane_cart | Displays the cart contents for review during checkout. |
| uc_checkout_pane_comments | Allows a customer to make comments on the order. |
| uc_checkout_pane_customer | Gets the user's email address for login. |
| uc_checkout_pane_delivery | Gets the delivery information. |
| _checkout_pane_data | Returns data from a checkout pane by pane ID and the array key. |
| _checkout_pane_list | Builds a list of checkout panes defined in the enabled modules. |
| _uc_cart_checkout_next_pane | Finds the pane that displays below the pane with an ID of $pane_id. |
| _uc_cart_checkout_prev_pane | Finds the collapsible pane displayed above the pane with an ID of $pane_id. |