Delivery Class Reference

Class to manage receptions. More...

Inheritance diagram for Delivery:

Collaboration diagram for Delivery:

Public Member Functions
	__construct ($db)
	Constructor.
	create ($user)
	Create delivery receipt in database.
	create_line ($origin_id, $qty, $fk_product, $description, $array_options=null)
	Create a line.
	fetch ($id)
	Load a delivery receipt.
	valid ($user, $notrigger=0)
	Validate object and update stock if option enabled.
	create_from_sending ($user, $sending_id)
	Creating the delivery slip from an existing shipment.
	update_line ($id, $array_options=0)
	Update a livraison line (only extrafields)
	addline ($origin_id, $qty, $array_options=null)
	Add line.
	deleteline ($lineid)
	Delete line.
	delete ($user=null)
	Delete object.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $save_lastsearch_value=-1)
	Return clicable name (with picto eventually)
	fetch_lines ()
	Load lines insto $this->lines.
	getLibStatut ($mode=0)
	Return the label of the status.
	LibStatut ($status, $mode)
	Return the label of a given status.
	initAsSpecimen ()
	Initialise an instance with random values.
	getRemainingDelivered ()
	Renvoie la quantite de produit restante a livrer pour une commande.
	setDeliveryDate ($user, $delivery_date)
	Set the planned delivery date.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create object on disk.
Public Member Functions inherited from CommonObject
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=false, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output datas.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=false)
	Create object into database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=false)
	Update object into database.
	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=false)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
static	replaceProduct (DoliDB $db, $origin_id, $dest_id)
	Function used to replace a product id with another one.
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

Additional Inherited Members
Public Attributes inherited from CommonObject
	$fk_projet
	$expedition
	$livraison
	$commandeFournisseur
	$note
	$date_modification
Protected Member Functions inherited from CommonObject
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

Class to manage receptions.

Definition at line 46 of file delivery.class.php.

Constructor & Destructor Documentation

__construct()

Delivery::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 133 of file delivery.class.php.

Member Function Documentation

addline()

Delivery::addline	(		$origin_id,
			$qty,
			$array_options = null )

Add line.

Parameters

int	$origin_id	Origin id
int	$qty	Qty
array	$array_options	Array options

Returns

void

Definition at line 639 of file delivery.class.php.

References getDolGlobalString().

create()

Delivery::create

(

$user

)

Create delivery receipt in database.

Parameters

User

$user

Objet du user qui cree

Returns

int Return integer <0 si erreur, id delivery cree si ok

Definition at line 149 of file delivery.class.php.

References CommonObject\add_object_linked(), create_line(), description, dol_now(), dol_syslog(), getDolGlobalInt(), CommonObject\setStatut(), and user.

Referenced by create_from_sending().

create_from_sending()

Delivery::create_from_sending	(		$user,
			$sending_id )

Creating the delivery slip from an existing shipment.

Parameters

User	$user	User who creates
int	$sending_id	Id of the expedition that serves as a model

Returns

integer Return integer <=0 if KO, >0 if OK

Definition at line 553 of file delivery.class.php.

References CommonObject\$expedition, create(), and getDolGlobalString().

create_line()

Delivery::create_line	(		$origin_id,
			$qty,
			$fk_product,
			$description,
			$array_options = null )

Create a line.

Parameters

string	$origin_id	Id of order
string	$qty	Quantity
string	$fk_product	Id of predefined product
string	$description	Description
array	$array_options	Array options

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 283 of file delivery.class.php.

References dol_syslog(), and price2num().

Referenced by create().

delete()

Delivery::delete

(

$user = null

)

Delete object.

Parameters

User

$user

User making the deletion

Returns

integer

Definition at line 684 of file delivery.class.php.

References CommonObject\call_trigger(), CommonObject\deleteObjectLinked(), dol_delete_dir(), dol_delete_file(), dol_sanitizeFileName(), and ref.

deleteline()

Delivery::deleteline

(

$lineid

)

Delete line.

Parameters

int

$lineid

Line id

Returns

integer Return integer <0 if KO, 0 if nothing done, >0 if OK

Definition at line 660 of file delivery.class.php.

References statut, and CommonObject\update_price().

fetch()

Delivery::fetch

(

$id

)

Load a delivery receipt.

Parameters

int

$id

Id of object to load

Returns

integer

Definition at line 323 of file delivery.class.php.

References dol_syslog(), fetch_lines(), CommonObject\fetch_optionals(), ref, status, and statut.

fetch_lines()

Delivery::fetch_lines

(

)

Load lines insto $this->lines.

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 845 of file delivery.class.php.

References dol_syslog().

Referenced by fetch().

generateDocument()

Delivery::generateDocument	(		$modele,
			$outputlangs,
			$hidedetails = 0,
			$hidedesc = 0,
			$hideref = 0 )

Create object on disk.

Parameters

string	$modele	force le modele a utiliser ('' to not force)
Translate	$outputlangs	Object langs to use for output
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref

Returns

int 0 if KO, 1 if OK

Definition at line 1120 of file delivery.class.php.

References CommonObject\commonGenerateDocument(), dol_strlen(), and getDolGlobalString().

getLibStatut()

Delivery::getLibStatut

(

$mode = 0

)

Return the label of the status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

Definition at line 922 of file delivery.class.php.

References LibStatut(), and statut.

getNomUrl()

Delivery::getNomUrl	(		$withpicto = 0,
			$save_lastsearch_value = -1 )

Return clicable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string Chaine avec URL

Definition at line 780 of file delivery.class.php.

References getDolGlobalInt(), and getTooltipContentArray().

getRemainingDelivered()

Delivery::getRemainingDelivered

(

)

Renvoie la quantite de produit restante a livrer pour une commande.

Returns

array|int Product remaining to be delivered or <0 if KO TODO use new function

Definition at line 1023 of file delivery.class.php.

References CommonObject\fetchObjectLinked().

getTooltipContentArray()

Delivery::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array

$params

params to construct tooltip data

Since

v18

Returns

array

Reimplemented from CommonObject.

Definition at line 759 of file delivery.class.php.

References img_picto().

Referenced by getNomUrl().

initAsSpecimen()

Delivery::initAsSpecimen

(

)

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns

void

Definition at line 970 of file delivery.class.php.

References dol_now(), and ref.

LibStatut()

Delivery::LibStatut	(		$status,
			$mode )

Return the label of a given status.

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns

string Label of status

Definition at line 935 of file delivery.class.php.

Referenced by getLibStatut().

replaceProduct()

static Delivery::replaceProduct ( DoliDB $db, $origin_id, $dest_id )

static

Function used to replace a product id with another one.

Parameters

DoliDB	$db	Database handler
int	$origin_id	Old product id
int	$dest_id	New product id

Returns

bool

Definition at line 1167 of file delivery.class.php.

References CommonObject\commonReplaceProduct().

replaceThirdparty()

static Delivery::replaceThirdparty ( DoliDB $dbs, $origin_id, $dest_id )

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

Definition at line 1150 of file delivery.class.php.

References CommonObject\commonReplaceThirdparty().

setDeliveryDate()

Delivery::setDeliveryDate	(		$user,
			$delivery_date )

Set the planned delivery date.

Parameters

User	$user	Objet utilisateur qui modifie
integer	$delivery_date	Delivery date

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 1089 of file delivery.class.php.

References dol_syslog().

update_line()

Delivery::update_line	(		$id,
			$array_options = 0 )

Update a livraison line (only extrafields)

Parameters

int	$id	Id of line (livraison line)
array	$array_options	extrafields array

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 605 of file delivery.class.php.

References getDolGlobalString().

valid()

Delivery::valid	(		$user,
			$notrigger = 0 )

Validate object and update stock if option enabled.

Parameters

User	$user	Object user that validate
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int

Definition at line 400 of file delivery.class.php.

References CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), getDolGlobalString(), ref, and statut.

---

The documentation for this class was generated from the following file:

• dolibarr_19.0/htdocs/delivery/class/delivery.class.php