Contrat Class Reference

Inheritance diagram for Contrat:

Collaboration diagram for Contrat:

Public Member Functions
	__construct ($db)
	Constructor.
	getNextNumRef ($soc)
	Return next contract ref.
	active_line ($user, $line_id, $date_start, $date_end='', $comment='')
	Activate a contract line.
	close_line ($user, $line_id, $date_end, $comment='')
	Close a contract line.
	activateAll ($user, $date_start='', $notrigger=0, $comment='', $date_end='')
	Open all lines of a contract.
	closeAll (User $user, $notrigger=0, $comment='')
	Close all lines of a contract.
	validate (User $user, $force_number='', $notrigger=0)
	Validate a contract.
	reopen ($user, $notrigger=0)
	Unvalidate a contract.
	fetch ($id, $ref='', $ref_customer='', $ref_supplier='', $noextrafields=0, $nolines=0)
	Load a contract from database.
	fetch_lines ($only_services=0, $loadalsotranslation=0, $noextrafields=0)
	Load lines array into this->lines.
	create ($user)
	Create a contract into database.
	delete ($user)
	Delete object.
	update ($user, $notrigger=0)
	Update object into database.
	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.
	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.
	deleteLine ($idline, User $user)
	Delete a contract line.
	update_statut ($user)
	Update statut of contract according to services.
	getLibStatut ($mode)
	Return label of a contract status.
	LibStatut ($status, $mode)
	Return the label of a given contrat status.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $maxlength=0, $notooltip=0, $save_lastsearch_value=-1)
	Return clickable name (with picto eventually)
	info ($id)
	Charge les information d'ordre info dans l'objet contrat.
	array_detail ($status=-1)
	Return list of line rowid.
	getListOfContracts ($option='all', $status=[], $product_categories=[], $line_status=[])
	Return list of other contracts for the same company than current contract.
	load_board ($user, $mode)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ()
	Load the indicators this->nb for state board.
	getIdBillingContact ()
	Return id des contacts clients de facturation.
	getIdServiceContact ()
	Return id des contacts clients de prestation.
	initAsSpecimen ()
	Initialise an instance with random values.
	getLinesArray ()
	Create an array of order lines.
	getTicketsArray ()
	Create an array of associated tickets.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	createFromClone (User $user, $socid=0, $notrigger=0)
	Load an object from its id and create a new one in database.
	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.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	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).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	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).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	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.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	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.
	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)
	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).
	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).
	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.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	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.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	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.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	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.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	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.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one.
static	replaceProduct (DoliDB $db, $origin_id, $dest_id)
	Function used to replace a product id with another one.
static	contractCmpDate ($a, $b)
	Used to sort lines by date.
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.
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.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

Protected Attributes
	$table_ref_field = 'ref'
	{}

Additional Inherited Members
Public Attributes inherited from CommonObject
	$origin_object
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

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

Constructor & Destructor Documentation

__construct()

Contrat::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 304 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	$user	Object User making action
int | string	$date_start	Date start (now if empty)
int	$notrigger	1=Does not execute triggers, 0=Execute triggers
string	$comment	Comment
int | string	$date_end	Date end

Returns

int Return integer <0 if KO, >0 if OK

See also

()

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

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

active_line()

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

Activate a contract line.

Parameters

User	$user	Object User who activate contract
int	$line_id	Id of line to activate
int	$date_start	Opening date
int | string	$date_end	Expected end date
string	$comment	A comment typed by user

Returns

int Return integer <0 if KO, >0 if OK

Definition at line 373 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	$desc	Description of line
float	$pu_ht	Unit price net
float	$qty	Quantity
float	$txtva	Vat rate
float	$txlocaltax1	Local tax 1 rate
float	$txlocaltax2	Local tax 2 rate
int	$fk_product	Id produit
float	$remise_percent	Percentage discount of the line
int	$date_start	Date de debut prevue
int	$date_end	Date de fin prevue
string	$price_base_type	HT or TTC
float	$pu_ttc	Prix unitaire TTC
int	$info_bits	Bits of type of lines
int	$fk_fournprice	Fourn price id
int	$pa_ht	Buying price HT
	array<string,mixed>	$array_options extrafields array
string	$fk_unit	Code of the unit to use. Null to use the default one
int	$rang	Position

Returns

int Return integer <0 if KO, >0 if OK

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

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

array_detail()

Contrat::array_detail

(

$status = -1

)

Return list of line rowid.

Parameters

int

$status

Status of lines to get

Returns

int[]|int<min,-1> Array of line's rowid or <0 if error

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

References dol_syslog().

close_line()

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

Close a contract line.

Parameters

User	$user	Object User who close contract
int	$line_id	Id of line to close
int	$date_end	End date
string	$comment	A comment typed by user

Returns

int Return integer <0 if KO, >0 if OK

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

closeAll()

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

Close all lines of a contract.

Parameters

User	$user	Object User making action
int	$notrigger	1=Does not execute triggers, 0=Execute triggers
string	$comment	Comment

Returns

int Return integer <0 if KO, >0 if OK

See also

activateAll()

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

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

contractCmpDate()

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

static

Used to sort lines by date.

Parameters

Object	$a	1st element to test
Object	$b	2nd element to test

Returns

int

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

create()

Contrat::create

(

$user

)

Create a contract into database.

Parameters

User

$user

User that create

Returns

int Return integer <0 if KO, id of contract if OK

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

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

createFromClone()

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

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

Parameters

User	$user	User making the clone
int	$socid	Id of thirdparty
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int New id of clone

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

References dol_include_once(), dol_syslog(), fetch(), getDolGlobalString(), and CommonObject\setErrorsFromObject().

delete()

Contrat::delete

(

$user

)

Delete object.

Parameters

User

$user

User that deletes

Returns

int Return integer < 0 if KO, > 0 if OK

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

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

deleteLine()

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

Delete a contract line.

Parameters

int	$idline	Id of line to delete
User	$user	User that delete

Returns

int >0 if OK, <0 if KO

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

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

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_id	Thirdparty id
int	$delayindaysshort	To 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 2737 of file contrat.class.php.

References $object, dol_now(), dol_print_date(), dol_syslog(), dol_time_plus_duree(), and Facture\STATUS_DRAFT.

fetch()

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

Load a contract from database.

Parameters

int	$id	Id of contract to load
string	$ref	Ref
string	$ref_customer	Customer ref
string	$ref_supplier	Supplier ref
	int<0,1>	$noextrafields 0=Default to load extrafields, 1=No extrafields
	int<0,1>	$nolines 0=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 709 of file contrat.class.php.

References dol_syslog(), fetch_lines(), CommonObject\fetch_optionals(), ref, and status.

Referenced by createFromClone().

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<0,1>	$only_services 0=Default for all, 1=Force only services (depending on setup, we may also have physical products in a contract)
int<0,1>	$loadalsotranslation 0=Default to not load translations, 1=Load also translations of product descriptions
int<0,1>	$noextrafields 0=Default to load extrafields, 1=Do not load the extrafields of lines

Returns

array<int,ContratLigne>|int<min,-1> Return array of contract lines

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

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

Referenced by activateAll(), closeAll(), fetch(), and 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	$modele	Force model to use ('' to not force)
Translate	$outputlangs	Object langs to use for output
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int Return integer < 0 if KO, 0 = no doc generated, > 0 if OK

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

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

getIdBillingContact()

Contrat::getIdBillingContact

(

)

Return id des contacts clients de facturation.

Returns

int[] Liste des id contacts facturation

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

References CommonObject\getIdContact().

getIdServiceContact()

Contrat::getIdServiceContact

(

)

Return id des contacts clients de prestation.

Returns

int[] Liste des id contacts prestation

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

References CommonObject\getIdContact().

getKanbanView()

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

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

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

References dol_print_date(), getNomUrl(), and img_picto().

getLibStatut()

Contrat::getLibStatut

(

$mode

)

Return label of a contract status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto, 7=Same than 6 with fixed length

Returns

string Label

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

References LibStatut().

getLinesArray()

Contrat::getLinesArray

(

)

Create an array of order lines.

Returns

int >0 if OK, <0 if KO

Definition at line 2520 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

	'all'|'others'	$option 'all' or 'others'
int[]	$status	sort contracts having these status
string[]	$product_categories	sort contracts containing these product categories
int[]	$line_status	sort contracts where lines have these status

Returns

array<int,Contrat>|int<min,-1> Array of contracts id or <0 if error

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

References dol_syslog().

getNextNumRef()

Contrat::getNextNumRef

(

$soc

)

Return next contract ref.

Parameters

Societe

$soc

Thirdparty object

Returns

string free reference for contract

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

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

Referenced by validate().

getNomUrl()

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

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
int	$maxlength	Max length of ref
int	$notooltip	1=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 2098 of file contrat.class.php.

References getDolGlobalInt(), getDolGlobalString(), getTooltipContentArray(), img_object(), and ref.

Referenced by getKanbanView().

getTicketsArray()

Contrat::getTicketsArray

(

)

Create an array of associated tickets.

Returns

Ticket[]|int<min,-1> Array o tickets or <0 if KO

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

getTooltipContentArray()

Contrat::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

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

References CommonObject\fetch_thirdparty(), CommonObject\fetchProject(), getDolGlobalString(), img_picto(), price(), and ref.

Referenced by getNomUrl().

info()

Contrat::info

(

$id

)

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

Parameters

int

$id

id du contrat a charger

Returns

void

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

References dol_print_error(), and ref.

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

References dol_now(), ref, and status.

LibStatut()

Contrat::LibStatut	(		$status,
			$mode )

Return the label of a given contrat status.

Parameters

int	$status	Id status
int	$mode	0=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 1985 of file contrat.class.php.

References getDolGlobalString().

Referenced by getLibStatut().

load_board()

Contrat::load_board	(		$user,
			$mode )

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

Parameters

User	$user	Object 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 2289 of file contrat.class.php.

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

loadStateBoard()

Contrat::loadStateBoard

(

)

Load the indicators this->nb for state board.

Returns

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

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

References dol_print_error().

reopen()

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

Unvalidate a contract.

Parameters

User	$user	Object User
int	$notrigger	1=Does not execute triggers, 0=execute triggers

Returns

int Return integer <0 if KO, >0 if OK

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

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

replaceProduct()

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

static

Function used to replace a product id with another one.

Parameters

DoliDB	$db	Database handler
int	$origin_id	Old product id
int	$dest_id	New product id

Returns

bool

Definition at line 2602 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	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool

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

References CommonObject\commonReplaceThirdparty().

update()

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

Update object into database.

Parameters

User	$user	User that modifies
int	$notrigger	0=launch triggers after, 1=disable triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References CommonObject\call_trigger(), dol_syslog(), CommonObject\insertExtraFields(), ref, and status.

update_statut()

Contrat::update_statut

(

$user

)

Update statut of contract according to services.

Parameters

User

$user

Object 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 1943 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	$rowid	Id de la ligne de facture
string	$desc	Description de la ligne
float	$pu	Prix unitaire
float	$qty	Quantite
float	$remise_percent	Percentage discount of the line
int	$date_start	Date de debut prevue
int	$date_end	Date de fin prevue
float	$tvatx	Taux TVA
float	$localtax1tx	Local tax 1 rate
float	$localtax2tx	Local tax 2 rate
int | string	$date_start_real	Date de debut reelle
int | string	$date_end_real	Date de fin reelle
string	$price_base_type	HT or TTC
int	$info_bits	Bits of type of lines
int	$fk_fournprice	Fourn price id
int	$pa_ht	Buying price HT
	array<string,mixed>	$array_options extrafields array
string	$fk_unit	Code of the unit to use. Null to use the default one
int	$rang	Position

Returns

int Return integer <0 if KO, >0 if OK

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

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

validate()

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

Validate a contract.

Parameters

User	$user	Object User
string	$force_number	Reference to force on contract (not implemented yet)
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

int Return integer <0 if KO, >0 if OK

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

References CommonObject\call_trigger(), dol_dir_list(), dol_now(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), CommonObject\fetch_thirdparty(), getDolGlobalString(), getNextNumRef(), ref, and status.

Referenced by activateAll(), and closeAll().

---

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

• dolibarr_dev/htdocs/contrat/class/contrat.class.php