dolibarr 25.0.0-alpha
sendings.lib.php File Reference

Library for expedition module. More...

Go to the source code of this file.

Functions

 shippingGetStandaloneDispatchSourceLine ($object, $sourceLineId, $lineId, $productId)
 Resolve a standalone dispatch group from the loaded shipment lines.
 
 shippingSetStandaloneLineSellPrice ($line, $buyer)
 Complete a line of a standalone shipment (SHIPMENT_STANDALONE, no source order) before it is copied into an invoice.
 
 shipping_prepare_head ($object)
 Prepare array with list of tabs.
 
 delivery_prepare_head ($object)
 Prepare array with list of tabs.
 

Detailed Description

Library for expedition module.

Definition in file sendings.lib.php.

Function Documentation

◆ delivery_prepare_head()

delivery_prepare_head ( $object)

Prepare array with list of tabs.

Parameters
Delivery$objectObject related to tabs
Returns
array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 240 of file sendings.lib.php.

References $conf, $object, complete_head_from_modules(), Link\count(), dol_dir_list(), dol_getcache(), dol_sanitizeFileName(), dol_setcache(), dol_syslog(), getDolGlobalInt(), getDolGlobalString(), and isModEnabled().

◆ shipping_prepare_head()

shipping_prepare_head ( $object)

Prepare array with list of tabs.

Parameters
Expedition$objectObject related to tabs
Returns
array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 105 of file sendings.lib.php.

References $conf, $object, complete_head_from_modules(), Link\count(), dol_dir_list(), dol_getcache(), dol_sanitizeFileName(), dol_setcache(), dol_syslog(), getDolGlobalInt(), getDolGlobalString(), isModEnabled(), and Expedition\STATUS_DRAFT.

◆ shippingGetStandaloneDispatchSourceLine()

shippingGetStandaloneDispatchSourceLine ( $object,
$sourceLineId,
$lineId,
$productId )

Resolve a standalone dispatch group from the loaded shipment lines.

The caller must separately check shipment access and write permissions.

Parameters
Expedition$objectShipment with its lines loaded
int$sourceLineIdRoot shipment line identifying the dispatch group
int$lineIdExisting allocation id, or <= 0 for a new allocation
int$productIdProduct submitted for the allocation
Returns
ExpeditionLigne|null Stored source line, or null for an invalid dispatch

Definition at line 41 of file sendings.lib.php.

References $object, getDolGlobalString(), and Expedition\STATUS_DRAFT.

◆ shippingSetStandaloneLineSellPrice()

shippingSetStandaloneLineSellPrice ( $line,
$buyer )

Complete a line of a standalone shipment (SHIPMENT_STANDALONE, no source order) before it is copied into an invoice.

Such a line has no price nor VAT: use the selling price and the default VAT rate of the product for the customer.

Parameters
CommonObjectLine$lineShipment line, completed in place
Societe$buyerCustomer of the invoice
Returns
void

Definition at line 80 of file sendings.lib.php.

References $mysoc.