dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
AccountLine Class Reference

Class to manage bank transaction lines. More...

+ Inheritance diagram for AccountLine:
+ Collaboration diagram for AccountLine:

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 fetch ($rowid, $ref='', $num='')
 Load into memory content of a bank transaction line. More...
 
 insert ()
 Inserts a transaction to a bank account. More...
 
 delete (User $user=null)
 Delete transaction bank line record. More...
 
 delete_urls (User $user=null)
 Delete bank line records. More...
 
 update (User $user, $notrigger=0)
 Update bank account record in database. More...
 
 update_conciliation (User $user, $cat, $conciliated=1)
 Update conciliation field. More...
 
 datev_change ($rowid, $sign=1)
 Increase/decrease value date of a rowid. More...
 
 datev_next ($id)
 Increase value date of a rowid. More...
 
 datev_previous ($id)
 Decrease value date of a rowid. More...
 
 dateo_change ($rowid, $sign=1)
 Increase/decrease operation date of a rowid. More...
 
 dateo_next ($id)
 Increase operation date of a rowid. More...
 
 dateo_previous ($id)
 Decrease operation date of a rowid. More...
 
 info ($id)
 Load miscellaneous information for tab "Info". More...
 
 getNomUrl ($withpicto=0, $maxlen=0, $option='', $notooltip=0)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Return label of status (activity, closed) More...
 
 LibStatut ($statut, $mode=0)
 Renvoi le libelle d'un statut donne. More...
 
 getVentilExportCompta ()
 Return if a bank line was dispatched into bookkeeping. 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...
 

Public Attributes

 $datev
 Value date.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

Additional Inherited Members

- 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...
 
- 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 bank transaction lines.

Definition at line 1659 of file account.class.php.

Constructor & Destructor Documentation

◆ __construct()

AccountLine::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 1755 of file account.class.php.

Member Function Documentation

◆ dateo_change()

AccountLine::dateo_change (   $rowid,
  $sign = 1 
)

Increase/decrease operation date of a rowid.

Parameters
int$rowidId of line
int$sign1 or -1
Returns
int >0 if OK, 0 if KO

Definition at line 2145 of file account.class.php.

◆ dateo_next()

AccountLine::dateo_next (   $id)

Increase operation date of a rowid.

Parameters
int$idId of line to change
Returns
int >0 if OK, 0 if KO

Definition at line 2184 of file account.class.php.

◆ dateo_previous()

AccountLine::dateo_previous (   $id)

Decrease operation date of a rowid.

Parameters
int$idId of line to change
Returns
int >0 if OK, 0 if KO

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

◆ datev_change()

AccountLine::datev_change (   $rowid,
  $sign = 1 
)

Increase/decrease value date of a rowid.

Parameters
int$rowidId of line
int$sign1 or -1
Returns
int >0 if OK, 0 if KO

Definition at line 2078 of file account.class.php.

◆ datev_next()

AccountLine::datev_next (   $id)

Increase value date of a rowid.

Parameters
int$idId of line to change
Returns
int >0 if OK, 0 if KO

Definition at line 2117 of file account.class.php.

◆ datev_previous()

AccountLine::datev_previous (   $id)

Decrease value date of a rowid.

Parameters
int$idId of line to change
Returns
int >0 if OK, 0 if KO

Definition at line 2130 of file account.class.php.

◆ delete()

AccountLine::delete ( User  $user = null)

Delete transaction bank line record.

Parameters
User$userUser object that delete
Returns
int <0 if KO, >0 if OK

Definition at line 1890 of file account.class.php.

References Account\error().

◆ delete_urls()

AccountLine::delete_urls ( User  $user = null)

Delete bank line records.

Parameters
User$userUser object that delete
Returns
int <0 if KO, >0 if OK

Definition at line 1940 of file account.class.php.

References Account\error().

◆ fetch()

AccountLine::fetch (   $rowid,
  $ref = '',
  $num = '' 
)

Load into memory content of a bank transaction line.

Parameters
int$rowidId of bank transaction to load
string$refRef of bank transaction to load
string$numExternal num to load (ex: num of transaction for paypal fee)
Returns
int <0 if KO, 0 if OK but not found, >0 if OK and found

Definition at line 1768 of file account.class.php.

◆ getLibStatut()

AccountLine::getLibStatut (   $mode = 0)

Return label of status (activity, closed)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long
Returns
string Libelle

Definition at line 2301 of file account.class.php.

◆ getNomUrl()

AccountLine::getNomUrl (   $withpicto = 0,
  $maxlen = 0,
  $option = '',
  $notooltip = 0 
)

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
int$maxlenLongueur max libelle
string$optionOption ('showall')
int$notooltip1=Disable tooltip
Returns
string Chaine avec URL

Definition at line 2260 of file account.class.php.

◆ getVentilExportCompta()

AccountLine::getVentilExportCompta ( )

Return if a bank line was dispatched into bookkeeping.

Returns
int <0 if KO, 0=no, 1=yes

Definition at line 2358 of file account.class.php.

◆ info()

AccountLine::info (   $id)

Load miscellaneous information for tab "Info".

Parameters
int$idId of object to load
Returns
void

Definition at line 2210 of file account.class.php.

◆ insert()

AccountLine::insert ( )

Inserts a transaction to a bank account.

Returns
int <0 if KO, rowid of the line if OK

Definition at line 1840 of file account.class.php.

◆ LibStatut()

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

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle du statut

Definition at line 2314 of file account.class.php.

◆ update()

AccountLine::update ( User  $user,
  $notrigger = 0 
)

Update bank account record in database.

Parameters
User$userObject user making update
int$notrigger0=Disable all triggers
Returns
int <0 if KO, >0 if OK

Definition at line 1979 of file account.class.php.

◆ update_conciliation()

AccountLine::update_conciliation ( User  $user,
  $cat,
  $conciliated = 1 
)

Update conciliation field.

Parameters
User$userObjet user making update
int$catCategory id
int$conciliated1=Set transaction to conciliated, 0=Keep transaction non conciliated
Returns
int <0 if KO, >0 if OK

Definition at line 2014 of file account.class.php.


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