dolibarr  9.0.0
Public Member Functions | Public Attributes | List of all members
RemiseCheque Class Reference

Class to manage cheque delivery receipts. More...

+ Inheritance diagram for RemiseCheque:
+ Collaboration diagram for RemiseCheque:

Public Member Functions

 __construct ($db)
 Constructor. More...
 
 fetch ($id, $ref='')
 Load record. More...
 
 create ($user, $account_id, $limit, $toRemise)
 Create a receipt to send cheques. More...
 
 delete ($user='')
 Supprime la remise en base. More...
 
 validate ($user)
 Validate a receipt. More...
 
 getNextNumRef ($mode='next')
 Return next reference of cheque receipts not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON. More...
 
 load_board ($user)
 Load indicators for dashboard (this->nbtodo and this->nbtodolate) More...
 
 load_state_board ()
 Charge indicateurs this->nb de tableau de bord. More...
 
 generatePdf ($model, $outputlangs)
 Build document. More...
 
 updateAmount ()
 Mets a jour le montant total. More...
 
 removeCheck ($account_id)
 Insere la remise en base. More...
 
 rejectCheck ($bank_id, $rejection_date)
 Check return management Reopen linked invoices and create a new negative payment. More...
 
 load_previous_next_id ()
 Charge les proprietes ref_previous et ref_next. More...
 
 set_date ($user, $date)
 Set the creation date. More...
 
 set_number ($user, $ref)
 Set the ref of bordereau. More...
 
 initAsSpecimen ($option='')
 Initialise an instance with random values. More...
 
 getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
 Return clicable name (with picto eventually) More...
 
 getLibStatut ($mode=0)
 Retourne le libelle du statut d'une facture (brouillon, validee, abandonnee, payee) More...
 
 LibStatut ($status, $mode=0)
 Return label of a status. 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="\, $withregion=0)
 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. 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 ()
 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)
 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, $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)
 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, $orderby='sourcetype', $loadalsoobjects=1)
 Fetch array of objects linked to current object (object of enabled modules only). 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='', $trigkey='')
 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...
 
 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's 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 Move this into files.lib.php. 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, $trigger=null, $userused=null)
 Update an extra field value for the current object. More...
 
 showInputField ($val, $key, $value, $moreparam='', $keysuffix='', $keyprefix='', $morecss=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='', $onetrtd=0)
 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...
 
 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...
 
 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, $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...
 
 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...
 

Public Attributes

 $errno
 Numero d'erreur Plage 1024-1279.
 
- Public Attributes inherited from CommonObject
 $projet
 
 $note
 

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...
 
- 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...
 
 setSaveQuery ()
 Function to prepare the values to insert. More...
 
 setVarsFromFetchObj (&$obj)
 Function to load data from a SQL pointer into properties of current object $this. More...
 
 getFieldList ()
 Function to concat keys of fields. More...
 
 quote ($value, $fieldsentry)
 Add quote to field value if necessary. More...
 

Detailed Description

Class to manage cheque delivery receipts.

Definition at line 34 of file remisecheque.class.php.

Constructor & Destructor Documentation

◆ __construct()

RemiseCheque::__construct (   $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 73 of file remisecheque.class.php.

Member Function Documentation

◆ create()

RemiseCheque::create (   $user,
  $account_id,
  $limit,
  $toRemise 
)

Create a receipt to send cheques.

Parameters
User$userUser making creation
int$account_idBank account for cheque receipt
int$limitLimit ref of cheque to this
array$toRemisearray with cheques to remise
Returns
int <0 if KO, >0 if OK

Definition at line 145 of file remisecheque.class.php.

◆ delete()

RemiseCheque::delete (   $user = '')

Supprime la remise en base.

Parameters
User$userUtilisateur qui effectue l'operation
Returns
int

Definition at line 302 of file remisecheque.class.php.

◆ fetch()

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

Load record.

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

Definition at line 87 of file remisecheque.class.php.

◆ generatePdf()

RemiseCheque::generatePdf (   $model,
  $outputlangs 
)

Build document.

Parameters
string$modelModel name
Translate$outputlangsObject langs
Returns
int <0 if KO, >0 if OK

Definition at line 601 of file remisecheque.class.php.

◆ getLibStatut()

RemiseCheque::getLibStatut (   $mode = 0)

Retourne le libelle du statut d'une facture (brouillon, validee, abandonnee, payee)

Parameters
int$mode0=libelle long, 1=libelle court, 2=Picto + Libelle court, 3=Picto, 4=Picto + Libelle long, 5=Libelle court + Picto
Returns
string Libelle

Definition at line 1067 of file remisecheque.class.php.

◆ getNextNumRef()

RemiseCheque::getNextNumRef (   $mode = 'next')

Return next reference of cheque receipts not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON.

Parameters
string$mode'next' for next value or 'last' for last value
Returns
string free ref or last ref

$numref can be empty in case we ask for the last value because if there is no invoice created with the set up mask.

Definition at line 419 of file remisecheque.class.php.

◆ getNomUrl()

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

Return clicable name (with picto eventually)

Parameters
int$withpicto0=No picto, 1=Include picto into link, 2=Only picto
string$optionSur quoi pointe le lien
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 Chaine avec URL

Definition at line 1016 of file remisecheque.class.php.

◆ initAsSpecimen()

RemiseCheque::initAsSpecimen (   $option = '')

Initialise an instance with random values.

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

Parameters
string$option''=Create a specimen invoice with lines, 'nolines'=No lines
Returns
void

Definition at line 991 of file remisecheque.class.php.

◆ LibStatut()

RemiseCheque::LibStatut (   $status,
  $mode = 0 
)

Return label of a status.

Parameters
int$statusStatut
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
Returns
string Libelle du statut

Definition at line 1080 of file remisecheque.class.php.

◆ load_board()

RemiseCheque::load_board (   $user)

Load indicators for dashboard (this->nbtodo and this->nbtodolate)

Parameters
User$userObjet user
Returns
WorkboardResponse|int <0 if KO, WorkboardResponse if OK

Definition at line 505 of file remisecheque.class.php.

◆ load_previous_next_id()

RemiseCheque::load_previous_next_id ( )

Charge les proprietes ref_previous et ref_next.

Returns
int <0 if KO, 0 if OK

Definition at line 875 of file remisecheque.class.php.

◆ load_state_board()

RemiseCheque::load_state_board ( )

Charge indicateurs this->nb de tableau de bord.

Returns
int <0 if ko, >0 if ok

Definition at line 559 of file remisecheque.class.php.

◆ rejectCheck()

RemiseCheque::rejectCheck (   $bank_id,
  $rejection_date 
)

Check return management Reopen linked invoices and create a new negative payment.

Parameters
int$bank_idId of bank transaction line concerned
date$rejection_dateDate to use on the negative payment
Returns
int Id of negative payment line created

Definition at line 779 of file remisecheque.class.php.

◆ removeCheck()

RemiseCheque::removeCheck (   $account_id)

Insere la remise en base.

Parameters
int$account_idCompte bancaire concerne
Returns
int

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

◆ set_date()

RemiseCheque::set_date (   $user,
  $date 
)

Set the creation date.

Parameters
User$userObject user
int$dateDate creation
Returns
int <0 if KO, >0 if OK

Definition at line 920 of file remisecheque.class.php.

◆ set_number()

RemiseCheque::set_number (   $user,
  $ref 
)

Set the ref of bordereau.

Parameters
User$userObject user
int$refref of bordereau
Returns
int <0 if KO, >0 if OK

Definition at line 956 of file remisecheque.class.php.

◆ updateAmount()

RemiseCheque::updateAmount ( )

Mets a jour le montant total.

Returns
int 0 en cas de succes

Definition at line 685 of file remisecheque.class.php.

◆ validate()

RemiseCheque::validate (   $user)

Validate a receipt.

Parameters
User$userUser
Returns
int <0 if KO, >0 if OK

Definition at line 356 of file remisecheque.class.php.


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