dolibarr  20.0.0-alpha
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Account Class Reference

Class to manage bank accounts. More...

Inheritance diagram for Account:
Inheritance graph
[legend]
Collaboration diagram for Account:
Collaboration graph
[legend]

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 __toString ()
 Shows the account number in the appropriate 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=0, $url_id=0, $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, $num_releve='', $amount_main_currency=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 ($status, $mode=0)
 Return label of given object status. More...
 
 can_be_deleted ()
 Indicates if an account can be deleted or not (without movements) More...
 
 error ()
 Return error. More...
 
 solde ($option=0, $date_end='', $field='dateo')
 Return current balance. More...
 
 load_board (User $user, $filteraccountid=0)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 loadStateBoard ($filteraccountid=0)
 Load the indicators this->nb for the state board. More...
 
 countAccountToReconcile ()
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 getTooltipContentArray ($params)
 getTooltipContentArray More...
 
 getNomUrl ($withpicto=0, $mode='', $option='', $save_lastsearch_value=-1, $notooltip=0, $morecss='')
 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...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. 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...
 
 getKanbanView ($option='', $arraydata=null)
 Return clicable link of object (with eventually picto) More...
 
- Public Member Functions inherited from CommonObject
 setErrorsFromObject ($object)
 setErrorsFromObject More...
 
 getTooltipContent ($params)
 getTooltipContent More...
 
 errorsToString ()
 Method to output saved errors. More...
 
 getFormatedCustomerRef ($objref)
 Return customer ref for screen output. More...
 
 getFormatedSupplierRef ($objref)
 Return supplier ref for screen output. More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. 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 in llx_element_contact. More...
 
 liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
 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...
 
 listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
 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->contact_id 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_project ()
 Load the project with id $this->fk_project into this->project. 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, $notrigger=0)
 Link element with a project. More...
 
 setPaymentMethods ($id)
 Change the payments methods. More...
 
 setMulticurrencyCode ($code)
 Change the multicurrency code. More...
 
 setPaymentTerms ($id, $deposit_percent=null)
 Change the payments terms. More...
 
 setTransportMode ($id)
 Change the transport mode methods. More...
 
 setRetainedWarrantyPaymentTerms ($id)
 Change the retained warranty payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id, $notrigger=0, $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=0, $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, $includealltree=0)
 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='', $notrigger=0)
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 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). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 getElementType ()
 Return an element type string formatted like element_element target_type and source_type. 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...
 
 clearObjectLinkedCache ()
 Clear the cache saying that all linked object were already loaded. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
 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, $entity=0)
 Function to check if an object is used by others (by children). 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...
 
 formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
 Show add free and predefined products/services form. More...
 
 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. More...
 
 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) More...
 
 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). More...
 
 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). 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...
 
 indexFile ($destfull, $update_main_doc_field)
 Index a file into the ECM database. More...
 
 addThumbs ($file)
 Build thumb. More...
 
 delThumbs ($file)
 Delete thumbs. More...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
 Return the default value to use for a field when showing the create form of object. More...
 
 call_trigger ($triggerName, $user)
 Call trigger based on this instance. More...
 
 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. More...
 
 setValuesForExtraLanguages ($onlykey='')
 Fill array_options property of object by extrafields value (using for data sent by forms) More...
 
 fetchNoCompute ($id)
 Function to make a fetch but set environment to avoid to load computed values before. 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...
 
 insertExtraLanguages ($trigger='', $userused=null)
 Add/Update all extra fields values for the current object. More...
 
 updateExtraField ($key, $trigger=null, $userused=null)
 Update 1 extra field value for the current object. More...
 
 updateExtraLanguages ($key, $trigger=null, $userused=null)
 Update an extra language value for the current object. More...
 
 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. More...
 
 clearFieldError ($fieldKey)
 clear validation message result for a field More...
 
 setFieldError ($fieldKey, $msg='')
 set validation error message a field More...
 
 getFieldError ($fieldKey)
 get field error message More...
 
 validateField ($fields, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
 Function to show lines of extrafields with output data. More...
 
 getJSListDependancies ($type='_extra')
 
 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...
 
 getDataToShowPhoto ($modulepart, $imagesize)
 getDataToShowPhoto More...
 
 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. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 isDuration ($info)
 Function test if type is duration. 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...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 emtpyObjectVars ()
 Sets all object fields to null. More...
 
 getFieldList ($alias='', $excludefields=array())
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=0)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='', $noextrafields=0)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=0)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=0)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a status. More...
 
 setSignedStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a signed status. 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...
 
 getCategoriesCommon ($type_categ)
 Sets object to given categories. More...
 
 setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
 Sets object to given categories. More...
 
 cloneCategories ($fromId, $toId, $type='')
 Copy related categories to another object. More...
 
 deleteEcmFiles ($mode=0)
 Delete related files of object in database. More...
 

Static Public Member Functions

static getAccountNumberOrder ()
 Returns the components of the bank account in order. More...
 
static replaceThirdparty ($dbs, $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 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. More...
 
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. More...
 
static getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Count items linked to an object id in association table. More...
 
static deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
 Function used to remove all items linked to an object id in association table. More...
 
static commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product 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
 $origin_object
 
 $fk_departement
 var int State ID More...
 

Protected Member Functions

 deprecatedProperties ()
 Provide list of deprecated properties and replacements. 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...
 
 canBeNull ($info)
 Function test if field can be null. More...
 
 isForcedToNullIfZero ($info)
 Function test if field is forced to null if zero or empty. More...
 
 isIndex ($info)
 Function test if is indexed. More...
 
 setSaveQuery ()
 Function to return the array of data key-value from the ->fields and all the ->properties of an object. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage bank accounts.

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

Constructor & Destructor Documentation

◆ __construct()

Account::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Reimplemented in UserBankAccount, and CompanyBankAccount.

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

Member Function Documentation

◆ __toString()

Account::__toString ( )

Shows the account number in the appropriate format.

Returns
string

Definition at line 444 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 of bank entry
int$url_idId of object related to link
string$urlUrl (deprecated, we use now 'url_id' and 'type' instead)
string$labelLink label
string$typeType of link ('payment', 'company', 'member', ...)
Returns
int Return integer <0 if KO, id line if OK

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

◆ addline()

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

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

Parameters
int$dateDate operation
string$oper'VIR','PRE','LIQ','VAD','CB','CHQ'...
string$labelDescription
float$amountAmount
string$num_chqNumero cheque or transfer
int$categorieCategory id (optional)
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
string$num_releveLabel of bank receipt for reconciliation
float$amount_main_currencyAmount
Returns
int Rowid of added entry, <0 if KO

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

◆ can_be_deleted()

Account::can_be_deleted ( )

Indicates if an account can be deleted or not (without movements)

Returns
boolean True is the deletion is ok, false if not

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

References $sql.

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

◆ countAccountToReconcile()

Account::countAccountToReconcile ( )

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

Returns
int Nb of account we can reconciliate

Definition at line 1447 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 Return integer < 0 if KO, > 0 if OK

Reimplemented in UserBankAccount, and CompanyBankAccount.

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

◆ delete()

Account::delete ( User  $user = null)

Delete bank account from database.

Parameters
User | null$userUser deleting
Returns
int Return integer <0 if KO, >0 if OK

Reimplemented in UserBankAccount.

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

References $sql.

◆ deprecatedProperties()

Account::deprecatedProperties ( )
protected

Provide list of deprecated properties and replacements.

Returns
array<string,string> Old property to new property mapping

Reimplemented from CommonObject.

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

◆ error()

Account::error ( )

Return error.

Returns
string Error string

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

Referenced by fetch(), 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 Return integer <0 if KO, >0 if OK

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

References $sql, dol_syslog(), and error().

◆ get_url()

Account::get_url (   $fk_bank = 0,
  $url_id = 0,
  $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 537 of file account.class.php.

References $sql, dol_syslog(), and 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 1860 of file account.class.php.

◆ getBannerAddress()

Account::getBannerAddress (   $htmlkey,
  $object 
)

Return full address for banner.

Parameters
string$htmlkeyHTML id to make banner content unique
Object$objectObject (thirdparty, thirdparty of contact for contact, null for a member)
Returns
string Full address string

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

◆ getCountryCode()

Account::getCountryCode ( )

Return account country code.

Returns
string country code

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

◆ 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 Array of fields to show
See also
useDetailedBBAN()

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

◆ getKanbanView()

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

Return clicable link of object (with eventually picto)

Parameters
string$optionWhere point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
array$arraydataArray of data
Returns
string HTML Code for Kanban thumb.

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

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

◆ getNomUrl()

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

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
string$morecssAdd more css on link
Returns
string Chaine avec URL

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

◆ getTooltipContentArray()

Account::getTooltipContentArray (   $params)

getTooltipContentArray

Parameters
array$paramsParams to construct tooltip data
Since
v18
Returns
array

Reimplemented from CommonObject.

Definition at line 1483 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 1803 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
int

Reimplemented in CompanyBankAccount.

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

◆ LibStatut()

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

Return label of given object status.

Parameters
int$statusId status
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 1252 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$userObject user
int$filteraccountidTo get info for a particular account id
Returns
WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

◆ loadStateBoard()

Account::loadStateBoard (   $filteraccountid = 0)

Load the indicators this->nb for the state board.

Parameters
int$filteraccountidTo get info for a particular account id
Returns
int Return integer <0 if KO, >0 if OK

Definition at line 1408 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 1745 of file account.class.php.

◆ replaceThirdparty()

static Account::replaceThirdparty (   $dbs,
  $origin_id,
  $dest_id 
)
static

Function used to replace a thirdparty id with another one.

Parameters
DoliDB$dbsDatabase handler
int$origin_idOld thirdparty id
int$dest_idNew thirdparty id
Returns
bool True=SQL success, False=SQL error

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

◆ 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$categoriesCategory or categories IDs
Returns
int Return integer <0 if KO, >0 if OK

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

◆ solde()

Account::solde (   $option = 0,
  $date_end = '',
  $field = 'dateo' 
)

Return current balance.

Parameters
int$option1=Exclude future operation date (this is to exclude input made in advance and have real account sold)
int | string$date_endDate until we want to get bank account balance
string$field'dateo' or 'datev'
Returns
float|-1 current balance (value date <= today), or -1 if error

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

Referenced by CompanyBankAccount\__construct(), and UserBankAccount\__construct().

◆ update()

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

Update bank account card.

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

Reimplemented in UserBankAccount, and CompanyBankAccount.

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

◆ update_bban()

Account::update_bban ( User  $user = null)

Update BBAN (RIB) account fields.

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

Definition at line 1004 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 1727 of file account.class.php.

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


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