dolibarr  7.0.0-beta
Public Member Functions | Protected Attributes | List of all members
ChargeSociales Class Reference

Classe permettant la gestion des paiements des charges La tva collectee n'est calculee que sur les factures payees. More...

+ Inheritance diagram for ChargeSociales:
+ Collaboration diagram for ChargeSociales:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 fetch ($id, $ref='')
 Retrouve et charge une charge sociale. More...
 
 check ()
 Check if a social contribution can be created into database. More...
 
 create ($user)
 Create a social contribution into database. More...
 
 delete ($user)
 Delete a social contribution. More...
 
 update ($user)
 Met a jour une charge sociale. More...
 
 solde ($year=0)
 Calculate amount remaining to pay by year. More...
 
 set_paid ($user)
 Tag social contribution as payed completely. More...
 
 set_unpaid ($user)
 Remove tag payed on social contribution. More...
 
 getLibStatut ($mode=0, $alreadypaid=-1)
 Retourne le libelle du statut d'une charge (impaye, payee) More...
 
 LibStatut ($statut, $mode=0, $alreadypaid=-1)
 Renvoi le libelle d'un statut donne. More...
 
 getNomUrl ($withpicto=0, $maxlen=0, $notooltip=0)
 Return a link to the object card (with optionaly the picto) More...
 
 getSommePaiement ()
 Return amount of payments already done. More...
 
 info ($id)
 Charge les informations d'ordre info dans l'objet entrepot. More...
 
 initAsSpecimen ()
 Initialise an instance with random values. 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...
 

Protected Attributes

 $table_ref_field = 'ref'
 {}
 

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

Classe permettant la gestion des paiements des charges La tva collectee n'est calculee que sur les factures payees.

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

Constructor & Destructor Documentation

ChargeSociales::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 64 of file chargesociales.class.php.

Member Function Documentation

ChargeSociales::check ( )

Check if a social contribution can be created into database.

Returns
boolean True or false

Definition at line 136 of file chargesociales.class.php.

References price2num().

Referenced by create().

ChargeSociales::create (   $user)

Create a social contribution into database.

Parameters
User$userUser making creation
Returns
int <0 if KO, id if OK

Definition at line 156 of file chargesociales.class.php.

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

ChargeSociales::delete (   $user)

Delete a social contribution.

Parameters
User$userObject user making delete
Returns
int <0 if KO, >0 if OK

Definition at line 212 of file chargesociales.class.php.

References $resql, and dol_syslog().

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

Retrouve et charge une charge sociale.

Parameters
int$idId
string$refRef
Returns
int <0 KO >0 OK

Definition at line 77 of file chargesociales.class.php.

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

ChargeSociales::getLibStatut (   $mode = 0,
  $alreadypaid = -1 
)

Retourne le libelle du statut d'une charge (impaye, payee)

Parameters
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto
double$alreadypaid0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
Returns
string Label

Definition at line 390 of file chargesociales.class.php.

References LibStatut().

ChargeSociales::getNomUrl (   $withpicto = 0,
  $maxlen = 0,
  $notooltip = 0 
)

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

Parameters
int$withpictoInclude picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
int$maxlenMax length of label
int$notooltip1=Disable tooltip
Returns
string String with link

Definition at line 462 of file chargesociales.class.php.

References dol_escape_htmltag(), dol_trunc(), and img_object().

ChargeSociales::getSommePaiement ( )

Return amount of payments already done.

Returns
int Amount of payment already done, <0 if KO

Definition at line 487 of file chargesociales.class.php.

References $resql, and dol_syslog().

ChargeSociales::info (   $id)

Charge les informations d'ordre info dans l'objet entrepot.

Parameters
int$idId of social contribution
Returns
int <0 if KO, >0 if OK

Definition at line 520 of file chargesociales.class.php.

References dol_print_error(), and dol_syslog().

ChargeSociales::initAsSpecimen ( )

Initialise an instance with random values.

Used to build previews or test instances. id must be 0 if object instance is a specimen.

Returns
void

Definition at line 577 of file chargesociales.class.php.

References type.

ChargeSociales::LibStatut (   $statut,
  $mode = 0,
  $alreadypaid = -1 
)

Renvoi le libelle d'un statut donne.

Parameters
int$statutId statut
int$mode0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=short label + picto, 6=Long label + picto
double$alreadypaid0=No payment already done, >0=Some payments were already done (we recommand to put here amount payed if you have it, 1 otherwise)
Returns
string Label

Definition at line 403 of file chargesociales.class.php.

References img_picto().

Referenced by getLibStatut().

ChargeSociales::set_paid (   $user)

Tag social contribution as payed completely.

Parameters
User$userObject user making change
Returns
int <0 if KO, >0 if OK

Definition at line 358 of file chargesociales.class.php.

ChargeSociales::set_unpaid (   $user)

Remove tag payed on social contribution.

Parameters
User$userObject user making change
Returns
int <0 if KO, >0 if OK

Definition at line 373 of file chargesociales.class.php.

ChargeSociales::solde (   $year = 0)

Calculate amount remaining to pay by year.

Parameters
int$yearYear
Returns
number

Definition at line 317 of file chargesociales.class.php.

References print.

ChargeSociales::update (   $user)

Met a jour une charge sociale.

Parameters
User$userUtilisateur qui modifie
Returns
int <0 si erreur, >0 si ok

Definition at line 283 of file chargesociales.class.php.

References $resql, and dol_syslog().


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