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

Class to manage bank accounts. More...

+ Inheritance diagram for Account:
+ Collaboration diagram for Account:

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 __toString ()
 Shows the account number in the appropiate format. More...
 
 canBeConciliated ()
 Return if a bank account need to be conciliated. More...
 
 add_url_line ($line_id, $url_id, $url, $label, $type)
 Add a link between bank line record and its source. More...
 
 get_url ($fk_bank='', $url_id='', $type='')
 TODO Move this into AccountLine Return array with links from llx_bank_url. More...
 
 addline ($date, $oper, $label, $amount, $num_chq, $categorie, User $user, $emetteur='', $banque='', $accountancycode='', $datev=null)
 Add an entry into table ".MAIN_DB_PREFIX."bank. More...
 
 create (User $user, $notrigger=0)
 Create bank account into database. More...
 
 update (User $user, $notrigger=0)
 Update bank account card. More...
 
 update_bban (User $user=null)
 Update BBAN (RIB) account fields. More...
 
 fetch ($id, $ref='')
 Load a bank account into memory from database. More...
 
 setCategories ($categories)
 Sets object to supplied categories. More...
 
 delete (User $user=null)
 Delete bank account from database. More...
 
 getLibStatut ($mode=0)
 Return label of object status. More...
 
 LibStatut ($statut, $mode=0)
 Return label of given object status. More...
 
 can_be_deleted ()
 Renvoi si un compte peut etre supprimer ou non (sans mouvements) More...
 
 error ()
 Return error. More...
 
 solde ($option=0)
 Return current sold. More...
 
 load_board (User $user, $filteraccountid=0)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 load_state_board ($filteraccountid=0)
 Charge indicateurs this->nb de tableau de bord. More...
 
 getNomUrl ($withpicto=0, $mode='', $option='', $save_lastsearch_value=-1, $notooltip=0)
 Return clicable name (with picto eventually) More...
 
 verif ()
 Return if an account has valid information for Direct debit payment. More...
 
 getCountryCode ()
 Return account country code. More...
 
 useDetailedBBAN ()
 Return if a bank account is defined with detailed information (bank code, desk code, number and key). More...
 
 needIBAN ()
 Return 1 if IBAN / BIC is mandatory (otherwise option) More...
 
 info ($id)
 Load miscellaneous information for tab "Info". More...
 
 getFieldsToShow ($includeibanbic=0)
 Returns the fields in order that this bank account should show to the user Will return an array with the following values: More...
 
 initAsSpecimen ()
 Initialise an instance with random values. 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 countAccountToReconcile ()
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
static getAccountNumberOrder ()
 Returns the components of the bank account in order. 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 TYPE_CURRENT = 1
 Current account.
 
const TYPE_CASH = 2
 Cash account.
 
const TYPE_SAVINGS = 0
 Savings account.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

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 bank accounts.

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

Constructor & Destructor Documentation

◆ __construct()

Account::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

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

Member Function Documentation

◆ __toString()

Account::__toString ( )

Shows the account number in the appropiate format.

Returns
string

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

◆ add_url_line()

Account::add_url_line (   $line_id,
  $url_id,
  $url,
  $label,
  $type 
)

Add a link between bank line record and its source.

Parameters
int$line_idId ecriture bancaire
int$url_idId parametre url
string$urlUrl
string$labelLink label
string$typeType of link ('payment', 'company', 'member', ...)
Returns
int <0 if KO, id line if OK

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

◆ addline()

Account::addline (   $date,
  $oper,
  $label,
  $amount,
  $num_chq,
  $categorie,
User  $user,
  $emetteur = '',
  $banque = '',
  $accountancycode = '',
  $datev = null 
)

Add an entry into table ".MAIN_DB_PREFIX."bank.

Parameters
int$dateDate operation
string$oper1,2,3,4... (deprecated) or 'TYP','VIR','PRE','LIQ','VAD','CB','CHQ'...
string$labelDescripton
float$amountAmount
string$num_chqNumero cheque ou virement
int$categorieCategory id (optionnal)
User$userUser that create
string$emetteurName of cheque writer
string$banqueBank of cheque writer
string$accountancycodeWhen we record a free bank entry, we must provide accounting account if accountancy module is on.
int$datevDate value
Returns
int Rowid of added entry, <0 if KO

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

◆ can_be_deleted()

Account::can_be_deleted ( )

Renvoi si un compte peut etre supprimer ou non (sans mouvements)

Returns
boolean vrai si peut etre supprime, faux sinon

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

◆ canBeConciliated()

Account::canBeConciliated ( )

Return if a bank account need to be conciliated.

Returns
int 1 if need to be concialiated, < 0 otherwise.

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

◆ countAccountToReconcile()

static Account::countAccountToReconcile ( )
static

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

Returns
int Nb of account we can reconciliate

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

◆ create()

Account::create ( User  $user,
  $notrigger = 0 
)

Create bank account into database.

Parameters
User$userObject user making creation
int$notrigger1=Disable triggers
Returns
int < 0 if KO, > 0 if OK

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

◆ delete()

Account::delete ( User  $user = null)

Delete bank account from database.

Parameters
User$userUser deleting
Returns
int <0 if KO, >0 if OK

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

◆ error()

Account::error ( )

Return error.

Returns
string Error string

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

Referenced by AccountLine\delete(), AccountLine\delete_urls(), and get_url().

◆ fetch()

Account::fetch (   $id,
  $ref = '' 
)

Load a bank account into memory from database.

Parameters
int$idId of bank account to get
string$refRef of bank account to get
Returns
int <0 if KO, >0 if OK

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

◆ get_url()

Account::get_url (   $fk_bank = '',
  $url_id = '',
  $type = '' 
)

TODO Move this into AccountLine Return array with links from llx_bank_url.

Parameters
int$fk_bankTo search using bank transaction id
int$url_idTo search using link to
string$typeTo search using type
Returns
array|int Array of links array('url'=>, 'url_id'=>, 'label'=>, 'type'=> 'fk_bank'=> ) or -1 on error

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

References error().

◆ getAccountNumberOrder()

static Account::getAccountNumberOrder ( )
static

Returns the components of the bank account in order.

Will return an array with the following values:

  • BankAccountNumber
  • BankCode
  • BankAccountNumberKey
  • DeskCode
Returns
array

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

◆ getCountryCode()

Account::getCountryCode ( )

Return account country code.

Returns
string country code

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

Referenced by needIBAN(), and useDetailedBBAN().

◆ getFieldsToShow()

Account::getFieldsToShow (   $includeibanbic = 0)

Returns the fields in order that this bank account should show to the user Will return an array with the following values:

  • BankAccountNumber
  • BankCode
  • BankAccountNumberKey
  • DeskCode

Some countries show less or more bank account properties to the user

Parameters
int$includeibanbic1=Return also key for IBAN and BIC
Returns
array
See also
useDetailedBBAN

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

References useDetailedBBAN().

◆ getLibStatut()

Account::getLibStatut (   $mode = 0)

Return label of object status.

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

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

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpictoInclude picto into link
string$mode''=Link to card, 'transactions'=Link to transactions card
string$option''=Show ref, 'reflabel'=Show ref+label
int$save_lastsearch_value-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking
int$notooltip1=Disable tooltip
Returns
string Chaine avec URL

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

◆ info()

Account::info (   $id)

Load miscellaneous information for tab "Info".

Parameters
int$idId of object to load
Returns
void

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

◆ initAsSpecimen()

Account::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 1634 of file account.class.php.

◆ LibStatut()

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

Return label of given object status.

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 1092 of file account.class.php.

◆ load_board()

Account::load_board ( User  $user,
  $filteraccountid = 0 
)

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

Parameters
User$userObjet user
int$filteraccountidTo get info for a particular account id
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

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

◆ load_state_board()

Account::load_state_board (   $filteraccountid = 0)

Charge indicateurs this->nb de tableau de bord.

Parameters
int$filteraccountidTo get info for a particular account id
Returns
int <0 if ko, >0 if ok

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

◆ needIBAN()

Account::needIBAN ( )

Return 1 if IBAN / BIC is mandatory (otherwise option)

Returns
int 1 = mandatory / 0 = Not mandatory

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

References getCountryCode().

◆ setCategories()

Account::setCategories (   $categories)

Sets object to supplied categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters
int[]|int$categories Category or categories IDs
Returns
void

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

◆ solde()

Account::solde (   $option = 0)

Return current sold.

Parameters
int$option1=Exclude future operation date (this is to exclude input made in advance and have real account sold)
Returns
int Current sold (value date <= today)

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

◆ update()

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

Update bank account card.

Parameters
User$userObject user making action
int$notrigger1=Disable triggers
Returns
int <0 if KO, >0 if OK

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

◆ update_bban()

Account::update_bban ( User  $user = null)

Update BBAN (RIB) account fields.

Parameters
User$userObject user making update
Returns
int <0 if KO, >0 if OK

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

◆ useDetailedBBAN()

Account::useDetailedBBAN ( )

Return if a bank account is defined with detailed information (bank code, desk code, number and key).

More information on codes used by countries on page http://en.wikipedia.org/wiki/Bank_code

Returns
int 0=No bank code need + Account number is enough 1=Need 2 fields for bank code: Bank, Desk (France, Spain, ...) + Account number and key 2=Need 1 field for bank code: Bank only (Sort code for Great Britain, BSB for Australia) + Account number

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

References getCountryCode().

Referenced by getFieldsToShow().

◆ verif()

Account::verif ( )

Return if an account has valid information for Direct debit payment.

Returns
int 1 if correct, <=0 if wrong

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


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