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

Class to manage proposals. More...

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

Public Member Functions

 __construct ($db, $socid=0, $propalid=0)
 Constructor. More...
 
 add_product ($idproduct, $qty, $remise_percent=0)
 Add line into array ->lines $this->thirdparty should be loaded. More...
 
 insert_discount ($idremise)
 Adding line of fixed discount in the proposal in DB. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.0, $fk_product=0, $remise_percent=0.0, $price_base_type='HT', $pu_ttc=0.0, $info_bits=0, $type=0, $rang=-1, $special_code=0, $fk_parent_line=0, $fk_fournprice=0, $pa_ht=0, $label='', $date_start='', $date_end='', $array_options=array(), $fk_unit=null, $origin='', $origin_id=0, $pu_ht_devise=0, $fk_remise_except=0, $noupdateafterinsertline=0)
 Add a proposal line into database (linked to product/service or not) The parameters are already supposed to be appropriate and with final values to the call of this method. More...
 
 updateline ($rowid, $pu, $qty, $remise_percent, $txtva, $txlocaltax1=0.0, $txlocaltax2=0.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, $date_start='', $date_end='', $array_options=array(), $fk_unit=null, $pu_ht_devise=0, $notrigger=0, $rang=0)
 Update a proposal line. More...
 
 deleteLine ($lineid, $id=0)
 Delete detail line. More...
 
 create ($user, $notrigger=0)
 Create commercial proposal into database this->ref can be set or empty. More...
 
 createFromClone (User $user, $socid=0, $forceentity=null, $update_prices=false, $update_desc=false)
 Load an object from its id and create a new one in database. More...
 
 fetch ($rowid, $ref='', $ref_ext='', $forceentity=0)
 Load a proposal from database. More...
 
 update (User $user, $notrigger=0)
 Update database. More...
 
 fetch_lines ($only_product=0, $loadalsotranslation=0, $sqlforgedfilters='')
 Load array lines. More...
 
 valid ($user, $notrigger=0)
 Set status to validated. More...
 
 set_date ($user, $date, $notrigger=0)
 Define proposal date. More...
 
 set_echeance ($user, $date_end_validity, $notrigger=0)
 Define end validity date. More...
 
 set_date_livraison ($user, $delivery_date, $notrigger=0)
 Set delivery date. More...
 
 setDeliveryDate ($user, $delivery_date, $notrigger=0)
 Set delivery date. More...
 
 set_availability ($user, $id, $notrigger=0)
 Set delivery. More...
 
 set_demand_reason ($user, $id, $notrigger=0)
 Set source of demand. More...
 
 set_ref_client ($user, $ref_client, $notrigger=0)
 Set customer reference number. More...
 
 reopen ($user, $status, $note='', $notrigger=0)
 Reopen the commercial proposal. More...
 
 closeProposal ($user, $status, $note='', $notrigger=0)
 Close/set the commercial proposal to status signed or refused (fill also date signature) More...
 
 classifyBilled (User $user, $notrigger=0, $note='')
 Classify the proposal to status Billed. More...
 
 setCancel (User $user)
 Cancel the proposal. More...
 
 setDraft ($user, $notrigger=0)
 Set draft status. More...
 
 liste_array ($shortlist=0, $draft=0, $notcurrentuser=0, $socid=0, $limit=0, $offset=0, $sortfield='p.datep', $sortorder='DESC')
 Return list of proposal (eventually filtered on user) into an array. More...
 
 getInvoiceArrayList ()
 Returns an array with the numbers of related invoices. More...
 
 InvoiceArrayList ($id)
 Returns an array with id and ref of related invoices. More...
 
 delete ($user, $notrigger=0)
 Delete proposal. More...
 
 availability ($availability_id, $notrigger=0)
 Change the delivery time. More...
 
 demand_reason ($demand_reason_id, $notrigger=0)
 Change source demand. More...
 
 info ($id)
 Object Proposal 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 the indicators this->nb for the state board. More...
 
 getNextNumRef ($soc)
 Returns the reference to the following non used Proposal used depending on the active numbering module defined into PROPALE_ADDON. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $option='', $get_params='', $notooltip=0, $save_lastsearch_value=-1, $addlinktonotes=-1)
 Return clicable link of object (with eventually picto) More...
 
 getLinesArray ($sqlforgedfilters='')
 Retrieve an array of 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
 isEmpty ()
 isEmpty We consider CommonObject isEmpty if this->id is empty More...
 
 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...
 
 getExtraField ($key)
 Convenience method for retrieving the value of an extrafield without actually fetching it from the database. More...
 
 setExtraField ($key, $value)
 Convenience method for setting the value of an extrafield without actually updating it in the database. 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)
 Function used to get the logos or photos of an object. 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 in the 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

 $datec
 
 $datev
 
 $datep
 
 $price
 
 $tva
 
 $total
 
const STATUS_CANCELED = -1
 Canceled status.
 
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.
 
const STATUS_BILLED = 4
 Billed or processed quote.
 
- Public Attributes inherited from CommonObject
 $origin_object
 

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 proposals.

Definition at line 54 of file propal.class.php.

Constructor & Destructor Documentation

◆ __construct()

Propal::__construct (   $db,
  $socid = 0,
  $propalid = 0 
)

Constructor.

Parameters
DoliDB$dbDatabase handler
int$socidId third party
int$propalidId proposal

Definition at line 407 of file propal.class.php.

References getDolGlobalInt().

Member Function Documentation

◆ add_product()

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

Add line into array ->lines $this->thirdparty should be loaded.

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

TODO Replace calls to this function by generation object Ligne

Definition at line 431 of file propal.class.php.

◆ addline()

Propal::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1 = 0.0,
  $txlocaltax2 = 0.0,
  $fk_product = 0,
  $remise_percent = 0.0,
  $price_base_type = 'HT',
  $pu_ttc = 0.0,
  $info_bits = 0,
  $type = 0,
  $rang = -1,
  $special_code = 0,
  $fk_parent_line = 0,
  $fk_fournprice = 0,
  $pa_ht = 0,
  $label = '',
  $date_start = '',
  $date_end = '',
  $array_options = array(),
  $fk_unit = null,
  $origin = '',
  $origin_id = 0,
  $pu_ht_devise = 0,
  $fk_remise_except = 0,
  $noupdateafterinsertline = 0 
)

Add a proposal line into database (linked to product/service or not) The parameters are already supposed to be appropriate and with final values to the call of this method.

Also, for the VAT rate, it must have already been defined by whose calling the method get_default_tva (societe_vendeuse, societe_acheteuse, '' product) and desc must already have the right value (it's up to the caller to manage multilanguage)

Parameters
string$descDescription of line
float$pu_htUnit price
float$qtyQuantity
float | string$txtvaForce Vat rate, -1 for auto (Can contain the vat_src_code too with syntax '9.9 (CODE)')
float$txlocaltax1Local tax 1 rate (deprecated, use instead txtva with code inside)
float$txlocaltax2Local tax 2 rate (deprecated, use instead txtva with code inside)
int$fk_productProduct/Service ID predefined
float$remise_percentPourcentage de remise de la ligne
string$price_base_typeHT or TTC
float$pu_ttcPrix unitaire TTC
int$info_bitsBits for type of lines
int$typeType of line (0=product, 1=service). Not used if fk_product is defined, the type of product is used.
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
int$pa_htBuying price without tax
string$label???
int | string$date_startStart date of the line
int | string$date_endEnd date of the line
array$array_optionsextrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
string$originDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be 'orderdet', 'propaldet'..., else 'order','propal,'....
int$origin_idDepend on global conf MAIN_CREATEFROM_KEEP_LINE_ORIGIN_INFORMATION can be Id of origin object (aka line id), else object id
double$pu_ht_deviseUnit price in currency
int$fk_remise_exceptId discount if line is from a discount
int$noupdateafterinsertlineNo update after insert of line
Returns
int >0 if OK, <0 if KO
See also
add_product()

Definition at line 593 of file propal.class.php.

◆ availability()

Propal::availability (   $availability_id,
  $notrigger = 0 
)

Change the delivery time.

Parameters
int$availability_idId of new delivery time
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int >0 if OK, <0 if KO
Deprecated:
use set_availability

Definition at line 3145 of file propal.class.php.

References $sql, dol_syslog(), and status.

◆ classifyBilled()

Propal::classifyBilled ( User  $user,
  $notrigger = 0,
  $note = '' 
)

Classify the proposal to status Billed.

Parameters
User$userObject user
int$notrigger1=Does not execute triggers, 0= execute triggers
string$noteComplete private note with this note
Returns
int Return integer <0 if KO, 0 = nothing done, >0 if OK

Definition at line 2660 of file propal.class.php.

◆ closeProposal()

Propal::closeProposal (   $user,
  $status,
  $note = '',
  $notrigger = 0 
)

Close/set the commercial proposal to status signed or refused (fill also date signature)

Parameters
User$userObject user that close
int$statusStatus (self::STATUS_BILLED or self::STATUS_REFUSED)
string$noteComplete private note with this note
int$notrigger1=Does not execute triggers, 0=Execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2544 of file propal.class.php.

◆ create()

Propal::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 1063 of file propal.class.php.

◆ createFromClone()

Propal::createFromClone ( User  $user,
  $socid = 0,
  $forceentity = null,
  $update_prices = false,
  $update_desc = false 
)

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

Parameters
User$userUser making the clone
int$socidId of thirdparty
int$forceentityEntity id to force
bool$update_prices[=false] Update prices if true
bool$update_desc[=false] Update description if true
Returns
int New id of clone

Definition at line 1382 of file propal.class.php.

◆ delete()

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

Delete proposal.

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

Definition at line 3022 of file propal.class.php.

◆ deleteLine()

Propal::deleteLine (   $lineid,
  $id = 0 
)

Delete detail line.

Parameters
int$lineidId of line to delete
int$idId of object (for a check)
Returns
int >0 if OK, <0 if KO

Definition at line 1014 of file propal.class.php.

◆ demand_reason()

Propal::demand_reason (   $demand_reason_id,
  $notrigger = 0 
)

Change source demand.

Parameters
int$demand_reason_idId of new source demand
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int >0 si ok, <0 si ko
Deprecated:
use set_demand_reason

Definition at line 3208 of file propal.class.php.

References $sql, dol_syslog(), and status.

◆ fetch()

Propal::fetch (   $rowid,
  $ref = '',
  $ref_ext = '',
  $forceentity = 0 
)

Load a proposal from database.

Get also lines.

Parameters
int$rowidId of object to load
string$refRef of proposal
string$ref_extRef ext of proposal
int$forceentityEntity id to force when searching on ref or ref_ext
Returns
int >0 if OK, <0 if KO

Definition at line 1567 of file propal.class.php.

◆ fetch_lines()

Propal::fetch_lines (   $only_product = 0,
  $loadalsotranslation = 0,
  $sqlforgedfilters = '' 
)

Load array lines.

Parameters
int$only_productReturn only physical products
int$loadalsotranslationReturn translation for products
string$sqlforgedfiltersFilter on other fields
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1846 of file propal.class.php.

References $sql, and dol_syslog().

Referenced by getLinesArray().

◆ generateDocument()

Propal::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 3882 of file propal.class.php.

◆ getInvoiceArrayList()

Propal::getInvoiceArrayList ( )

Returns an array with the numbers of related invoices.

Returns
array Array of invoices

Definition at line 2937 of file propal.class.php.

References InvoiceArrayList().

◆ getKanbanView()

Propal::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.

Reimplemented in WebPortalPropal.

Definition at line 3945 of file propal.class.php.

◆ getLibStatut()

Propal::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, 6=Long label + Picto
Returns
string Label

Reimplemented in WebPortalPropal.

Definition at line 3315 of file propal.class.php.

◆ getLinesArray()

Propal::getLinesArray (   $sqlforgedfilters = '')

Retrieve an array of proposal lines.

Parameters
string$sqlforgedfiltersFilter on other fields
Returns
int >0 if OK, <0 if KO

Definition at line 3866 of file propal.class.php.

References fetch_lines().

◆ getNextNumRef()

Propal::getNextNumRef (   $soc)

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

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

Definition at line 3615 of file propal.class.php.

◆ getNomUrl()

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

Return clicable link of object (with eventually picto)

Parameters
int$withpictoAdd picto into link
string$optionWhere point the link ('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$addlinktonotes-1=Disable, 0=Just add label show notes, 1=Add private note (only internal user), 2=Add public note (internal or external user), 3=Add private (internal user) and public note (internal and external user)
Returns
string String with URL

Reimplemented in WebPortalPropal.

Definition at line 3734 of file propal.class.php.

◆ getTooltipContentArray()

Propal::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsparams to construct tooltip data
Since
v18
Returns
array

Reimplemented from CommonObject.

Reimplemented in WebPortalPropal.

Definition at line 3665 of file propal.class.php.

◆ info()

Propal::info (   $id)

Object Proposal Information.

Parameters
int$idProposal id
Returns
void

Definition at line 3270 of file propal.class.php.

References $sql.

◆ initAsSpecimen()

Propal::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 3474 of file propal.class.php.

◆ insert_discount()

Propal::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 491 of file propal.class.php.

◆ InvoiceArrayList()

Propal::InvoiceArrayList (   $id)

Returns an array with id and ref of related invoices.

Parameters
int$idId propal
Returns
array|int Array of invoices id

Definition at line 2949 of file propal.class.php.

References CommonObject\fetchObjectLinked().

Referenced by getInvoiceArrayList().

◆ LibStatut()

Propal::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

Reimplemented in WebPortalPropal.

Definition at line 3328 of file propal.class.php.

◆ liste_array()

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

Return list of proposal (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 2863 of file propal.class.php.

◆ load_board()

Propal::load_board (   $user,
  $mode 
)

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

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

Definition at line 3385 of file propal.class.php.

◆ loadStateBoard()

Propal::loadStateBoard ( )

Load the indicators this->nb for the state board.

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

Definition at line 3566 of file propal.class.php.

◆ reopen()

Propal::reopen (   $user,
  $status,
  $note = '',
  $notrigger = 0 
)

Reopen the commercial proposal.

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

Definition at line 2485 of file propal.class.php.

References $sql, and dol_syslog().

◆ replaceProduct()

static Propal::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 3929 of file propal.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

static Propal::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 3912 of file propal.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_availability()

Propal::set_availability (   $user,
  $id,
  $notrigger = 0 
)

Set delivery.

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

Definition at line 2299 of file propal.class.php.

References $sql, and dol_syslog().

◆ set_date()

Propal::set_date (   $user,
  $date,
  $notrigger = 0 
)

Define proposal date.

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

Definition at line 2104 of file propal.class.php.

◆ set_date_livraison()

Propal::set_date_livraison (   $user,
  $delivery_date,
  $notrigger = 0 
)

Set delivery date.

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

Definition at line 2228 of file propal.class.php.

References setDeliveryDate().

◆ set_demand_reason()

Propal::set_demand_reason (   $user,
  $id,
  $notrigger = 0 
)

Set source of demand.

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

Definition at line 2362 of file propal.class.php.

References $sql, and dol_syslog().

◆ set_echeance()

Propal::set_echeance (   $user,
  $date_end_validity,
  $notrigger = 0 
)

Define end validity date.

Parameters
User$userObject user that modify
int$date_end_validityEnd of validity date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 2168 of file propal.class.php.

References $sql, and dol_syslog().

◆ set_ref_client()

Propal::set_ref_client (   $user,
  $ref_client,
  $notrigger = 0 
)

Set customer reference number.

Parameters
User$userObject user that modify
string$ref_clientCustomer reference
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if ko, >0 if ok

Definition at line 2427 of file propal.class.php.

References $sql, and dol_syslog().

◆ setCancel()

Propal::setCancel ( User  $user)

Cancel the proposal.

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

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

References $sql.

◆ setDeliveryDate()

Propal::setDeliveryDate (   $user,
  $delivery_date,
  $notrigger = 0 
)

Set delivery date.

Parameters
User$userObject user that modify
int$delivery_dateDelivery date
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int Return integer <0 if ko, >0 if ok

Definition at line 2242 of file propal.class.php.

References $sql, and dol_syslog().

Referenced by set_date_livraison().

◆ setDraft()

Propal::setDraft (   $user,
  $notrigger = 0 
)

Set draft status.

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

Definition at line 2794 of file propal.class.php.

References $sql, dol_syslog(), and status.

◆ update()

Propal::update ( User  $user,
  $notrigger = 0 
)

Update database.

Parameters
User$userUser that modify
int$notrigger0=launch triggers after, 1=disable triggers
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1735 of file propal.class.php.

◆ updateline()

Propal::updateline (   $rowid,
  $pu,
  $qty,
  $remise_percent,
  $txtva,
  $txlocaltax1 = 0.0,
  $txlocaltax2 = 0.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,
  $date_start = '',
  $date_end = '',
  $array_options = array(),
  $fk_unit = null,
  $pu_ht_devise = 0,
  $notrigger = 0,
  $rang = 0 
)

Update a proposal line.

Parameters
int$rowidId of line
float$puUnit price (HT or TTC depending on price_base_type)
float$qtyQuantity
float$remise_percentDiscount on line
float | string$txtvaVAT Rate (Can be '1.23' or '1.23 (ABC)')
float$txlocaltax1Local tax 1 rate
float$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
int | string$date_startStart date of the line
int | string$date_endEnd date of the line
array$array_optionsextrafields array
int | null$fk_unitCode of the unit to use. Null to use the default one
double$pu_ht_deviseUnit price in currency
int$notriggerdisable line update trigger
integer$rangline rank
Returns
int 0 if OK, <0 if KO

Definition at line 839 of file propal.class.php.

◆ valid()

Propal::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=Nothing done, >=0 if OK

Definition at line 1977 of file propal.class.php.

Member Data Documentation

◆ $datec

Propal::$datec
Deprecated:
See also
$date_creation

Definition at line 150 of file propal.class.php.

◆ $datep

Propal::$datep
Deprecated:
See also
$date

Definition at line 182 of file propal.class.php.

◆ $datev

Propal::$datev
Deprecated:
See also
$date_validation

Definition at line 156 of file propal.class.php.

◆ $price

Propal::$price
Deprecated:
See also
$total_ht

Definition at line 204 of file propal.class.php.

◆ $total

Propal::$total
Deprecated:
See also
$total_ttc

Definition at line 215 of file propal.class.php.

◆ $tva

Propal::$tva
Deprecated:
See also
$total_tva

Definition at line 210 of file propal.class.php.


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