Class to manage donations. More...

Inheritance diagram for Don:

Collaboration diagram for Don:

Public Member Functions
	__construct ($db)
	Constructor. More...

	getLibStatut ($mode=0)
	Returns the donation status label (draft, valid, abandoned, paid) More...

	LibStatut ($status, $mode=0)
	Return the label of a given status. More...

	initAsSpecimen ()
	Initialise an instance with random values. More...

	check ($minimum=0)
	Check params and init ->errors array. More...

	create ($user, $notrigger=0)
	Create donation record into database. More...

	update ($user, $notrigger=0)
	Update a donation record. More...

	delete ($user, $notrigger=0)
	Delete a donation from database. More...

	fetch ($id, $ref='')
	Load donation from database. More...

	setValid ($user, $notrigger=0)
	Validate a intervention. More...

	valid_promesse ($id, $userid, $notrigger=0)
	Validate a promise of donation. More...

	set_paid ($id, $modepayment=0)
	Classify the donation as paid, the donation was received. More...

	setPaid ($id, $modepayment=0)
	Classify the donation as paid, the donation was received. More...

	set_cancel ($id)
	Set donation to status cancelled. More...

	reopen ($user, $notrigger=0)
	Set cancel status. More...

	sum_donations ($param)
	Sum of donations. More...

	load_state_board ()
	Charge indicateurs this->nb pour le tableau de bord. More...

	getNomUrl ($withpicto=0, $notooltip=0, $moretitle='', $save_lastsearch_value=-1)
	Return clicable name (with picto eventually) More...

	info ($id)
	Information on record. More...

	generateDocument ($modele, $outputlangs, $hidedetails=0, $hidedesc=0, $hideref=0)
	Create a document onto disk according to template module. More...

	getRemainToPay ()
	Function to get reamain to pay for a donation. 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. More...

	liste_contact ($statusoflink=-1, $source='external', $list=0, $code='', $status=-1)
	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...

Static Public Member Functions
static	replaceThirdparty (DoliDB $dbs, $origin_id, $dest_id)
	Function used to replace a thirdparty id with another one. More...

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 $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a thirdparty id with another one. More...

static	commonReplaceProduct (DoliDB $dbs, $origin_id, $dest_id, array $tables, $ignoreerrors=0)
	Function used to replace a product id with another one. More...

Additional Inherited Members
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 prepare a part of the query for insert by returning an array with all properties of object. More...

	quote ($value, $fieldsentry)
	Add quote to field value if necessary. More...

Detailed Description

Class to manage donations.

Definition at line 38 of file don.class.php.

Constructor & Destructor Documentation

◆ __construct()

Don::__construct ( $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 147 of file don.class.php.

References db.

Member Function Documentation

◆ check()

Don::check ( $minimum = 0 )

Check params and init ->errors array.

TODO This function seems to not be used by core code.

Parameters

int $minimum Minimum

Returns: int 0 if KO, >0 if OK

Definition at line 265 of file don.class.php.

◆ create()

Don::create	(	$user,
		$notrigger = `0`
	)

Create donation record into database.

Parameters

User	$user	User who created the donation
int	$notrigger	Disable triggers

Returns: int <0 if KO, id of created donation if OK TODO add numbering module for Ref

Definition at line 342 of file don.class.php.

◆ delete()

Don::delete	(	$user,
		$notrigger = `0`
	)

Delete a donation from database.

Parameters

User	$user	User
int	$notrigger	Disable triggers

Returns: int <0 if KO, 0 if not possible, >0 if OK

Definition at line 550 of file don.class.php.

◆ fetch()

Don::fetch	(	$id,
		$ref = `''`
	)

Load donation from database.

Parameters

int	$id	Id of donation to load
string	$ref	Ref of donation to load

Returns: int <0 if KO, >0 if OK

Definition at line 613 of file don.class.php.

◆ generateDocument()

Don::generateDocument	(	$modele,
		$outputlangs,
		$hidedetails = `0`,
		$hidedesc = `0`,
		$hideref = `0`
	)

Create a document onto disk according to template module.

Parameters

string	$modele	Force template to use ('' to not force)
Translate	$outputlangs	objet lang a utiliser pour traduction
int	$hidedetails	Hide details of lines
int	$hidedesc	Hide description
int	$hideref	Hide ref

Returns: int 0 if KO, 1 if OK

Definition at line 1011 of file don.class.php.

◆ getLibStatut()

Don::getLibStatut ( $mode = 0 )

Returns the donation status label (draft, valid, abandoned, paid)

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 159 of file don.class.php.

◆ getNomUrl()

Don::getNomUrl	(	$withpicto = `0`,
		$notooltip = `0`,
		$moretitle = `''`,
		$save_lastsearch_value = `-1`
	)

Return clicable name (with picto eventually)

Parameters

int	$withpicto	0=No picto, 1=Include picto into link, 2=Only picto
int	$notooltip	1=Disable tooltip
string	$moretitle	Add more text to title tooltip
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 914 of file don.class.php.

◆ getRemainToPay()

Don::getRemainToPay ( )

Function to get reamain to pay for a donation.

Returns: int <0 if KO, > reamain to pay if OK

Definition at line 1123 of file don.class.php.

References dol_syslog().

◆ info()

Don::info ( $id )

Information on record.

Parameters

int $id Id of record

Returns: void

Definition at line 974 of file don.class.php.

◆ initAsSpecimen()

Don::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 207 of file don.class.php.

◆ LibStatut()

Don::LibStatut	(	$status,
		$mode = `0`
	)

Return the label of a given status.

Parameters

int	$status	Id statut
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 172 of file don.class.php.

◆ load_state_board()

Don::load_state_board ( )

Charge indicateurs this->nb pour le tableau de bord.

Returns: int <0 if KO, >0 if OK

Definition at line 879 of file don.class.php.

◆ reopen()

Don::reopen	(	$user,
		$notrigger = `0`
	)

Set cancel status.

Parameters

User	$user	Object user that modify
int	$notrigger	1=Does not execute triggers, 0=Execute triggers

Returns: int <0 if KO, 0=Nothing done, >0 if OK

Definition at line 828 of file don.class.php.

References CommonObject\setStatusCommon().

◆ replaceThirdparty()

static Don::replaceThirdparty	(	DoliDB	$dbs,
			$origin_id,
			$dest_id
	)

static

Function used to replace a thirdparty id with another one.

Parameters

DoliDB	$dbs	Database handler, because function is static we name it $dbs not $db to avoid breaking coding test
int	$origin_id	Old thirdparty id
int	$dest_id	New thirdparty id

Returns: bool

Definition at line 1109 of file don.class.php.

References CommonObject\commonReplaceThirdparty().

◆ set_cancel()

Don::set_cancel ( $id )

Set donation to status cancelled.

Parameters

int $id id of donation

Returns: int <0 if KO, >0 if OK

Definition at line 802 of file don.class.php.

◆ set_paid()

Don::set_paid	(	$id,
		$modepayment = `0`
	)

Classify the donation as paid, the donation was received.

Deprecated:

See also: setPaid()

Parameters

int	$id	id of donation
int	$modepayment	mode of payment

Returns: int <0 if KO, >0 if OK

Definition at line 759 of file don.class.php.

References dol_syslog(), and setPaid().

◆ setPaid()

Don::setPaid	(	$id,
		$modepayment = `0`
	)

Classify the donation as paid, the donation was received.

Parameters

int	$id	id of donation
int	$modepayment	mode of payment

Returns: int <0 if KO, >0 if OK

Definition at line 773 of file don.class.php.

Referenced by set_paid().

◆ setValid()

Don::setValid	(	$user,
		$notrigger = `0`
	)

Validate a intervention.

Parameters

User	$user	User that validate
int	$notrigger	1=Does not execute triggers, 0= execute triggers

Returns: int <0 if KO, >0 if OK

Definition at line 697 of file don.class.php.

References valid_promesse().

◆ sum_donations()

Don::sum_donations ( $param )

Sum of donations.

Parameters

string $param 1=promesses de dons validees , 2=xxx, 3=encaisses

Returns: int Summ of donations

Definition at line 852 of file don.class.php.

◆ update()

Don::update	(	$user,
		$notrigger = `0`
	)

Update a donation record.

Parameters

User	$user	Objet utilisateur qui met a jour le don
int	$notrigger	Disable triggers

Returns: int >0 if OK, <0 if KO

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

◆ valid_promesse()

Don::valid_promesse	(	$id,
		$userid,
		$notrigger = `0`
	)

Validate a promise of donation.

Parameters

int	$id	id of donation
int	$userid	User who validate the donation/promise
int	$notrigger	Disable triggers

Returns: int <0 if KO, >0 if OK

Definition at line 711 of file don.class.php.

Referenced by setValid().

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

htdocs/don/class/don.class.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ check()

◆ create()

◆ delete()

◆ fetch()

◆ generateDocument()

◆ getLibStatut()

◆ getNomUrl()

◆ getRemainToPay()

◆ info()

◆ initAsSpecimen()

◆ LibStatut()

◆ load_state_board()

◆ reopen()

◆ replaceThirdparty()

◆ set_cancel()

◆ set_paid()

◆ setPaid()

◆ setValid()

◆ sum_donations()

◆ update()

◆ valid_promesse()