Fichinter Class Reference

Inheritance diagram for Fichinter:

Collaboration diagram for Fichinter:

Public Member Functions
	__construct ($db)
	Constructor.
	loadStateBoard ()
	Load indicators into this->nb for board.
	create ($user, $notrigger=0)
	Create an intervention into data base.
	update ($user, $notrigger=0)
	Update an intervention.
	fetch ($rowid, $ref='')
	Fetch a intervention.
	setDraft ($user)
	Set status to draft.
	setValid ($user, $notrigger=0)
	Validate a intervention.
	setClose ($user, $notrigger=0)
	Close intervention.
	getAmount ()
	Returns amount based on user thm.
	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
	Create a document onto disk according to template module.
	getLibStatut ($mode=0)
	Returns the label status.
	LibStatut ($status, $mode=0)
	Returns the label of a status.
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $save_lastsearch_value=-1, $morecss='')
	Return clickable name (with picto eventually)
	getNextNumRef ($soc)
	Returns the next non used reference of intervention depending on the module numbering assets within FICHEINTER_ADDON.
	info ($id)
	Load information on object.
	delete (User $user, $notrigger=0)
	Delete intervetnion.
	set_date_delivery ($user, $date_delivery)
	Defines a delivery date of intervention.
	set_description ($user, $description)
	Define the label of the intervention.
	set_contrat ($user, $contractid)
	Link intervention to a contract.
	createFromClone (User $user, $socid=0)
	Load an object from its id and create a new one in database.
	addline ($user, $fichinterid, $desc, $date_intervention, $duration, $array_options=[])
	Adding a line of intervention into data base.
	initAsSpecimen ()
	Initialise an instance with random values.
	fetch_lines ()
	Load array lines ->lines.
	setRefClient ($user, $ref_client, $notrigger=0)
	Set customer reference number.
	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 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.

Public Attributes
const	STATUS_DRAFT = 0
	Draft status.
const	STATUS_VALIDATED = 1
	Validated status.
const	STATUS_BILLED = 2
	Billed.
const	STATUS_CLOSED = 3
	Closed.
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.
	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 41 of file fichinter.class.php.

Constructor & Destructor Documentation

__construct()

Fichinter::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Reimplemented in FichinterRec.

Definition at line 220 of file fichinter.class.php.

Member Function Documentation

addline()

Fichinter::addline	(		$user,
			$fichinterid,
			$desc,
			$date_intervention,
			$duration,
			$array_options = [] )

Adding a line of intervention into data base.

Parameters

user	$user	User that do the action
int	$fichinterid	Id of intervention
string	$desc	Line description
int	$date_intervention	Intervention date
int	$duration	Intervention duration
	array<string,?mixed>	$array_options Array option

Returns

int >0 if ok, <0 if ko

Definition at line 1387 of file fichinter.class.php.

References dol_syslog(), and status.

Referenced by createFromClone().

create()

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

Create an intervention into data base.

Parameters

User	$user	Object user that make creation
int	$notrigger	Disable all triggers

Returns

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

Reimplemented in FichinterRec.

Definition at line 268 of file fichinter.class.php.

References CommonObject\add_object_linked(), CommonObject\call_trigger(), description, dol_now(), dol_print_error(), dol_syslog(), CommonObject\insertExtraFields(), CommonObject\isExistingObject(), and ref.

Referenced by createFromClone().

createFromClone()

Fichinter::createFromClone	(	User	$user,
			$socid = 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

Returns

int New id of clone

Definition at line 1294 of file fichinter.class.php.

References addline(), create(), ref, CommonObject\setErrorsFromObject(), status, and STATUS_DRAFT.

delete()

Fichinter::delete	(	User	$user,
			$notrigger = 0 )

Delete intervetnion.

Parameters

User	$user	Object user who delete
int	$notrigger	Disable trigger

Returns

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

Reimplemented in FichinterRec.

Definition at line 1080 of file fichinter.class.php.

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

fetch()

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

Fetch a intervention.

Parameters

int	$rowid	Id of intervention
string	$ref	Ref of intervention

Returns

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

Definition at line 469 of file fichinter.class.php.

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

fetch_lines()

Fichinter::fetch_lines

(

)

Load array lines ->lines.

Returns

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

Definition at line 1470 of file fichinter.class.php.

References dol_syslog().

Referenced by fetch(), and FichinterRec\fetch().

generateDocument()

Fichinter::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<0,1>	$hidedetails Hide details of lines
	int<0,1>	$hidedesc Hide description
	int<0,1>	$hideref Hide ref
	?array<string,mixed>	$moreparams Array to provide more information

Returns

int 0 if KO, 1 if OK

Definition at line 794 of file fichinter.class.php.

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

getAmount()

Fichinter::getAmount

(

)

Returns amount based on user thm.

Returns

float Amount

Definition at line 766 of file fichinter.class.php.

References price2num().

getKanbanView()

Fichinter::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 1595 of file fichinter.class.php.

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

getLibStatut()

Fichinter::getLibStatut

(

$mode = 0

)

Returns the label status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto

Returns

string Label

Reimplemented in FichinterRec.

Definition at line 821 of file fichinter.class.php.

References LibStatut().

getNextNumRef()

Fichinter::getNextNumRef

(

$soc

)

Returns the next non used reference of intervention depending on the module numbering assets within FICHEINTER_ADDON.

Parameters

Societe

$soc

Thirdparty object

Returns

string Free reference for intervention

Definition at line 990 of file fichinter.class.php.

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

Referenced by setValid().

getNomUrl()

Fichinter::getNomUrl	(		$withpicto = 0,
			$option = '',
			$notooltip = 0,
			$save_lastsearch_value = -1,
			$morecss = '' )

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=_No picto, 1=Includes the picto in the linkn, 2=Picto only
string	$option	Options
int	$notooltip	1=Disable tooltip
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
string	$morecss	Add more css on link

Returns

string String with URL

Reimplemented in FichinterRec.

Definition at line 897 of file fichinter.class.php.

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

Referenced by getKanbanView().

getTooltipContentArray()

Fichinter::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 871 of file fichinter.class.php.

References img_picto(), and status.

Referenced by getNomUrl().

info()

Fichinter::info

(

$id

)

Load information on object.

Parameters

int

$id

Id of object

Returns

void

Definition at line 1040 of file fichinter.class.php.

References dol_print_error().

initAsSpecimen()

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

Reimplemented in FichinterRec.

Definition at line 1430 of file fichinter.class.php.

References dol_now(), and ref.

LibStatut()

Fichinter::LibStatut	(		$status,
			$mode = 0 )

Returns the label of a status.

Parameters

int	$status	Id status
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

Returns

string Label

Definition at line 834 of file fichinter.class.php.

References getLibSignedStatus(), STATUS_BILLED, STATUS_CLOSED, STATUS_DRAFT, and STATUS_VALIDATED.

Referenced by getLibStatut(), and FichinterRec\getLibStatut().

loadStateBoard()

Fichinter::loadStateBoard

(

)

Load indicators into this->nb for board.

Returns

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

Definition at line 230 of file fichinter.class.php.

References dol_print_error(), and getEntity().

replaceThirdparty()

static Fichinter::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

Reimplemented in FichinterRec.

Definition at line 1522 of file fichinter.class.php.

References CommonObject\commonReplaceThirdparty().

set_contrat()

Fichinter::set_contrat	(		$user,
			$contractid )

Link intervention to a contract.

Parameters

User	$user	Object user who modify
int	$contractid	Description

Returns

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

Definition at line 1265 of file fichinter.class.php.

set_date_delivery()

Fichinter::set_date_delivery	(		$user,
			$date_delivery )

Defines a delivery date of intervention.

Parameters

User	$user	Object user who define
integer	$date_delivery	date of delivery

Returns

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

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

References dol_syslog().

set_description()

Fichinter::set_description	(		$user,
			$description )

Define the label of the intervention.

Parameters

User	$user	Object user who modify
string	$description	description

Returns

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

Definition at line 1234 of file fichinter.class.php.

References description, and dol_syslog().

setClose()

Fichinter::setClose	(		$user,
			$notrigger = 0 )

Close intervention.

Parameters

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

Returns

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

Definition at line 714 of file fichinter.class.php.

References CommonObject\call_trigger(), dol_now(), STATUS_CLOSED, and STATUS_DRAFT.

setDraft()

Fichinter::setDraft

(

$user

)

Set status to draft.

Parameters

User

$user

User that set draft

Returns

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

Definition at line 545 of file fichinter.class.php.

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

setRefClient()

Fichinter::setRefClient	(		$user,
			$ref_client,
			$notrigger = 0 )

Set customer reference number.

Parameters

User	$user	Object user that modify
string	$ref_client	Customer reference
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns

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

Definition at line 1539 of file fichinter.class.php.

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

setValid()

Fichinter::setValid	(		$user,
			$notrigger = 0 )

Validate a intervention.

Parameters

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

Returns

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

Definition at line 596 of file fichinter.class.php.

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

update()

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

Update an intervention.

Parameters

User	$user	Object user that make creation
int	$notrigger	Disable all triggers

Returns

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

Definition at line 405 of file fichinter.class.php.

References CommonObject\call_trigger(), description, dol_strlen(), dol_syslog(), and CommonObject\insertExtraFields().

---

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

• dolibarr_dev/htdocs/fichinter/class/fichinter.class.php