function commerce_fedex_settings_form in Commerce FedEx 7

Builds the admin settings form for configuring FedEx.

Return value

array Drupal form for FedEx settings.

1 string reference to 'commerce_fedex_settings_form'

commerce_fedex_menu in ./commerce_fedex.module

Implements hook_menu().

File

includes/commerce_fedex.admin.inc, line 14

Admin functions for Commerce FedEx.

Code

function commerce_fedex_settings_form() {
  $request_mode = variable_get('commerce_fedex_request_mode', 'testing');
  $form = array();
  $form['auth'] = array(
    '#title' => t('FedEx web authentication'),
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
  );
  $form['auth']['commerce_fedex_request_mode'] = array(
    '#type' => 'radios',
    '#title' => t('FedEx Request Mode'),
    '#description' => t('If switching to production mode, make sure that you have acquired production credentials from FedEx. These will be different than your testing credentials.'),
    '#options' => array(
      'testing' => t('Testing'),
      'production' => t('Production'),
    ),
    '#default_value' => $request_mode,
  );
  $form['auth']['production'] = array(
    '#title' => t('Production Settings'),
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => $request_mode == 'production' ? FALSE : TRUE,
    '#states' => array(
      'expanded' => array(
        ':input[name=commerce_fedex_request_mode]' => array(
          'value' => 'production',
        ),
      ),
    ),
  );
  $form['auth']['production']['commerce_fedex_key'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Key'),
    '#default_value' => variable_get('commerce_fedex_key'),
    '#required' => $request_mode == 'production' ? TRUE : FALSE,
    '#states' => array(
      'required' => array(
        ':input[name=commerce_fedex_request_mode]' => array(
          'value' => 'production',
        ),
      ),
    ),
  );
  $form['auth']['production']['commerce_fedex_password'] = array(
    '#type' => 'password',
    '#title' => t('FedEx Password'),
    '#description' => variable_get('commerce_fedex_password') ? t('FedEx password has been set. Leave blank unless you want to change the saved password.') : NULL,
  );
  $form['auth']['production']['commerce_fedex_account_number'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Account Number'),
    '#default_value' => variable_get('commerce_fedex_account_number'),
  );
  $form['auth']['production']['commerce_fedex_meter_number'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Meter Number'),
    '#default_value' => variable_get('commerce_fedex_meter_number'),
  );
  $form['auth']['testing'] = array(
    '#title' => t('Test Settings'),
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#collapsed' => !$form['auth']['production']['#collapsed'],
    '#states' => array(
      'expanded' => array(
        ':input[name=commerce_fedex_request_mode]' => array(
          'value' => 'testing',
        ),
      ),
    ),
  );
  $form['auth']['testing']['commerce_fedex_key_testing'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Key'),
    '#default_value' => variable_get('commerce_fedex_key_testing'),
  );
  $form['auth']['testing']['commerce_fedex_password_testing'] = array(
    '#type' => 'password',
    '#title' => t('FedEx Password'),
    '#description' => variable_get('commerce_fedex_password_testing') ? t('FedEx password has been set. Leave blank unless you want to change the saved password.') : NULL,
  );
  $form['auth']['testing']['commerce_fedex_account_number_testing'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Account Number'),
    '#default_value' => variable_get('commerce_fedex_account_number_testing'),
  );
  $form['auth']['testing']['commerce_fedex_meter_number_testing'] = array(
    '#type' => 'textfield',
    '#title' => t('FedEx Meter Number'),
    '#default_value' => variable_get('commerce_fedex_meter_number_testing'),
  );
  foreach (element_children($form['auth']) as $mode) {
    foreach (element_children($form['auth'][$mode]) as $field_name) {
      $form['auth'][$mode][$field_name] += array(
        '#states' => array(
          'required' => array(
            ':input[name=commerce_fedex_request_mode]' => array(
              'value' => $mode,
            ),
          ),
        ),
      );
    }
  }
  $form['origin'] = array(
    '#type' => 'fieldset',
    '#title' => t('Ship From Address'),
    '#collapsible' => TRUE,
  );
  $form['origin']['commerce_fedex_shipper_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Name'),
    '#default_value' => variable_get('commerce_fedex_shipper_name'),
  );
  $form['origin']['commerce_fedex_company_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Company Name'),
    '#default_value' => variable_get('commerce_fedex_company_name'),
  );
  $form['origin']['commerce_fedex_address_line_1'] = array(
    '#type' => 'textfield',
    '#title' => t('Address'),
    '#required' => TRUE,
    '#default_value' => variable_get('commerce_fedex_address_line_1'),
  );
  $form['origin']['commerce_fedex_address_line_2'] = array(
    '#type' => 'textfield',
    '#title' => t('Address (Additional)'),
    '#default_value' => variable_get('commerce_fedex_address_line_2'),
  );
  $form['origin']['commerce_fedex_city'] = array(
    '#type' => 'textfield',
    '#title' => t('City'),
    '#required' => TRUE,
    '#default_value' => variable_get('commerce_fedex_city'),
  );
  $form['origin']['commerce_fedex_state'] = array(
    '#type' => 'textfield',
    '#title' => t('State or Province'),
    '#description' => t('If shipping from USA or Canada, enter the 2 character abbreviation for the shipping State or Province.'),
    '#default_value' => variable_get('commerce_fedex_state'),
    '#size' => 2,
  );
  $form['origin']['commerce_fedex_postal_code'] = array(
    '#type' => 'textfield',
    '#title' => t('Postal Code'),
    '#description' => t('Enter your postal code if available.'),
    '#size' => 12,
    '#default_value' => variable_get('commerce_fedex_postal_code'),
  );
  $form['origin']['commerce_fedex_country_code'] = array(
    '#type' => 'select',
    '#title' => t('Country'),
    '#default_value' => variable_get('commerce_fedex_country_code'),
    '#options' => array(
      '' => t('Select Country'),
    ) + commerce_fedex_serviced_countries(),
    '#required' => TRUE,
  );
  $form['services'] = array(
    '#type' => 'fieldset',
    '#title' => t('Enabled FedEx Shipping Services'),
    '#collapsible' => TRUE,
  );
  $form['services']['commerce_fedex_services'] = array(
    '#type' => 'checkboxes',
    '#options' => commerce_fedex_shipping_service_types(),
    '#default_value' => variable_get('commerce_fedex_services', array()),
  );
  $form['services']['smartpost'] = array(
    '#type' => 'fieldset',
    '#title' => t('FedEx SmartPost Configuration'),
    '#collapsible' => FALSE,
    '#states' => array(
      'visible' => array(
        ':input[name="commerce_fedex_services[SMART_POST]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
    '#description' => t('To use SmartPost, you will need to enter these SmartPost settings.'),
  );
  $form['services']['smartpost']['commerce_fedex_smartpost_indicia_type'] = array(
    '#title' => t('Indicia Type'),
    '#type' => 'select',
    '#options' => array(
      '' => t('Select indicia type'),
    ) + commerce_fedex_smartpost_indicia_types(),
    '#default_value' => variable_get('commerce_fedex_smartpost_indicia_type', ''),
    '#states' => array(
      'required' => array(
        ':input[name="commerce_fedex_services[SMART_POST]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
  );
  $form['services']['smartpost']['commerce_fedex_smartpost_hub_id'] = array(
    '#title' => t('Hub ID'),
    '#type' => 'select',
    '#options' => array(
      '' => t('Select Hub'),
    ) + commerce_fedex_smartpost_hub_ids(),
    '#default_value' => variable_get('commerce_fedex_smartpost_hub_id', ''),
    '#states' => array(
      'required' => array(
        ':input[name="commerce_fedex_services[SMART_POST]"]' => array(
          'checked' => TRUE,
        ),
      ),
    ),
  );
  $form['packaging'] = array(
    '#type' => 'fieldset',
    '#title' => t('FedEx Packaging'),
    '#collapsible' => TRUE,
  );
  $form['packaging']['commerce_fedex_default_package_type'] = array(
    '#type' => 'select',
    '#title' => t('Default package type'),
    '#options' => commerce_fedex_package_types(),
    '#default_value' => variable_get('commerce_fedex_default_package_type', 'YOUR_PACKAGING'),
    '#description' => t('FedEx package types are only for Express usage. If you want to use Ground or Ground Home Delivery, make sure that you select <em>Customer Supplied Packaging</em>.'),
  );
  $form['packaging']['default_package_size'] = array(
    '#type' => 'fieldset',
    '#title' => t('Default package size (inches)'),
    '#collapsible' => FALSE,
    '#description' => 'FedEx requires a package size when determining estimates.',
  );
  $form['packaging']['default_package_size']['commerce_fedex_default_package_size_length'] = array(
    '#type' => 'textfield',
    '#title' => t('Length'),
    '#size' => 5,
    '#required' => TRUE,
    '#default_value' => variable_get('commerce_fedex_default_package_size_length'),
  );
  $form['packaging']['default_package_size']['commerce_fedex_default_package_size_width'] = array(
    '#type' => 'textfield',
    '#title' => t('Width'),
    '#size' => 5,
    '#required' => TRUE,
    '#default_value' => variable_get('commerce_fedex_default_package_size_width'),
  );
  $form['packaging']['default_package_size']['commerce_fedex_default_package_size_height'] = array(
    '#type' => 'textfield',
    '#title' => t('Height'),
    '#size' => 5,
    '#required' => TRUE,
    '#default_value' => variable_get('commerce_fedex_default_package_size_height'),
  );
  $form['packaging']['default_package_size']['details'] = array(
    '#markup' => 'The package size is used to determine the number of packages
     necessary to create a FedEx shipping cost estimate. <strong>If products do
     not have physical dimensions and weights associated with them, the
     estimates will not be accurate.</strong> The logic implemented works as:
     <ul>
     <li>Assume each order requires at least one package.</li>
     <li>Use the combined volume of all products in an order to determine the
     number of packages.</li>
     </ul>
     This is a simple calculation that can get close to actual shipping costs.
     More complex logic involving multiple package sizes, weights, and void
     space can be implemented via custom modules.',
  );
  $form['options'] = array(
    '#type' => 'fieldset',
    '#title' => t('Other FedEx Options'),
    '#collapsible' => TRUE,
  );
  $form['options']['commerce_fedex_rate_service_type'] = array(
    '#type' => 'select',
    '#title' => t('Pricing options'),
    '#description' => t('Select the pricing option to use when requesting a rate quote. Note that discounted rates are only available when sending production requests.'),
    '#options' => array(
      'list' => t('Standard pricing (LIST)'),
      'account' => t('This FedEx account\'s discounted pricing (ACCOUNT)'),
    ),
    '#default_value' => variable_get('commerce_fedex_rate_service_type', 'list'),
  );
  $form['options']['commerce_fedex_shipto_residential'] = array(
    '#type' => 'select',
    '#title' => t('Ship to destination type'),
    '#description' => t('Leave this set as residential unless you only ship to commercial addresses.'),
    '#options' => array(
      'residential' => t('Residential'),
      'commercial' => t('Commercial'),
    ),
    '#default_value' => variable_get('commerce_fedex_shipto_residential', 'residential'),
  );
  $form['options']['commerce_fedex_dropoff'] = array(
    '#type' => 'select',
    '#title' => t('Default dropoff/pickup location for your FedEx shipments'),
    '#options' => commerce_fedex_dropoff_types(),
    '#default_value' => variable_get('commerce_fedex_dropoff', 'REGULAR_PICKUP'),
  );
  $form['options']['commerce_fedex_insurance'] = array(
    '#type' => 'checkbox',
    '#title' => t('Include insurance value of shippable line items in FedEx rate requests'),
    '#default_value' => variable_get('commerce_fedex_insurance'),
  );
  $form['options']['commerce_fedex_show_logo'] = array(
    '#type' => 'checkbox',
    '#title' => t('Display FedEx Logo next to FedEx services.'),
    '#default_value' => variable_get('commerce_fedex_show_logo', 0),
  );
  $form['options']['commerce_fedex_log'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Log the following messages for debugging'),
    '#options' => array(
      'request' => t('API request messages'),
      'response' => t('API response messages'),
    ),
    '#default_value' => variable_get('commerce_fedex_log', array()),
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  return $form;
}