dolibarr  20.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
SupplierProposal Class Reference

Class to manage price ask supplier. More...

Inheritance diagram for SupplierProposal:
Inheritance graph
[legend]
Collaboration diagram for SupplierProposal:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db, $socid=0, $supplier_proposalid=0)
 Constructor. More...
 
 add_product ($idproduct, $qty, $remise_percent=0)
 Add line into array ->lines. More...
 
 insert_discount ($idremise)
 Adding line of fixed discount in the proposal in DB. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0, $txlocaltax2=0, $fk_product=0, $remise_percent=0, $price_base_type='HT', $pu_ttc=0, $info_bits=0, $type=0, $rang=-1, $special_code=0, $fk_parent_line=0, $fk_fournprice=0, $pa_ht=0, $label='', $array_options=[], $ref_supplier='', $fk_unit=0, $origin='', $origin_id=0, $pu_ht_devise=0, $date_start=0, $date_end=0)
 Add a proposal line into database (linked to product/service or not) Les parameters sont deja cense etre juste et avec valeurs finales a l'appel de cette methode. More...
 
 updateline ($rowid, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0, $txlocaltax2=0, $desc='', $price_base_type='HT', $info_bits=0, $special_code=0, $fk_parent_line=0, $skip_update_total=0, $fk_fournprice=0, $pa_ht=0, $label='', $type=0, $array_options=[], $ref_supplier='', $fk_unit=0, $pu_ht_devise=0)
 Update a proposal line. More...
 
 deleteLine ($lineid)
 Delete detail line. More...
 
 create ($user, $notrigger=0)
 Create commercial proposal into database this->ref can be set or empty. More...
 
 createFromClone (User $user, $fromid=0)
 Load an object from its id and create a new one in database. More...
 
 fetch ($rowid, $ref='')
 Load a proposal from database and its ligne array. More...
 
 valid ($user, $notrigger=0)
 Set status to validated. More...
 
 set_date_livraison ($user, $delivery_date)
 Set delivery date. More...
 
 setDeliveryDate ($user, $delivery_date)
 Set delivery date. More...
 
 reopen ($user, $statut, $note='', $notrigger=0)
 Set an overall discount on the proposal. More...
 
 cloture ($user, $status, $note)
 Close the askprice. More...
 
 updateOrCreatePriceFournisseur ($user)
 Add or update supplier price according to result of proposal. More...
 
 updatePriceFournisseur ($idProductFournPrice, $product, $user)
 Update ProductFournisseur. More...
 
 createPriceFournisseur ($product, $user)
 Create ProductFournisseur. More...
 
 setDraft ($user)
 Set draft status. More...
 
 liste_array ($shortlist=0, $draft=0, $notcurrentuser=0, $socid=0, $limit=0, $offset=0, $sortfield='p.datec', $sortorder='DESC')
 Return list of askprice (eventually filtered on user) into an array. More...
 
 delete ($user, $notrigger=0)
 Delete askprice. More...
 
 info ($id)
 Object SupplierProposal Information. More...
 
 getLibStatut ($mode=0)
 Return label of status of proposal (draft, validated, ...) More...
 
 LibStatut ($status, $mode=1)
 Return label of a status (draft, validated, ...) More...
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 loadStateBoard ()
 Load indicator this->nb of global stats widget. More...
 
 getNextNumRef ($soc)
 Returns the reference to the following non used Proposal used depending on the active numbering module defined into SUPPLIER_PROPOSAL_ADDON. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $get_params='', $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=0)
 Return clicable link of object (with eventually picto) More...
 
 getLinesArray ()
 Retrieve an array of supplier proposal lines. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 errorsToString ()
 Method to output saved errors. More...
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output. More...
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output. More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. 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 in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 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...
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 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->contact_id 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_project ()
 Load the project with id $this->fk_project into this->project. 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, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms. More...
 
 setTransportMode ($id)
 Change the transport mode methods. More...
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=0, $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=0, $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, $includealltree=0)
 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='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($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). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. 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...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 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, $entity=0)
 Function to check if an object is used by others (by children). 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...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='', $selectedLines=array())
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). 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...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. 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...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 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...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 getDataToShowPhoto More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isDuration ($info)
 Function test if type is duration. 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...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed status. 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...
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories. More...
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories. More...
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object. More...
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
static replaceProduct (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a product id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $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. More...
 
static getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
 Function used to get an array with all items linked to an object id in association table. More...
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 

Public Attributes

 $author
 
 $statut
 
 $datec
 
 $datev
 
 $price
 
 $tva
 
 $total
 
const STATUS_DRAFT = 0
 Draft status.
 
const STATUS_VALIDATED = 1
 Validated status.
 
const STATUS_SIGNED = 2
 Signed quote.
 
const STATUS_NOTSIGNED = 3
 Not signed quote, canceled.
 
const STATUS_CLOSE = 4
 Billed or closed/processed quote.
 
- Public Attributes inherited from CommonObject
 $origin_object
 
 $fk_departement
 var int State ID More...
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 deprecatedProperties ()
 Provide list of deprecated properties and replacements. More...
 
 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...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage price ask supplier.

Definition at line 51 of file supplier_proposal.class.php.

Constructor & Destructor Documentation

◆ __construct()

SupplierProposal::__construct (   $db,
  $socid = 0,
  $supplier_proposalid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party
int$supplier_proposalidId supplier_proposal

Definition at line 232 of file supplier_proposal.class.php.

Member Function Documentation

◆ add_product()

SupplierProposal::add_product (   $idproduct,
  $qty,
  $remise_percent = 0 
)

Add line into array ->lines.

Parameters
int$idproductProduct Id to add
float$qtyQuantity
int$remise_percentDiscount effected on Product
Returns
int Return integer <0 if KO, >0 if OK

TODO Remplacer les appels a cette fonction par generation object Ligne

Definition at line 254 of file supplier_proposal.class.php.

◆ addline()

SupplierProposal::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $fk_product = 0,
  $remise_percent = 0,
  $price_base_type = 'HT',
  $pu_ttc = 0,
  $info_bits = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $fk_parent_line = 0,
  $fk_fournprice = 0,
  $pa_ht = 0,
  $label = '',
  $array_options = [],
  $ref_supplier = '',
  $fk_unit = 0,
  $origin = '',
  $origin_id = 0,
  $pu_ht_devise = 0,
  $date_start = 0,
  $date_end = 0 
)

Add a proposal line into database (linked to product/service or not) Les parameters sont deja cense etre juste et avec valeurs finales a l'appel de cette methode.

Aussi, pour le taux tva, il doit deja avoir ete defini par l'appelant par la methode get_default_tva(societe_vendeuse,societe_acheteuse,'',produit) et le desc doit deja avoir la bonne valeur (a l'appelant de gerer le multilangue)

Parameters
string$descDescription de la ligne
double$pu_htPrix unitaire
double$qtyQuantite
double$txtvaTaux de tva
double$txlocaltax1Local tax 1 rate
double$txlocaltax2Local tax 2 rate
int$fk_productProduct/Service ID predefined
double$remise_percentPercentage discount of the line
string$price_base_typeHT or TTC
double$pu_ttcPrix unitaire TTC
int$info_bitsBits of type of lines
int$typeType of line (product, service)
int$rangPosition of line
int$special_codeSpecial code (also used by externals modules!)
int$fk_parent_lineId of parent line
int$fk_fournpriceId supplier price. If 0, we will take best price. If -1 we keep it empty.
int$pa_htBuying price without tax
string$label???
array$array_optionsextrafields array
string$ref_supplierSupplier price reference
int$fk_unitId of the unit to use.
string$origin'order', 'supplier_proposal', ...
int$origin_idId of origin line
double$pu_ht_deviseAmount in currency
int$date_startDate start
int$date_endDate end
Returns
int >0 if OK, <0 if KO
See also
add_product()

Definition at line 401 of file supplier_proposal.class.php.

◆ cloture()

SupplierProposal::cloture (   $user,
  $status,
  $note 
)

Close the askprice.

Parameters
User$userObject user that close
int$statusStatus
string$noteComment
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1685 of file supplier_proposal.class.php.

◆ create()

SupplierProposal::create (   $user,
  $notrigger = 0 
)

Create commercial proposal into database this->ref can be set or empty.

If empty, we will use "(PROVid)"

Parameters
User$userUser that create
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 879 of file supplier_proposal.class.php.

◆ createFromClone()

SupplierProposal::createFromClone ( User  $user,
  $fromid = 0 
)

Load an object from its id and create a new one in database.

Parameters
User$userUser making the clone
int$fromidId of thirdparty
Returns
int New id of clone

Definition at line 1106 of file supplier_proposal.class.php.

◆ createPriceFournisseur()

SupplierProposal::createPriceFournisseur (   $product,
  $user 
)

Create ProductFournisseur.

Parameters
Product$productObject Product
User$userObject user
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1822 of file supplier_proposal.class.php.

◆ delete()

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

Delete askprice.

Parameters
User$userObject user that delete
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int 1 if ok, otherwise if error

Definition at line 2017 of file supplier_proposal.class.php.

◆ deleteLine()

SupplierProposal::deleteLine (   $lineid)

Delete detail line.

Parameters
int$lineidId of line to delete
Returns
int >0 if OK, <0 if KO

Definition at line 848 of file supplier_proposal.class.php.

◆ fetch()

SupplierProposal::fetch (   $rowid,
  $ref = '' 
)

Load a proposal from database and its ligne array.

Parameters
int$rowidid of object to load
string$refRef of proposal
Returns
int >0 if OK, <0 if KO

Definition at line 1197 of file supplier_proposal.class.php.

◆ generateDocument()

SupplierProposal::generateDocument (   $modele,
  $outputlangs,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0,
  $moreparams = null 
)

Create a document onto disk according to template module.

Parameters
string$modeleForce model to use ('' to not force)
Translate$outputlangsObject langs to use for output
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

Definition at line 2696 of file supplier_proposal.class.php.

◆ getKanbanView()

SupplierProposal::getKanbanView (   $option = '',
  $arraydata = null 
)

Return clicable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array$arraydataArray of data
Returns
string HTML Code for Kanban thumb.

Definition at line 2761 of file supplier_proposal.class.php.

◆ getLibStatut()

SupplierProposal::getLibStatut (   $mode = 0)

Return label of status of proposal (draft, validated, ...)

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

Definition at line 2159 of file supplier_proposal.class.php.

◆ getLinesArray()

SupplierProposal::getLinesArray ( )

Retrieve an array of supplier proposal lines.

Returns
int >0 if OK, <0 if KO

Definition at line 2607 of file supplier_proposal.class.php.

References $sql, and dol_syslog().

◆ getNextNumRef()

SupplierProposal::getNextNumRef (   $soc)

Returns the reference to the following non used Proposal used depending on the active numbering module defined into SUPPLIER_PROPOSAL_ADDON.

Parameters
Societe$socObject thirdparty
Returns
string Reference libre pour la propale

Definition at line 2415 of file supplier_proposal.class.php.

◆ getNomUrl()

SupplierProposal::getNomUrl (   $withpicto = 0,
  $option = '',
  $get_params = '',
  $notooltip = 0,
  $save_lastsearch_value = -1,
  $addlinktonotes = 0 
)

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link ('compta', 'expedition', 'document', ...)
string$get_paramsParameters added to url
int$notooltip1=Disable tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$addlinktonotesAdd link to show notes
Returns
string String with URL

Definition at line 2511 of file supplier_proposal.class.php.

◆ getTooltipContentArray()

SupplierProposal::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsex option, infologin
Since
v18
Returns
array

Reimplemented from CommonObject.

Definition at line 2464 of file supplier_proposal.class.php.

◆ info()

SupplierProposal::info (   $id)

Object SupplierProposal Information.

Parameters
int$idProposal id
Returns
void

Definition at line 2122 of file supplier_proposal.class.php.

References $sql.

◆ initAsSpecimen()

SupplierProposal::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
int

Definition at line 2295 of file supplier_proposal.class.php.

◆ insert_discount()

SupplierProposal::insert_discount (   $idremise)

Adding line of fixed discount in the proposal in DB.

Parameters
int$idremiseId of fixed discount
Returns
int >0 if OK, <0 if KO

Definition at line 307 of file supplier_proposal.class.php.

◆ LibStatut()

SupplierProposal::LibStatut (   $status,
  $mode = 1 
)

Return label of a status (draft, validated, ...)

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

Definition at line 2172 of file supplier_proposal.class.php.

◆ liste_array()

SupplierProposal::liste_array (   $shortlist = 0,
  $draft = 0,
  $notcurrentuser = 0,
  $socid = 0,
  $limit = 0,
  $offset = 0,
  $sortfield = 'p.datec',
  $sortorder = 'DESC' 
)

Return list of askprice (eventually filtered on user) into an array.

Parameters
int$shortlist0=Return array[id]=ref, 1=Return array[](id=>id,ref=>ref,name=>name)
int$draft0=not draft, 1=draft
int$notcurrentuser0=all user, 1=not current user
int$socidId third party
int$limitFor pagination
int$offsetFor pagination
string$sortfieldSort criteria
string$sortorderSort order
Returns
array|int -1 if KO, array with result if OK

Definition at line 1943 of file supplier_proposal.class.php.

◆ load_board()

SupplierProposal::load_board (   $user,
  $mode 
)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters
User$userObject user
string$mode"opened" for askprice to close, "signed" for proposal to invoice
Returns
WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

Definition at line 2217 of file supplier_proposal.class.php.

◆ loadStateBoard()

SupplierProposal::loadStateBoard ( )

Load indicator this->nb of global stats widget.

Returns
int Return integer <0 if ko, >0 if ok

Definition at line 2375 of file supplier_proposal.class.php.

◆ reopen()

SupplierProposal::reopen (   $user,
  $statut,
  $note = '',
  $notrigger = 0 
)

Set an overall discount on the proposal.

Parameters
User$userObject user that modify
double$remiseAmount discount
Returns
int Return integer <0 if ko, >0 if ok Set an absolute overall discount on the proposal
Parameters
User$userObject user that modify
double$remiseAmount discount
Returns
int Return integer <0 if ko, >0 if ok Reopen the commercial proposal
Parameters
User$userObject user that close
int$statutStatut
string$noteComment
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1626 of file supplier_proposal.class.php.

◆ replaceProduct()

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

Function used to replace a product id with another one.

Parameters
DoliDB$dbDatabase handler
int$origin_idOld product id
int$dest_idNew product id
Returns
bool

Definition at line 2744 of file supplier_proposal.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler, because function is static we name it $dbs not $db to avoid breaking coding test
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool

Definition at line 2727 of file supplier_proposal.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_date_livraison()

SupplierProposal::set_date_livraison (   $user,
  $delivery_date 
)

Set delivery date.

Parameters
User$userObject user that modify
int$delivery_dateDelivery date
Returns
int Return integer <0 if ko, >0 if ok
Deprecated:
Use setDeliveryDate

Definition at line 1515 of file supplier_proposal.class.php.

References setDeliveryDate().

◆ setDeliveryDate()

SupplierProposal::setDeliveryDate (   $user,
  $delivery_date 
)

Set delivery date.

Parameters
User$userObject user that modify
int$delivery_dateDelivery date
Returns
int Return integer <0 if ko, >0 if ok

Definition at line 1528 of file supplier_proposal.class.php.

References $sql.

Referenced by set_date_livraison().

◆ setDraft()

SupplierProposal::setDraft (   $user)

Set draft status.

Parameters
User$userObject user that modify
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1885 of file supplier_proposal.class.php.

◆ updateline()

SupplierProposal::updateline (   $rowid,
  $pu,
  $qty,
  $remise_percent,
  $txtva,
  $txlocaltax1 = 0,
  $txlocaltax2 = 0,
  $desc = '',
  $price_base_type = 'HT',
  $info_bits = 0,
  $special_code = 0,
  $fk_parent_line = 0,
  $skip_update_total = 0,
  $fk_fournprice = 0,
  $pa_ht = 0,
  $label = '',
  $type = 0,
  $array_options = [],
  $ref_supplier = '',
  $fk_unit = 0,
  $pu_ht_devise = 0 
)

Update a proposal line.

Parameters
int$rowidId de la ligne
double$puUnit price (HT or TTC depending on price_base_type)
double$qtyQuantity
double$remise_percentDiscount on line
double$txtvaVAT rate
double$txlocaltax1Local tax 1 rate
double$txlocaltax2Local tax 2 rate
string$descDescription
string$price_base_typeHT or TTC
int$info_bitsMiscellaneous information
int$special_codeSpecial code (also used by externals modules!)
int$fk_parent_lineId of parent line (0 in most cases, used by modules adding sublevels into lines).
int$skip_update_totalKeep fields total_xxx to 0 (used for special lines by some modules)
int$fk_fournpriceId of origin supplier price
int$pa_htPrice (without tax) of product when it was bought
string$label???
int$type0/1=Product/service
array$array_optionsextrafields array
string$ref_supplierSupplier price reference
int$fk_unitId of the unit to use.
double$pu_ht_deviseUnit price in currency
Returns
int 0 if OK, <0 if KO

Definition at line 681 of file supplier_proposal.class.php.

◆ updateOrCreatePriceFournisseur()

SupplierProposal::updateOrCreatePriceFournisseur (   $user)

Add or update supplier price according to result of proposal.

Parameters
User$userObject user
Returns
int > 0 if OK

Definition at line 1758 of file supplier_proposal.class.php.

◆ updatePriceFournisseur()

SupplierProposal::updatePriceFournisseur (   $idProductFournPrice,
  $product,
  $user 
)

Update ProductFournisseur.

Parameters
int$idProductFournPriceid of llx_product_fournisseur_price
Product$productcontain information to update
User$userObject user
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1799 of file supplier_proposal.class.php.

References $price, $sql, and price2num().

◆ valid()

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

Set status to validated.

Parameters
User$userObject user that validate
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >=0 if OK

Definition at line 1393 of file supplier_proposal.class.php.

Member Data Documentation

◆ $author

SupplierProposal::$author
Deprecated:
See also
$user_author_id

Definition at line 103 of file supplier_proposal.class.php.

◆ $datec

SupplierProposal::$datec
Deprecated:
See also
$date_creation

Definition at line 127 of file supplier_proposal.class.php.

◆ $datev

SupplierProposal::$datev
Deprecated:
See also
$date_validation

Definition at line 138 of file supplier_proposal.class.php.

◆ $price

SupplierProposal::$price
Deprecated:
See also
$price_ht

Definition at line 152 of file supplier_proposal.class.php.

Referenced by updatePriceFournisseur().

◆ $statut

SupplierProposal::$statut
Deprecated:

Definition at line 111 of file supplier_proposal.class.php.

◆ $total

SupplierProposal::$total
Deprecated:
See also
$total_ttc

Definition at line 164 of file supplier_proposal.class.php.

◆ $tva

SupplierProposal::$tva
Deprecated:
See also
$total_tva

Definition at line 158 of file supplier_proposal.class.php.


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