dolibarr  17.0.4
Public Member Functions | List of all members
BookKeeping Class Reference

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

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

Public Member Functions

 __construct (DoliDB $db)
 Constructor. More...
 
 create (User $user, $notrigger=false)
 Create object into database. More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
 Return a link to the object card (with optionally the picto) More...
 
 createStd (User $user, $notrigger=false, $mode='')
 Create object into database. More...
 
 fetch ($id, $ref=null, $mode='')
 Load object in memory from the database. More...
 
 fetchAllByAccount ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $option=0)
 Load object in memory from the database. More...
 
 fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $showAlreadyExportMovements=1)
 Load object in memory from the database. More...
 
 fetchAllBalance ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND')
 Load object in memory from the database. More...
 
 update (User $user, $notrigger=false, $mode='')
 Update object into database. More...
 
 updateByMvt ($piece_num='', $field='', $value='', $mode='')
 Update accounting movement. More...
 
 delete (User $user, $notrigger=false, $mode='')
 Delete object in database. More...
 
 deleteByImportkey ($importkey)
 Delete bookkeeping by importkey. More...
 
 deleteByYearAndJournal ($delyear=0, $journal='', $mode='', $delmonth=0)
 Delete bookkeeping by year. More...
 
 deleteMvtNum ($piecenum)
 Delete bookkeeping by piece number. More...
 
 createFromClone (User $user, $fromid)
 Load an object from its id and create a new one in database. More...
 
 initAsSpecimen ()
 Initialise object with example values Id must be 0 if object instance is a specimen. More...
 
 fetchPerMvt ($piecenum, $mode='')
 Load an accounting document into memory from database. More...
 
 getNextNumMvt ($mode='')
 Return next number movement. More...
 
 fetchAllPerMvt ($piecenum, $mode='')
 Load all informations of accountancy document. More...
 
 export_bookkeeping ($model='ebp')
 Export bookkeeping. More...
 
 transformTransaction ($direction=0, $piece_num='')
 Transform transaction. More...
 
 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. More...
 
 getRootAccount ($account=null)
 Return id and description of a root accounting account. More...
 
 get_compte_desc ($account=null)
 Description of accounting account. More...
 
- Public Member Functions inherited from CommonObject
 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...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 setUpperOrLowerCase ()
 Set to upper or ucwords/lower if needed. More...
 
 getKanbanView ($option='')
 Return clicable link of object (with eventually picto) More...
 
 getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode='')
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
 Return the link of last main doc file for direct public download. More...
 
 add_contact ($fk_socpeople, $type_contact, $source='external', $notrigger=0)
 Add a link between element $this->element and a contact. More...
 
 copy_linked_contact ($objFrom, $source='internal')
 Copy contact from one element to current. More...
 
 update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
 Update a link to contact line. More...
 
 delete_contact ($rowid, $notrigger=0)
 Delete a link to contact line. More...
 
 delete_linked_contact ($source='', $code='')
 Delete all links between an object $this and all its contacts 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...
 
 setMulticurrencyRate ($rate, $mode=1)
 Change the multicurrency rate. 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=false, $userused=null)
 Change the shipping method. More...
 
 setWarehouse ($warehouse_id)
 Change the warehouse. More...
 
 setDocModel ($user, $modelpdf)
 Set last model used by doc generator. More...
 
 setBankAccount ($fk_account, $notrigger=false, $userused=null)
 Change the bank account. More...
 
 line_order ($renum=false, $rowidorder='ASC', $fk_parent_line=true)
 Save a new position (field rang) for details lines. More...
 
 getChildrenOfLine ($id, $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='')
 Update note of element. More...
 
 update_note_public ($note)
 Update public note (kept for backward compatibility) More...
 
 update_price ($exclspec=0, $roundingadjust='none', $nodatabaseupdate=0, $seller=null)
 Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...
 
 add_object_linked ($origin=null, $origin_id=null, $f_user=null, $notrigger=0)
 Add an object link into llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). More...
 
 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='', $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. 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...
 
 getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
 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 ($val, $fieldKey, $fieldValue)
 Return validation test result for a field. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='', $onetrtd=0, $display_type='card')
 Function to show lines of extrafields with output datas. 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...
 
 show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
 Show photos of an object (nbmax maximum), into several columns. More...
 
 isDate ($info)
 Function test if type is date. More...
 
 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...
 
 getFieldList ($alias='')
 Function to concat keys of fields. More...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null, $morewhere='')
 Load object in memory from the database. More...
 
 fetchLinesCommon ($morewhere='')
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
 Delete object in database. More...
 
 deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
 Delete all child object from a parent ID. More...
 
 deleteLineCommon (User $user, $idline, $notrigger=false)
 Delete a line of object in database. More...
 
 setStatusCommon ($user, $status, $notrigger=0, $triggercode='')
 Set to a 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from CommonObject
static isExistingObject ($element, $id, $ref='', $ref_ext='')
 Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...
 
static 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 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 $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
static commonReplaceProduct (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a product id with another one. More...
 
- Public Attributes inherited from CommonObject
 $projet
 
 $fk_projet
 
 $note
 
- 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 Ledger (General Ledger and Subledger)

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

Constructor & Destructor Documentation

◆ __construct()

BookKeeping::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDb$dbDatabase handler

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

References db.

Member Function Documentation

◆ create()

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

Create object into database.

Parameters
User$userUser that creates
bool$notriggerfalse=launch triggers after, true=disable triggers
Returns
int <0 if KO, Id of created object if OK

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

◆ createFromClone()

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

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

Parameters
User$userUser making the clone
int$fromidId of object to clone
Returns
int New id of clone

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

References dol_syslog().

◆ createStd()

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

Create object into database.

Parameters
User$userUser that creates
bool$notriggerfalse=launch triggers after, true=disable triggers
string$modeMode
Returns
int <0 if KO, Id of created object if OK

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

◆ delete()

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

Delete object in database.

Parameters
User$userUser that deletes
bool$notriggerfalse=launch triggers after, true=disable triggers
string$modeMode
Returns
int <0 if KO, >0 if OK

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

◆ deleteByImportkey()

BookKeeping::deleteByImportkey (   $importkey)

Delete bookkeeping by importkey.

Parameters
string$importkeyImport key
Returns
int Result

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

References db.

◆ deleteByYearAndJournal()

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

Delete bookkeeping by year.

Parameters
int$delyearYear to delete
string$journalJournal to delete
string$modeMode
int$delmonthMonth
Returns
int <0 if KO, >0 if OK

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

◆ deleteMvtNum()

BookKeeping::deleteMvtNum (   $piecenum)

Delete bookkeeping by piece number.

Parameters
int$piecenumPiecenum to delete
Returns
int Result

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

◆ export_bookkeeping()

BookKeeping::export_bookkeeping (   $model = 'ebp')

Export bookkeeping.

Parameters
string$modelModel
Returns
int Result

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

◆ fetch()

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

Load object in memory from the database.

Parameters
int$idId object
string$refRef
string$modeMode
Returns
int <0 if KO, 0 if not found, >0 if OK

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

◆ fetchAll()

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

Load object in memory from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitOffset limit
int$offsetOffset limit
array$filterFilter array
string$filtermodeFilter mode (AND or OR)
int$showAlreadyExportMovementsShow movements when field 'date_export' is not empty (0:No / 1:Yes (Default))
Returns
int <0 if KO, >0 if OK

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

◆ fetchAllBalance()

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

Load object in memory from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitoffset limit
int$offsetoffset limit
array$filterfilter array
string$filtermodefilter mode (AND or OR)
Returns
int <0 if KO, >0 if OK

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

◆ fetchAllByAccount()

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

Load object in memory from the database.

Parameters
string$sortorderSort Order
string$sortfieldSort field
int$limitoffset limit
int$offsetoffset limit
array$filterfilter array
string$filtermodefilter mode (AND or OR)
int$optionoption (0: general account or 1: subaccount)
Returns
int <0 if KO, >=0 if OK

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

◆ fetchAllPerMvt()

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

Load all informations of accountancy document.

Parameters
int$piecenumId of line to get
string$modeMode
Returns
int <0 if KO, >0 if OK

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

◆ fetchPerMvt()

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

Load an accounting document into memory from database.

Parameters
int$piecenumAccounting document to get
string$modeMode
Returns
int <0 if KO, >0 if OK

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

◆ get_compte_desc()

BookKeeping::get_compte_desc (   $account = null)

Description of accounting account.

Parameters
string$accountAccounting account
Returns
string Account desc

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

◆ getNextNumMvt()

BookKeeping::getNextNumMvt (   $mode = '')

Return next number movement.

Parameters
string$modeMode
Returns
string Next numero to use

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

◆ 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$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string$optionOn what the link point to ('nolink', ...)
int$notooltip1=Disable tooltip
string$morecssAdd 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 469 of file bookkeeping.class.php.

◆ 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$accountAccounting account
Returns
array Array with root account information (max 2 upper level)

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

◆ initAsSpecimen()

BookKeeping::initAsSpecimen ( )

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

Returns
void

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

◆ 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$selectidPreselected chart of accounts
string$htmlnameName of field in html form
int$showemptyAdd an empty field
array$eventEvent options
int$select_inValue is a aa.rowid (0 default) or aa.account_number (1)
int$select_outSet value returned by select 0=rowid (default), 1=account_number
int$aabaseSet accounting_account base class to display empty=all or from 1 to 8 will display only account beginning by this number
Returns
string String with HTML select

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

◆ transformTransaction()

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

Transform transaction.

Parameters
number$directionIf 0: tmp => real, if 1: real => tmp
string$piece_numPiece num = Transaction ref
Returns
int int <0 if KO, >0 if OK

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

◆ update()

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

Update object into database.

Parameters
User$userUser that modifies
bool$notriggerfalse=launch triggers after, true=disable triggers
string$modeMode ('' or _tmp')
Returns
int <0 if KO, >0 if OK

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

◆ updateByMvt()

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

Update accounting movement.

Parameters
string$piece_numPiece num
string$fieldField
string$valueValue
string$modeMode ('' or _tmp')
Returns
number <0 if KO, >0 if OK

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


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