Inheritance diagram for Lettering:

Collaboration diagram for Lettering:

[legend]

Public Member Functions
	letteringThirdparty ($socid)
	letteringThirdparty

	updateLettering ($ids=array(), $notrigger=false)

	deleteLettering ($ids, $notrigger=false)

	bookkeepingLetteringAll ($bookkeeping_ids, $unlettering=false)
	Lettering bookkeeping lines all types.

	bookkeepingLettering ($bookkeeping_ids, $unlettering=false)
	Lettering bookkeeping lines.

	getLinkedLines ($bookkeeping_ids, $only_has_subledger_account=true)
	Lettering bookkeeping lines.

	getDocTypeAndFkDocFromBankLines ($bank_ids)
	Get all fk_doc by doc_type from list of bank ids.

	getBankLinesFromFkDocAndDocType ($document_ids, $doc_type)
	Get all bank ids from list of document ids of a type.

	getLinkedDocumentByGroup ($document_ids, $doc_type)
	Get all linked document ids by group and type.

	getGroupElements (&$link_by_element, &$element_by_link, $link_key='', &$current_group=array())
	Get element ids grouped by link or element in common.

Public Member Functions inherited from BookKeeping
	__construct (DoliDB $db)
	Constructor.

	create (User $user, $notrigger=false)
	Create object into database.

	getNomUrl ($withpicto=0, $option='', $notooltip=0, $morecss='', $save_lastsearch_value=-1)
	Return a link to the object card (with optionally the picto)

	createStd (User $user, $notrigger=false, $mode='')
	Create object into database.

	fetch ($id, $ref=null, $mode='')
	Load object in memory from the database.

	fetchAllByAccount ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $option=0, $countonly=0)
	Load object in memory from the database in ->lines.

	fetchAll ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $showAlreadyExportMovements=1)
	Load object in memory from the database.

	fetchAllBalance ($sortorder='', $sortfield='', $limit=0, $offset=0, array $filter=array(), $filtermode='AND', $option=0)
	Load object in memory from the database.

	update (User $user, $notrigger=false, $mode='')
	Update object into database.

	updateByMvt ($piece_num='', $field='', $value='', $mode='')
	Update accounting movement.

	delete (User $user, $notrigger=false, $mode='')
	Delete object in database.

	deleteByImportkey ($importkey)
	Delete bookkeeping by importkey.

	deleteByYearAndJournal ($delyear=0, $journal='', $mode='', $delmonth=0)
	Delete bookkeeping by year.

	deleteMvtNum ($piecenum)
	Delete bookkeeping by piece number.

	createFromClone (User $user, $fromid)
	Load an object from its id and create a new one in database.

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

	fetchPerMvt ($piecenum, $mode='')
	Load an accounting document into memory from database.

	getNextNumMvt ($mode='')
	Return next number movement.

	fetchAllPerMvt ($piecenum, $mode='')
	Load all informations of accountancy document.

	export_bookkeeping ($model='ebp')
	Export bookkeeping.

	transformTransaction ($direction=0, $piece_num='')
	Transform transaction.

	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.

	getRootAccount ($account=null)
	Return id and description of a root accounting account.

	get_compte_desc ($account=null)
	Description of accounting account.

Public Member Functions inherited from CommonObject
	setErrorsFromObject ($object)
	setErrorsFromObject

	getTooltipContentArray ($params)
	Return array of datas 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.

	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=false, $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=false, $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='none', $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.

	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='', $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.

	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=0, $display_type='card')
	Function to show lines of extrafields with output datas.

	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.

	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.

	getFieldList ($alias='', $excludefields=array())
	Function to concat keys of fields.

	createCommon (User $user, $notrigger=false)
	Create object into database.

	fetchCommon ($id, $ref=null, $morewhere='')
	Load object in memory from the database.

	fetchLinesCommon ($morewhere='')
	Load object in memory from the database.

	updateCommon (User $user, $notrigger=false)
	Update object into database.

	deleteCommon (User $user, $notrigger=false, $forcechilddeletion=0)
	Delete object in database.

	deleteByParentField ($parentId=0, $parentField='', $filter=array(), $filtermode="AND")
	Delete all child object from a parent ID.

	deleteLineCommon (User $user, $idline, $notrigger=false)
	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 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.

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	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
	$fk_projet

	$note

	$date_modification

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.

	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 Lettering.

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

Member Function Documentation

◆ bookkeepingLettering()

Lettering::bookkeepingLettering	(		$bookkeeping_ids,
			$unlettering = false )

Lettering bookkeeping lines.

Parameters

array	$bookkeeping_ids	Lettering specific list of bookkeeping id
bool	$unlettering	Do unlettering

Returns: int <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered)

Definition at line 444 of file lettering.class.php.

References deleteLettering(), getLinkedLines(), price2num(), and updateLettering().

Referenced by bookkeepingLetteringAll().

◆ bookkeepingLetteringAll()

Lettering::bookkeepingLetteringAll	(		$bookkeeping_ids,
			$unlettering = false )

Lettering bookkeeping lines all types.

Parameters

array	$bookkeeping_ids	Lettering specific list of bookkeeping id
bool	$unlettering	Do unlettering

Returns: int <0 if error (nb lettered = result -1), 0 if noting to lettering, >0 if OK (nb lettered)

Definition at line 412 of file lettering.class.php.

References bookkeepingLettering(), and dol_syslog().

◆ deleteLettering()

Lettering::deleteLettering	(		$ids,
			$notrigger = false )

Parameters

array	$ids	ids array
boolean	$notrigger	no trigger

Returns: int

Definition at line 376 of file lettering.class.php.

References dol_syslog().

Referenced by bookkeepingLettering().

◆ getBankLinesFromFkDocAndDocType()

Lettering::getBankLinesFromFkDocAndDocType	(		$document_ids,
			$doc_type )

Get all bank ids from list of document ids of a type.

Parameters

array	$document_ids	List of document id
string	$doc_type	Type of document ('customer_invoice' or 'supplier_invoice', ...)

Returns: array|int <0 if error otherwise all all bank ids from list of document ids of a type

Definition at line 695 of file lettering.class.php.

References dol_syslog().

Referenced by getLinkedLines().

◆ getDocTypeAndFkDocFromBankLines()

Lettering::getDocTypeAndFkDocFromBankLines ( $bank_ids )

Get all fk_doc by doc_type from list of bank ids.

Parameters

array $bank_ids List of bank ids

Returns: array|int <0 if error otherwise all fk_doc by doc_type

Definition at line 652 of file lettering.class.php.

References dol_syslog().

Referenced by getLinkedLines().

◆ getGroupElements()

Lettering::getGroupElements	(	&	$link_by_element,
		&	$element_by_link,
			$link_key = '',
		&	$current_group = array() )

Get element ids grouped by link or element in common.

Parameters

array	$link_by_element	List of payment ids by link key
array	$element_by_link	List of element ids by link key
string	$link_key	Link key (used for recursive function)
array	$current_group	Current group (used for recursive function)