RemiseCheque Class Reference

Class to manage cheque delivery receipts. More...

Inheritance diagram for RemiseCheque:

Collaboration diagram for RemiseCheque:

Public Member Functions
	__construct ($db)
	Constructor.
	fetch ($id, $ref='')
	Load record.
	create ($user, $account_id, $limit, $toRemise)
	Create a receipt to send cheques.
	delete ($user)
	Delete deposit from database.
	validate ($user)
	Validate a receipt.
	getNextNumRef ($mode='next')
	Return next reference of cheque receipts not already used (or last reference) according to numbering module defined into constant FACTURE_ADDON.
	load_board ($user, $type='CHQ')
	Load indicators for dashboard (this->nbtodo and this->nbtodolate)
	loadStateBoard ($type='CHQ')
	Load indicators this->nb for the state board.
	generatePdf ($model, $outputlangs)
	Build document.
	updateAmount ()
	Mets a jour le montant total.
	removeCheck ($account_id)
	Insere la remise en base.
	rejectCheck ($bank_id, $rejection_date)
	Check return management Reopen linked invoices and create a new negative payment.
	set_date ($user, $date)
	Set the creation date.
	set_number ($user, $ref)
	Set the ref of bordereau.
	initAsSpecimen ($option='')
	Initialise an instance with random values.
	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return clickable name (with picto eventually)
	getLibStatut ($mode=0)
	Return the label of the status.
	LibStatut ($status, $mode=0)
	Return the label of a given status.
	getKanbanView ($option='', $arraydata=null)
	Return clickable link of object (with eventually picto)
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.
	fetchBarCode ()
	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 cheque delivery receipts.

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

Constructor & Destructor Documentation

__construct()

RemiseCheque::__construct

(

$db

)

Constructor.

Parameters

DoliDB

$db

Database handler

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

Member Function Documentation

create()

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

Create a receipt to send cheques.

Parameters

User	$user	User making creation
int	$account_id	Bank account for cheque receipt
int	$limit	Limit ref of cheque to this
int[]	$toRemise	array with cheques to remise

Returns

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

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

References $conf, dol_now(), dol_syslog(), getDolGlobalString(), type, updateAmount(), and validate().

delete()

RemiseCheque::delete

(

$user

)

Delete deposit from database.

Parameters

User

$user

User that delete

Returns

int

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

References $conf, and dol_syslog().

fetch()

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

Load record.

Parameters

int	$id	Id record
string	$ref	Ref record

Returns

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

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

References $conf, dol_syslog(), ref, and type.

generatePdf()

RemiseCheque::generatePdf	(		$model,
			$outputlangs )

Build document.

Parameters

string	$model	Model name
Translate	$outputlangs	Object langs

Returns

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

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

References $conf, dol_print_error(), and dol_syslog().

getKanbanView()

RemiseCheque::getKanbanView	(		$option = '',
			$arraydata = null )

Return clickable link of object (with eventually picto)

Parameters

string	$option	Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)
	array{string,mixed}	$arraydata Array of data

Returns

string HTML Code for Kanban thumb.

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

References dol_print_date(), getNomUrl(), img_picto(), and price().

getLibStatut()

RemiseCheque::getLibStatut

(

$mode = 0

)

Return the label of the status.

Parameters

int

$mode

0=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 Label of status

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

References LibStatut().

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 430 of file remisecheque.class.php.

References $conf, dol_buildpath(), dol_print_error(), and getDolGlobalString().

Referenced by validate().

getNomUrl()

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

Return clickable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
string	$option	Indicate where the link points to
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 Chaine avec URL

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

References $conf, getDolGlobalString(), and img_object().

Referenced by getKanbanView().

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

int

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

References $conf, dol_getdate(), dol_mktime(), dol_now(), and ref.

LibStatut()

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

Return the label of a given status.

Parameters

int	$status	Id status
int	$mode	0=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 Label of status

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

References dolGetStatus().

Referenced by getLibStatut().

load_board()

RemiseCheque::load_board	(		$user,
			$type = 'CHQ' )

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

Parameters

User	$user	Object user
string	$type	Type of payment mode deposit ('CHQ', 'TRA', ...)

Returns

WorkboardResponse|int Return integer <0 if KO, WorkboardResponse if OK

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

References $conf, dol_now(), dol_print_error(), and img_object().

loadStateBoard()

RemiseCheque::loadStateBoard

(

$type = 'CHQ'

)

Load indicators this->nb for the state board.

Parameters

string

$type

Type of payment mode deposit ('CHQ', 'TRA', ...)

Returns

int Return integer <0 if ko, >0 if ok

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

References dol_print_error().

rejectCheck()

RemiseCheque::rejectCheck	(		$bank_id,
			$rejection_date )

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

Parameters

int	$bank_id	Id of bank transaction line concerned
integer	$rejection_date	Date to use on the negative payment

Returns

int Id of negative payment line created

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

References dol_getIdFromCode(), and price2num().

removeCheck()

RemiseCheque::removeCheck

(

$account_id

)

Insere la remise en base.

Parameters

int

$account_id

Compte bancaire concerne

Returns

int

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

References dol_syslog(), and updateAmount().

set_date()

RemiseCheque::set_date	(		$user,
			$date )

Set the creation date.

Parameters

User	$user	Object user
int	$date	Date creation

Returns

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

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

References dol_syslog().

set_number()

RemiseCheque::set_number	(		$user,
			$ref )

Set the ref of bordereau.

Parameters

User	$user	Object user
int	$ref	ref of bordereau

Returns

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

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

References dol_syslog().

updateAmount()

RemiseCheque::updateAmount

(

)

Mets a jour le montant total.

Returns

int 0 en cas de success

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

References $conf, and dol_syslog().

Referenced by create(), and removeCheck().

validate()

RemiseCheque::validate

(

$user

)

Validate a receipt.

Parameters

User

$user

User

Returns

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

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

References $conf, dol_syslog(), getNextNumRef(), ref, and status.

Referenced by create().

---

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

• dolibarr_dev/htdocs/compta/paiement/cheque/class/remisecheque.class.php