dolibarr  7.0.0-beta
Public Member Functions | List of all members
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. More...
 
 create (User $user, $notrigger=false)
 Create object into database. 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')
 Load object in memory from the database. More...
 
 fetchAll ($sortorder= '', $sortfield= '', $limit=0, $offset=0, array $filter=array(), $filtermode= 'AND')
 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 movement. More...
 
 delete (User $user, $notrigger=false, $mode='')
 Delete object in database. More...
 
 deleteByImportkey ($importkey)
 Delete bookkepping by importkey. More...
 
 deleteByYearAndJournal ($delyear='', $journal='', $mode='')
 Delete bookkepping by year. More...
 
 deleteMvtNum ($piecenum)
 Delete bookkepping by piece number. More...
 
 createFromClone ($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_bookkeping ($model= 'ebp')
 Export bookkeping. 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...
 
 get_compte_racine ($account=null)
 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...
 
 getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
 Return full name (civility+' '+name+' '+lastname) More...
 
 getFullAddress ($withcountry=0, $sep="\n")
 Return full address of contact. More...
 
 getBannerAddress ($htmlkey, $object)
 Return full address for banner. More...
 
 getLastMainDocLink ($modulepart, $initsharekey=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. More...
 
 liste_contact ($statut=-1, $source='external', $list=0, $code='')
 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...
 
 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->contactid 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_projet ()
 Charge le projet d'id $this->fk_project dans this->projet. More...
 
 fetch_user ($userid)
 Charge le user d'id userid dans this->user. More...
 
 fetch_origin ()
 Read linked origin object. More...
 
 fetchObjectFrom ($table, $field, $key)
 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='')
 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 project. More...
 
 setProject ($projectid)
 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)
 Change the payments terms. More...
 
 setDeliveryAddress ($id)
 Define delivery address. More...
 
 setShippingMethod ($shipping_method_id)
 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)
 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)
 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)
 Add objects linked in llx_element_element. More...
 
 fetchObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $clause='OR', $alsosametype=1)
 Fetch array of objects linked to current object. More...
 
 updateObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='')
 Update object linked of a current object. More...
 
 deleteObjectLinked ($sourceid=null, $sourcetype='', $targetid=null, $targettype='', $rowid='')
 Delete all links between an object $this. More...
 
 setStatut ($status, $elementId=null, $elementType='')
 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)
 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...
 
 display_incoterms ()
 Return incoterms informations TODO Use a cache for label get. More...
 
 getIncotermsForPDF ()
 Return incoterms informations for pdf display. More...
 
 setIncoterms ($id_incoterm, $location)
 Define incoterms values of current object. More...
 
 isInEEC ()
 Return if a country is inside the EEC (European Economic Community) More...
 
 formAddObjectLine ($dateSelector, $seller, $buyer)
 Show add free and predefined products/services form. More...
 
 printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0)
 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'st possible as we keep a method available on overloaded objects. More...
 
 printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafieldsline=0)
 Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...
 
 printOriginLinesList ($restrictlist='')
 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='')
 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...
 
 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 ($trigger_name, $user)
 Call trigger based on this instance. 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...
 
 updateExtraField ($key)
 Update an exta field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...
 
 showOutputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $showsize=0)
 Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...
 
 showOptionals ($extrafields, $mode='view', $params=null, $keysuffix='', $keyprefix='')
 Function to show lines of extrafields with output datas. More...
 
 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...
 
 isDate ($info)
 Function test if type is date. 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...
 
 createCommon (User $user, $notrigger=false)
 Create object into database. More...
 
 fetchCommon ($id, $ref=null)
 Load object in memory from the database. More...
 
 updateCommon (User $user, $notrigger=false)
 Update object into database. More...
 
 deleteCommon (User $user, $notrigger=false)
 Delete object in database. 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...
 

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 commonReplaceThirdparty (DoliDB $db, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
 Function used to replace a thirdparty id with another one. More...
 
- Public Attributes inherited from CommonObject
 $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...
 
 isNull ($info)
 Function test if type is null. More...
 
 isIndex ($info)
 Function test if is indexed. 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 32 of file bookkeeping.class.php.

Constructor & Destructor Documentation

BookKeeping::__construct ( DoliDB  $db)

Constructor.

Parameters
DoliDb$dbDatabase handler

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

Member Function Documentation

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 102 of file bookkeeping.class.php.

References $resql, dol_now(), dol_strlen(), dol_syslog(), and getEntity().

BookKeeping::createFromClone (   $fromid)

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

Parameters
int$fromidId of object to clone
Returns
int New id of clone

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

References dol_syslog().

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 365 of file bookkeeping.class.php.

References $resql, dol_now(), dol_strlen(), dol_syslog(), and price2num().

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 1128 of file bookkeeping.class.php.

References $resql, and dol_syslog().

BookKeeping::deleteByImportkey (   $importkey)

Delete bookkepping by importkey.

Parameters
string$importkeyImport key
Returns
int Result

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

References $resql, and dol_syslog().

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

Delete bookkepping by year.

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

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

References $resql, dol_syslog(), and getEntity().

BookKeeping::deleteMvtNum (   $piecenum)

Delete bookkepping by piece number.

Parameters
int$piecenumPiecenum to delete
Returns
int Result

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

References $resql, dol_syslog(), and getEntity().

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

Export bookkeping.

Parameters
string$modelModel
Returns
int Result

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

References $resql, dol_syslog(), and getEntity().

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 536 of file bookkeeping.class.php.

References $resql, dol_syslog(), and getEntity().

BookKeeping::fetchAll (   $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 757 of file bookkeeping.class.php.

References $resql, dol_syslog(), and getEntity().

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 879 of file bookkeeping.class.php.

References $resql, dol_syslog(), and getEntity().

BookKeeping::fetchAllByAccount (   $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 633 of file bookkeeping.class.php.

References $resql, dol_syslog(), and getEntity().

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 1424 of file bookkeeping.class.php.

References dol_syslog(), and getEntity().

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 1360 of file bookkeeping.class.php.

References dol_syslog(), and getEntity().

BookKeeping::get_compte_desc (   $account = null)

Description of accounting account.

Parameters
string$accountAccounting account
Returns
string Account desc

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

References $resql, dol_syslog(), and getEntity().

BookKeeping::get_compte_racine (   $account = null)

Description of a root accounting account.

Parameters
string$accountAccounting account
Returns
string Root account

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

References $resql, dol_syslog(), and getEntity().

BookKeeping::getNextNumMvt (   $mode = '')

Return next number movement.

Parameters
string$modeMode
Returns
string Next numero to use

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

References dol_syslog(), and getEntity().

Referenced by transformTransaction().

BookKeeping::initAsSpecimen ( )

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

Returns
void

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

References dol_now().

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 1639 of file bookkeeping.class.php.

References $resql, ajax_combobox(), dol_syslog(), getEntity(), length_accountg(), and Form\selectarray().

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

Transform transaction.

Parameters
number$directionIf 0 tmp => real, if 1 real => tmp
string$piece_numPiece num
Returns
void

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

References $resql, dol_syslog(), and getNextNumMvt().

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
Returns
int <0 if KO, >0 if OK

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

References $resql, dol_strlen(), dol_syslog(), and price2num().

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

Update movement.

Parameters
string$piece_numPiece num
string$fieldField
string$valueValue
string$modeMode
Returns
number <0 if KO, >0 if OK

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

References $resql, and dol_syslog().


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