BookKeeping Class Reference

Class to manage Ledger (General Ledger and Subledger) More...

Inheritance diagram for BookKeeping:

Collaboration diagram for BookKeeping:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.
	create (User $user, $notrigger=0)
	Create object into database.
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return a link to the object card (with optionally the picto)
	createStd (User $user, $notrigger=0, $mode='')
	Create object into database.
	fetch ($id, $ref=null, $mode='')
	Load object in memory from the database.
	fetchAllByAccount ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $option=0, $countonly=0)
	Load object in memory from the database in ->lines.
	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND', $showAlreadyExportMovements=1)
	Load object in memory from the database.
	fetchAllBalance ($sortorder='', $sortfield='', $limit=0, $offset=0, $filter='', $filtermode='AND', $option=0)
	Load object in memory from the database.
	update (User $user, $notrigger=0, $mode='')
	Update object into database.
	updateByMvt ($piece_num='', $field='', $value='', $mode='')
	Update accounting movement.
	delete (User $user, $notrigger=0, $mode='')
	Delete object in database.
	deleteByImportkey ($importkey, $mode='')
	Delete bookkeeping by importkey.
	deleteByYearAndJournal ($delyear=0, $journal='', $mode='', $delmonth=0)
	Delete bookkeeping by year.
	deleteMvtNum ($piecenum, $mode='')
	Delete bookkeeping by piece number.
	createFromClone (User $user, $fromid)
	Load an object from its id and create a new one in database.
	initAsSpecimen ()
	Initialise object with example values Id must be 0 if object instance is a specimen.
	fetchPerMvt ($piecenum, $mode='')
	Load an accounting document into memory from database.
	getNextNumMvt ($mode='')
	Return next movement number.
	fetchAllPerMvt ($piecenum, $mode='')
	Load all accounting lines related to a given transaction ID $piecenum.
	export_bookkeeping ($model='ebp')
	Export bookkeeping.
	transformTransaction ($direction=0, $piece_num='')
	Transform transaction.
	select_account ($selectid, $htmlname='account', $showempty=0, $event=array(), $select_in=0, $select_out=0, $aabase='')
	Return list of accounts with label by chart of accounts.
	getRootAccount ($account=null)
	Return id and description of a root accounting account.
	get_compte_desc ($account=null)
	Description of accounting account.
	getCanModifyBookkeepingSQL ($alias='', $force=false)
	Get SQL string for check if the bookkeeping can be modified or deleted ? (cached)
	canModifyBookkeeping ($id, $mode='')
	Is the bookkeeping can be modified or deleted ?
	accountingLabelForOperation ($thirdpartyname, $reference, $labelaccount)
	Generate label operation when operation is transferred into accounting.
	validBookkeepingDate ($date)
	Is the bookkeeping date valid (on an open period or not on a closed period) ?
	loadFiscalPeriods ($force=false, $mode='active')
	Load list of active fiscal period.
	getFiscalPeriods ($filter='')
	Get list of fiscal period ordered by start date.
	getCountByMonthForFiscalPeriod ($date_start, $date_end)
	Get list of count by month into the fiscal period.
	validateMovementForFiscalPeriod ($date_start, $date_end)
	Validate all movement between the specified dates.
	accountingResult ($date_start, $date_end)
	Define accounting result.
	closeFiscalPeriod ($fiscal_period_id, $new_fiscal_period_id, $separate_auxiliary_account=false, $generate_bookkeeping_records=true)
	Close fiscal period.
	insertAccountingReversal ($fiscal_period_id, $inventory_journal_id, $new_fiscal_period_id, $date_start, $date_end)
	Insert accounting reversal into the inventory journal of the new fiscal period.
Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty
	setErrorsFromObject ($object)
	setErrorsFromObject
	getTooltipContentArray ($params)
	Return array of data to show into a tooltip.
	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.

Additional Inherited Members
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 inherited from CommonObject
	$origin_object
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 Ledger (General Ledger and Subledger)

Definition at line 38 of file bookkeeping.class.php.

Constructor & Destructor Documentation

__construct()

BookKeeping::__construct

(

DoliDB

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

Definition at line 208 of file bookkeeping.class.php.

Member Function Documentation

accountingLabelForOperation()

BookKeeping::accountingLabelForOperation	(		$thirdpartyname,
			$reference,
			$labelaccount )

Generate label operation when operation is transferred into accounting.

Parameters

string	$thirdpartyname	Thirdparty name
string	$reference	Reference of the element
string	$labelaccount	Label of the accounting account

Returns

string Label of the operation

Definition at line 2442 of file bookkeeping.class.php.

References dol_syslog(), dol_trunc(), and getDolGlobalString().

accountingResult()

BookKeeping::accountingResult	(		$date_start,
			$date_end )

Define accounting result.

Parameters

int	$date_start	Date start
int	$date_end	Date end

Returns

string Accounting result

Definition at line 2722 of file bookkeeping.class.php.

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

canModifyBookkeeping()

BookKeeping::canModifyBookkeeping	(		$id,
			$mode = '' )

Is the bookkeeping can be modified or deleted ?

Parameters

int	$id	Bookkeeping ID
string	$mode	Mode ('' or 'tmp_')

Returns

int Return integer <0 if KO, == 0 if No, == 1 if Yes

Definition at line 2384 of file bookkeeping.class.php.

References getDolGlobalString(), and loadFiscalPeriods().

Referenced by delete(), and update().

closeFiscalPeriod()

BookKeeping::closeFiscalPeriod	(		$fiscal_period_id,
			$new_fiscal_period_id,
			$separate_auxiliary_account = false,
			$generate_bookkeeping_records = true )

Close fiscal period.

Parameters

int	$fiscal_period_id	Fiscal year ID
int	$new_fiscal_period_id	New fiscal year ID
bool	$separate_auxiliary_account	Separate auxiliary account
bool	$generate_bookkeeping_records	Generate closure bookkeeping records

Returns

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

Definition at line 2775 of file bookkeeping.class.php.

References dol_now(), dol_syslog(), getDolGlobalInt(), and getDolGlobalString().

create()

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

Create object into database.

Parameters

User	$user	User that creates
int	$notrigger	false=launch triggers after, true=disable triggers

Returns

int Return integer <0 if KO, Id of created object if OK

Definition at line 220 of file bookkeeping.class.php.

References CommonObject\call_trigger(), dol_now(), dol_syslog(), getDolGlobalString(), and validBookkeepingDate().

createFromClone()

BookKeeping::createFromClone	(	User	$user,
			$fromid )

Load an object from its id and create a new one in database.

Parameters

User	$user	User making the clone
int	$fromid	Id of object to clone

Returns

int New id of clone

Definition at line 1759 of file bookkeeping.class.php.

References $object, and dol_syslog().

createStd()

BookKeeping::createStd	(	User	$user,
			$notrigger = 0,
			$mode = '' )

Create object into database.

Parameters

User	$user	User that creates
int	$notrigger	false=launch triggers after, true=disable triggers
string	$mode	Mode

Returns

int Return integer <0 if KO, Id of created object if OK

Definition at line 570 of file bookkeeping.class.php.

References CommonObject\call_trigger(), dol_now(), dol_syslog(), getDolGlobalString(), price2num(), and validBookkeepingDate().

delete()

BookKeeping::delete	(	User	$user,
			$notrigger = 0,
			$mode = '' )

Delete object in database.

Parameters

User	$user	User that deletes
int	$notrigger	0=launch triggers after, 1=disable triggers
string	$mode	Mode ('' or 'tmp_')

Returns

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

Definition at line 1556 of file bookkeeping.class.php.

References CommonObject\call_trigger(), canModifyBookkeeping(), dol_syslog(), and getDolGlobalString().

deleteByImportkey()

BookKeeping::deleteByImportkey	(		$importkey,
			$mode = '' )

Delete bookkeeping by importkey.

Parameters

string	$importkey	Import key
string	$mode	Mode

Returns

int Result

Definition at line 1617 of file bookkeeping.class.php.

References dol_syslog(), and getCanModifyBookkeepingSQL().

deleteByYearAndJournal()

BookKeeping::deleteByYearAndJournal	(		$delyear = 0,
			$journal = '',
			$mode = '',
			$delmonth = 0 )

Delete bookkeeping by year.

Parameters

int	$delyear	Year to delete
string	$journal	Journal to delete
string	$mode	Mode
int	$delmonth	Month

Returns

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

Definition at line 1654 of file bookkeeping.class.php.

References dol_syslog(), dolSqlDateFilter(), and getCanModifyBookkeepingSQL().

deleteMvtNum()

BookKeeping::deleteMvtNum	(		$piecenum,
			$mode = '' )

Delete bookkeeping by piece number.

Parameters

int	$piecenum	Piecenum to delete
string	$mode	Mode ('' or '_tmp')

Returns

int Nb of record deleted

Definition at line 1712 of file bookkeeping.class.php.

References dol_syslog(), and getCanModifyBookkeepingSQL().

export_bookkeeping()

BookKeeping::export_bookkeeping

(

$model = 'ebp'

)

Export bookkeeping.

Parameters

string

$model

Model

Returns

int Result

Definition at line 1997 of file bookkeeping.class.php.

References dol_syslog().

fetch()

BookKeeping::fetch	(		$id,
			$ref = null,
			$mode = '' )

Load object in memory from the database.

Parameters

int	$id	Id object
string | null	$ref	Ref
string	$mode	Mode ('' or 'tmp_')

Returns

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

Definition at line 746 of file bookkeeping.class.php.

References dol_syslog().

fetchAll()

BookKeeping::fetchAll	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
			$filter = '',
			$filtermode = 'AND',
			$showAlreadyExportMovements = 1 )

Load object in memory from the database.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
int	$limit	Limit
int	$offset	Offset limit
	string|array<string,string>	$filter Filter array
string	$filtermode	Filter mode (AND or OR)
int	$showAlreadyExportMovements	Show movements when field 'date_export' is not empty (0:No / 1:Yes (Default))

Returns

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

Definition at line 1053 of file bookkeeping.class.php.

References dol_syslog(), forgeSQLFromUniversalSearchCriteria(), and natural_search().

fetchAllBalance()

BookKeeping::fetchAllBalance	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
			$filter = '',
			$filtermode = 'AND',
			$option = 0 )

Load object in memory from the database.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
int	$limit	Limit
int	$offset	Offset limit
	string|array<string,string>	$filter Filter
string	$filtermode	Filter mode (AND or OR)
int	$option	option (0: aggregate by general account or 1: aggreegate by subaccount)

Returns

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

Definition at line 1241 of file bookkeeping.class.php.

References dol_syslog(), forgeSQLFromUniversalSearchCriteria(), and natural_search().

fetchAllByAccount()

BookKeeping::fetchAllByAccount	(		$sortorder = '',
			$sortfield = '',
			$limit = 0,
			$offset = 0,
		array	$filter = array(),
			$filtermode = 'AND',
			$option = 0,
			$countonly = 0 )

Load object in memory from the database in ->lines.

Or just make a simple count if $countonly=1.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
int	$limit	limit
int	$offset	offset limit
	array<string,string>	$filter filter array
string	$filtermode	filter mode (AND or OR)
int	$option	option (0: general account or 1: subaccount)
int	$countonly	Do not fill the $object->lines, return only the count.

Returns

int Return integer <0 if KO, Number of lines if OK

Definition at line 853 of file bookkeeping.class.php.

References dol_syslog(), and natural_search().

fetchAllPerMvt()

BookKeeping::fetchAllPerMvt	(		$piecenum,
			$mode = '' )

Load all accounting lines related to a given transaction ID $piecenum.

Parameters

int	$piecenum	Id of line to get
string	$mode	Mode ('' or '_tmp')

Returns

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

Definition at line 1928 of file bookkeeping.class.php.

References dol_syslog().

fetchPerMvt()

BookKeeping::fetchPerMvt	(		$piecenum,
			$mode = '' )

Load an accounting document into memory from database.

Parameters

int	$piecenum	Accounting document to get
string	$mode	Mode

Returns

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

Definition at line 1846 of file bookkeeping.class.php.

References dol_syslog().

get_compte_desc()

BookKeeping::get_compte_desc

(

$account = null

)

Description of accounting account.

Parameters

string

$account

Accounting account

Returns

string|int Account desc or -1 if KO

Definition at line 2302 of file bookkeeping.class.php.

References dol_syslog(), and getDolGlobalInt().

getCanModifyBookkeepingSQL()

BookKeeping::getCanModifyBookkeepingSQL	(		$alias = '',
			$force = false )

Get SQL string for check if the bookkeeping can be modified or deleted ? (cached)

Parameters

string	$alias	Bookkeeping alias table
bool	$force	Force reload

Returns

string|null SQL filter or null if error

Definition at line 2343 of file bookkeeping.class.php.

References loadFiscalPeriods().

Referenced by deleteByImportkey(), deleteByYearAndJournal(), deleteMvtNum(), transformTransaction(), and updateByMvt().

getCountByMonthForFiscalPeriod()

BookKeeping::getCountByMonthForFiscalPeriod	(		$date_start,
			$date_end )

Get list of count by month into the fiscal period.

This function can be called by step 1 of closure process.

Parameters

int	$date_start	Date start
int	$date_end	Date end

Returns

array{total:int,list:array<array{year:int,count:array<int<1,12>,int>,total:int}>}|int<-1,-1> Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...]

Definition at line 2626 of file bookkeeping.class.php.

References dol_syslog(), getDolGlobalString(), and getEntity().

getFiscalPeriods()

BookKeeping::getFiscalPeriods

(

$filter = ''

)

Get list of fiscal period ordered by start date.

Parameters

string

$filter

Filter

Returns

array<array{id:int,label:string,date_start:string,date_end:string,status:int}>|int Return integer <0 if KO, Fiscal periods : [[id, date_start, date_end, label], ...]

Definition at line 2586 of file bookkeeping.class.php.

getNextNumMvt()

BookKeeping::getNextNumMvt

(

$mode = ''

)

Return next movement number.

Parameters

string

$mode

Mode

Returns

int<1, max>|-1 Return next movement number or -1 if error

Definition at line 1894 of file bookkeeping.class.php.

References dol_syslog().

Referenced by transformTransaction().

getNomUrl()

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

Return a link to the object card (with optionally the picto)

Parameters

int	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('nolink', ...)
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns

string String with URL

Definition at line 494 of file bookkeeping.class.php.

References getDolGlobalString(), and img_object().

getRootAccount()

BookKeeping::getRootAccount

(

$account = null

)

Return id and description of a root accounting account.

FIXME: This function takes the parent of parent to get the root account !

Parameters

string

$account

Accounting account

Returns

array{id:int,account_number:string,label:string}|int<-1,-1> Array with root account information (max 2 upper level), <0 if KO

Definition at line 2262 of file bookkeeping.class.php.

References dol_syslog(), and getDolGlobalInt().

initAsSpecimen()

BookKeeping::initAsSpecimen

(

)

Initialise object with example values Id must be 0 if object instance is a specimen.

Returns

int

Definition at line 1807 of file bookkeeping.class.php.

References dol_now().

insertAccountingReversal()

BookKeeping::insertAccountingReversal	(		$fiscal_period_id,
			$inventory_journal_id,
			$new_fiscal_period_id,
			$date_start,
			$date_end )

Insert accounting reversal into the inventory journal of the new fiscal period.

Parameters

int	$fiscal_period_id	Fiscal year ID
int	$inventory_journal_id	Inventory journal ID
int	$new_fiscal_period_id	New fiscal year ID
int	$date_start	Date start
int	$date_end	Date end

Returns

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

Definition at line 3013 of file bookkeeping.class.php.

References dol_now(), and dol_syslog().

loadFiscalPeriods()

BookKeeping::loadFiscalPeriods	(		$force = false,
			$mode = 'active' )

Load list of active fiscal period.

Parameters

bool	$force	Force reload
string	$mode	active or closed ?

Returns

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

Definition at line 2526 of file bookkeeping.class.php.

Referenced by canModifyBookkeeping(), getCanModifyBookkeepingSQL(), and validBookkeepingDate().

select_account()

BookKeeping::select_account	(		$selectid,
			$htmlname = 'account',
			$showempty = 0,
			$event = array(),
			$select_in = 0,
			$select_out = 0,
			$aabase = '' )

Return list of accounts with label by chart of accounts.

Parameters

string	$selectid	Preselected chart of accounts
string	$htmlname	Name of field in html form
	int<0,1>	$showempty Add an empty field
	array<array{method:string,url:string,htmlname:string,params:array<string,string>}>	$event Event options
int	$select_in	Value is a aa.rowid (0 default) or aa.account_number (1)
int	$select_out	Set value returned by select 0=rowid (default), 1=account_number
string	$aabase	Set accounting_account base class to display empty=all or from 1 to 8 will display only account starting from this number

Returns

string|int String with HTML select or -1 if KO

Definition at line 2196 of file bookkeeping.class.php.

References ajax_combobox(), dol_syslog(), getDolGlobalInt(), length_accountg(), and Form\selectarray().

transformTransaction()

BookKeeping::transformTransaction	(		$direction = 0,
			$piece_num = '' )

Transform transaction.

Parameters

int	$direction	If 0: tmp => real, if 1: real => tmp
string	$piece_num	Piece num = Transaction ref

Returns

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

Definition at line 2062 of file bookkeeping.class.php.

References dol_now(), dol_syslog(), getCanModifyBookkeepingSQL(), and getNextNumMvt().

update()

BookKeeping::update	(	User	$user,
			$notrigger = 0,
			$mode = '' )

Update object into database.

Parameters

User	$user	User that modifies
int	$notrigger	false=launch triggers after, true=disable triggers
string	$mode	Mode ('' or _tmp')

Returns

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

Definition at line 1379 of file bookkeeping.class.php.

References CommonObject\call_trigger(), canModifyBookkeeping(), dol_syslog(), getDolGlobalString(), and price2num().

updateByMvt()

BookKeeping::updateByMvt	(		$piece_num = '',
			$field = '',
			$value = '',
			$mode = '' )

Update accounting movement.

Parameters

string	$piece_num	Piece num
string	$field	Field
string	$value	Value
string	$mode	Mode ('' or _tmp')

Returns

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

Definition at line 1514 of file bookkeeping.class.php.

References dol_syslog(), and getCanModifyBookkeepingSQL().

validateMovementForFiscalPeriod()

BookKeeping::validateMovementForFiscalPeriod	(		$date_start,
			$date_end )

Validate all movement between the specified dates.

Parameters

int	$date_start	Date start
int	$date_end	Date end

Returns

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

Definition at line 2691 of file bookkeeping.class.php.

References dol_now(), and dol_syslog().

validBookkeepingDate()

BookKeeping::validBookkeepingDate

(

$date

)

Is the bookkeeping date valid (on an open period or not on a closed period) ?

Parameters

int

$date

Bookkeeping date

Returns

int Return integer <0 if KO, == 0 if No, == 1 if date is valid for a transfer

Definition at line 2481 of file bookkeeping.class.php.

References getDolGlobalString(), and loadFiscalPeriods().

Referenced by create(), and createStd().

---

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

• dolibarr_dev/htdocs/accountancy/class/bookkeeping.class.php