dolibarr  9.0.0
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | List of all members
Fichinter Class Reference

Class to manage interventions. More...

+ Inheritance diagram for Fichinter:
+ Collaboration diagram for Fichinter:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 load_state_board ()
 Load indicators into this->nb for board. More...
 
 create ($user, $notrigger=0)
 Create an intervention into data base. More...
 
 update ($user, $notrigger=0)
 Update an intervention. More...
 
 fetch ($rowid, $ref='')
 Fetch a intervention. More...
 
 setDraft ($user)
 Set status to draft. More...
 
 setValid ($user, $notrigger=0)
 Validate a intervention. More...
 
 getAmount ()
 Returns amount based on user thm. More...
 
 generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0, $moreparams=null)
 Create a document onto disk according to template module. More...
 
 getLibStatut ($mode=0)
 Returns the label status. More...
 
 LibStatut ($statut, $mode=0)
 Returns the label of a statut. More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getNextNumRef ($soc)
 Returns the next non used reference of intervention depending on the module numbering assets within FICHEINTER_ADDON. More...
 
 info ($id)
 Load information on object. More...
 
 delete ($user, $notrigger=0)
 Delete intervetnion. More...
 
 set_date_delivery ($user, $date_delivery)
 Defines a delivery date of intervention. More...
 
 set_description ($user, $description)
 Define the label of the intervention. More...
 
 set_contrat ($user, $contractid)
 Link intervention to a contract. More...
 
 createFromClone ($socid=0)
 Load an object from its id and create a new one in database. More...
 
 addline ($user, $fichinterid, $desc, $date_intervention, $duration, $array_options='')
 Adding a line of intervention into data base. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. More...
 
 fetch_lines ()
 Load array lines ->lines. More...
 
- Public Member Functions inherited from CommonObject
 errorsToString ()
 Method to output saved errors. More...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\, $withregion=0)
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. 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. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 Get array of all contacts for an object. More...
 
 swapContactStatus ($rowid)
 Update status of a contact linked to object. More...
 
 liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
 Return array with list of possible values for type of contacts. More...
 
 getIdContact ($source, $code, $status=0)
 Return id of contacts for a source and a contact code. More...
 
 fetch_contact ($contactid=null)
 Load object contact with id=$this->contactid into $this->contact. More...
 
 fetch_thirdparty ($force_thirdparty_id=0)
 Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...
 
 fetchOneLike ($ref)
 Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set. More...
 
 fetch_barcode ()
 Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode. More...
 
 fetch_projet ()
 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)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. More...
 
 setPaymentTerms ($id)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=false, $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=false, $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)
 Get children of line. More...
 
 line_up ($rowid, $fk_parent_line=true)
 Update a line to have a lower rank. More...
 
 line_down ($rowid, $fk_parent_line=true)
 Update a line to have a higher rank. More...
 
 updateRangOfLine ($rowid, $rang)
 Update position of line (rang) More...
 
 line_ajaxorder ($rows)
 Update position of line with ajax (rang) More...
 
 updateLineUp ($rowid, $rang)
 Update position of line up (rang) More...
 
 updateLineDown ($rowid, $rang, $max)
 Update position of line down (rang) More...
 
 getRangOfLine ($rowid)
 Get position of line (rang) More...
 
 getIdOfLine ($rang)
 Get rowid of the line relative to its position. More...
 
 line_max ($fk_parent_line=0)
 Get max value used for position of line (rang) More...
 
 update_ref_ext ($ref_ext)
 Update external ref of element. More...
 
 update_note ($note, $suffix='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='')
 Set status of an object. More...
 
 getCanvas ($id=0, $ref='')
 Load type of canvas of an object if it exists. More...
 
 getSpecialCode ($lineid)
 Get special code of a line. More...
 
 isObjectUsed ($id=0)
 Function to check if an object is used by others. More...
 
 hasProductsOrServices ($predefined=-1)
 Function to say how many lines object contains. More...
 
 getTotalDiscount ()
 Function that returns the total amount HT of discounts applied for all lines. More...
 
 getTotalWeightVolume ()
 Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...
 
 setExtraParameters ()
 Set extra parameters. More...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 printOriginLine ($line, $var, $restrictlist='')
 Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...
 
 add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
 Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...
 
 delete_resource ($rowid, $element, $notrigger=0)
 Delete a link to resource line. More...
 
 __clone ()
 Overwrite magic function to solve problem of cloning object that are kept as references. More...
 
 addThumbs ($file)
 Build thumb Move this into files.lib.php. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($trigger_name, $user)
 Call trigger based on this instance. More...
 
 fetch_optionals ($rowid=null, $optionsArray=null)
 Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...
 
 deleteExtraFields ()
 Delete all extra fields values for the current object. More...
 
 insertExtraFields ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0)
 Function to show lines of extrafields with output datas. More...
 
 getRights ()
 Returns the rights used for this class. More...
 
 defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
 Get buy price to use for margin calculation. More...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isInt ($info)
 Function test if type is integer. More...
 
 isFloat ($info)
 Function test if type is float. More...
 
 isText ($info)
 Function test if type is text. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 initAsSpecimenCommon ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchComments ()
 Load comments linked with current task. More...
 
 getNbComments ()
 Return nb comments already posted. More...
 
 trimParameters ($parameters)
 Trim object parameters. More...
 

Static Public Member Functions

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

Public Attributes

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
 $projet
 
 $note
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

Additional Inherited Members

- Protected Member Functions inherited from CommonObject
 commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
 Common function for all objects extending CommonObject for generating documents. More...
 
 isArray ($info)
 Function test if type is array. More...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage interventions.

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

Constructor & Destructor Documentation

◆ __construct()

Fichinter::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 125 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$userUser that do the action
int$fichinteridId of intervention
string$descLine description
date$date_interventionIntervention date
int$durationIntervention duration
array$array_optionsArray option
Returns
int >0 if ok, <0 if ko

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

◆ create()

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

Create an intervention into data base.

Parameters
User$userObjet user that make creation
int$notriggerDisable all triggers
Returns
int <0 if KO, >0 if OK

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

◆ createFromClone()

Fichinter::createFromClone (   $socid = 0)

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

Parameters
int$socidId of thirdparty
Returns
int New id of clone

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

◆ delete()

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

Delete intervetnion.

Parameters
User$userObject user who delete
int$notriggerDisable trigger
Returns
int <0 if KO, >0 if OK

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

◆ fetch()

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

Fetch a intervention.

Parameters
int$rowidId of intervention
string$refRef of intervention
Returns
int <0 if KO, >0 if OK

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

◆ fetch_lines()

Fichinter::fetch_lines ( )

Load array lines ->lines.

Returns
int <0 if KO, >0 if OK

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

◆ generateDocument()

Fichinter::generateDocument (   $modele,
  $outputlangs,
  $hidedetails = 0,
  $hidedesc = 0,
  $hideref = 0,
  $moreparams = null 
)

Create a document onto disk according to template module.

Parameters
string$modeleForce model to use ('' to not force)
Translate$outputlangsObject langs to use for output
int$hidedetailsHide details of lines
int$hidedescHide description
int$hiderefHide ref
null | array$moreparamsArray to provide more information
Returns
int 0 if KO, 1 if OK

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

◆ getAmount()

Fichinter::getAmount ( )

Returns amount based on user thm.

Returns
float Amount

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

◆ getLibStatut()

Fichinter::getLibStatut (   $mode = 0)

Returns the label status.

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto
Returns
string Label

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

◆ getNextNumRef()

Fichinter::getNextNumRef (   $soc)

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

Parameters
Societe$socThirdparty object
Returns
string Free reference for intervention

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

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpicto0=_No picto, 1=Includes the picto in the linkn, 2=Picto only
string$optionOptions
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 String with URL

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

◆ info()

Fichinter::info (   $id)

Load information on object.

Parameters
int$idId of object
Returns
void

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

◆ 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
void

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

◆ LibStatut()

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

Returns the label of a statut.

Parameters
int$statutid statut
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto
Returns
string Label

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

◆ load_state_board()

Fichinter::load_state_board ( )

Load indicators into this->nb for board.

Returns
int <0 if KO, >0 if OK

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

◆ replaceThirdparty()

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

Function used to replace a thirdparty id with another one.

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

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

References CommonObject\commonReplaceThirdparty().

◆ set_contrat()

Fichinter::set_contrat (   $user,
  $contractid 
)

Link intervention to a contract.

Parameters
User$userObject user who modify
int$contractidDescription
Returns
int <0 if ko, >0 if ok

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

◆ set_date_delivery()

Fichinter::set_date_delivery (   $user,
  $date_delivery 
)

Defines a delivery date of intervention.

Parameters
User$userObject user who define
date$date_deliverydate of delivery
Returns
int <0 if ko, >0 if ok

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

◆ set_description()

Fichinter::set_description (   $user,
  $description 
)

Define the label of the intervention.

Parameters
User$userObject user who modify
string$descriptiondescription
Returns
int <0 if KO, >0 if OK

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

◆ setDraft()

Fichinter::setDraft (   $user)

Set status to draft.

Parameters
User$userUser that set draft
Returns
int <0 if KO, >0 if OK

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

◆ setValid()

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

Validate a intervention.

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

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

◆ update()

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

Update an intervention.

Parameters
User$userObjet user that make creation
int$notriggerDisable all triggers
Returns
int <0 if KO, >0 if OK

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

References dol_strlen().


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