ProductFournisseur
class ProductFournisseur extends Product (View source)
Class to manage predefined suppliers products
Traits
Class for handling deprecated properties and methods
Parent class of all other business classes (invoices, contracts, proposals, orders, ...)
Constants
| SELL_OR_EAT_BY_MANDATORY_ID_NONE |
Const sell or eat by mandatory id |
| SELL_OR_EAT_BY_MANDATORY_ID_SELL_BY |
|
| SELL_OR_EAT_BY_MANDATORY_ID_EAT_BY |
|
| SELL_OR_EAT_BY_MANDATORY_ID_SELL_AND_EAT |
|
| TYPE_PRODUCT |
Regular product |
| TYPE_SERVICE |
Service |
| DISABLED_STOCK |
Stockable product |
| ENABLED_STOCK |
|
| STATUS_OPEN |
|
| STATUS_CANCELED |
|
Properties
| DoliDB | $db | ||
| string | $error | ||
| string[] | $errors | from CommonTrigger | |
| string | $TRIGGER_PREFIX | ||
| string | $module | from CommonObject | |
| int | $id | ||
| ?int | $entity | from CommonObject | |
| $errorhidden | from CommonObject | ||
| string[] | $warnings | from CommonObject | |
| string | $element | from Product | |
| string | $fk_element | from Product | |
| string | $element_for_permission | from CommonObject | |
| string | $table_element | from Product | |
| ?string | $table_rowid | from CommonObject | |
| string | $table_element_line | from CommonObject | |
| int<0, 1>|string|null | $ismultientitymanaged | from CommonObject | |
| ?string | $import_key | from CommonObject | |
| array<string, mixed> | $array_options | from CommonObject | |
| array<string, array{type: string, label: string, langfile?: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int<-6, 6>|string, alwayseditable?: int<0, 1>|string, noteditable?: int<0, 1>, default?: string, index?: int, foreignkey?: string, searchall?: int<0, 1>, isameasure?: int<0, 1>, css?: string, cssview?: string, csslist?: string, help?: string, showoncombobox?: int<0, 4>|string, disabled?: int<0, 1>, arrayofkeyval?: array<int|string, string>, autofocusoncreate?: int<0, 1>, comment?: string, copytoclipboard?: int<1, 2>, validate?: int<0, 1>, showonheader?: int<0, 1>, searchmulti?: int<0, 1>}> | $fields | from Product | |
| array<string, array<string, string>> | $array_languages | from CommonObject | |
| array<int, array{parentId: int, source: string, socid: int, id: int, nom: string, civility: string, lastname: string, firstname: string, email: string, login: string, photo: string, statuscontact: int, rowid: int, code: string, libelle: string, status: int, fk_c_type_contact: int}> | $contacts_ids | from CommonObject | |
| array<int, array{parentId: int, source: string, socid: int, id: int, nom: string, civility: string, lastname: string, firstname: string, email: string, login: string, photo: string, statuscontact: int, rowid: int, code: string, libelle: string, status: int, fk_c_type_contact: int}> | $contacts_ids_internal | from CommonObject | |
| mixed | $linked_objects | from CommonObject | |
| array<string, array<int, int>> | $linkedObjectsIds | from CommonObject | |
| CommonObject[]> | $linkedObjects | from CommonObject | |
| ?static | $oldcopy | from CommonObject | |
| string | $oldref | from CommonObject | |
| protected | $table_ref_field | {@inheritdoc} | from Product |
| int | $restrictiononfksoc | from CommonObject | |
| array<string, mixed> | $context | from CommonObject | |
| string | $actionmsg | from CommonObject | |
| string | $actionmsg2 | from CommonObject | |
| string | $canvas | from CommonObject | |
| Project|null | $project | from CommonObject | |
| $fk_project | from CommonObject | ||
| $fk_projet | from CommonObject | ||
| Contact|null | $contact | from CommonObject | |
| int | $contact_id | from CommonObject | |
| Societe | $thirdparty | from CommonObject | |
| User | $user | from CommonObject | |
| Product | $product | from CommonObject | |
| string | $origin_type | from CommonObject | |
| int | $origin_id | from CommonObject | |
| CommonObject | $origin_object | from CommonObject | |
| CommonObject|string|null deprecated | $origin | from CommonObject | |
| ?string | $ref | from CommonObject | |
| ?string | $ref_ext | from CommonObject | |
| string | $ref_previous | from CommonObject | |
| string | $ref_next | from CommonObject | |
| ?string | $newref | from CommonObject | |
| $statut | from CommonObject | ||
| ?int | $status | Status indicates whether the product is on sale '1' or not '0' |
from Product |
| string | $country | from CommonObject | |
| $country_id | from CommonObject | ||
| $country_code | from CommonObject | ||
| ?string | $state | from CommonObject | |
| $state_id | from CommonObject | ||
| $state_code | from CommonObject | ||
| $region_id | from CommonObject | ||
| $region_code | from CommonObject | ||
| $region | from CommonObject | ||
| int | $barcode_type | from Product | |
| string | $barcode_type_code | from Product | |
| $barcode_type_label | from CommonObject | ||
| $barcode_type_coder | from CommonObject | ||
| ?int | $mode_reglement_id | from CommonObject | |
| ?int | $cond_reglement_id | from CommonObject | |
| ?int | $demand_reason_id | from CommonObject | |
| int | $transport_mode_id | from CommonObject | |
| protected int|string | $depr_cond_reglement | from CommonObject | |
| ?int deprecated | $fk_delivery_address | from CommonObject | |
| ?int | $shipping_method_id | from CommonObject | |
| ?string | $shipping_method | from CommonObject | |
| int | $fk_multicurrency | from CommonObject | |
| string|string[] | $multicurrency_code | from CommonObject | |
| null|float|float[] | $multicurrency_tx | from CommonObject | |
| float | $multicurrency_total_ht | from CommonObject | |
| float | $multicurrency_total_tva | from CommonObject | |
| float|string | $multicurrency_total_localtax1 | from CommonObject | |
| float|string | $multicurrency_total_localtax2 | from CommonObject | |
| float | $multicurrency_total_ttc | from CommonObject | |
| ?string | $model_pdf | from CommonObject | |
| string | $last_main_doc | from CommonObject | |
| $fk_bank | from CommonObject | ||
| ?int | $fk_account | from CommonObject | |
| ?string | $note_public | from CommonObject | |
| ?string | $note_private | from CommonObject | |
| $note | from CommonObject | ||
| ?float | $total_ht | from CommonObject | |
| ?float | $total_tva | from CommonObject | |
| ?float | $total_localtax1 | from CommonObject | |
| ?float | $total_localtax2 | from CommonObject | |
| ?float | $total_ttc | from CommonObject | |
| CommonObjectLine[]|CommonObject[]|stdClass[] | $lines | from CommonObject | |
| string | $actiontypecode | from CommonObject | |
| mixed | $comments | from CommonObject | |
| ?string | $name | from CommonObject | |
| ?string | $lastname | from CommonObject | |
| ?string | $firstname | from CommonObject | |
| string deprecated | $civility_id | from CommonObject | |
| string | $civility_code | from CommonObject | |
| int|""|null | $date_creation | from CommonObject | |
| int|""|null | $date_validation | from CommonObject | |
| int|""|null | $date_modification | from CommonObject | |
| int deprecated | $tms | Update timestamp record (tms) |
from CommonObject |
| int|""|null | $date_cloture | from CommonObject | |
| int|null | $user_creation_id | from CommonObject | |
| int|null | $user_validation_id | from CommonObject | |
| int|null | $user_closing_id | from CommonObject | |
| int|null | $user_modification_id | from CommonObject | |
| int|null deprecated | $fk_user_creat | from CommonObject | |
| int|null deprecated | $fk_user_modif | from CommonObject | |
| string | $next_prev_filter | from CommonObject | |
| int<0, 1> | $specimen | from CommonObject | |
| int[] | $sendtoid | from CommonObject | |
| $alreadypaid | from CommonObject | ||
| $totalpaid | from CommonObject | ||
| $totalpaid_multicurrency | from CommonObject | ||
| array<int, string> | $labelStatus | ||
| array<int, string> | $labelStatusShort | ||
| array<string, int|float|string|null> | $tpl | from CommonObject | |
| int | $showphoto_on_popup | from CommonObject | |
| array{actionscomm?: int, banklines?: int, cheques?: int, contacts?: int, contracts?: int, customers?: int, dolresource?: int, donations?: int, expensereports?: int, holidays?: int, interventions?: int, invoices?: int, members?: int, orders?: int, products?: int, projects?: int, proposals?: int, prospects?: int, services?: int, supplier_invoices?: int, supplier_orders?: int, supplier_proposals?: int, suppliers?: int, tasks?: int, ticket?: int, users?: int} | $nb | from CommonObject | |
| int | $nbphoto | Number of pictures |
from Product |
| string | $output | from CommonObject | |
| array<string, string>|string | $extraparams | from CommonObject | |
| protected array<string, string[]> | $childtables | from Product | |
| protected string[] | $childtablesoncascade | from CommonObject | |
| int | $cond_reglement_supplier_id | from CommonObject | |
| float|string | $deposit_percent | from CommonObject | |
| int | $retained_warranty_fk_cond_reglement | from CommonObject | |
| int | $warehouse_id | from CommonObject | |
| int<0, 1> | $isextrafieldmanaged | from CommonObject | |
| string | $picto | Label of the pictogram used for this object ('product' or 'service') |
from Product |
| $regeximgext | from Product | ||
| $libelle | from Product | ||
| string | $label | Product label |
from Product |
| string | $description | Product description |
from Product |
| string | $other | Product other fields PRODUCT_USE_OTHER_FIELD_IN_TRANSLATION |
from Product |
| int | $type | Check TYPE constants |
from Product |
| float | $price | Selling price without tax |
from Product |
| string | $price_formated | from Product | |
| float | $price_ttc | Selling price with tax |
from Product |
| string | $price_ttc_formated | from Product | |
| float | $price_min | Minimum price net |
from Product |
| float | $price_min_ttc | Minimum price with tax |
from Product |
| string | $price_base_type | Base price ('TTC' for price including tax or 'HT' for net price) |
from Product |
| string | $price_label | from Product | |
| array<int, float> | $multiprices | from Product | |
| array<int, float> | $multiprices_ttc | from Product | |
| array<int, string> | $multiprices_base_type | from Product | |
| array<int, string> | $multiprices_default_vat_code | from Product | |
| array<int, float> | $multiprices_min | from Product | |
| array<int, float> | $multiprices_min_ttc | from Product | |
| array<int, null|int|float|string> | $multiprices_tva_tx | from Product | |
| array<int, int> | $multiprices_recuperableonly | from Product | |
| int<0, 0>|float | $price_by_qty | from Product | |
| array<int, float> | $prices_by_qty | from Product | |
| array<int, float> | $prices_by_qty_id | from Product | |
| array<int, array<array{rowid: int, price_base_type: string, unitprice: string}>> | $prices_by_qty_list | from Product | |
| int | $level | from Product | |
| ?array<string, array{label: string, description: string, note?: string, other?: string}> | $multilangs | from Product | |
| string | $default_vat_code | from Product | |
| string|int|float | $tva_tx | from Product | |
| int<0, 1> | $tva_npr | from Product | |
| string | $remise_percent | from Product | |
| string|int|float | $localtax1_tx | from Product | |
| string|int|float | $localtax2_tx | from Product | |
| string | $localtax1_type | from Product | |
| string | $localtax2_type | from Product | |
| string | $desc_supplier | ||
| string | $vatrate_supplier | ||
| string | $default_vat_code_supplier | from Product | |
| int|float|string|null | $fourn_multicurrency_price | ||
| int|float|string | $fourn_multicurrency_unitprice | ||
| int|float|string|null | $fourn_multicurrency_tx | ||
| int | $fourn_multicurrency_id | ||
| ?string | $fourn_multicurrency_code | ||
| ?float | $packaging | from Product | |
| int|null | $lifetime | Lifetime (in seconds) |
from Product |
| int|null | $qc_frequency | Quality control frequency (in days ?) |
from Product |
| float | $stock_reel | Stock real (denormalized data) |
from Product |
| float | $stock_theorique | Stock virtual |
from Product |
| ?float | $cost_price | Cost price |
from Product |
| ?float | $pmp | Average price value for product entry into stock (PMP) |
from Product |
| ?float | $seuil_stock_alerte | Stock alert |
from Product |
| ?float | $desiredstock | from Product | |
| ?int | $duration_value | from Product | |
| string | $duration_unit | from Product | |
| string | $duration | from Product | |
| int | $fk_default_workstation | from Product | |
| $tosell | Status indicates whether the product is on sale '1' or not '0' |
from Product | |
| ?int | $status_buy | Status indicate whether the product is available for purchase '1' or not '0' |
from Product |
| $tobuy | Status indicate whether the product is available for purchase '1' or not '0' |
from Product | |
| ?int | $finished | Status indicates whether the product is a finished product '1' or a raw material '0' |
from Product |
| ?int | $fk_default_bom | fk_default_bom indicates the default bom |
from Product |
| int | $product_fourn_price_id | ||
| float | $buyprice | buyprice indicates buy price off the product |
from Product |
| int | $tobatch | for backward compatibility |
from Product |
| int | $status_batch | We must manage lot/batch number, sell-by date and so on : '0':no, '1':yes, '2": yes with unique serial number |
from Product |
| int | $sell_or_eat_by_mandatory | Make sell-by or eat-by date mandatory |
from Product |
| string | $batch_mask | If allowed, we can edit batch or serial number mask for each product |
from Product |
| string | $customcode | Customs code |
from Product |
| string | $url | Product URL |
from Product |
| float|string | $weight | from Product | |
| ?int | $weight_units | from Product | |
| float|string | $length | from Product | |
| ?int | $length_units | from Product | |
| float|string | $width | from Product | |
| ?int | $width_units | from Product | |
| float|string|null | $height | from Product | |
| ?int | $height_units | from Product | |
| float|string|null | $surface | from Product | |
| ?int | $surface_units | from Product | |
| float|string|null | $volume | from Product | |
| ?int | $volume_units | from Product | |
| float|string|null | $net_measure | from Product | |
| ?int | $net_measure_units | from Product | |
| ?string | $accountancy_code_sell | from Product | |
| ?string | $accountancy_code_sell_intra | from Product | |
| ?string | $accountancy_code_sell_export | from Product | |
| ?string | $accountancy_code_buy | from Product | |
| ?string | $accountancy_code_buy_intra | from Product | |
| ?string | $accountancy_code_buy_export | from Product | |
| string|int | $barcode | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_propale | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_commande | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_contrat | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_facture | from Product | |
| array{}|array{suppliers: int, nb: int, rows: int, qty: float} | $stats_proposal_supplier | from Product | |
| array{}|array{suppliers: int, nb: int, rows: int, qty: float} | $stats_commande_fournisseur | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_expedition | from Product | |
| array{}|array{suppliers: int, nb: int, rows: int, qty: float} | $stats_reception | from Product | |
| array{}|array{customers_toconsume: int, nb_toconsume: int, qty_toconsume: float, customers_consumed: int, nb_consumed: int, qty_consumed: float, customers_toproduce: int, nb_toproduce: int, qty_toproduce: float, customers_produced: int, nb_produced: int, qty_produced: float} | $stats_mo | from Product | |
| array{}|array{nb_toproduce: int, nb_toconsume: int, qty_toproduce: float, qty_toconsume: float} | $stats_bom | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_mrptoconsume | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_mrptoproduce | from Product | |
| array{}|array{customers: int, nb: int, rows: int, qty: float} | $stats_facturerec | from Product | |
| array{}|array{suppliers: int, nb: int, rows: int, qty: float} | $stats_facture_fournisseur | from Product | |
| array{}|array{suppliers: int, nb: int, rows: int, qty: float} | $stats_facturefournrec | from Product | |
| int|string | $imgWidth | from Product | |
| int|string | $imgHeight | from Product | |
| int | $product_fourn_id | ||
| int | $product_id_already_linked | Product ID already linked to a reference supplier |
from Product |
| stdClass> | $stock_warehouse | from Product | |
| int | $fk_default_warehouse | from Product | |
| int | $fk_price_expression | from Product | |
| float | $fourn_qty | ||
| float | $fourn_pu | ||
| "HT"|"TTC" | $fourn_price_base_type | Supplier price found : VAT type |
from Product |
| int | $fourn_socid | from Product | |
| $ref_fourn | from Product | ||
| string | $ref_supplier | ||
| int|null | $fk_unit | from Product | |
| int | $price_autogen | Price is generated using multiprice rules |
from Product |
| null|array<string, array<int, array{0: int, 1: float, 2: int, 3: string, 4: int, 5: string}>> | $sousprods | Array with list of sub-products for Kits |
from Product |
| CommonObject}> | $res | from Product | |
| bool | $is_object_used | Property set to save result of isObjectUsed(). Used for example by Product API. |
from Product |
| float | $is_sousproduit_qty | If this Product is within a kit: Quantity of this Product within this kit |
from Product |
| int<0, 1> | $is_sousproduit_incdec | If this Product is within a kit: 1 = modify the stock of this child Product upon modification of the stock of its parent Product ("incdec" stands for increase/decrease) |
from Product |
| int | $mandatory_period | from Product | |
| int | $stockable_product | 0=This service or product is not managed in stock, 1=This service or product is managed in stock |
from Product |
| $fourn_ref | |||
| int | $delivery_time_days | ||
| $fk_product | |||
| int | $product_id | ||
| string | $product_ref | ||
| int | $fourn_id | ||
| string | $fourn_name | ||
| ?float | $fourn_price | ||
| ?float | $fourn_remise_percent | ||
| float | $fourn_remise | ||
| ?float | $fourn_charges | ||
| string | $product_fourn_entity | ||
| float | $product_fourn_packaging | ||
| int | $user_id | ||
| int | $fk_availability | ||
| int|string | $fourn_unitprice | ||
| float|int | $fourn_unitprice_with_discount | ||
| string | $fourn_tva_tx | ||
| int<0, 1> | $fourn_tva_npr | ||
| int | $fk_supplier_price_expression | ||
| string | $supplier_reputation | ||
| string[] | $reputations | ||
| $fourn_barcode | |||
| string | $supplier_barcode | ||
| $fourn_fk_barcode_type | |||
| string | $supplier_fk_barcode_type |
Methods
Provide list of deprecated properties
Provide list of deprecated methods
Call trigger based on this instance.
Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch
Return customer ref for screen output.
Return supplier ref for screen output.
Return full address of contact
Return the link of last main doc file for direct public download.
Add a link between element $this->element and a contact
Copy contact from one element to current
Update a link to contact line
Delete all links between an object $this and all its contacts in llx_element_contact
Get array of all contacts for an object
Return array with list of possible values for type of contacts
Return array with list of possible values for type of contacts
Return id of contacts for a source and a contact code.
Load object contact with id=$this->contact_id into $this->contact
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.
Load the product with id $this->fk_product into this->product
Load object from specific field
Getter generic. Load value from a specific field
Setter generic. Update a specific field into database.
Load properties id_previous and id_next by comparing $fieldid with $this->ref
Return list of id of contacts of object
Change the retained warranty payments terms
Change the shipping method
Change the bank account
Save a new position (field rang) for details lines.
Update a line to have a higher rank
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
Add an object link into llx_element_element.
Return an element type string formatted like element_element target_type and source_type
Fetch array of objects linked to current object (object of enabled modules only). Links are loaded into this->linkedObjectsIds array + this->linkedObjects array if $loadalsoobjects = 1 or $loadalsoobjects = type Possible usage for parameters:
- all parameters empty -> we look all link to current object (current object can be source or target)
- source id+type -> will get list of targets linked to source
- target id+type -> will get list of sources linked to target
- source id+type + target type -> will get list of targets of the type linked to source
- target id+type + source type -> will get list of sources of the type linked to target
Clear the cache saying that all linked object were already loaded. So next fetchObjectLinked will reload all links.
Update object linked of a current object
Delete all links between an object $this
Function used to get an array with all items linked to an object id in association table
Count items linked to an object id in association table
Function used to remove all items linked to an object id in association table
Set status of an object.
Load type of canvas of an object if it exists
Function to check if an object is used by others (by children).
Function to say how many lines object contains
Function that returns the total amount HT of discounts applied for all lines.
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.
Show add free and predefined products/services form
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.
Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
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 resources to the current object : add entry into llx_element_resources Need $this->element & $this->id
Delete a link to resource line
Overwrite magic function to solve problem of cloning object that are kept as references
Common function for all objects extending CommonObject for generating documents
Index a file into the ECM database
Return the default value to use for a field when showing the create form of object.
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.
Fill array_options property of object by extrafields value (using for data sent by forms) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.
Function to make a fetch but set environment to avoid to load computed values before.
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.
Add/Update all extra fields values for the current object.
Add/Update all extra languages values for the current object.
Update 1 extra field value for the current object. Keep other fields unchanged.
Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
Convenience method for setting the value of an extrafield without actually updating it in the database.
Update an extra language value for the current object.
Return HTML string to put an input field into a page Code very similar with showInputField of extra fields
Return HTML string to show a field into a page Code very similar with showOutputField of extra fields
clear validation message result for a field
set validation error message a field
Return validation test result for a field
Function to show lines of extrafields with output data.
Function used to replace a thirdparty id with another one.
Function used to replace a product id with another one.
Get buy price to use for margin calculation. This function is called when buy price is unknown.
Function used to get the logos or photos of an object
Show photos of an object (nbmax maximum), into several columns
Function test if type is array
Function test if type is date
Function test if type is duration
Function test if type is integer
Function test if type is float
Function test if type is text
Function test if field can be null
Function test if field is forced to null if zero or empty
Function test if is indexed
Function to return the array of data key-value from the ->fields and all the ->properties of an object.
Function to load data from a SQL pointer into properties of current object $this
Sets all object fields to null. Useful for example in lists, when printing multiple lines and a different object os fetched for each line.
Function to concat keys of fields
Add quote to field value if necessary
Load object in memory from the database. This does not load line. This is done by parent fetch() that call fetchCommon
Load object in memory from the database
Delete object in database
Delete all child object from a parent ID
Initialise object with example values Id must be 0 if object instance is a specimen
Sets object to given categories.
Sets object to given categories.
Copy related categories to another object
Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order
Set the error message for the object without logging it.
Set the error message for the object and log it.
Update a record into database.
Get the array of labels of Sell by or Eat by all mandatory flags for each status
Get the label for sell by or eat by mandatory flag of the current product
Sets an accountancy code for a product.
Return price of sell of a product for a seller/buyer/product.
Read price used by a provider.
Modify customer price of a product/Service for a given level
Load a product in memory from database
Charge tableau des stats propale pour le produit/service
Charge tableau des stats propale pour le produit/service
Charge tableau des stats commande client pour le produit/service
Charge tableau des stats commande fournisseur pour le produit/service
Charge tableau des stats expedition client pour le produit/service
Charge tableau des stats réception fournisseur pour le produit/service
Charge tableau des stats production pour le produit/service
Charge tableau des stats contrat pour le produit/service
Charge tableau des stats facture pour le produit/service
Load array of statistics for recurring invoice for product/service
Load array of statistics for vendor invoice for product/service
Load array of statistics for recurring supplier invoice for product/service
Return nb of units or customers invoices in which product is included
Return nb of units or supplier invoices in which product is included
Return nb of units in proposals in which product is included
Return nb of units in proposals in which product is included
Return nb of units in orders in which product is included
Return nb of units in orders in which product is included
Return nb of units in orders in which product is included
Return nb of units in orders in which product is included
Link a product/service to a parent product/service
Modify composed product
Remove a link between a subproduct and a parent product/service
Check if it is a sub-product into a kit
Add a supplier price for the product.
Recopie les prix d'un produit/service sur un autre
Recopie les fournisseurs et prix fournisseurs d'un produit/service sur un autre
Function recursive, used only by get_arbo_each_prod(), to build tree of subproducts into ->res Define value of this->res
Build the tree of subproducts and return it.
Count all parent and children products for current product (first level only)
Return all parent products for current product (first level only)
Return children of product $id
Return tree of all subproducts for product. Tree contains array of array(0=prodid, 1=>qty, 2=>product type, 3=>label, 4=>incdec, 5=>product ref) Set this->sousprods
Return a link to the object card (with optionally the picto).
Create a document onto disk according to template module.
Return the label of the status
Return the status
Adjust stock in a warehouse for product
Adjust stock in a warehouse for product with batch number
Load information about stock of a product into ->stock_reel, ->stock_warehouse[] (including stock_warehouse[idwarehouse]->detail_batch for batch products) This function need a lot of load. If you use it on list, use a cache to execute it once for each product id.
Load value ->stock_theorique of a product. Property this->id must be defined.
Load stock for components of virtual product (first level only)
Move an uploaded file described into $file array into target directory $sdir.
Return an array with all photos of product found on disk. There is no sorting criteria.
Get a barcode from the module to generate barcode values.
Reads the units dictionary to return the translation code of a unit (if type='code'), or translated long label (if type='long') or short label (if type='short').
Function used to replace a thirdparty id with another one.
Generates prices for a product based on product multiprice generation rules
Return the duration of a service in hours (for a service based on duration fields)
Return clickable link of object (with eventually picto)
Remove all prices for this couple supplier-product
Remove a price for a couple supplier-product
Modify the purchase price for a supplier
Loads the price information of a provider
List all supplier prices of a product
Load properties for minimum price
Sets the supplier price expression
Display supplier of product
Display price of product
Function used to replace a product id with another one.
List supplier prices log of a supplier price
Display log price of product supplier price
Details
mixed
__get(string $name)
Get deprecated property
void
__set(string $name, mixed $value)
Set deprecated property
void
__unset(string $name)
Unset deprecated property
void
__isset(string $name)
Test if deprecated property is set
mixed
__call(string $name, mixed[] $arguments)
Call deprecated method
protected array<string, string>
deprecatedProperties()
Provide list of deprecated properties
Override this method in subclasses
protected array<string, string>
deprecatedMethods()
Provide list of deprecated methods
Override this method in subclasses
final static protected string
getCallerInfoString()
Get caller info
int
call_trigger(string $triggerName, User $user)
Call trigger based on this instance.
Some context information may also be provided into array property this->context. NB: Error from trigger are stacked in interface->errors NB2: If return code of triggers are < 0, action calling trigger should cancel all transaction.
static
isExistingObject($element, int $id, $ref = '', $ref_ext = '')
Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch
@param string $element String of element ('product', 'facture', ...)
bool
isEmpty()
isEmpty We consider CommonObject isEmpty if this->id is empty
void
setErrorsFromObject(CommonObject|HookManager $object)
setErrorsFromObject
getTooltipContentArray($params)
getTooltipContentArray
getTooltipContent($params)
getTooltipContent
string
errorsToString()
Method to output saved errors
string
getFormatedCustomerRef(string $objref)
Return customer ref for screen output.
string
getFormatedSupplierRef(string $objref)
Return supplier ref for screen output.
string
getFullAddress($withcountry = 0, string $sep = "\n", $withregion = 0, $extralangcode = '')
Return full address of contact
@param int<0,1> $withcountry 1=Add country into address string
string|-1
getLastMainDocLink(string $modulepart, int $initsharekey = 0, int $relativelink = 0)
Return the link of last main doc file for direct public download.
add_contact($fk_socpeople, int|string $type_contact, $source = 'external', $notrigger = 0)
Add a link between element $this->element and a contact
@param int $fk_socpeople Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link
copy_linked_contact($objFrom, "internal"|"external" $source = 'internal')
Copy contact from one element to current
@param CommonObject $objFrom Source element
update_contact($rowid, int $statut, $type_contact_id = 0, $fk_socpeople = 0)
Update a link to contact line
@param int $rowid Id of line contact-element
delete_contact($rowid, int $notrigger = 0)
Delete a link to contact line
@param int $rowid Id of contact link line to delete
delete_linked_contact($source = '', string $code = '')
Delete all links between an object $this and all its contacts in llx_element_contact
@param string $source '' or 'internal' or 'external'
liste_contact($statusoflink = -1, "external"|"thirdparty"|"internal" $source = 'external', $list = 0, $code = '', $status = -1, $arrayoftcids = array())
Get array of all contacts for an object
@param int $statusoflink Status of links to get (-1=all). Not used.
int
swapContactStatus($rowid)
Update status of a contact linked to object
@param int $rowid Id of link between object and contact
liste_type_contact($source = 'internal', string $order = 'position', $option = 0, $activeonly = 0, $code = '')
Return array with list of possible values for type of contacts
@param 'internal'|'external'|'all' $source 'internal', 'external' or 'all'
listeTypeContacts($source = 'internal', int<0, 1> $option = 0, $activeonly = 0, $code = '', $element = '', $excludeelement = '')
Return array with list of possible values for type of contacts
@param string $source 'internal', 'external' or 'all'
getIdContact(string $source, $code, $status = 0)
Return id of contacts for a source and a contact code.
Example: contact client de facturation ('external', 'BILLING') Example: contact client de livraison ('external', 'SHIPPING') Example: contact interne suivi paiement ('internal', 'SALESREPFOLL')
int<-1, 1>
fetch_contact($contactid = null)
Load object contact with id=$this->contact_id into $this->contact
@param ?int $contactid Id du contact. Use this->contact_id if empty.
int<-1, 1>
fetch_thirdparty($force_thirdparty_id = 0)
Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty
@param int<0,1> $force_thirdparty_id Force thirdparty id
int<-1, 1>
fetchOneLike(string $ref)
Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set
int<-1, 1>
fetch_barcode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.
int<-1, 1>
fetchBarCode()
Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.
fetchProject()
Load the project with id $this->fk_project into this->project
@return int<-1,1> Return integer <0 if KO, >=0 if OK
fetch_project()
deprecated
deprecated
Load the project with id $this->fk_project into this->project
@return int<-1,1> Return integer <0 if KO, >=0 if OK
fetch_projet()
deprecated
deprecated
Load the project with id $this->fk_project into this->project
@return int Return integer <0 if KO, >=0 if OK
int<-1, 1>
fetch_product()
Load the product with id $this->fk_product into this->product
int<-1, 1>
fetch_user(int $userid)
Load the user with id $userid into this->user
void
fetch_origin()
Read linked origin object.
Set ->origin_object
int<-1, 1>|false
fetchObjectFrom($table, string $field, $key, $element = null)
Load object from specific field
@param string $table Table element or element line
int<-1, 1>
getValueFrom(string $table, int $id, string $field)
Getter generic. Load value from a specific field
int<-2, 1>
setValueFrom(string $field, mixed $value, string $table = '', ?int $id = null, string $format = '', string $id_field = '', User|string|null $fuser = null, $trigkey = '', $fk_user_field = 'fk_user_modif')
Setter generic. Update a specific field into database.
Warning: Trigger is run only if param trigkey is provided.
load_previous_next_ref($filter, string $fieldid, $nodbprefix = 0)
Load properties id_previous and id_next by comparing $fieldid with $this->ref
@param string $filter Optional SQL filter. Use SQL or Universal Search Filter. Example: "(t.field1 = 'aa' OR t.field2 = 'bb')". Do not allow user input data here with this syntax. Example: "((t.field1:=:'aa') OR (t.field2:=:'bb'))".
int[]
getListContactId($source = 'external')
Return list of id of contacts of object
@param string $source Source of contact: external (llx_socpeople) or internal (llx_user) or thirdparty (llx_societe)
int<-1, 1>
setProject(int $projectid, $notrigger = 0)
Link element with a project
int
setPaymentMethods($id)
Change the payments methods
@param int $id Id of new payment method
int
setMulticurrencyCode($code)
Change the multicurrency code
@param string $code multicurrency code
setMulticurrencyRate($rate, int $mode = 1)
Change the multicurrency rate
@param double $rate multicurrency rate
setPaymentTerms($id, float $deposit_percent = null)
Change the payments terms
@param int $id Id of new payment terms
int
setTransportMode($id)
Change the transport mode methods
@param int $id Id of transport mode
int
setRetainedWarrantyPaymentTerms($id)
Change the retained warranty payments terms
@param int $id Id of new payment terms
int
setDeliveryAddress(int $id)
Define delivery address
@deprecated
setShippingMethod($shipping_method_id, int $notrigger = 0, $userused = null)
Change the shipping method
@param int $shipping_method_id Id of shipping method
int
setWarehouse($warehouse_id)
Change the warehouse
@param int $warehouse_id Id of warehouse
setDocModel($user, string $modelpdf)
Set last model used by doc generator
@param User $user User object that make change
setBankAccount($fk_account, int $notrigger = 0, $userused = null)
Change the bank account
@param int $fk_account Id of bank account
line_order(bool $renum = false, $rowidorder = 'ASC', $fk_parent_line = true)
Save a new position (field rang) for details lines.
You can choose to set position for lines with already a position or lines without any position defined.
getChildrenOfLine($id, int<0, 1001> $includealltree = 0)
Get children of line
@param int $id Id of parent line
line_up($rowid, bool $fk_parent_line = true)
Update a line to have a lower rank
@param int $rowid Id of line
line_down($rowid, bool $fk_parent_line = true)
Update a line to have a higher rank
@param int $rowid Id of line
updateRangOfLine($rowid, int $rang)
Update position of line (rang)
@param int $rowid Id of line
void
line_ajaxorder($rows)
Update position of line with ajax (rang)
@param int[] $rows Array of rows
updateLineUp($rowid, int $rang)
Update position of line up (rang)
@param int $rowid Id of line
updateLineDown($rowid, int $rang, $max)
Update position of line down (rang)
@param int $rowid Id of line
int
getRangOfLine($rowid)
Get position of line (rang)
@param int $rowid Id of line
int
getIdOfLine($rang)
Get rowid of the line relative to its position
@param int $rang Rang value
int
line_max($fk_parent_line = 0)
Get max value used for position of line (rang)
@param int $fk_parent_line Parent line id
int
update_ref_ext($ref_ext)
Update external ref of element
@param string $ref_ext Update field ref_ext
update_note($note, string $suffix = '', $notrigger = 0)
Update note of element
@param string $note New value for note
int
update_note_public(string $note)
deprecated
deprecated
Update public note (kept for backward compatibility)
int<-1, 1>
update_price(int $exclspec = 0, $roundingadjust = 'auto', $nodatabaseupdate = 0, $seller = null)
Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
Must be called at end of methods addline or updateline.
add_object_linked($origin = null, $origin_id = null, $f_user = null, $notrigger = 0)
Add an object link into llx_element_element.
string
getElementType()
Return an element type string formatted like element_element target_type and source_type
int<-1, 1>
fetchObjectLinked(?int $sourceid = null, string $sourcetype = '', ?int $targetid = null, string $targettype = '', string $clause = 'OR', $alsosametype = 1, $orderby = 'sourcetype', $loadalsoobjects = 1)
Fetch array of objects linked to current object (object of enabled modules only). Links are loaded into this->linkedObjectsIds array + this->linkedObjects array if $loadalsoobjects = 1 or $loadalsoobjects = type Possible usage for parameters:
- all parameters empty -> we look all link to current object (current object can be source or target)
- source id+type -> will get list of targets linked to source
- target id+type -> will get list of sources linked to target
- source id+type + target type -> will get list of targets of the type linked to source
- target id+type + source type -> will get list of sources of the type linked to target
int
clearObjectLinkedCache()
Clear the cache saying that all linked object were already loaded. So next fetchObjectLinked will reload all links.
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
static array|int
getAllItemsLinkedByObjectID(int $fk_object_where, string $field_select, string $field_where, string $table_element)
Function used to get an array with all items linked to an object id in association table
static array|int
getCountOfItemsLinkedByObjectID(int $fk_object_where, string $field_where, string $table_element)
Count items linked to an object id in association table
static int
deleteAllItemsLinkedByObjectID(int $fk_object_where, string $field_where, string $table_element)
Function used to remove all items linked to an object id in association table
setStatut($status, ?int $elementId = null, $elementType = '', $trigkey = '', $fieldstatus = '')
Set status of an object.
@param int $status Status to set
getCanvas($id = 0, string $ref = '')
Load type of canvas of an object if it exists
@param int $id Record id
int
getSpecialCode($lineid)
Get special code of a line
@param int $lineid Id of line
isObjectUsed(int $id = 0, $entity = 0)
Function to check if an object is used by others (by children).
Check is done into this->childtables. There is no check into llx_element_element.
hasProductsOrServices(int $predefined = -1)
Function to say how many lines object contains
float|null
getTotalDiscount()
Function that returns the total amount HT of discounts applied for all lines.
array{weight: int|float, volume: int|float, ordered: int|float, toship: int|float}|array{}
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.
int
setExtraParameters()
Set extra parameters
void
formAddObjectLine($dateSelector, Societe $seller, $buyer, $defaulttpldir = '/core/tpl')
Show add free and predefined products/services form
@param int $dateSelector 1=Show also date range input fields
void
printObjectLines(string $action, Societe $seller, Societe $buyer, int<0, max> $selected = 0, int $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.
void
printObjectLine(string $action, CommonObjectLine $line, "" $var, int $num, int $i, int $dateSelector, Societe $seller, Societe $buyer, int<0, max> $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(""|"services" $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).
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, so we keep the method available on overloaded objects.
printOriginLine(CommonObjectLine $line, $var, string $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).
If lines are into a template, titles 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.
int
add_element_resource(int $resource_id, string $resource_type, int $busy = 0, int $mandatory = 0, $notrigger = 0)
Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id
delete_resource($rowid, string $element = '', $notrigger = 0)
Delete a link to resource line
@param int $rowid Id of resource line to delete
void
__clone()
Overwrite magic function to solve problem of cloning object that are kept as references
protected int<-1, 1>
commonGenerateDocument(string $modelspath, string $modele, Translate $outputlangs, int<0, 1> $hidedetails, int<0, 1> $hidedesc, int<0, 1> $hideref, ?array<string, mixed> $moreparams = null)
Common function for all objects extending CommonObject for generating documents
int
indexFile(string $destfull, int $update_main_doc_field)
Index a file into the ECM database
void
addThumbs(string $file, $quality = 50)
Build thumb
@todo Move this into files.lib.php
void
delThumbs(string $file)
Delete thumbs
@todo Move this into files.lib.php
string|string[]
getDefaultCreateValueFor(string $fieldname, string $alternatevalue = null, string $type = 'alphanohtml')
Return the default value to use for a field when showing the create form of object.
Return values in this order: 1) If parameter is available into POST, we return it first. 2) If not but an alternate value was provided as parameter of function, we return it. 3) If not but a constant $conf->global->OBJECTELEMENT_FIELDNAME is set, we return it (It is better to use the dedicated table). 4) Return value found into database (TODO No yet implemented)
int<-1, 1>
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.
Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.
int<-1, 1>
setValuesForExtraLanguages(string $onlykey = '')
Fill array_options property of object by extrafields value (using for data sent by forms) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.
int<-1, 1>
fetchNoCompute(int $id)
Function to make a fetch but set environment to avoid to load computed values before.
fetch_optionals($rowid = null, array{}|array{label: array<string, string>, type: array<string, string>, size: array<string, string>, default: array<string, string>, computed: array<string, string>, unique: array<string, int>, required: array<string, int>, param: array<string, mixed>, perms: array<string, mixed[]>, list: array<string, int>|array<string, string>, pos: array<string, int>, totalizable: array<string, int>, help: array<string, string>, printable: array<string, int>, enabled: array<string, int>, langfile: array<string, string>, css: array<string, string>, csslist: array<string, string>, hidden: array<string, int>, mandatoryfieldsofotherentities?: array<string, string>, loaded?: int, count: int} $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.
@param int $rowid Id of line. Use the id of object if not defined. Deprecated. Function must be called without parameters.
deleteExtraFields()
Delete all extra fields values for the current object.
@return int<-1,1> Return integer <0 if KO, >0 if OK
insertExtraFields(string $trigger = '', $userused = null)
Add/Update all extra fields values for the current object.
Data to describe values to insert/update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) This function delete record with all extrafields and insert them again from the array $this->array_options.
insertExtraLanguages(string $trigger = '', $userused = null)
Add/Update all extra languages values for the current object.
Data to describe values to insert/update are stored into $this->array_languages=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) This function delete record with all languages and insert them again from the array $this->array_languages. Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.
updateExtraField(string $key, $trigger = null, $userused = null)
Update 1 extra field value for the current object. Keep other fields unchanged.
Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)
mixed|null
getExtraField(string $key)
Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
void
setExtraField(string $key, mixed $value)
Convenience method for setting the value of an extrafield without actually updating it in the database.
updateExtraLanguages(string $key, $trigger = null, $userused = null)
Update an extra language value for the current object.
Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)
string
showInputField(?array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $val, string $key, string|string[] $value, string $moreparam = '', string $keysuffix = '', string $keyprefix = '', string|int $morecss = 0, int<0, 1> $nonewbutton = 0)
Return HTML string to put an input field into a page Code very similar with showInputField of extra fields
string
showOutputField(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $val, string $key, string $value, string $moreparam = '', string $keysuffix = '', string $keyprefix = '', mixed $morecss = '')
Return HTML string to show a field into a page Code very similar with showOutputField of extra fields
void
clearFieldError(string $fieldKey)
clear validation message result for a field
void
setFieldError(string $fieldKey, string $msg = '')
set validation error message a field
string
getFieldError(string $fieldKey)
get field error message
bool
validateField(array<string, array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int<-2, 5>|string, alwayseditable?: int<0, 1>, noteditable?: int<0, 1>, default?: string, index?: int, foreignkey?: string, searchall?: int<0, 1>, isameasure?: int<0, 1>, css?: string, csslist?: string, help?: string, showoncombobox?: int<0, 2>, disabled?: int<0, 1>, arrayofkeyval?: array<int, string>, autofocusoncreate?: int<0, 1>, comment?: string, copytoclipboard?: int<1, 2>, validate?: int<0, 1>}> $fields, string $fieldKey, string $fieldValue)
Return validation test result for a field
string
showOptionals(ExtraFields $extrafields, string $mode = 'view', array<string, mixed> $params = null, string $keysuffix = '', string $keyprefix = '', string $onetrtd = '', string $display_type = 'card')
Function to show lines of extrafields with output data.
This function is responsible to output the
string
getJSListDependancies(string $type = '_extra')
No description
null|int|stdClass
getRights()
Returns the rights used for this class
static bool
commonReplaceThirdparty(DoliDB $dbs, int $origin_id, int $dest_id, array $tables, int<0, 1> $ignoreerrors = 0)
Function used to replace a thirdparty id with another one.
This function is meant to be called from replaceThirdparty with the appropriate tables Column name fk_soc MUST exist.
static bool
commonReplaceProduct(DoliDB $dbs, int $origin_id, int $dest_id, array $tables, int<0, 1> $ignoreerrors = 0)
Function used to replace a product id with another one.
This function is meant to be called from replaceProduct with the appropriate tables Column name fk_product MUST be used to identify products
float|int<-2, -1>
defineBuyPrice(float $unitPrice = 0.0, float $discountPercent = 0.0, int $fk_product = 0)
Get buy price to use for margin calculation. This function is called when buy price is unknown.
Set buy price = sell price if ForceBuyingPriceIfNull configured, elseif calculation MARGIN_TYPE = 'costprice' and costprice is defined, use costprice as buyprice elseif calculation MARGIN_TYPE = 'pmp' and pmp is calculated, use pmp as buyprice else set min buy price as buy price
array{dir: string, file: string, originalfile: string, altfile: string, email: string, capture: string}
getDataToShowPhoto(string $modulepart, string $imagesize)
Function used to get the logos or photos of an object
show_photos($modulepart, string $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
@param string $modulepart 'product', 'ticket', ...
protected bool
isArray(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is array
bool
isDate(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is date
bool
isDuration(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is duration
bool
isInt(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is integer
bool
isFloat(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is float
bool
isText(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if type is text
protected bool
canBeNull(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if field can be null
protected bool
isForcedToNullIfZero(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if field is forced to null if zero or empty
protected bool
isIndex(array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $info)
Function test if is indexed
protected array<string, null|int|float|string>
setSaveQuery()
Function to return the array of data key-value from the ->fields and all the ->properties of an object.
Note: $this->${field} are set by the page that make the createCommon() or the updateCommon(). $this->${field} should be a clean and string value (so date are formatted for SQL insert).
void
setVarsFromFetchObj(stdClass $obj)
Function to load data from a SQL pointer into properties of current object $this
void
emtpyObjectVars()
Sets all object fields to null. Useful for example in lists, when printing multiple lines and a different object os fetched for each line.
string
getFieldList(string $alias = '', string[] $excludefields = array())
Function to concat keys of fields
protected string|int
quote(string|int $value, array{type: string, label: string, enabled: int<0, 2>|string, position: int, notnull?: int, visible: int, noteditable?: int, default?: string, index?: int, foreignkey?: string, searchall?: int, isameasure?: int, css?: string, csslist?: string, help?: string, showoncombobox?: int, disabled?: int, arrayofkeyval?: array<int, string>, comment?: string} $fieldsentry)
Add quote to field value if necessary
int<-1, max>
createCommon(User $user, int<0, 1> $notrigger = 0)
Create object in the database
int<-4, 1>
fetchCommon(int $id, ?string $ref = null, string $morewhere = '', int<0, 1> $noextrafields = 0)
Load object in memory from the database. This does not load line. This is done by parent fetch() that call fetchCommon
int<-1, 1>
fetchLinesCommon(string $morewhere = '', int<0, 1> $noextrafields = 0)
Load object in memory from the database
int<-1, 1>
updateCommon(User $user, int<0, 1> $notrigger = 0)
Update object into database
int<-1, 1>
deleteCommon(User $user, int<0, 1> $notrigger = 0, int<0, 1> $forcechilddeletion = 0)
Delete object in database
int
deleteByParentField(int $parentId = 0, string $parentField = '', string $filter = '', string $filtermode = "AND")
Delete all child object from a parent ID
deleteLineCommon(User $user, $idline, $notrigger = 0)
Delete a line of object in database
int
setStatusCommon(User $user, $status, $notrigger = 0, $triggercode = '')
Set to a status
int
initAsSpecimenCommon()
Initialise object with example values Id must be 0 if object instance is a specimen
int<0, max>|-1
fetchComments()
Load comments linked with current task
int
getNbComments()
Return nb comments already posted
void
trimParameters(string[] $parameters)
Trim object parameters
int[]|int
getCategoriesCommon(string $type_categ)
Sets object to given categories.
Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.
int
setCategoriesCommon(int[]|int $categories, string $type_categ = '', bool $remove_existing = true)
Sets object to given categories.
Assign the object to all categories not yet assigned. Unasign object from existing categories not supplied in $categories (if remove_existing==true). If remove_existing is false, existing categories are left untouch.
int
cloneCategories(int $fromId, int $toId, string $type = '')
Copy related categories to another object
bool
deleteEcmFiles(int $mode = 0)
Delete related files of object in database
bool
checkActiveProductInLines(string $status = 'onsale')
Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order
void
setErrorWithoutLog(string $message)
Set the error message for the object without logging it.
void
setErrorWithLog(string $message, int<0, 7> $loglevel = LOG_ERR)
Set the error message for the object and log it.
__construct(DoliDB $db)
Constructor
@param DoliDB $db Database handler
int
check()
Check that ref and label are ok
int
create(User $user, int $notrigger = 0)
Insert product into database
int
verify()
Check properties of product are ok (like name, barcode, ...).
All properties must be already loaded on object (this->barcode, this->barcode_type_code, ...).
int
check_barcode(string $valuetotest, string $typefortest)
Check barcode
int
update(int $id, User $user, int $notrigger = 0, string $action = 'update', bool $updatetype = false)
Update a record into database.
If batch flag is set to on, we create records into llx_product_batch
int
delete(User $user, int $notrigger = 0)
Delete a product from database (if not used)
static array{0: string, 1: string, 2: string, 3: string}
getSellOrEatByMandatoryList()
Get the array of labels of Sell by or Eat by all mandatory flags for each status
string
getSellOrEatByMandatoryLabel()
Get the label for sell by or eat by mandatory flag of the current product
int
setMultiLangs(User $user)
Update or add a translation for a product
int
delMultiLangs(string $langtodelete, User $user)
Delete a language for this product
int
setAccountancyCode(string $type, string $value)
Sets an accountancy code for a product.
Also calls PRODUCT_MODIFY trigger when modified
int
getMultiLangs()
Load array this->multilangs
int
log_price_delete(User $user, int $rowid)
Delete a price line
getSellPrice($thirdparty_seller, $thirdparty_buyer, $pqp = 0)
Return price of sell of a product for a seller/buyer/product.
get_buyprice($prodfournprice, $qty, $product_id = 0, $fourn_ref = '', $fk_soc = 0)
Read price used by a provider.
We enter as input couple prodfournprice/qty or triplet qty/product_id/fourn_ref. This also set some properties on product like ->buyprice, ->fourn_pu, ...
int<-1, 1>
updatePrice(float $newprice, string $newpricebase, User $user, ?float $newvat = null, float|int $newminprice = 0, int $level = 0, int<0, 1> $newnpr = 0, int<0, 1> $newpbq = 0, int<0, 1> $ignore_autogen = 0, array{}|array{0: string, 1: int|string, 2: string, 3: string}|array{0: string, 1: int|string, 2: string, 3: int|string, 4: string, 5: string} $localtaxes_array = array(), string $newdefaultvatcode = '', string $price_label = '', int $notrigger = 0)
Modify customer price of a product/Service for a given level
int
setPriceExpression(int $expression_id)
deprecated
deprecated
Sets the supplier price expression
int
fetch(int $id = 0, string $ref = '', string $ref_ext = '', string $barcode = '', int $ignore_expression = 0, int $ignore_price_load = 0, int $ignore_lang_load = 0)
Load a product in memory from database
int
load_stats_mo(int $socid = 0)
Charge tableau des stats OF pour le produit/service
int
load_stats_bom(int $socid = 0)
Charge tableau des stats OF pour le produit/service
int
load_stats_propale(int $socid = 0)
Charge tableau des stats propale pour le produit/service
int
load_stats_proposal_supplier(int $socid = 0)
Charge tableau des stats propale pour le produit/service
int
load_stats_commande(int $socid = 0, string $filtrestatut = '', int $forVirtualStock = 0)
Charge tableau des stats commande client pour le produit/service
int
load_stats_commande_fournisseur(int $socid = 0, string $filtrestatut = '', int $forVirtualStock = 0, int $dateofvirtualstock = null)
Charge tableau des stats commande fournisseur pour le produit/service
int
load_stats_sending(int $socid = 0, string $filtrestatut = '', int $forVirtualStock = 0, string $filterShipmentStatus = '')
Charge tableau des stats expedition client pour le produit/service
int
load_stats_reception(int $socid = 0, string $filtrestatut = '', int $forVirtualStock = 0, int $dateofvirtualstock = null)
Charge tableau des stats réception fournisseur pour le produit/service
int
load_stats_inproduction(int $socid = 0, string $filtrestatut = '', int $forVirtualStock = 0, int $dateofvirtualstock = null, int $warehouseid = 0)
Charge tableau des stats production pour le produit/service
int
load_stats_contrat(int $socid = 0)
Charge tableau des stats contrat pour le produit/service
int
load_stats_facture(int $socid = 0)
Charge tableau des stats facture pour le produit/service
int
load_stats_facturerec(int $socid = 0)
Load array of statistics for recurring invoice for product/service
int
load_stats_facture_fournisseur(int $socid = 0)
Load array of statistics for vendor invoice for product/service
int
load_stats_facturefournrec($socid = 0)
Load array of statistics for recurring supplier invoice for product/service
@param int $socid Id societe
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_vente(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units or customers invoices in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_achat(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units or supplier invoices in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_propal(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in proposals in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_propalsupplier(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in proposals in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_order(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in orders in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_ordersupplier(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in orders in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_contract(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in orders in which product is included
array<int<0, 11>, array<int, int|float>>|int<-1, -1>
get_nb_mos(int $socid, string $mode, int $filteronproducttype = -1, int $year = 0, string $morefilter = '')
Return nb of units in orders in which product is included
int
add_sousproduit(int $id_pere, int $id_fils, float $qty, int $incdec = 1, int $notrigger = 0)
Link a product/service to a parent product/service
int
update_sousproduit(int $id_pere, int $id_fils, float $qty, int $incdec = 1, int $notrigger = 0)
Modify composed product
int
del_sousproduit(int $fk_parent, int $fk_child, int $notrigger = 0)
Remove a link between a subproduct and a parent product/service
int<-1, 1>
is_sousproduit(int $fk_parent, int $fk_child)
Check if it is a sub-product into a kit
int<-3, 1>
add_fournisseur(User $user, int $id_fourn, string $ref_fourn, float $quantity)
Add a supplier price for the product.
Note: Duplicate ref is accepted for different quantity only, or for different companies.
int[]
list_suppliers()
Return list of suppliers providing the product or service
int
clone_price(int $fromId, int $toId)
Recopie les prix d'un produit/service sur un autre
int
clone_associations(int $fromId, int $toId)
Clone links between products
int
clone_fournisseurs(int $fromId, int $toId)
Recopie les fournisseurs et prix fournisseurs d'un produit/service sur un autre
void
fetch_prod_arbo(array<int, array{0: int, 1: float, 2: int, 3: string, 4: int, 5: string}> $prod, string $compl_path = '', int|float $multiply = 1, int $level = 1, int $id_parent = 0, int<0, 1> $ignore_stock_load = 0)
Function recursive, used only by get_arbo_each_prod(), to build tree of subproducts into ->res Define value of this->res
CommonObject}>
get_arbo_each_prod(int|float $multiply = 1, int<0, 1> $ignore_stock_load = 0)
Build the tree of subproducts and return it.
this->sousprods must have been loaded by this->get_sousproduits_arbo()
hasFatherOrChild($mode = 0)
Count all parent and children products for current product (first level only)
int
hasVariants()
Return if a product has variants or not
bool|int
isVariant()
Return if loaded product is a variant
array<int, array{id: int, ref: string, label: string, qty: float, incdec: int<0, 1>, fk_product_type: int, entity: int, status: int, status_buy: int}>|int<-1, -1>
getFather()
Return all parent products for current product (first level only)
array<int, array{0: int, 1: float, 2: int, 3: string, 4: int, 5: string}>|array{}|int<-1, -1>
getChildsArbo(int $id, int $firstlevelonly = 0, int $level = 1, int[] $parents = array())
Return children of product $id
void
get_sousproduits_arbo()
Return tree of all subproducts for product. Tree contains array of array(0=prodid, 1=>qty, 2=>product type, 3=>label, 4=>incdec, 5=>product ref) Set this->sousprods
string
getNomUrl(int $withpicto = 0, string $option = '', int $maxlength = 0, int $save_lastsearch_value = -1, int $notooltip = 0, string $morecss = '', int $add_label = 0, string $sep = ' - ')
Return a link to the object card (with optionally the picto).
Used getNomUrl of ProductFournisseur if a specific supplier ref is loaded. Otherwise use Product->getNomUrl().
int
generateDocument(string $modele, Translate $outputlangs, int $hidedetails = 0, int $hidedesc = 0, int $hideref = 0)
Create a document onto disk according to template module.
string
getLibStatut(int<0, 6> $mode = 0, int<0, 2> $type = 0)
Return the label of the status
@param 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
string
LibStatut(int $status, int<0, 6> $mode = 0, int<0, 2> $type = 0)
Return the status
@param int $status Id status
string|int
getLibFinished()
Retour label of nature of product
int
correct_stock(User $user, int $id_entrepot, float $nbpiece, int<0, 1> $movement, string $label = '', int|float $price = 0, string $inventorycode = '', string $origin_element = '', ?int $origin_id = null, int $disablestockchangeforsubproduct = 0, ExtraFields $extrafields = null)
Adjust stock in a warehouse for product
int
correct_stock_batch(User $user, int $id_entrepot, float $nbpiece, int<0, 1> $movement, string $label = '', int|float $price = 0, int|""|null $dlc = '', int|""|null $dluo = '', string|null $lot = '', string $inventorycode = '', string $origin_element = '', ?int $origin_id = null, int $disablestockchangeforsubproduct = 0, ExtraFields $extrafields = null, bool $force_update_batch = false)
Adjust stock in a warehouse for product with batch number
load_stock($option = '', $includedraftpoforvirtual = null, $dateofvirtualstock = null)
Load information about stock of a product into ->stock_reel, ->stock_warehouse[] (including stock_warehouse[idwarehouse]->detail_batch for batch products) This function need a lot of load. If you use it on list, use a cache to execute it once for each product id.
If ENTREPOT_EXTRA_STATUS is set, filtering on warehouse status is possible.
load_virtual_stock(int $includedraftpoforvirtual = null, $dateofvirtualstock = null)
Load value ->stock_theorique of a product. Property this->id must be defined.
This function need a lot of load. If you use it on list, use a cache to execute it one for each product id.
int
loadStockForVirtualProduct(string $option = '', int|float $qtyWish = 1)
Load stock for components of virtual product (first level only)
loadBatchInfo($batch)
Load existing information about a serial
int
add_photo(string $sdir, array{name: string, tmp_name: string} $file)
Move an uploaded file described into $file array into target directory $sdir.
bool
is_photo_available(string $sdir)
Return if at least one photo is available
array<array{photo: string, photo_vignette: string}>
liste_photos(string $dir, int $nbmax = 0)
Return an array with all photos of product found on disk. There is no sorting criteria.
void
delete_photo(string $file)
Delete a photo and its thumbs
void
get_image_size(string $file)
Load size of image file
int
loadStateBoard()
Load indicators this->nb for the dashboard
bool
isProduct()
Return if the object is a product.
bool
isService()
Return if the object is a service.
bool
isStockManaged()
Return if the object is managed in stock.
bool
isMandatoryPeriod()
Return if the object has a constraint on mandatory_period
bool
hasbatch()
Return if the object has a sell-by or eat-by date.
string
get_barcode(Product $object, string $type = '')
Get a barcode from the module to generate barcode values.
Return value is stored into this->barcode
int
initAsSpecimen()
Initialise an instance with random values.
Used to build previews or test instances. id must be 0 if object instance is a specimen.
string|int
getLabelOfUnit(string $type = 'long', Translate|null $outputlangs = null, int $noentities = 0)
Reads the units dictionary to return the translation code of a unit (if type='code'), or translated long label (if type='long') or short label (if type='short').
TODO Duplicate of getLabelOfUnit() in commonobjectline.class.php
int
min_recommended_price()
Return minimum product recommended price
int
setCategories(int[]|int $categories)
Sets object to supplied categories.
Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.
static bool
replaceThirdparty(DoliDB $dbs, int $origin_id, int $dest_id)
Function used to replace a thirdparty id with another one.
int
generateMultiprices(User $user, float $baseprice, string $price_type, float $price_vat, int $npr, int<0, 1> $psq)
Generates prices for a product based on product multiprice generation rules
void
info(int $id)
Load information for tab info
float|-1
getProductDurationHours()
Return the duration of a service in hours (for a service based on duration fields)
getKanbanView(string $option = '', $arraydata = null)
Return clickable link of object (with eventually picto)
int
remove_fournisseur($id_fourn)
Remove all prices for this couple supplier-product
@param int $id_fourn Supplier Id
int
remove_product_fournisseur_price($rowid)
Remove a price for a couple supplier-product
@param int $rowid Line id of price
update_buyprice($qty, float $buyprice, $user, $price_base_type, $fourn, $availability, $ref_fourn, $tva_tx, $charges = 0, $remise_percent = 0, $remise = 0, $newnpr = 0, $delivery_time_days = 0, $supplier_reputation = '', $localtaxes_array = array(), $newdefaultvatcode = '', $multicurrency_buyprice = 0, $multicurrency_price_base_type = 'HT', $multicurrency_tx = 1, $multicurrency_code = '', $desc_fourn = '', $barcode = '', $fk_barcode_type = 0, $options = array())
Modify the purchase price for a supplier
@param float $qty Min quantity for which price is valid
fetch_product_fournisseur_price($rowid, int $ignore_expression = 0)
Loads the price information of a provider
@param int $rowid Line id in product_fournisseur_price
list_product_fournisseur_price($prodid, string $sortfield = '', $sortorder = '', $limit = 0, $offset = 0, $socid = 0)
List all supplier prices of a product
@param int $prodid Id of product
find_min_price_product_fournisseur($prodid, float $qty = 0, $socid = 0)
Load properties for minimum price
@param int $prodid Product id
int
setSupplierPriceExpression($expression_id)
Sets the supplier price expression
@param int $expression_id Expression
string
getSocNomUrl(int $withpicto = 0, string $option = 'supplier', int $maxlen = 0, $notooltip = 0)
Display supplier of product
display_price_product_fournisseur($showunitprice = 1, int<0, 1> $showsuptitle = 1, $maxlen = 0, $notooltip = 0, $productFournList = array())
Display price of product
@param int<0,1> $showunitprice Show "Unit price" into output string
static bool
replaceProduct(DoliDB $dbs, int $origin_id, int $dest_id)
Function used to replace a product id with another one.
listProductFournisseurPriceLog($product_fourn_price_id, string $sortfield = '', $sortorder = '', $limit = 0, $offset = 0)
List supplier prices log of a supplier price
@param int $product_fourn_price_id Id of supplier price
string
displayPriceProductFournisseurLog($productFournLogList = array())
Display log price of product supplier price
@param array<array{rowid:int,supplier_ref:int,datec:int,lastname:string,price:float,quantity:float,fk_multicurrency:int,multicurrency_code:string,multicurrency_tx:string,multicurrency_price:string,multicurrency_unitprice:string}>|int<-1,-1> $productFournLogList list of ProductFournisseur price log objects to display in table format.