function uc_shipping_views_data in Ubercart 7.3
Implements hook_views_data().
File
- shipping/
uc_shipping/ views/ uc_shipping.views.inc, line 11 - Views hooks for Ubercart shipping.
Code
function uc_shipping_views_data() {
$data['uc_shipments']['table']['group'] = t('Shipment');
// Allow base tables of shipments.
$data['uc_shipments']['table']['base'] = array(
'field' => 'sid',
// This is the identifier field for the view.
'title' => t('Ubercart shipments'),
'help' => t('Ubercart shipments contain shipping information for orders and can be related to orders and packages.'),
);
// Shipment relationship for orders.
$data['uc_orders']['shipments'] = array(
'relationship' => array(
'title' => t('Shipments'),
'help' => t('Relate shipments to an order. This relationship will create one record for each shipment.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_shipments',
'base field' => 'order_id',
'relationship field' => 'order_id',
'label' => t('shipment'),
),
);
// Order relationship for shipments.
$data['uc_shipments']['order'] = array(
'relationship' => array(
'title' => t('Order'),
'help' => t('Relate an order to a shipment. Use this relationship to get order information for a shipment.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_orders',
'base field' => 'order_id',
'relationship field' => 'order_id',
'label' => t('order'),
),
);
// Expose packages to their shipments as a relationship.
$data['uc_shipments']['packages'] = array(
'relationship' => array(
'title' => t('Packages'),
'help' => t('Relate packages to a shipment. This relationship will create one record for each shipped package.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_packages',
'base field' => 'sid',
'relationship field' => 'sid',
'label' => t('package'),
),
);
// Shipment ID field.
$data['uc_shipments']['sid'] = array(
'title' => t('Shipment ID'),
'help' => t('The shipment ID.'),
'field' => array(
'handler' => 'uc_shipping_handler_field_shipment_id',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'title',
'numeric' => TRUE,
'validate type' => 'sid',
),
);
// Order ID field.
$data['uc_shipments']['order_id'] = array(
'title' => t('Order ID'),
'help' => t('The order ID.'),
'field' => array(
'handler' => 'uc_order_handler_field_order_id',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'title',
'numeric' => TRUE,
'validate type' => 'order_id',
),
);
// Carrier field.
$data['uc_shipments']['carrier'] = array(
'title' => t('Carrier'),
'help' => t('The company making the delivery.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
// Shipment transaction ID field.
$data['uc_shipments']['transaction_id'] = array(
'title' => t('Transaction ID'),
'help' => t("The carrier's shipment identifier."),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// Shipment tracking number field.
$data['uc_shipments']['tracking_number'] = array(
'title' => t('Tracking number'),
'help' => t('The number used by the carrier to locate the shipment while it is in transit.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
$data['uc_shipments']['ship_date'] = array(
'title' => t('Ship date'),
'help' => t('The date when the shipment left the origin address.'),
'field' => array(
'handler' => 'views_handler_field_date',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_date',
),
'filter' => array(
'handler' => 'views_handler_filter_date',
),
);
$data['uc_shipments']['expected_delivery'] = array(
'title' => t('Expected delivery date'),
'help' => t('The expected date of delivery.'),
'field' => array(
'handler' => 'views_handler_field_date',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_date',
),
'filter' => array(
'handler' => 'views_handler_filter_date',
),
);
$data['uc_shipments']['changed'] = array(
'title' => t('Last modified'),
'help' => t('The time the shipment was last modified.'),
'field' => array(
'handler' => 'views_handler_field_date',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort_date',
),
'filter' => array(
'handler' => 'views_handler_filter_date',
),
);
$data['uc_shipments']['cost'] = array(
'title' => t('Cost'),
'help' => t('The cost of the shipment.'),
'field' => array(
'handler' => 'uc_order_handler_field_money_amount',
'click sortable' => TRUE,
'float' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
);
$addresses = array(
'o' => t('Origin address'),
'd' => t('Delivery address'),
);
$fields = array(
'first_name' => t('First name'),
'last_name' => t('Last name'),
'company' => t('Company'),
'street1' => t('Street address 1'),
'street2' => t('Street address 2'),
'city' => t('City'),
'postal_code' => t('Postal code'),
);
foreach ($addresses as $prefix => $address) {
$group = t('Shipment') . ': ' . $address;
foreach ($fields as $field => $label) {
$data['uc_shipments'][$prefix . '_' . $field] = array(
'group' => $group,
'title' => $label,
'help' => t('The !field of the !address of the shipment.', array(
'!field' => drupal_strtolower($label),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
}
// uc_order is required by shipping module so is safe to use uc_order handler.
$data['uc_shipments'][$prefix . '_full_name'] = array(
'group' => $group,
'title' => t('Full name'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('full name'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'additional fields' => array(
$prefix . '_first_name',
$prefix . '_last_name',
),
'handler' => 'uc_order_handler_field_order_fullname',
'prefix' => $prefix,
),
);
$data['uc_shipments_' . $prefix . '_countries']['table']['group'] = $group;
$data['uc_shipments_' . $prefix . '_countries']['table']['join']['uc_shipments'] = array(
'table' => 'uc_countries',
'left_field' => $prefix . '_country',
'field' => 'country_id',
);
$data['uc_shipments_' . $prefix . '_countries']['country_id'] = array(
'title' => t('ISO country code (numeric)'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('numeric ISO country code'),
'!address' => drupal_strtolower($address),
)),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'country_iso_code_2',
'numeric' => TRUE,
'validate type' => 'country_id',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
);
$data['uc_shipments_' . $prefix . '_countries']['country_name'] = array(
'title' => t('Country'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('country name'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
$data['uc_shipments_' . $prefix . '_countries']['country_iso_code_2'] = array(
'title' => t('ISO country code (2 characters)'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('ISO country code'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
$data['uc_shipments_' . $prefix . '_countries']['country_iso_code_3'] = array(
'title' => t('ISO country code (3 characters)'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('ISO country code'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
$data['uc_shipments_' . $prefix . '_zones']['table']['group'] = $group;
$data['uc_shipments_' . $prefix . '_zones']['table']['join']['uc_shipments'] = array(
'table' => 'uc_zones',
'left_field' => $prefix . '_zone',
'field' => 'zone_id',
);
$data['uc_shipments_' . $prefix . '_zones']['zone_name'] = array(
'title' => t('State/Province'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('state or province'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
$data['uc_shipments_' . $prefix . '_zones']['zone_code'] = array(
'title' => t('State/Province code'),
'help' => t('The !field of the !address of the shipment.', array(
'!field' => t('state or province code'),
'!address' => drupal_strtolower($address),
)),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
}
// Expose packages.
$data['uc_packages']['table']['group'] = t('Package');
// Allow base tables of packages.
$data['uc_packages']['table']['base'] = array(
'field' => 'sid',
// This is the identifier field for the view.
'title' => t('Ubercart packages'),
'help' => t('Ubercart packages contain physical characteristics, tracking, and label information. They can be related to their orders, shipments, and contents.'),
);
// Expose packages to their order as a relationship.
// Packages can exists without a shipment so this relationship may be useful.
$data['uc_orders']['packages'] = array(
'relationship' => array(
'title' => t('Packages'),
'help' => t('Relate packages to an order. This relationship will create one record for each package of an order.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_packages',
'base field' => 'order_id',
'relationship field' => 'order_id',
'label' => t('package'),
),
);
// Order relationship for packages.
$data['uc_packages']['order'] = array(
'relationship' => array(
'title' => t('Order'),
'help' => t('Relate an order to a package. Use this relationship to get order information for a package.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_orders',
'base field' => 'order_id',
'relationship field' => 'order_id',
'label' => t('order'),
),
);
// Expose packaged products to their package as a relationship.
$data['uc_packages']['packaged_products'] = array(
'relationship' => array(
'title' => t('Products'),
'help' => t('Relate packaged products to a package. This relationship will create one record for each packaged product.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_packaged_products',
'base field' => 'package_id',
'relationship field' => 'package_id',
'label' => t('product'),
),
);
// Expose shipments to their packages as a relationship.
$data['uc_packages']['shipment'] = array(
'relationship' => array(
'title' => t('Shipment'),
'help' => t('Relate shipment to package. Use this relationship to get shipping information for the package. Note that this relationship might not exist.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_shipments',
'base field' => 'sid',
'relationship field' => 'sid',
'label' => t('shipment'),
),
);
// Package ID field.
// We don't redirect to the shipment page because a package can exist without a shipment.
$data['uc_packages']['package_id'] = array(
'title' => t('Package ID'),
'help' => t('The package ID.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'title',
'numeric' => TRUE,
'validate type' => 'sid',
),
);
// Shipment ID field.
$data['uc_packages']['sid'] = array(
'title' => t('Shipment ID'),
'help' => t('The shipment ID.'),
'field' => array(
'handler' => 'uc_shipping_handler_field_shipment_id',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'title',
'numeric' => TRUE,
'validate type' => 'sid',
),
);
// Order ID field.
$data['uc_packages']['order_id'] = array(
'title' => t('Order ID'),
'help' => t('The order ID.'),
'field' => array(
'handler' => 'uc_order_handler_field_order_id',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
'argument' => array(
'handler' => 'views_handler_argument_numeric',
'name field' => 'title',
'numeric' => TRUE,
'validate type' => 'order_id',
),
);
// Shipment type field.
$data['uc_packages']['shipping_type'] = array(
'title' => t('Shipment type'),
'help' => t('The basic type of shipment, e.g.: small package, freight, etc.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
// Package type.
$data['uc_packages']['pkg_type'] = array(
'title' => t('Package type'),
'help' => t('The type of packaging.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
);
// Package value.
$data['uc_packages']['value'] = array(
'title' => t('Value'),
'help' => t('The monetary value of the package contents.'),
'field' => array(
'handler' => 'uc_order_handler_field_money_amount',
'click sortable' => TRUE,
'float' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
);
// Package tracking number field.
$data['uc_packages']['tracking_number'] = array(
'title' => t('Tracking number'),
'help' => t('The number used by the carrier to locate the package while it is in transit.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_string',
),
'argument' => array(
'handler' => 'views_handler_argument_string',
),
);
// Package length field.
$data['uc_packages']['length'] = array(
'title' => t('Length'),
'help' => t('The physical length.'),
'field' => array(
'additional fields' => array(
'field' => 'length_units',
),
'handler' => 'uc_product_handler_field_length',
'click sortable' => TRUE,
'float' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_float',
),
);
// Package width field.
$data['uc_packages']['width'] = array(
'title' => t('Width'),
'help' => t('The physical width.'),
'field' => array(
'additional fields' => array(
'field' => 'length_units',
),
'handler' => 'uc_product_handler_field_length',
'click sortable' => TRUE,
'float' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_float',
),
);
// Package height field.
$data['uc_packages']['height'] = array(
'title' => t('Height'),
'help' => t('The physical height.'),
'field' => array(
'additional fields' => array(
'field' => 'length_units',
),
'handler' => 'uc_product_handler_field_length',
'click sortable' => TRUE,
'float' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_float',
),
);
// Package weight field.
$data['uc_packages']['weight'] = array(
'title' => t('Weight'),
'help' => t('The physical weight of package.'),
'field' => array(
'additional fields' => array(
'package_id',
),
'handler' => 'uc_shipping_handler_field_package_weight',
'click sortable' => FALSE,
'float' => TRUE,
),
);
// Expose packaged products.
$data['uc_packaged_products']['table']['group'] = t('Package: Product');
// Expose packaged products to the ordered product as a relationship.
// By using a relation and not expose fields directly we make sure that
// when ordered products will be fieldable entities all their custom fields,
// the one not stored in the schema, will get loaded.
$data['uc_packaged_products']['uc_order_products'] = array(
'relationship' => array(
'title' => t('Ordered product'),
'help' => t('Relate packaged product to the ordered product.'),
'handler' => 'views_handler_relationship',
'base' => 'uc_order_products',
'base field' => 'order_product_id',
'relationship field' => 'order_product_id',
'label' => t('ordered product'),
),
);
// Packaged quantity field.
$data['uc_packaged_products']['qty'] = array(
'title' => t('Quantity'),
'help' => t('The quantity packaged.'),
'field' => array(
'handler' => 'views_handler_field',
'click sortable' => TRUE,
),
'sort' => array(
'handler' => 'views_handler_sort',
),
'filter' => array(
'handler' => 'views_handler_filter_numeric',
),
);
return $data;
}