Account Class Reference

Class to manage bank accounts. More...

Inheritance diagram for Account:

Collaboration diagram for Account:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	__toString ()
	Shows the account number in the appropriate format.
	canBeConciliated ()
	Return if a bank account need to be conciliated.
	add_url_line ($line_id, $url_id, $url, $label, $type)
	Add a link between bank line record and its source.
	get_url ($fk_bank=0, $url_id=0, $type='')
	TODO Move this into AccountLine Return array with links from llx_bank_url.
	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.
	create ($user, $notrigger=0)
	Create bank account into database.
	update ($user, $notrigger=0)
	Update bank account card.
	update_bban ($user=null)
	Update BBAN (RIB) account fields.
	fetch ($id, $ref='')
	Load a bank account into memory from database.
	setCategories ($categories)
	Sets object to supplied categories.
	delete ($user=null, $notrigger=0)
	Delete bank account from database.
	getLibStatut ($mode=0)
	Return label of object status.
	LibStatut ($status, $mode=0)
	Return label of given object status.
	can_be_deleted ()
	Indicates if an account can be deleted or not (without movements)
	error ()
	Return error.
	solde ($option=0, $date_end='', $field='dateo')
	Return current balance.
	load_board (User $user, $filteraccountid=0)
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ($filteraccountid=0)
	Load the indicators this->nb for the state board.
	countAccountToReconcile ()
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	getTooltipContentArray ($params)
	getTooltipContentArray
	getNomUrl ($withpicto=0, $mode='', $option='', $save_lastsearch_value=-1, $notooltip=0, $morecss='')
	Return clickable name (with picto eventually)
	verif ()
	Return if an account has valid information for Direct debit payment.
	getCountryCode ()
	Return account country code.
	getBannerAddress ($htmlkey, $object)
	Return full address for banner.
	useDetailedBBAN ()
	Return if a bank account is defined with detailed information (bank code, desk code, number and key).
	needIBAN ()
	Return 1 if IBAN is mandatory (otherwise option)
	needBIC ()
	Return 1 if BIC is mandatory (otherwise option)
	info ($id)
	Load miscellaneous information for tab "Info".
	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:
	initAsSpecimen ()
	Initialise an instance with random values.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContent ($params)
	getTooltipContent
	errorsToString ()
	Method to output saved errors.
	getFormatedCustomerRef ($objref)
	Return customer ref for screen output.
	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output.
	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
	Return full address of contact.
	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download.
	add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
	Add a link between element $this->element and a contact.
	copy_linked_contact ($objFrom, $source='internal')
	Copy contact from one element to current.
	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line.
	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line.
	delete_linked_contact ($source='', $code='')
	Delete all links between an object $this and all its contacts in llx_element_contact.
	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1, $arrayoftcids=array())
	Get array of all contacts for an object.
	swapContactStatus ($rowid)
	Update status of a contact linked to object.
	liste_type_contact ($source='internal', $order='position', $option=0, $activeonly=0, $code='')
	Return array with list of possible values for type of contacts.
	listeTypeContacts ($source='internal', $option=0, $activeonly=0, $code='', $element='', $excludeelement='')
	Return array with list of possible values for type of contacts.
	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code.
	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact.
	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.
	fetchOneLike ($ref)
	Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.
	fetch_barcode ()
	Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.
	fetchProject ()
	Load the project with id $this->fk_project into this->project.
	fetch_project ()
	Load the project with id $this->fk_project into this->project.
	fetch_projet ()
	Load the project with id $this->fk_project into this->project.
	fetch_product ()
	Load the product with id $this->fk_product into this->product.
	fetch_user ($userid)
	Load the user with id $userid into this->user.
	fetch_origin ()
	Read linked origin object.
	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field.
	getValueFrom ($table, $id, $field)
	Getter generic.
	setValueFrom ($field, $value, $table='', $id=null, $format='', $id_field='', $fuser=null, $trigkey='', $fk_user_field='fk_user_modif')
	Setter generic.
	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref.
	getListContactId ($source='external')
	Return list of id of contacts of object.
	setProject ($projectid, $notrigger=0)
	Link element with a project.
	setPaymentMethods ($id)
	Change the payments methods.
	setMulticurrencyCode ($code)
	Change the multicurrency code.
	setPaymentTerms ($id, $deposit_percent=null)
	Change the payments terms.
	setTransportMode ($id)
	Change the transport mode methods.
	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms.
	setDeliveryAddress ($id)
	Define delivery address.
	setShippingMethod ($shipping_method_id, $notrigger=0, $userused=null)
	Change the shipping method.
	setWarehouse ($warehouse_id)
	Change the warehouse.
	setDocModel ($user, $modelpdf)
	Set last model used by doc generator.
	setBankAccount ($fk_account, $notrigger=0, $userused=null)
	Change the bank account.
	line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines.
	getChildrenOfLine ($id, $includealltree=0)
	Get children of line.
	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank.
	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank.
	updateRangOfLine ($rowid, $rang)
	Update position of line (rang)
	line_ajaxorder ($rows)
	Update position of line with ajax (rang)
	updateLineUp ($rowid, $rang)
	Update position of line up (rang)
	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang)
	getRangOfLine ($rowid)
	Get position of line (rang)
	getIdOfLine ($rang)
	Get rowid of the line relative to its position.
	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang)
	update_ref_ext ($ref_ext)
	Update external ref of element.
	update_note ($note, $suffix='', $notrigger=0)
	Update note of element.
	update_note_public ($note)
	Update public note (kept for backward compatibility)
	update_price ($exclspec=0, $roundingadjust='auto', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).
	add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
	Add an object link into llx_element_element.
	getElementType ()
	Return an element type string formatted like element_element target_type and source_type.
	fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only).
	clearObjectLinkedCache ()
	Clear the cache saying that all linked object were already loaded.
	updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $f_user=null, $notrigger=0)
	Update object linked of a current object.
	deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid=0, $f_user=null, $notrigger=0)
	Delete all links between an object $this.
	setStatut ($status, $elementId=null, $elementType='', $trigkey='', $fieldstatus='fk_statut')
	Set status of an object.
	getCanvas ($id=0, $ref='')
	Load type of canvas of an object if it exists.
	getSpecialCode ($lineid)
	Get special code of a line.
	isObjectUsed ($id=0, $entity=0)
	Function to check if an object is used by others (by children).
	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains.
	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines.
	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line.
	setExtraParameters ()
	Set extra parameters.
	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir='/core/tpl')
	Show add free and predefined products/services form.
	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir='/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects.
	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir='/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php)
	printOriginLinesList ($restrictlist='', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	printOriginLine ($line, $var, $restrictlist='', $defaulttpldir='/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php).
	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id.
	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line.
	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references.
	indexFile ($destfull, $update_main_doc_field)
	Index a file into the ECM database.
	addThumbs ($file)
	Build thumb.
	delThumbs ($file)
	Delete thumbs.
	getDefaultCreateValueFor ($fieldname, $alternatevalue=null, $type='alphanohtml')
	Return the default value to use for a field when showing the create form of object.
	call_trigger ($triggerName, $user)
	Call trigger based on this instance.
	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately.
	setValuesForExtraLanguages ($onlykey='')
	Fill array_options property of object by extrafields value (using for data sent by forms)
	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before.
	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately.
	deleteExtraFields ()
	Delete all extra fields values for the current object.
	insertExtraFields ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	insertExtraLanguages ($trigger='', $userused=null)
	Add/Update all extra fields values for the current object.
	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object.
	getExtraField ($key)
	Convenience method for retrieving the value of an extrafield without actually fetching it from the database.
	setExtraField ($key, $value)
	Convenience method for setting the value of an extrafield without actually updating it in the database.
	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object.
	showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields.
	clearFieldError ($fieldKey)
	clear validation message result for a field
	setFieldError ($fieldKey, $msg='')
	set validation error message a field
	getFieldError ($fieldKey)
	get field error message
	validateField ($fields, $fieldKey, $fieldValue)
	Return validation test result for a field.
	showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd='', $display_type='card')
	Function to show lines of extrafields with output data.
	getJSListDependancies ($type='_extra')
	getRights ()
	Returns the rights used for this class.
	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation.
	getDataToShowPhoto ($modulepart, $imagesize)
	Function used to get the logos or photos of an object.
	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $overwritetitle=0, $usesharelink=0, $cache='', $addphotorefcss='photoref')
	Show photos of an object (nbmax maximum), into several columns.
	isDate ($info)
	Function test if type is date.
	isDuration ($info)
	Function test if type is duration.
	isInt ($info)
	Function test if type is integer.
	isFloat ($info)
	Function test if type is float.
	isText ($info)
	Function test if type is text.
	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this.
	emtpyObjectVars ()
	Sets all object fields to null.
	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.
	createCommon (User $user, $notrigger=0)
	Create object in the database.
	fetchCommon ($id, $ref=null, $morewhere='', $noextrafields=0)
	Load object in memory from the database.
	fetchLinesCommon ($morewhere='', $noextrafields=0)
	Load object in memory from the database.
	updateCommon (User $user, $notrigger=0)
	Update object into database.
	deleteCommon (User $user, $notrigger=0, $forcechilddeletion=0)
	Delete object in database.
	deleteByParentField ($parentId=0, $parentField='', $filter='', $filtermode="AND")
	Delete all child object from a parent ID.
	deleteLineCommon (User $user, $idline, $notrigger=0)
	Delete a line of object in database.
	setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
	Set to a status.
	initAsSpecimenCommon ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchComments ()
	Load comments linked with current task.
	getNbComments ()
	Return nb comments already posted.
	trimParameters ($parameters)
	Trim object parameters.
	getCategoriesCommon ($type_categ)
	Sets object to given categories.
	setCategoriesCommon ($categories, $type_categ='', $remove_existing=true)
	Sets object to given categories.
	cloneCategories ($fromId, $toId, $type='')
	Copy related categories to another object.
	deleteEcmFiles ($mode=0)
	Delete related files of object in database.

Static Public Member Functions
static	getAccountNumberOrder ()
	Returns the components of the bank account in order.
static	replaceThirdparty ($dbs, $origin_id, $dest_id)
	Function used to replace a third party id with another one.
Static Public Member Functions inherited from CommonObject
static	isExistingObject ($element, $id, $ref='', $ref_ext='')
	Check if an object id or ref exists If you don't need or want to instantiate the object and just need to know if the object exists, use this method instead of fetch.
static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.
static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.
static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.
static	commonReplaceThirdparty (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one.
static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one.

Public Attributes
const	TYPE_CURRENT = 1
	Current account.
const	TYPE_CASH = 2
	Cash account.
const	TYPE_SAVINGS = 0
	Savings account.
Public Attributes inherited from CommonObject
	$origin_object

Additional Inherited Members
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents.
	isArray ($info)
	Function test if type is array.
	canBeNull ($info)
	Function test if field can be null.
	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty.
	isIndex ($info)
	Function test if is indexed.
	setSaveQuery ()
	Function to return the array of data key-value from the ->fields and all the ->properties of an object.
	quote ($value, $fieldsentry)
	Add quote to field value if necessary.

Detailed Description

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

$db

Database handler

Reimplemented in CompanyBankAccount, and UserBankAccount.

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

Member Function Documentation

__toString()

Account::__toString

(

)

Shows the account number in the appropriate format.

Returns

string

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

References getFieldsToShow().

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_id	Id of bank entry
int	$url_id	Id of object related to link
string	$url	Url (deprecated, we use now 'url_id' and 'type' instead)
string	$label	Link label
string	$type	Type of link ('payment', 'company', 'member', ...)

Returns

int Return integer <0 if KO, id line if OK

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

References dol_syslog(), and error().

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	$date	Date operation
string	$oper	'VIR','PRE','LIQ','VAD','CB','CHQ'...
string	$label	Description
float	$amount	Amount
string	$num_chq	Numero cheque or transfer
int	$categorie	Category id (optional)
User	$user	User that create
string	$emetteur	Name of cheque writer
string	$banque	Bank of cheque writer
string	$accountancycode	When we record a free bank entry, we must provide accounting account if accountancy module is on.
int	$datev	Date value
string	$num_releve	Label of bank receipt for reconciliation
float	$amount_main_currency	Amount

Returns

int Rowid of added entry, <0 if KO

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

References dol_now(), dol_print_error(), dol_syslog(), error(), CommonObject\setErrorsFromObject(), type, and TYPE_CASH.

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

References dol_print_error().

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

References getDolGlobalString(), status, type, and TYPE_CASH.

countAccountToReconcile()

Account::countAccountToReconcile

(

)

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

Returns

int Nb of account we can reconciliate

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

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

create()

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

Create bank account into database.

Parameters

User	$user	Object user making creation
int	$notrigger	1=Disable triggers

Returns

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

Reimplemented in CompanyBankAccount, and UserBankAccount.

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

References address, CommonObject\call_trigger(), dol_now(), dol_syslog(), error(), CommonObject\insertExtraFields(), price2num(), ref, solde(), status, and update().

delete()

Account::delete	(		$user = null,
			$notrigger = 0 )

Delete bank account from database.

Parameters

?User	$user	User deleting
	int<0,1>	$notrigger 1=Disable triggers

Returns

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

Reimplemented in CompanyBankAccount, and UserBankAccount.

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

References CommonObject\deleteExtraFields(), dol_syslog(), and error().

error()

Account::error

(

)

Return error.

Returns

string Error string

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

Referenced by add_url_line(), addline(), create(), CompanyBankAccount\create(), delete(), UserBankAccount\delete(), fetch(), get_url(), load_board(), loadStateBoard(), update(), CompanyBankAccount\update(), update_bban(), and verif().

fetch()

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

Load a bank account into memory from database.

Parameters

int	$id	Id of bank account to get
string	$ref	Ref of bank account to get

Returns

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

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

References address, dol_syslog(), error(), CommonObject\fetch_optionals(), ref, status, and type.

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_bank	To search using bank transaction id
int	$url_id	To search using link to
string	$type	To search using type

Returns

int<-1,-1>|array<int,array{0:string,1:int,2:string,3:int,url:string,url_id:int,label:string,type:int,fk_bank:int}> Array of links array('url'=>, 'url_id'=>, 'label'=>, 'type'=> 'fk_bank'=> ) or -1 on error

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

References dol_print_error(), 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

string[]

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

getBannerAddress()

Account::getBannerAddress	(		$htmlkey,
			$object )

Return full address for banner.

Parameters

string	$htmlkey	HTML id to make banner content unique
Object	$object	Object (thirdparty, thirdparty of contact for contact, null for a member)

Returns

string Full address string

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

References getDolGlobalInt(), and CommonObject\getFullAddress().

getCountryCode()

Account::getCountryCode

(

)

Return account country code.

Returns

string country code

Definition at line 1672 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<0,1>

$includeibanbic 1=Return also key for IBAN and BIC

Returns

string[] Array of fields to show

See also

useDetailedBBAN()

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

Referenced by __toString().

getKanbanView()

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

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

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

References info().

getLibStatut()

Account::getLibStatut

(

$mode = 0

)

Return label of object status.

Parameters

int

$mode

0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto

Returns

string Label

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

References LibStatut(), and status.

getNomUrl()

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

Return clickable name (with picto eventually)

Parameters

int	$withpicto	Include 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	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link

Returns

string Chaine avec URL

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

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

getTooltipContentArray()

Account::getTooltipContentArray

(

$params

)

getTooltipContentArray

Parameters

array<string,mixed>

$params params to construct tooltip data

Since

v18

Returns

array{picto?:string,ref?:string,refsupplier?:string,label?:string,date?:string,date_echeance?:string,amountht?:string,total_ht?:string,totaltva?:string,amountlt1?:string,amountlt2?:string,amountrevenustamp?:string,totalttc?:string}|array{optimize:string}

Reimplemented from CommonObject.

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

References getIbanHumanReadable(), img_picto(), length_accountg(), and status.

Referenced by getNomUrl().

info()

Account::info

(

$id

)

Load miscellaneous information for tab "Info".

Parameters

int

$id

Id of object to load

Returns

void

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

Referenced by getKanbanView().

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

LibStatut()

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

Return label of given object status.

Parameters

int	$status	Id status
int	$mode	0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto

Returns

string Label

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

Referenced by getLibStatut().

load_board()

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

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

Parameters

User	$user	Object user
int	$filteraccountid	To get info for a particular account id

Returns

WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

References dol_now(), dol_print_error(), error(), img_object(), and TYPE_CASH.

loadStateBoard()

Account::loadStateBoard

(

$filteraccountid = 0

)

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

Parameters

int

$filteraccountid

To get info for a particular account id

Returns

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

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

References dol_print_error(), and error().

needBIC()

Account::needBIC

(

)

Return 1 if BIC is mandatory (otherwise option)

Returns

int 1 = mandatory / 0 = Not mandatory

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

needIBAN()

Account::needIBAN

(

)

Return 1 if IBAN is mandatory (otherwise option)

Returns

int 1 = mandatory / 0 = Not mandatory

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

replaceThirdparty()

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

static

Function used to replace a third party id with another one.

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns

bool True=SQL success, False=SQL error

Definition at line 1992 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

$categories

Category or categories IDs

Returns

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

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

solde()

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

Return current balance.

Parameters

int	$option	1=Exclude future operation date (this is to exclude input made in advance and have real account sold)
int | string	$date_end	Date 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 1339 of file account.class.php.

References dol_now(), and price2num().

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

update()

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

Update bank account card.

Parameters

User	$user	Object user making action
	int<0,1>	$notrigger 1=Disable triggers

Returns

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

Reimplemented in CompanyBankAccount, and UserBankAccount.

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

References address, CommonObject\call_trigger(), dol_print_error(), dol_sanitizeFileName(), dol_syslog(), error(), CommonObject\insertExtraFields(), price2num(), ref, status, and type.

Referenced by create().

update_bban()

Account::update_bban

(

$user = null

)

Update BBAN (RIB) account fields.

Parameters

?User

$user

Object user making update

Returns

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

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

References address, dol_print_error(), dol_syslog(), error(), and ref.

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

References checkIbanForAccount(), checkSwiftForAccount(), error(), and getDolGlobalInt().

---

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

• dolibarr_dev/htdocs/compta/bank/class/account.class.php