HikaShop – Best practice for saving custom shipping data (locker selection)

public function onBeforeOrderCreate(&$order, &$do) {
    if(empty($order->order_shipping_method))
        return;

    $app = JFactory::getApplication();
    $cart_shipping_ids = $order->cart->cart_shipping_ids;
    $process = array();
    
    // Find which shipping methods belong to this plugin
    foreach($cart_shipping_ids as $shipping_id) {
        list($sip, $warehouse) = explode('@', $shipping_id, 2);
        $current = null;
        foreach($order->cart->shipping as $shipping) {
            if($shipping->shipping_id != $sip)
                continue;
            $current = $shipping;
            break;
        }
        if(empty($current) || $current->shipping_type != $this->name)
            continue;
        $process[$warehouse] = $sip;
    }
    
    if(empty($process))
        return;

    if(empty($order->cart->cart_params->shipping)) {
        $app->enqueueMessage('BoxNow: Please select a locker', 'error');
        $do = false;
        return;
    }

    $order_shipping_params = $order->order_shipping_params;
    
    foreach($process as $warehouse => $id) {
        // Get the locker ID from cart_params->shipping
        $shipping_data = null;
        if(is_object($order->cart->cart_params->shipping) && isset($order->cart->cart_params->shipping->{$warehouse}))
            $shipping_data = $order->cart->cart_params->shipping->{$warehouse};
        if(is_array($order->cart->cart_params->shipping) && isset($order->cart->cart_params->shipping[$warehouse]))
            $shipping_data = $order->cart->cart_params->shipping[$warehouse];
            
        if(empty($shipping_data))
            continue;
            
        $locker_id = isset($shipping_data->{$id}->locker_id) ? $shipping_data->{$id}->locker_id : '';
        
        if(empty($locker_id))
            continue;
        
        // Get the FULL locker data from session cache
        $full_data = @$_SESSION['boxnow_locations'][$locker_id];
        if(empty($full_data)) {
            $app->enqueueMessage('BoxNow: Invalid locker selection', 'error');
            $do = false;
            return;
        }
        
        // Store full data in order_shipping_params
        if(empty($order_shipping_params->boxnow_locker))
            $order_shipping_params->boxnow_locker = array();
        $order_shipping_params->boxnow_locker[$warehouse] = $full_data;
    }
    
    $order->order_shipping_params = $order_shipping_params;
}

// Build the input name prefix
$map = 'checkout[shipping][custom]';
if(isset($order->shipping_warehouse_id)) {
    $map .= '['.$order->shipping_warehouse_id.']';
}
$map .= '['.$rate->shipping_id.']';
// Cache the full locker data from your widget/API in the session
$_SESSION['boxnow_locations'][$locker_id] = $full_locker_data_from_api;
// Your form inputs - only need to pass the locker ID
$rate->custom_html = '<select name="'.$map.'[locker_id]" onchange="...">';
foreach($locations as $id => $location) {
    $rate->custom_html .= '<option value="'.$id.'">'.$location['name'].'</option>';
}
$rate->custom_html .= '</select>';

$data['shipping']['custom'][$group][$id]

public function onShippingCustomSave(&$cart, &$shipping, $warehouse_id, $custom_data) {
    if(empty($custom_data['locker_id'])) {
        JFactory::getApplication()->enqueueMessage('Please select a locker', 'error');
        return false;
    }
    
    $ret = new stdClass();
    $ret->locker_id = $custom_data['locker_id'];
    return $ret;
}

public function onHikashopBeforeDisplayView(&$viewObj) {
    $viewName = $viewObj->getName();
    $layout = $viewObj->getLayout();
    
    if($viewName == 'order' && $layout == 'show') {
        if(empty($viewObj->order->order_shipping_params->boxnow_locker))
            return;
            
        $app = JFactory::getApplication();
        if($app->isClient('administrator')) {
            $content = '';
            foreach($viewObj->order->order_shipping_params->boxnow_locker as $warehouse => $data) {
                $content .= '<strong>'.$data['name'].'</strong><br/>';
                $content .= $data['address'].'<br/>';
                $content .= $data['zipcode'].' '.$data['city'];
            }
            
            if(empty($viewObj->extra_data))
                $viewObj->extra_data = array();
            if(empty($viewObj->extra_data['additional']))
                $viewObj->extra_data['additional'] = array();
                
            $viewObj->extra_data['additional']['boxnow'] = array(
                'title' => 'BoxNow Locker',
                'data' => $content
            );
        }
    }
}

public function onAfterOrderProductsListingDisplay(&$orderObject, $name) {
    // Check if we have shipping params
    if(empty($orderObject->order_shipping_params))
        return;
    
    // Handle both serialized string and object formats
    $shipping_params = is_string($orderObject->order_shipping_params) 
        ? hikashop_unserialize($orderObject->order_shipping_params) 
        : $orderObject->order_shipping_params;
    
    // Check if our plugin's data exists
    if(empty($shipping_params->boxnow_locker))
        return;
    
    // Build the content HTML
    $content = '';
    foreach($shipping_params->boxnow_locker as $warehouse => $data) {
        $lockerName = isset($data['name']) ? $data['name'] : '';
        $addr = isset($data['address']) ? $data['address'] : '';
        $zip = isset($data['zipcode']) ? $data['zipcode'] : '';
        $city = isset($data['city']) ? $data['city'] : '';

        $content .= '<p><strong>'.$lockerName.'</strong><br/>';
        $content .= $addr . '<br/>';
        $content .= $zip.' '.$city.'</p>';
    }

    // Handle different display contexts
    if($name == 'email_notification_html') {
        // For order notification emails - append to shipping address override
        if(empty($orderObject->override_shipping_address))
            $orderObject->override_shipping_address = '';
        $orderObject->override_shipping_address .= $content;
    } elseif($name == 'custom_display') {
        // For frontend order view - store in static variable for getShippingAddress()
        self::$address_override = $content;
    }
}

// Also implement getShippingAddress() for frontend order display
public function getShippingAddress($shipping_id = 0, $order = null) {
    if(!empty(self::$address_override))
        return '<strong>'.JText::_('BOXNOW_LOCKER_LOCATION').'</strong><br/>'.self::$address_override;
    return false;
}

checkout[shipping][custom][warehouse][shipping_id][field]

// In onShippingDisplay()
$value = ''; // Default: no locker selected

// Check if there's previously stored shipping data
$shipping_data = null;
if(!empty($order->cart_params->shipping) && is_object($order->cart_params->shipping) 
   && isset($order->cart_params->shipping->{$order->shipping_warehouse_id}))
    $shipping_data = $order->cart_params->shipping->{$order->shipping_warehouse_id};

if(!empty($order->cart_params->shipping) && is_array($order->cart_params->shipping) 
   && isset($order->cart_params->shipping[$order->shipping_warehouse_id]))
    $shipping_data = $order->cart_params->shipping[$order->shipping_warehouse_id];

if(!empty($shipping_data)) {
    $data = isset($shipping_data->{$rate->shipping_id}) ? $shipping_data->{$rate->shipping_id} : null;
    // Restore the previously selected value
    $value = !empty($data->locker_id) ? $data->locker_id : '';
}

// Now render the custom_html with the restored value
$rate->custom_html = '<input type="hidden" name="'.$map.'[locker_id]" value="'.htmlspecialchars($value).'" id="boxnow_locker_id_'.$rate->shipping_id.'"/>';
// ... rest of your widget HTML

1. User selects locker → JS updates hidden input
2. User clicks Submit → form submitted
3. onShippingCustomSave() → data saved to cart_params->shipping
4. AJAX refresh occurs → DOM replaced
5. onShippingDisplay() called → read cart_params->shipping → render hidden input with saved value
6. User continues checkout → value is present