function hook_shipment in Ubercart 5

Same name and namespace in other branches

1. 6.2 docs/hooks.php \hook_shipment()

Handle additional data for shipments.

Parameters

$op: The action being taken on the shipment. One of the following values:

• "load": The shipment and its packages are loaded from the database.
• "save": Changes to the shipment have been written.
• "delete": The shipment has been deleted and the packages are available for reshipment.

&$shipment: The shipment object.

Return value

Only given when $op is "load". An array of extra data to be added to the shipment object.

6 functions implement hook_shipment()

Note: this list is generated by pattern matching, so it may include some functions that are not actually implementations of this hook.

theme_uc_shipping_new_shipment in shipping/uc_shipping/uc_shipping.module

Format and display the new shipment form.

theme_uc_ups_confirm_shipment in shipping/uc_ups/uc_ups.module

Display final shipment information for review.

uc_shipping_make_shipment in shipping/uc_shipping/uc_shipping.module

Default method to send packages on a shipment.

uc_shipping_new_shipment in shipping/uc_shipping/uc_shipping.module

Set up a new shipment with the chosen packages.

uc_ups_confirm_shipment in shipping/uc_ups/uc_ups.module

Last chance for user to review shipment.

... See full list

3 invocations of hook_shipment()

uc_shipping_shipment_delete in shipping/uc_shipping/uc_shipping.module

Delete a shipment.

uc_shipping_shipment_load in shipping/uc_shipping/uc_shipping.module

Load a shipment and it's packages.

uc_shipping_shipment_save in shipping/uc_shipping/uc_shipping.module

Save a shipment.

File

docs/hooks.php, line 843

These are the hooks that are invoked by the Übercart core.

Code

function hook_shipment($op, &$shipment) {
  switch ($op) {
    case 'save':
      $google_order_number = uc_google_checkout_get_google_number($shipment->order_id);
      if ($google_order_number && $shipment->is_new) {
        $xml_data = '';
        foreach ($shipment->packages as $package) {
          if ($package->tracking_number) {
            $tracking_number = $package->tracking_number;
          }
          else {
            if ($shipment->tracking_number) {
              $tracking_number = $shipment->tracking_number;
            }
          }
          if ($tracking_number) {
            foreach ($package->products as $product) {
              $xml_data .= '<item-shipping-information>';
              $xml_data .= '<item-id>';
              $xml_data .= '<merchant-item-id>' . check_plain($product->nid . '|' . $product->model) . '</merchant-item-id>';
              $xml_data .= '</item-id>';
              $xml_data .= '<tracking-data-list>';
              $xml_data .= '<tracking-data>';
              $xml_data .= '<carrier>' . check_plain($shipment->carrier) . '</carrier>';
              $xml_data .= '<tracking-number>' . check_plain($tracking_number) . '</tracking-number>';
              $xml_data .= '</tracking-data>';
              $xml_data .= '</tracking-data-list>';
              $xml_data .= '</item-shipping-information>';
            }
          }
        }
        if ($xml_data) {
          $request = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
          $request .= '<ship-items xmlns="http://checkout.google.com/schema/2" google-order-number="' . $google_order_number . '">';
          $request .= '<item-shipping-information-list>';
          $request .= $xml_data;
          $request .= '</item-shipping-information-list>';
          $request .= '<send-email>true</send-email>';
          $request .= '</ship-items>';
          $response = uc_google_checkout_send_request('request', $request);
        }
      }
      break;
    case 'delete':
      $google_order_number = uc_google_checkout_get_google_number($shipment->order_id);
      if ($google_order_number) {
        foreach ($shipment->packages as $package) {
          foreach ($package->products as $product) {
            $reset_ids[] = check_plain($product->nid . '|' . $product->model);
          }
        }
        $request = '<?xml version="1.0" encoding="UTF-8"?>' . "\n";
        $request .= '<reset-items-shipping-information xmlns="http://checkout.google.com/schema/2" google-order-number="' . $google_order_number . '">';
        $request .= '<item-ids>';
        foreach (array_unique($reset_ids) as $item_id) {
          $request .= '<item-id>';
          $request .= '<merchant-item-id>' . $item_id . '</merchant-item-id>';
          $request .= '</item-id>';
        }
        $request .= '</item-ids>';
        $request .= '<send-email>false</send-email>';
        $request .= '</reset-items-shipping-information>';
      }
      $response = uc_google_checkout_send_request('request', $request);
      break;
  }
}