dolibarr  7.0.0-beta
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Contrat Class Reference

Class to manage contracts. More...

+ Inheritance diagram for Contrat:
+ Collaboration diagram for Contrat:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNextNumRef ($soc)
 Return next contract ref. More...
 
 active_line ($user, $line_id, $date, $date_end='', $comment='')
 Activate a contract line. More...
 
 close_line ($user, $line_id, $date_end, $comment='')
 Close a contract line. More...
 
 activateAll ($user, $date_start='')
 Open all lines of a contract. More...
 
 closeAll (User $user, $notrigger=0)
 Close all lines of a contract. More...
 
 validate (User $user, $force_number='', $notrigger=0)
 Validate a contract. More...
 
 reopen ($user, $notrigger=0)
 Unvalidate a contract. More...
 
 fetch ($id, $ref='', $ref_customer='', $ref_supplier='')
 Load a contract from database. More...
 
 fetch_lines ()
 Load lines array into this->lines. More...
 
 create ($user)
 Create a contract into database. More...
 
 delete ($user)
 Supprime l'objet de la base. More...
 
 update ($user=null, $notrigger=0)
 Update object into database. More...
 
 addline ($desc, $pu_ht, $qty, $txtva, $txlocaltax1, $txlocaltax2, $fk_product, $remise_percent, $date_start, $date_end, $price_base_type='HT', $pu_ttc=0.0, $info_bits=0, $fk_fournprice=null, $pa_ht=0, $array_options=0, $fk_unit=null, $rang=0)
 Ajoute une ligne de contrat en base. More...
 
 updateline ($rowid, $desc, $pu, $qty, $remise_percent, $date_start, $date_end, $tvatx, $localtax1tx=0.0, $localtax2tx=0.0, $date_debut_reel='', $date_fin_reel='', $price_base_type='HT', $info_bits=0, $fk_fournprice=null, $pa_ht=0, $array_options=0, $fk_unit=null)
 Mets a jour une ligne de contrat. More...
 
 deleteline ($idline, User $user)
 Delete a contract line. More...
 
 update_statut ($user)
 Update statut of contract according to services. More...
 
 getLibStatut ($mode)
 Return label of a contract status. More...
 
 LibStatut ($statut, $mode)
 Renvoi label of a given contrat status. More...
 
 getNomUrl ($withpicto=0, $maxlength=0, $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet contrat. More...
 
 array_detail ($statut=-1)
 Return list of line rowid. More...
 
 getListOfContracts ($option='all')
 Return list of other contracts for same company than current contract. More...
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 load_state_board ()
 Charge indicateurs this->nb de tableau de bord. More...
 
 getIdBillingContact ()
 Return id des contacts clients de facturation. More...
 
 getIdServiceContact ()
 Return id des contacts clients de prestation. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 getLinesArray ()
 Create an array of order lines. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
 Create a document onto disk according to template module. More...
 
 createFromClone ($socid=0, $notrigger=0)
 Load an object from its id and create a new one in database. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. More...
 
 setProject ($projectid)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id)
 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)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1)
 Fetch array of objects linked to current object. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it'st possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='')
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 

Static Public Member Functions

static replaceThirdparty (DoliDB $db, $origin_id, $dest_id)
 Function used to replace a thirdparty id with another one. More...
 
- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 

Public Attributes

 $fk_projet
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage contracts.

Definition at line 41 of file contrat.class.php.

Constructor & Destructor Documentation

Contrat::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 166 of file contrat.class.php.

Member Function Documentation

Contrat::activateAll (   $user,
  $date_start = '' 
)

Open all lines of a contract.

Parameters
User$userObject User making action
int | string$date_startDate start (now if empty)
Returns
int <0 if KO, >0 if OK

Definition at line 266 of file contrat.class.php.

References dol_now(), dol_print_error(), fetch_lines(), and validate().

Contrat::active_line (   $user,
  $line_id,
  $date,
  $date_end = '',
  $comment = '' 
)

Activate a contract line.

Parameters
User$userObjet User who activate contract
int$line_idId of line to activate
int$dateDate d'ouverture
int | string$date_endDate fin prevue
string$commentA comment typed by user
Returns
int <0 if KO, >0 if OK

Definition at line 238 of file contrat.class.php.

Contrat::addline (   $desc,
  $pu_ht,
  $qty,
  $txtva,
  $txlocaltax1,
  $txlocaltax2,
  $fk_product,
  $remise_percent,
  $date_start,
  $date_end,
  $price_base_type = 'HT',
  $pu_ttc = 0.0,
  $info_bits = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $array_options = 0,
  $fk_unit = null,
  $rang = 0 
)

Ajoute une ligne de contrat en base.

Parameters
string$descDescription de la ligne
float$pu_htPrix unitaire HT
int$qtyQuantite
float$txtvaTaux tva
float$txlocaltax1Local tax 1 rate
float$txlocaltax2Local tax 2 rate
int$fk_productId produit
float$remise_percentPourcentage de remise de la ligne
int$date_startDate de debut prevue
int$date_endDate de fin prevue
string$price_base_typeHT or TTC
float$pu_ttcPrix unitaire TTC
int$info_bitsBits de type de lignes
int$fk_fournpriceFourn price id
int$pa_htBuying price HT
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
string$rangPosition
Returns
int <0 if KO, >0 if OK

Definition at line 1337 of file contrat.class.php.

References $resql, calcul_price_total(), CommonObject\call_trigger(), CommonObject\defineBuyPrice(), dol_strlen(), dol_syslog(), getLocalTaxesFromRate(), price2num(), and update_statut().

Contrat::array_detail (   $statut = -1)

Return list of line rowid.

Parameters
int$statutStatus of lines to get
Returns
array Array of line's rowid

Definition at line 2001 of file contrat.class.php.

References $resql, and dol_syslog().

Contrat::close_line (   $user,
  $line_id,
  $date_end,
  $comment = '' 
)

Close a contract line.

Parameters
User$userObjet User who close contract
int$line_idId of line to close
int$date_endDate end
string$commentA comment typed by user
Returns
int <0 if KO, >0 if OK

Definition at line 253 of file contrat.class.php.

Contrat::closeAll ( User  $user,
  $notrigger = 0 
)

Close all lines of a contract.

Parameters
User$userObject User making action
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 316 of file contrat.class.php.

References dol_now(), dol_print_error(), fetch_lines(), and validate().

Contrat::create (   $user)

Create a contract into database.

Parameters
User$userUser that create
Returns
int <0 if KO, id of contract if OK

Definition at line 830 of file contrat.class.php.

References $resql, CommonObject\add_contact(), CommonObject\add_object_linked(), CommonObject\call_trigger(), dol_include_once(), dol_now(), dol_print_error(), dol_strlen(), dol_syslog(), and CommonObject\insertExtraFields().

Contrat::createFromClone (   $socid = 0,
  $notrigger = 0 
)

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

Parameters
int$socidId of thirdparty
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int New id of clone

Definition at line 2355 of file contrat.class.php.

References dol_include_once(), dol_syslog(), and fetch().

Contrat::delete (   $user)

Supprime l'objet de la base.

Parameters
User$userUtilisateur qui supprime
Returns
int < 0 si erreur, > 0 si ok

Definition at line 1050 of file contrat.class.php.

References $resql, CommonObject\call_trigger(), CommonObject\delete_linked_contact(), CommonObject\deleteExtraFields(), CommonObject\deleteObjectLinked(), dol_delete_dir_recursive(), dol_sanitizeFileName(), and dol_syslog().

Contrat::deleteline (   $idline,
User  $user 
)

Delete a contract line.

Parameters
int$idlineId of line to delete
User$userUser that delete
Returns
int >0 if OK, <0 if KO

Definition at line 1715 of file contrat.class.php.

References $resql, CommonObject\call_trigger(), and dol_syslog().

Contrat::fetch (   $id,
  $ref = '',
  $ref_customer = '',
  $ref_supplier = '' 
)

Load a contract from database.

Parameters
int$idId of contract to load
string$refRef
string$ref_customerCustomer ref
string$ref_supplierSupplier ref
Returns
int <0 if KO, 0 if not found, Id of contract if OK

Definition at line 559 of file contrat.class.php.

References $resql, dol_syslog(), fetch_lines(), and CommonObject\fetch_optionals().

Referenced by createFromClone().

Contrat::fetch_lines ( )

Load lines array into this->lines.

Returns
ContratLigne[] Return array of contract lines

Definition at line 670 of file contrat.class.php.

References dol_now(), dol_syslog(), getMarginInfos(), and price2num().

Referenced by activateAll(), closeAll(), fetch(), and getLinesArray().

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

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
Returns
int 0 if KO, 1 if OK

Definition at line 2309 of file contrat.class.php.

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

Contrat::getIdBillingContact ( )

Return id des contacts clients de facturation.

Returns
array Liste des id contacts facturation

Definition at line 2197 of file contrat.class.php.

References CommonObject\getIdContact().

Contrat::getIdServiceContact ( )

Return id des contacts clients de prestation.

Returns
array Liste des id contacts prestation

Definition at line 2207 of file contrat.class.php.

References CommonObject\getIdContact().

Contrat::getLibStatut (   $mode)

Return label of a contract status.

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Long label of all services, 5=Libelle court + Picto, 6=Picto of all services, 7=Same than 6 with fixed length
Returns
string Label

Definition at line 1807 of file contrat.class.php.

References LibStatut().

Contrat::getLinesArray ( )

Create an array of order lines.

Returns
int >0 if OK, <0 if KO

Definition at line 2293 of file contrat.class.php.

References fetch_lines().

Contrat::getListOfContracts (   $option = 'all')

Return list of other contracts for same company than current contract.

Parameters
string$option'all' or 'others'
Returns
array Array of contracts id

Definition at line 2037 of file contrat.class.php.

References $resql, and dol_syslog().

Contrat::getNextNumRef (   $soc)

Return next contract ref.

Parameters
Societe$socThirdparty object
Returns
string free reference for contract

Definition at line 177 of file contrat.class.php.

References dol_buildpath(), dol_print_error(), and print.

Referenced by validate().

Contrat::getNomUrl (   $withpicto = 0,
  $maxlength = 0,
  $notooltip = 0,
  $save_lastsearch_value = -1 
)

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
int$maxlengthMax length of ref
int$notooltip1=Disable tooltip
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
Returns
string Chaine avec URL

Definition at line 1888 of file contrat.class.php.

References img_object(), and price().

int Date of last modification Not filled until you call Contrat::info (   $id)

Charge les informations d'ordre info dans l'objet contrat.

Parameters
int$idid du contrat a charger
Returns
void

Definition at line 1952 of file contrat.class.php.

References dol_print_error().

Contrat::initAsSpecimen ( )

Initialise an instance with random values.

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

Returns
void

Definition at line 2220 of file contrat.class.php.

References $resql, and dol_now().

Contrat::LibStatut (   $statut,
  $mode 
)

Renvoi label of a given contrat status.

Parameters
int$statutStatus id
int$mode0=Long label, 1=Short label, 2=Picto + Libelle court, 3=Picto, 4=Picto + Long label of all services, 5=Libelle court + Picto, 6=Picto of all services, 7=Same than 6 with fixed length
Returns
string Label

Definition at line 1819 of file contrat.class.php.

References img_picto().

Referenced by getLibStatut().

Contrat::load_board (   $user,
  $mode 
)

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

Parameters
User$userObjet user
string$mode"inactive" pour services a activer, "expired" pour services expires
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 2077 of file contrat.class.php.

References $resql, dol_now(), dol_print_error(), and img_object().

Contrat::load_state_board ( )

Charge indicateurs this->nb de tableau de bord.

Returns
int <0 si ko, >0 si ok

Definition at line 2153 of file contrat.class.php.

References $resql, and dol_print_error().

Contrat::reopen (   $user,
  $notrigger = 0 
)

Unvalidate a contract.

Parameters
User$userObjet User
int$notrigger1=Does not execute triggers, 0=execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 492 of file contrat.class.php.

References $resql, CommonObject\call_trigger(), dol_now(), dol_print_error(), dol_syslog(), and CommonObject\fetch_thirdparty().

static Contrat::replaceThirdparty ( DoliDB  $db,
  $origin_id,
  $dest_id 
)
static

Function used to replace a thirdparty id with another one.

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

Definition at line 2339 of file contrat.class.php.

References CommonObject\commonReplaceThirdparty().

Contrat::update (   $user = null,
  $notrigger = 0 
)

Update object into database.

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

Definition at line 1204 of file contrat.class.php.

References CommonObject\$projet, $resql, dol_syslog(), and CommonObject\insertExtraFields().

Contrat::update_statut (   $user)

Update statut of contract according to services.

Parameters
User$userObject user
Returns
int <0 if KO, >0 if OK
Deprecated:
This function will never be used. Status of a contract is status of its lines.

Definition at line 1781 of file contrat.class.php.

References dol_syslog().

Referenced by addline(), and updateline().

Contrat::updateline (   $rowid,
  $desc,
  $pu,
  $qty,
  $remise_percent,
  $date_start,
  $date_end,
  $tvatx,
  $localtax1tx = 0.0,
  $localtax2tx = 0.0,
  $date_debut_reel = '',
  $date_fin_reel = '',
  $price_base_type = 'HT',
  $info_bits = 0,
  $fk_fournprice = null,
  $pa_ht = 0,
  $array_options = 0,
  $fk_unit = null 
)

Mets a jour une ligne de contrat.

Parameters
int$rowidId de la ligne de facture
string$descDescription de la ligne
float$puPrix unitaire
int$qtyQuantite
float$remise_percentPourcentage de remise de la ligne
int$date_startDate de debut prevue
int$date_endDate de fin prevue
float$tvatxTaux TVA
float$localtax1txLocal tax 1 rate
float$localtax2txLocal tax 2 rate
int | string$date_debut_reelDate de debut reelle
int | string$date_fin_reelDate de fin reelle
string$price_base_typeHT or TTC
int$info_bitsBits de type de lignes
int$fk_fournpriceFourn price id
int$pa_htBuying price HT
array$array_optionsextrafields array
string$fk_unitCode of the unit to use. Null to use the default one
Returns
int < 0 si erreur, > 0 si ok

Definition at line 1554 of file contrat.class.php.

References calcul_price_total(), CommonObject\call_trigger(), CommonObject\defineBuyPrice(), dol_strlen(), dol_syslog(), getLocalTaxesFromRate(), price2num(), and update_statut().

Contrat::validate ( User  $user,
  $force_number = '',
  $notrigger = 0 
)

Validate a contract.

Parameters
User$userObjet User
string$force_numberReference to force on contract (not implemented yet)
int$notrigger1=Does not execute triggers, 0= execute triggers
Returns
int <0 if KO, >0 if OK

Definition at line 370 of file contrat.class.php.

References $resql, CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), CommonObject\fetch_thirdparty(), and getNextNumRef().

Referenced by activateAll(), and closeAll().

Member Data Documentation

Contrat::$fk_projet
Deprecated:
Use fk_project instead
See also
fk_project

Definition at line 145 of file contrat.class.php.


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