accounting.lib.php File Reference

( ) More...

Go to the source code of this file.

Functions
	is_empty ($var, $allow_false=false, $allow_ws=false)
	Check if a value is empty with some options.
	accounting_prepare_head (AccountingAccount $object)
	Prepare array with list of tabs.
	accounting_transaction_prepare_head (BookKeeping $object, $mode='', $type='', $backtopage='/accountancy/bookkeeping/listbyaccount.php')
	Prepare array with list of tabs for accounting transaction.
	accountingTransactionTemplatePrepareHead (BookkeepingTemplate $object)
	Prepare array with list of tabs for accounting transaction template.
	clean_account ($account)
	Return accounting account without zero on the right.
	length_accountg ($account)
	Return General accounting account with defined length (used for product and miscellaneous)
	length_accounta ($accounta)
	Return Auxiliary accounting account of thirdparties with defined length.
	checkGeneralAccountAllowsAuxiliary ($db, $general_account, $auxiliary_account, $general_account_id=0)
	Check if a general accounting account allows the use of an auxiliary account.
	journalHead ($nom, $variant, $period, $periodlink, $description, $builddate, $exportlink='', $moreparam=array(), $calcmode='', $varlink='', $moreoptions=array())
	Show header of a page used to transfer/dispatch data in accounting.
	getDefaultDatesForTransfer ()
	Return Default dates for transfer based on periodicity option in accountancy setup.
	getCurrentPeriodOfFiscalYear ($db, $conf, $from_time=null, $gm='tzserver', $withenddateonly=1)
	Get current period of fiscal year?
	getNextFiscalYear ($db, $after_date, $gm='tzserver')
	Get next fiscal year period after a given date.

Detailed Description

( )

Library of accountancy functions

Definition in file accounting.lib.php.

Function Documentation

accounting_prepare_head()

accounting_prepare_head

(

AccountingAccount

$object

)

Prepare array with list of tabs.

Parameters

AccountingAccount

$object

Accounting account

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 53 of file accounting.lib.php.

References $conf, $object, complete_head_from_modules(), and dolBuildUrl().

accounting_transaction_prepare_head()

accounting_transaction_prepare_head	(	BookKeeping	$object,
			$mode = '',
			$type = '',
			$backtopage = '/accountancy/bookkeeping/listbyaccount.php' )

Prepare array with list of tabs for accounting transaction.

Parameters

BookKeeping	$object	Bookkeeping
string	$mode	Mode _tmp if operation are drafted
string	$type	Type of list "sub" (for subsidiary list) or not
string	$backtopage	Back to page (return on ledger by default)

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 85 of file accounting.lib.php.

References $conf, $object, complete_head_from_modules(), and dolBuildUrl().

accountingTransactionTemplatePrepareHead()

accountingTransactionTemplatePrepareHead

(

BookkeepingTemplate

$object

)

Prepare array with list of tabs for accounting transaction template.

Parameters

BookkeepingTemplate

$object

Bookkeeping template

Returns

array<array{0:string,1:string,2:string}> Array of tabs to show

Definition at line 114 of file accounting.lib.php.

References $conf, $object, complete_head_from_modules(), and dolBuildUrl().

checkGeneralAccountAllowsAuxiliary()

checkGeneralAccountAllowsAuxiliary	(		$db,
			$general_account,
			$auxiliary_account,
			$general_account_id = 0 )

Check if a general accounting account allows the use of an auxiliary account.

Parameters

DoliDB	$db	Database handler
string	$general_account	The general account number (optional if $general_account_id is used)
string	$auxiliary_account	The auxiliary account number
int	$general_account_id	Optional rowid of the general accounting account

Returns

bool True if the auxiliary account is allowed, false otherwise

Definition at line 229 of file accounting.lib.php.

References $conf, $db, and getDolGlobalInt().

clean_account()

clean_account

(

$account

)

Return accounting account without zero on the right.

Parameters

string

$account

Accounting account

Returns

string String without zero on the right

Definition at line 139 of file accounting.lib.php.

Referenced by Product\create(), and Product\update().

getCurrentPeriodOfFiscalYear()

getCurrentPeriodOfFiscalYear	(		$db,
			$conf,
			$from_time = null,
			$gm = 'tzserver',
			$withenddateonly = 1 )

Get current period of fiscal year?

Parameters

DoliDB	$db	Database handler
Conf	$conf	Config
?int	$from_time	[=null] Get current time or set time to find fiscal period
	'tzserver'|'gmt'	$gm 'gmt' => we return GMT timestamp (recommended), 'tzserver' => we return in the PHP server timezone
int	$withenddateonly	Do not return period if end date is not defined

Returns

array{date_start:int,date_end:int} Period of fiscal year : [date_start, date_end]

Definition at line 446 of file accounting.lib.php.

References $date_start, $db, dol_get_last_day(), dol_get_last_hour(), dol_getdate(), dol_mktime(), dol_now(), and getDolGlobalInt().

Referenced by Asset\calculationDepreciation(), and Accountancy\exportData().

getDefaultDatesForTransfer()

getDefaultDatesForTransfer

(

)

Return Default dates for transfer based on periodicity option in accountancy setup.

Returns

array{date_start:int,date_end:int,pastmonthyear:int,pastmonth:int} Dates of periodicity by default

Definition at line 374 of file accounting.lib.php.

References $date_start, $db, dol_get_last_day(), dol_get_last_hour(), dol_mktime(), dol_now(), dol_print_date(), and getDolGlobalInt().

getNextFiscalYear()

getNextFiscalYear	(		$db,
			$after_date,
			$gm = 'tzserver' )

Get next fiscal year period after a given date.

Parameters

DoliDB	$db	Database handler
int	$after_date	Get fiscal period that starts after this date
	'tzserver'|'gmt'	$gm 'gmt' => we return GMT timestamp, 'tzserver' => PHP server timezone

Returns

array{date_start:int,date_end:int}|null Period of next fiscal year or null if not found

Definition at line 514 of file accounting.lib.php.

References $date_start, and $db.

Referenced by Asset\calculationDepreciation().

is_empty()

is_empty	(		$var,
			$allow_false = false,
			$allow_ws = false )

Check if a value is empty with some options.

Author

Michael - https://www.php.net/manual/fr/function.empty.php#90767

Parameters

?mixed	$var	Value to test
boolean	$allow_false	Setting this to true will make the function consider a boolean value of false as NOT empty. This parameter is false by default.
boolean	$allow_ws	Setting this to true will make the function consider a string with nothing but white space as NOT empty. This parameter is false by default.

Returns

boolean True of False

Definition at line 39 of file accounting.lib.php.

Referenced by journalHead(), length_accounta(), and length_accountg().

journalHead()

journalHead	(		$nom,
			$variant,
			$period,
			$periodlink,
			$description,
			$builddate,
			$exportlink = '',
			$moreparam = array(),
			$calcmode = '',
			$varlink = '',
			$moreoptions = array() )

Show header of a page used to transfer/dispatch data in accounting.

Parameters

string	$nom	Name of report
string	$variant	Link for alternate report
string	$period	Period of report
string	$periodlink	Link to switch period
string	$description	Description
integer	$builddate	Date of generation
string	$exportlink	Link for export or ''
	array<string,mixed>	$moreparam Array with list of params to add into hidden fields of form
string	$calcmode	Calculation mode
string	$varlink	Add a variable into the address of the page
	array<string,mixed>	$moreoptions Array with list of params to add to table

Returns

void

Definition at line 275 of file accounting.lib.php.

References dol_get_fiche_end(), dol_get_fiche_head(), and is_empty().

length_accounta()

length_accounta

(

$accounta

)

Return Auxiliary accounting account of thirdparties with defined length.

Parameters

string

$accounta

Auxiliary accounting account

Returns

string String with defined length

Definition at line 188 of file accounting.lib.php.

References $conf, getDolGlobalInt(), getDolGlobalString(), and is_empty().

Referenced by AccountancyExport\exportAgiris(), AccountancyExport\exportBob50(), AccountancyExport\exportCegid(), AccountancyExport\exportCiel(), AccountancyExport\exportCoala(), AccountancyExport\exportCogilog(), AccountancyExport\exportConfigurable(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportiSuiteExpert(), AccountancyExport\exportLDCompta(), AccountancyExport\exportLDCompta10(), AccountancyExport\exportOpenConcerto(), AccountancyExport\exportSAGE50SWISS(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), PaymentVarious\lengthAccounta(), pdf_balance\write_file(), and pdf_ledger\write_file().

length_accountg()

length_accountg

(

$account

)

Return General accounting account with defined length (used for product and miscellaneous)

Parameters

string

$account

General accounting account

Returns

string String with defined length

Definition at line 152 of file accounting.lib.php.

References getDolGlobalInt(), getDolGlobalString(), and is_empty().

Referenced by AccountancyExport\exportAgiris(), AccountancyExport\exportBob50(), AccountancyExport\exportCegid(), AccountancyExport\exportCiel(), AccountancyExport\exportCoala(), AccountancyExport\exportCogilog(), AccountancyExport\exportConfigurable(), AccountancyExport\exportFEC(), AccountancyExport\exportFEC2(), AccountancyExport\exportGestimumV3(), AccountancyExport\exportGestimumV5(), AccountancyExport\exportISTEA(), AccountancyExport\exportiSuiteExpert(), AccountancyExport\exportLDCompta(), AccountancyExport\exportLDCompta10(), AccountancyExport\exportOpenConcerto(), AccountancyExport\exportSAGE50SWISS(), AccountingJournal\getAccountingAccountInfos(), AccountingJournal\getAssetData(), AccountingJournal\getDiscountCustomer(), AccountingJournal\getDiscountSupplier(), AccountingAccount\getNomUrl(), ChargeSociales\getNomUrl(), ProductFournisseur\getNomUrl(), Account\getTooltipContentArray(), Product\getTooltipContentArray(), PaymentVarious\lengthAccountg(), FormAccounting\printJournalLine(), BookKeeping\select_account(), FormAccounting\select_account(), AccountancyCategory\updateAccAcc(), pdf_balance\write_file(), pdf_bookkeeping\write_file(), and pdf_ledger\write_file().