dolibarr  21.0.0-alpha
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:
Inheritance graph
[legend]
Collaboration diagram for Contrat:
Collaboration graph
[legend]

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 getNextNumRef ($soc)
 Return next contract ref. More...
 
 active_line ($user, $line_id, $date_start, $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='', $notrigger=0, $comment='', $date_end='')
 Open all lines of a contract. More...
 
 closeAll (User $user, $notrigger=0, $comment='')
 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='', $noextrafields=0, $nolines=0)
 Load a contract from database. More...
 
 fetch_lines ($only_services=0, $loadalsotranslation=0, $noextrafields=0)
 Load lines array into this->lines. More...
 
 create ($user)
 Create a contract into database. More...
 
 delete ($user)
 Delete object. More...
 
 update ($user, $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=array(), $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_start_real='', $date_end_real='', $price_base_type='HT', $info_bits=0, $fk_fournprice=null, $pa_ht=0, $array_options=array(), $fk_unit=null, $rang=0)
 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 ($status, $mode)
 Return the label of a given contrat status. More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $maxlength=0, $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 info ($id)
 Charge les information d'ordre info dans l'objet contrat. More...
 
 array_detail ($status=-1)
 Return list of line rowid. More...
 
 getListOfContracts ($option='all', $status=[], $product_categories=[], $line_status=[])
 Return list of other contracts for the same company than current contract. More...
 
 load_board ($user, $mode)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 loadStateBoard ()
 Load the indicators this->nb for state board. 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...
 
 getTicketsArray ()
 Create an array of associated tickets. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 createFromClone (User $user, $socid=0, $notrigger=0)
 Load an object from its id and create a new one in database. More...
 
 doAutoRenewContracts ($thirdparty_id=0, $delayindaysshort=0)
 Action executed by scheduler CAN BE A CRON TASK Loop on each contract lines and update the end of date. More...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
 setSignedStatus (User $user, int $status=0, int $notrigger=0, $triggercode='')
 Set signed status. 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 contractCmpDate ($a, $b)
 Used to sort lines by date. 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

 $fk_projet
 
- 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 contracts.

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

Constructor & Destructor Documentation

◆ __construct()

Contrat::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

◆ activateAll()

Contrat::activateAll (   $user,
  $date_start = '',
  $notrigger = 0,
  $comment = '',
  $date_end = '' 
)

Open all lines of a contract.

Parameters
User$userObject User making action
int | string$date_startDate start (now if empty)
int$notrigger1=Does not execute triggers, 0=Execute triggers
string$commentComment
int | string$date_endDate end
Returns
int Return integer <0 if KO, >0 if OK
See also
()

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

◆ active_line()

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

Activate a contract line.

Parameters
User$userObject User who activate contract
int$line_idId of line to activate
int$date_startOpening date
int | string$date_endExpected end date
string$commentA comment typed by user
Returns
int Return integer <0 if KO, >0 if OK

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

◆ addline()

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 = array(),
  $fk_unit = null,
  $rang = 0 
)

Ajoute une ligne de contrat en base.

Parameters
string$descDescription of line
float$pu_htUnit price net
float$qtyQuantity
float$txtvaVat rate
float$txlocaltax1Local tax 1 rate
float$txlocaltax2Local tax 2 rate
int$fk_productId produit
float$remise_percentPercentage discount of the line
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 of type of lines
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
int$rangPosition
Returns
int Return integer <0 if KO, >0 if OK

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

◆ array_detail()

Contrat::array_detail (   $status = -1)

Return list of line rowid.

Parameters
int$statusStatus of lines to get
Returns
array|int Array of line's rowid or <0 if error

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

◆ close_line()

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

Close a contract line.

Parameters
User$userObject User who close contract
int$line_idId of line to close
int$date_endEnd date
string$commentA comment typed by user
Returns
int Return integer <0 if KO, >0 if OK

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

◆ closeAll()

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

Close all lines of a contract.

Parameters
User$userObject User making action
int$notrigger1=Does not execute triggers, 0=Execute triggers
string$commentComment
Returns
int Return integer <0 if KO, >0 if OK
See also
activateAll()

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

◆ contractCmpDate()

static Contrat::contractCmpDate (   $a,
  $b 
)
static

Used to sort lines by date.

Parameters
Object$a1st element to test
Object$b2nd element to test
Returns
int

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

◆ create()

Contrat::create (   $user)

Create a contract into database.

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

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

◆ createFromClone()

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

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

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

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

◆ delete()

Contrat::delete (   $user)

Delete object.

Parameters
User$userUser that deletes
Returns
int Return integer < 0 if KO, > 0 if OK

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

◆ deleteLine()

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 1858 of file contrat.class.php.

◆ doAutoRenewContracts()

Contrat::doAutoRenewContracts (   $thirdparty_id = 0,
  $delayindaysshort = 0 
)

Action executed by scheduler CAN BE A CRON TASK Loop on each contract lines and update the end of date.

Do not execute the update if there is one pending invoice linked to contract.

Parameters
int$thirdparty_idThirdparty id
int$delayindaysshortTo renew the resources x day before (positive value) or after (negative value) the end of date (default is 0)
Returns
int 0 if OK, <>0 if KO (this function is used also by cron so only 0 is OK)

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

◆ fetch()

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

Load a contract from database.

Parameters
int$idId of contract to load
string$refRef
string$ref_customerCustomer ref
string$ref_supplierSupplier ref
int$noextrafields0=Default to load extrafields, 1=No extrafields
int$nolines0=Default to load lines, 1=No lines
Returns
int Return integer <0 if KO, 0 if not found or if two records found for same ref, Id of contract if OK

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

References $sql, and dol_syslog().

◆ fetch_lines()

Contrat::fetch_lines (   $only_services = 0,
  $loadalsotranslation = 0,
  $noextrafields = 0 
)

Load lines array into this->lines.

This set also nbofserviceswait, nbofservicesopened, nbofservicesexpired and nbofservicesclosed

Parameters
int$only_services0=Default for all, 1=Force only services (depending on setup, we may also have physical products in a contract)
int$loadalsotranslation0=Default to not load translations, 1=Load also translations of product descriptions
int$noextrafields0=Default to load extrafields, 1=Do not load the extrafields of lines
Returns
array|int Return array of contract lines

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

Referenced by getLinesArray().

◆ generateDocument()

Contrat::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 Return integer < 0 if KO, 0 = no doc generated, > 0 if OK

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

◆ getIdBillingContact()

Contrat::getIdBillingContact ( )

Return id des contacts clients de facturation.

Returns
array Liste des id contacts facturation

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

References CommonObject\getIdContact().

◆ getIdServiceContact()

Contrat::getIdServiceContact ( )

Return id des contacts clients de prestation.

Returns
array Liste des id contacts prestation

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

References CommonObject\getIdContact().

◆ getKanbanView()

Contrat::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 2895 of file contrat.class.php.

◆ getLibStatut()

Contrat::getLibStatut (   $mode)

Return label of a contract status.

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, 7=Same than 6 with fixed length
Returns
string Label

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

◆ getLinesArray()

Contrat::getLinesArray ( )

Create an array of order lines.

Returns
int >0 if OK, <0 if KO

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

References fetch_lines().

◆ getListOfContracts()

Contrat::getListOfContracts (   $option = 'all',
  $status = [],
  $product_categories = [],
  $line_status = [] 
)

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

Parameters
string$option'all' or 'others'
array$statussort contracts having these status
array$product_categoriessort contracts containing these product categories
array$line_statussort contracts where lines have these status
Returns
array|int Array of contracts id or <0 if error

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

◆ getNextNumRef()

Contrat::getNextNumRef (   $soc)

Return next contract ref.

Parameters
Societe$socThirdparty object
Returns
string free reference for contract

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

◆ getNomUrl()

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 2068 of file contrat.class.php.

◆ getTicketsArray()

Contrat::getTicketsArray ( )

Create an array of associated tickets.

Returns
array|int Array o tickets or <0 if KO

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

◆ getTooltipContentArray()

Contrat::getTooltipContentArray (   $params)

getTooltipContentArray

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

Reimplemented from CommonObject.

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

◆ info()

Contrat::info (   $id)

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

Parameters
int$idid du contrat a charger
Returns
void

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

References $sql.

◆ initAsSpecimen()

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
int

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

◆ LibStatut()

Contrat::LibStatut (   $status,
  $mode 
)

Return the label of a given contrat status.

Parameters
int$statusId status
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label (status of services), 5=Short label + Picto, 6=Long label + Picto (status of services), 7=Same than 6 with fixed length (status of services)
Returns
string Label

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

◆ load_board()

Contrat::load_board (   $user,
  $mode 
)

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

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

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

◆ loadStateBoard()

Contrat::loadStateBoard ( )

Load the indicators this->nb for state board.

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

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

◆ reopen()

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

Unvalidate a contract.

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

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

◆ replaceProduct()

static Contrat::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 2570 of file contrat.class.php.

References CommonObject\commonReplaceProduct().

◆ replaceThirdparty()

static Contrat::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 2553 of file contrat.class.php.

References CommonObject\commonReplaceThirdparty().

◆ setSignedStatus()

Contrat::setSignedStatus ( User  $user,
int  $status = 0,
int  $notrigger = 0,
  $triggercode = '' 
)

Set signed status.

Parameters
User$userObject user that modify
int$statusNewsigned status to set (often a constant like self::STATUS_XXX)
int$notrigger1 = Does not execute triggers, 0 = Execute triggers
string$triggercodeTrigger code to use
Returns
int 0 < if KO, > 0 if OK

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

◆ update()

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

Update object into database.

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

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

◆ update_statut()

Contrat::update_statut (   $user)

Update statut of contract according to services.

Parameters
User$userObject user
Returns
int Return integer <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 1916 of file contrat.class.php.

References dol_syslog().

◆ updateline()

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

Mets a jour une ligne de contrat.

Parameters
int$rowidId de la ligne de facture
string$descDescription de la ligne
float$puPrix unitaire
float$qtyQuantite
float$remise_percentPercentage discount of the line
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_start_realDate de debut reelle
int | string$date_end_realDate de fin reelle
string$price_base_typeHT or TTC
int$info_bitsBits of type of lines
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
int$rangPosition
Returns
int Return integer <0 if KO, >0 if OK

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

◆ validate()

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

Validate a contract.

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

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

Member Data Documentation

◆ $fk_projet

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

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


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