dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
Entrepot Class Reference

Class to manage warehouses. More...

+ Inheritance diagram for Entrepot:
+ Collaboration diagram for Entrepot:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 create ($user)
 Creation d'un entrepot en base. More...
 
 update ($id, $user)
 Update properties of a warehouse. More...
 
 delete ($user, $notrigger=0)
 Delete a warehouse. More...
 
 fetch ($id, $ref='')
 Load warehouse data. More...
 
 info ($id)
 Load warehouse info data. More...
 
 list_array ($status=1)
 Return list of all warehouses. More...
 
 nb_different_products ()
 Return number of unique different product into a warehouse. More...
 
 nb_products ()
 Return stock and value of warehosue. More...
 
 getLibStatut ($mode=0)
 Return label of status of object. More...
 
 LibStatut ($statut, $mode=0)
 Return label of a given status. More...
 
 getNomUrl ($withpicto=0, $option='', $showfullpath=0, $notooltip=0)
 Return clickable name (possibility with the pictogram) More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 get_full_arbo ()
 Return full path to current warehouse. More...
 
 get_children_warehouses ($id, &$TChildWarehouses)
 Return array of children warehouses ids from $id warehouse (recursive function) More...
 
 generateDocument ($modele, $outputlangs='', $hidedetails=0, $hidedesc=0, $hideref=0)
 Create object on disk. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Load the project with id $this->fk_project into this->project. More...
 
 fetch_product ()
 Load the product with id $this->fk_product into this->product. More...
 
 fetch_user ($userid)
 Load the user with id $userid into this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key, $element=null)
 Load object from specific field. More...
 
 getValueFrom ($table, $id, $field)
 Getter generic. More...
 
 setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
 Setter generic. More...
 
 load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
 Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...
 
 getListContactId ($source='external')
 Return list of id of contacts of object. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 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). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 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). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 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. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 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). More...
 
 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. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Public Attributes

const STATUS_CLOSED = 0
 Warehouse closed, inactive.
 
const STATUS_OPEN_ALL = 1
 Warehouse open and operations for customer shipping, supplier dispatch, internal stock transfers/corrections allowed.
 
const STATUS_OPEN_INTERNAL = 2
 Warehouse open and operations for stock transfers/corrections allowed (not for customer shipping and supplier dispatch).
 
 $zip
 Code Postal.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- 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. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
- 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. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage warehouses.

Definition at line 34 of file entrepot.class.php.

Constructor & Destructor Documentation

◆ __construct()

Entrepot::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 95 of file entrepot.class.php.

Member Function Documentation

◆ create()

Entrepot::create (   $user)

Creation d'un entrepot en base.

Parameters
User$userObject user that create the warehouse
Returns
int >0 if OK, =<0 if KO

Definition at line 118 of file entrepot.class.php.

◆ delete()

Entrepot::delete (   $user,
  $notrigger = 0 
)

Delete a warehouse.

Parameters
User$userObject user that made deletion
int$notrigger1=No trigger
Returns
int <0 if KO, >0 if OK

Definition at line 255 of file entrepot.class.php.

◆ fetch()

Entrepot::fetch (   $id,
  $ref = '' 
)

Load warehouse data.

Parameters
int$idWarehouse id
string$refWarehouse label
Returns
int >0 if OK, <0 if KO

Definition at line 326 of file entrepot.class.php.

◆ generateDocument()

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

Create object on disk.

Parameters
string$modeleforce le modele a utiliser ('' to not force)
Translate$outputlangsObject langs to use for output
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
Returns
int 0 if KO, 1 if OK

Definition at line 750 of file entrepot.class.php.

◆ get_children_warehouses()

Entrepot::get_children_warehouses (   $id,
$TChildWarehouses 
)

Return array of children warehouses ids from $id warehouse (recursive function)

Parameters
int$idid parent warehouse
array$TChildWarehousesarray which will contain all children (param by reference)
Returns
array $TChildWarehouses array which will contain all children

Definition at line 721 of file entrepot.class.php.

Referenced by update().

◆ get_full_arbo()

Entrepot::get_full_arbo ( )

Return full path to current warehouse.

Returns
string String full path to current warehouse separated by " >> "

Definition at line 677 of file entrepot.class.php.

◆ getLibStatut()

Entrepot::getLibStatut (   $mode = 0)

Return label of status of object.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
Returns
string Label of status

Definition at line 538 of file entrepot.class.php.

◆ getNomUrl()

Entrepot::getNomUrl (   $withpicto = 0,
  $option = '',
  $showfullpath = 0,
  $notooltip = 0 
)

Return clickable name (possibility with the pictogram)

Parameters
int$withpictowith pictogram
string$optionWhere the link point to
int$showfullpath0=Show ref only. 1=Show full path instead of Ref (this->fk_parent must be defined)
int$notooltip1=Disable tooltip
Returns
string String with URL

Definition at line 602 of file entrepot.class.php.

◆ info()

Entrepot::info (   $id)

Load warehouse info data.

Parameters
int$idwarehouse id
Returns
void

Definition at line 389 of file entrepot.class.php.

◆ initAsSpecimen()

Entrepot::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 650 of file entrepot.class.php.

◆ LibStatut()

Entrepot::LibStatut (   $statut,
  $mode = 0 
)

Return label of a given status.

Parameters
int$statutStatus
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
Returns
string Label of status

Definition at line 551 of file entrepot.class.php.

◆ list_array()

Entrepot::list_array (   $status = 1)

Return list of all warehouses.

Parameters
int$statusStatus
Returns
array Array list of warehouses

Definition at line 437 of file entrepot.class.php.

◆ nb_different_products()

Entrepot::nb_different_products ( )

Return number of unique different product into a warehouse.

Returns
Array Array('nb'=>Nb, 'value'=>Value)

Definition at line 469 of file entrepot.class.php.

◆ nb_products()

Entrepot::nb_products ( )

Return stock and value of warehosue.

Returns
Array Array('nb'=>Nb, 'value'=>Value)

Definition at line 503 of file entrepot.class.php.

◆ update()

Entrepot::update (   $id,
  $user 
)

Update properties of a warehouse.

Parameters
int$idid of warehouse to modify
User$userUser object
Returns
int >0 if OK, <0 if KO

Definition at line 192 of file entrepot.class.php.

References get_children_warehouses().


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