You are here

Home » API reference » Commerce Flat Rate 7

commerce_flat_rate.admin.inc in Commerce Flat Rate 7

Contains the administrative page and form callbacks for the Flat Rate module.

File

includes/commerce_flat_rate.admin.inc
View source 
<?php

/**
 * @file
 * Contains the administrative page and form callbacks for the Flat Rate module.
 */

/**
 * Builds the form for adding and editing flat rate services.
 */
function commerce_flat_rate_service_form($form, &$form_state, $shipping_service) {
  $form['#attached']['css'][] = drupal_get_path('module', 'commerce_flat_rate') . '/theme/commerce_flat_rate.css';

  // Store the initial shipping service in the form state.
  $form_state['shipping_service'] = $shipping_service;
  $form['flat_rate'] = array(
    '#tree' => TRUE,
  );
  $form['flat_rate']['title'] = array(
    '#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $shipping_service['title'],
    '#description' => t('The administrative title of this flat rate. It is recommended that this title begin with a capital letter and contain only letters, numbers, and spaces.'),
    '#required' => TRUE,
    '#size' => 32,
    '#maxlength' => 255,
    '#field_suffix' => ' <small id="edit-flat-rate-title-suffix">' . t('Machine name: @name', array(
      '@name' => $shipping_service['name'],
    )) . '</small>',
  );
  if (empty($shipping_service['name'])) {
    $form['flat_rate']['name'] = array(
      '#type' => 'machine_name',
      '#title' => t('Machine name'),
      '#default_value' => $shipping_service['name'],
      '#maxlength' => 32,
      '#required' => TRUE,
      '#machine_name' => array(
        'exists' => 'commerce_shipping_service_load',
        'source' => array(
          'flat_rate',
          'title',
        ),
      ),
      '#description' => t('The machine-name of this flat rate. This name must contain only lowercase letters, numbers, and underscores. It must be unique.'),
    );
  }
  else {
    $form['flat_rate']['name'] = array(
      '#type' => 'value',
      '#value' => $shipping_service['name'],
    );
  }
  $form['flat_rate']['display_title'] = array(
    '#type' => 'textfield',
    '#title' => t('Display title'),
    '#default_value' => $shipping_service['display_title'],
    '#description' => t('The front end display title of this flat rate shown to customers. Leave blank to default to the <em>Title</em> from above.'),
    '#size' => 32,
  );
  $form['flat_rate']['description'] = array(
    '#type' => 'textarea',
    '#title' => t('Description'),
    '#description' => t('Describe this flat rate if necessary. The text will be displayed in the flat rate services overview table.'),
    '#default_value' => $shipping_service['description'],
    '#rows' => 3,
  );
  $form['flat_rate']['amount'] = array(
    '#type' => 'textfield',
    '#title' => t('Base rate'),
    '#default_value' => commerce_currency_amount_to_decimal($shipping_service['base_rate']['amount'], $shipping_service['base_rate']['currency_code']),
    '#required' => TRUE,
    '#size' => 10,
    '#prefix' => '<div class="commerce-flat-rate-base-rate">',
  );

  // Build a currency options list from all enabled currencies.
  $options = commerce_currency_get_code(TRUE);

  // If the current currency value is not available, add it now with a
  // message in the help text explaining it.
  if (empty($options[$shipping_service['base_rate']['currency_code']])) {
    $options[$shipping_service['base_rate']['currency_code']] = check_plain($shipping_service['base_rate']['currency_code']);
    $description = t('The currency set for this rate is not currently enabled. If you change it now, you will not be able to set it back.');
  }
  else {
    $description = '';
  }

  // If only one currency option is available, don't use a select list.
  if (count($options) == 1) {
    $currency_code = key($options);
    $form['flat_rate']['amount']['#field_suffix'] = check_plain($currency_code);
    $form['flat_rate']['amount']['#suffix'] = '</div>';
    $form['flat_rate']['currency_code'] = array(
      '#type' => 'value',
      '#default_value' => $currency_code,
    );
  }
  else {
    $form['flat_rate']['currency_code'] = array(
      '#type' => 'select',
      '#description' => $description,
      '#options' => $options,
      '#default_value' => $shipping_service['base_rate']['currency_code'],
      '#suffix' => '</div>',
    );
  }

  // Add support for base rates including tax.
  if (module_exists('commerce_tax')) {

    // Build an array of tax types that are display inclusive.
    $inclusive_types = array();
    foreach (commerce_tax_types() as $name => $tax_type) {
      if ($tax_type['display_inclusive']) {
        $inclusive_types[$name] = $tax_type['title'];
      }
    }

    // Build an options array of tax rates of these types.
    $options = array();
    foreach (commerce_tax_rates() as $name => $tax_rate) {
      if (in_array($tax_rate['type'], array_keys($inclusive_types))) {
        $options[$inclusive_types[$tax_rate['type']]][$name] = t('Including @title', array(
          '@title' => $tax_rate['title'],
        ));
      }
    }
    if (!empty($options)) {

      // Find the default value for the tax included element.
      $default = '';
      if (!empty($shipping_service['data']['include_tax'])) {
        $default = $shipping_service['data']['include_tax'];
      }
      $form['flat_rate']['currency_code']['#title'] = '&nbsp;';
      $form['flat_rate']['include_tax'] = array(
        '#type' => 'select',
        '#title' => t('Include tax in this rate'),
        '#description' => t('Saving a rate tax inclusive will bypass later calculations for the specified tax.'),
        '#options' => count($options) == 1 ? reset($options) : $options,
        '#default_value' => $default,
        '#required' => FALSE,
        '#empty_value' => '',
      );
    }
  }
  $form['flat_rate']['weight'] = array(
    '#type' => 'select',
    '#title' => t('Sort order'),
    '#options' => drupal_map_assoc(range(1, 250)),
    '#default_value' => $shipping_service['weight'],
    '#required' => TRUE,
  );
  $form['actions'] = array(
    '#type' => 'container',
    '#attributes' => array(
      'class' => array(
        'form-actions',
      ),
    ),
    '#weight' => 40,
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save flat rate'),
  );
  if (!empty($form_state['shipping_service']['name'])) {
    $form['actions']['delete'] = array(
      '#type' => 'submit',
      '#value' => t('Delete flat rate'),
      '#suffix' => l(t('Cancel'), 'admin/commerce/config/shipping/services/flat-rate'),
      '#submit' => array(
        'commerce_flat_rate_service_form_delete_submit',
      ),
      '#weight' => 45,
    );
  }
  else {
    $form['actions']['submit']['#suffix'] = l(t('Cancel'), 'admin/commerce/config/shipping/services/flat-rate');
  }
  return $form;
}

/**
 * Validate handler: ensures a valid base rate was entered for the flat rate.
 */
function commerce_flat_rate_service_form_validate($form, &$form_state) {

  // Ensure the rate amount is numeric.
  if (!is_numeric($form_state['values']['flat_rate']['amount'])) {
    form_set_error('flat_rate][amount', t('You must enter a numeric value for the base rate amount.'));
  }
  else {

    // Convert the decimal amount value entered to an integer based amount value.
    form_set_value($form['flat_rate']['amount'], commerce_currency_decimal_to_amount($form_state['values']['flat_rate']['amount'], $form_state['values']['flat_rate']['currency_code']), $form_state);
  }
}

/**
 * Submit handler: saves the new or updated flat rate service.
 */
function commerce_flat_rate_service_form_submit($form, &$form_state) {
  $shipping_service = $form_state['shipping_service'];

  // Update the shipping service array with values from the form.
  foreach (array(
    'name',
    'title',
    'display_title',
    'description',
    'amount',
    'currency_code',
    'weight',
  ) as $key) {
    $shipping_service[$key] = $form_state['values']['flat_rate'][$key];
  }

  // If a tax was specified for inclusion, add it to the data array.
  if (!empty($form_state['values']['flat_rate']['include_tax'])) {
    $shipping_service['data']['include_tax'] = $form_state['values']['flat_rate']['include_tax'];
  }
  elseif (!empty($shipping_service['data']['include_tax'])) {
    unset($shipping_service['data']['include_tax']);
  }

  // Save the shipping service.
  unset($shipping_service['base_rate']);
  $op = commerce_flat_rate_service_save($shipping_service);
  if (!$op) {
    drupal_set_message(t('The flat rate service failed to save properly. Please review the form and try again.'), 'error');
    $form_state['rebuild'] = TRUE;
  }
  else {
    drupal_set_message(t('Flat rate service saved.'));
    $form_state['redirect'] = 'admin/commerce/config/shipping/services/flat-rate';
  }
}

/**
 * Submit handler: redirects to the flat rate service delete confirmation form.
 *
 * @see commerce_flat_rate_service_form()
 */
function commerce_flat_rate_service_form_delete_submit($form, &$form_state) {
  $form_state['redirect'] = 'admin/commerce/config/shipping/services/flat-rate-' . strtr($form_state['shipping_service']['name'], '_', '-') . '/delete';
}

/**
 * Displays the edit form for an existing flat rate service.
 *
 * @param $name
 *   The machine-name of the flat rate service to edit.
 */
function commerce_flat_rate_service_edit_page($name) {
  return drupal_get_form('commerce_flat_rate_service_form', commerce_shipping_service_load($name));
}

/**
 * Builds the form for deleting flat rate services.
 */
function commerce_flat_rate_service_delete_form($form, &$form_state, $shipping_service) {
  $form_state['shipping_service'] = $shipping_service;
  $form = confirm_form($form, t('Are you sure you want to delete the <em>%title</em> flat rate service?', array(
    '%title' => $shipping_service['title'],
  )), 'admin/commerce/config/shipping/services/flat-rate', '<p>' . t('This action cannot be undone.') . '</p>', t('Delete'), t('Cancel'), 'confirm');
  return $form;
}

/**
 * Submit callback for commerce_flat_rate_service_delete_form().
 */
function commerce_flat_rate_service_delete_form_submit($form, &$form_state) {
  $shipping_service = $form_state['shipping_service'];
  commerce_flat_rate_service_delete($shipping_service['name']);
  drupal_set_message(t('The flat rate service <em>%title</em> has been deleted.', array(
    '%title' => $shipping_service['title'],
  )));
  watchdog('commerce_flat_rate', 'Deleted flat rate service <em>%title</em>.', array(
    '%title' => $shipping_service['title'],
  ), WATCHDOG_NOTICE);
  $form_state['redirect'] = 'admin/commerce/config/shipping/services/flat-rate';
}

/**
 * Displays the delete confirmation form for an existing flat rate service.
 *
 * @param $name
 *   The machine-name of the flat rate service to delete.
 */
function commerce_flat_rate_service_delete_page($name) {
  return drupal_get_form('commerce_flat_rate_service_delete_form', commerce_shipping_service_load($name));
}

/**
 * Form callback: builds the form to make a flat rate service the default.
 */
function commerce_flat_rate_service_make_default_form($form, &$form_state, $name) {
  $form['service_name'] = array(
    '#type' => 'value',
    '#value' => $name,
  );
  return confirm_form($form, t('Are you sure you want to make <em>%title</em> the default flat rate service?', array(
    '%title' => commerce_shipping_service_get_title($name),
  )), 'admin/commerce/config/shipping/services/flat-rate', '', t('Make default'), t('Cancel'), 'confirm');
}

/**
 * Form callback: submits the form to make a flat rate service the default.
 */
function commerce_flat_rate_service_make_default_form_submit($form, &$form_state) {
  $name = $form_state['values']['service_name'];
  commerce_flat_rate_set_default_service($name);
  menu_rebuild();
  drupal_set_message(t('%title is now the default flat rate shipping service.', array(
    '%title' => commerce_shipping_service_get_title($name),
  )));
  $form_state['redirect'] = 'admin/commerce/config/shipping/services/flat-rate';
}

/**
 * Form callback: builds the form to unset the default flat rate service.
 */
function commerce_flat_rate_service_unset_default_form($form, &$form_state) {
  return confirm_form($form, t('Are you sure you want to unset the default flat rate service?'), 'admin/commerce/config/shipping/services/flat-rate', '', t('Unset default'), t('Cancel'), 'confirm');
}

/**
 * Form callback: submits the form to unset the default flat rate service.
 */
function commerce_flat_rate_service_unset_default_form_submit($form, &$form_state) {
  commerce_flat_rate_set_default_service('');
  menu_rebuild();
  drupal_set_message(t('Default flat rate service unset. The checkout form will default to the first available shipping service.'));
  $form_state['redirect'] = 'admin/commerce/config/shipping/services/flat-rate';
}

Functions

Namesort descending Description
commerce_flat_rate_service_delete_form Builds the form for deleting flat rate services.
commerce_flat_rate_service_delete_form_submit Submit callback for commerce_flat_rate_service_delete_form().
commerce_flat_rate_service_delete_page Displays the delete confirmation form for an existing flat rate service.
commerce_flat_rate_service_edit_page Displays the edit form for an existing flat rate service.
commerce_flat_rate_service_form Builds the form for adding and editing flat rate services.
commerce_flat_rate_service_form_delete_submit Submit handler: redirects to the flat rate service delete confirmation form.
commerce_flat_rate_service_form_submit Submit handler: saves the new or updated flat rate service.
commerce_flat_rate_service_form_validate Validate handler: ensures a valid base rate was entered for the flat rate.
commerce_flat_rate_service_make_default_form Form callback: builds the form to make a flat rate service the default.
commerce_flat_rate_service_make_default_form_submit Form callback: submits the form to make a flat rate service the default.
commerce_flat_rate_service_unset_default_form Form callback: builds the form to unset the default flat rate service.
commerce_flat_rate_service_unset_default_form_submit Form callback: submits the form to unset the default flat rate service.