Parent class of all other business classes (invoices, contracts, proposals, orders, ...) More...

Inheritance diagram for CommonObject:

[legend]

Collaboration diagram for CommonObject:

Public Member Functions
	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.

Static Public Member Functions
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
	$origin_object

Protected Member Functions
	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

Parent class of all other business classes (invoices, contracts, proposals, orders, ...)

@phan-forbid-undeclared-magic-properties

Definition at line 50 of file commonobject.class.php.

Member Function Documentation

◆ __clone()

CommonObject::__clone ( )

Overwrite magic function to solve problem of cloning object that are kept as references.

Returns: void

Definition at line 5756 of file commonobject.class.php.

◆ add_contact()

CommonObject::add_contact	(	$fk_socpeople,
		$type_contact,
		$source = 'external',
		$notrigger = 0 )

Add a link between element $this->element and a contact.

Parameters

int	$fk_socpeople	Id of thirdparty contact (if source = 'external') or id of user (if source = 'internal') to link
int \| string	$type_contact	Type of contact (code or id). Must be id or code found into table llx_c_type_contact. For example: SALESREPFOLL
string	$source	external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)
int	$notrigger	Disable all triggers

Returns: int Return integer <0 if KO, 0 if already added or code not valid, >0 if OK

Definition at line 1238 of file commonobject.class.php.

References call_trigger(), dol_now(), dol_syslog(), and liste_contact().

Referenced by CommandeFournisseur\approve(), copy_linked_contact(), Commande\create(), Contrat\create(), Facture\create(), Ticket\create(), and Task\mergeContactTask().

◆ add_element_resource()

CommonObject::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.

Parameters

int	$resource_id	Resource id
string	$resource_type	'resource'
int	$busy	Busy or not
int	$mandatory	Mandatory or not

Returns: int Return integer <=0 if KO, >0 if OK

Definition at line 5679 of file commonobject.class.php.

References dol_syslog().

◆ add_object_linked()

CommonObject::add_object_linked	(	$origin = null,
		$origin_id = null,
		$f_user = null,
		$notrigger = 0 )

Add an object link into llx_element_element.

Parameters

string	$origin	Linked element type
int	$origin_id	Linked element id
User	$f_user	User that create
int	$notrigger	1=Does not execute triggers, 0=execute triggers

Returns: int Return integer <=0 if KO, >0 if OK

See also: fetchObjectLinked(), updateObjectLinked(), deleteObjectLinked()

Definition at line 4181 of file commonobject.class.php.

References dol_syslog().

Referenced by Asset\create(), Commande\create(), CommandeFournisseur\create(), Contrat\create(), Delivery\create(), Expedition\create(), Facture\create(), FactureFournisseur\create(), FactureFournisseurRec\create(), FactureRec\create(), Fichinter\create(), Propal\create(), Reception\create(), Subscription\create(), SupplierProposal\create(), and Asset\dispose().

◆ addThumbs()

CommonObject::addThumbs ( $file )

Build thumb.

Parameters

string $file Path file in UTF8 to original file to create thumbs from.

Returns: void

Definition at line 6110 of file commonobject.class.php.

References dol_osencode(), getDefaultImageSizes(), and vignette().

Referenced by Categorie\add_photo(), and Product\add_photo().

◆ call_trigger()

CommonObject::call_trigger	(		$triggerName,
			$user )

Call trigger based on this instance.

Some context information may also be provided into array property this->context. NB: Error from trigger are stacked in interface->errors NB2: If return code of triggers are < 0, action calling trigger should cancel all transaction.

Parameters

string	$triggerName	trigger's name to execute
User	$user	Object user

Returns: int Result of run_triggers

Reimplemented in EcmDirectory.

Definition at line 6218 of file commonobject.class.php.

References $conf, and dol_print_error().

◆ canBeNull()

CommonObject::canBeNull ( $info )

protected

Function test if field can be null.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if it can be null

Definition at line 10064 of file commonobject.class.php.

◆ clearFieldError()

CommonObject::clearFieldError ( $fieldKey )

clear validation message result for a field

Parameters

string $fieldKey Key of attribute to clear

Returns: void

Definition at line 8876 of file commonobject.class.php.

◆ clearObjectLinkedCache()

CommonObject::clearObjectLinkedCache ( )

Clear the cache saying that all linked object were already loaded.

So next fetchObjectLinked will reload all links.

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

See also: fetchObjectLinked()

Definition at line 4446 of file commonobject.class.php.

◆ cloneCategories()

CommonObject::cloneCategories	(	$fromId,
		$toId,
		$type = '' )

Copy related categories to another object.

Parameters

int	$fromId	Id object source
int	$toId	Id object cible
string	$type	Type of category ('product', ...)

Returns: int Return integer < 0 if error, > 0 if ok

Reimplemented in User.

Definition at line 11265 of file commonobject.class.php.

◆ commonGenerateDocument()

CommonObject::commonGenerateDocument	(	$modelspath,
		$modele,
		$outputlangs,
		$hidedetails,
		$hidedesc,
		$hideref,
		$moreparams = null )

protected

Common function for all objects extending CommonObject for generating documents.

Parameters

string	$modelspath	Relative folder where generators are placed
string	$modele	Generator to use. Caller must set it to from obj->model_pdf or from GETPOST for example.
Translate	$outputlangs	Output language to use
	int<0,1>	$hidedetails 1 to hide details. 0 by default
	int<0,1>	$hidedesc 1 to hide product description. 0 by default
	int<0,1>	$hideref 1 to hide product reference. 0 by default
	?array<string,mixed>	$moreparams Array to provide more information

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

See also: addFileIntoDatabaseIndex()

Definition at line 5782 of file commonobject.class.php.

References $conf, dol_buildpath(), dol_delete_preview(), dol_dir_list(), dol_is_file(), dol_meta_create(), dol_sanitizeFileName(), dol_sanitizePathName(), dol_syslog(), and getDolGlobalString().

◆ commonReplaceProduct()

static CommonObject::commonReplaceProduct	(	DoliDB	$dbs,
			$origin_id,
			$dest_id,
		array	$tables,
			$ignoreerrors = 0 )

static

Function used to replace a product id with another one.

This function is meant to be called from replaceProduct with the appropriate tables Column name fk_product MUST be used to identify products

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old product id (the product to delete)
int	$dest_id	New product id (the product that will received element of the other)
string[]	$tables	Tables that need to be changed
	int<0,1>	$ignoreerrors Ignore errors. Return true even if errors. We need this when replacement can fails like for categories (categorie of old product may already exists on new one)

Returns: bool True if success, False if error

Definition at line 9609 of file commonobject.class.php.

References Database\query().

Referenced by BOM\replaceProduct(), Commande\replaceProduct(), CommandeFournisseur\replaceProduct(), Contrat\replaceProduct(), Delivery\replaceProduct(), Facture\replaceProduct(), FactureFournisseur\replaceProduct(), FactureRec\replaceProduct(), FichinterRec\replaceProduct(), ProductFournisseur\replaceProduct(), Propal\replaceProduct(), Reception\replaceProduct(), and SupplierProposal\replaceProduct().

◆ commonReplaceThirdparty()

static CommonObject::commonReplaceThirdparty	(	DoliDB	$dbs,
			$origin_id,
			$dest_id,
		array	$tables,
			$ignoreerrors = 0 )

static

Function used to replace a thirdparty id with another one.

This function is meant to be called from replaceThirdparty with the appropriate tables Column name fk_soc MUST exist.

Parameters

DoliDB	$dbs	Database handler
int	$origin_id	Old thirdparty id (the thirdparty to delete)
int	$dest_id	New thirdparty id (the thirdparty that will received element of the other)
string[]	$tables	Tables that need to be changed
	int<0,1>	$ignoreerrors Ignore errors. Return true even if errors. We need this when replacement can fails like for categories (categorie of old thirdparty may already exists on new one)

Returns: bool True if success, False if error

Definition at line 9566 of file commonobject.class.php.

References Database\query().

◆ copy_linked_contact()

CommonObject::copy_linked_contact	(		$objFrom,
			$source = 'internal' )

Copy contact from one element to current.

Parameters

CommonObject	$objFrom	Source element
	'internal'\|'external'	$source Nature of contact ('internal' or 'external')

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

Definition at line 1346 of file commonobject.class.php.

References add_contact().

◆ createCommon()

CommonObject::createCommon	(	User	$user,
			$notrigger = 0 )

Create object in the database.

Parameters

User	$user	User that creates
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns: int<-1,max> Return integer <0 if KO, Id of created object if OK

Definition at line 10314 of file commonobject.class.php.

References $id, dol_hash(), dol_now(), dol_string_nospecial(), dol_syslog(), and ref.

Referenced by ActionCommReminder\create(), Asset\create(), AssetModel\create(), Availabilities\create(), BOM\create(), BOMLine\create(), Calendar\create(), CompanyPaymentMode\create(), ConferenceOrBoothAttendee\create(), CTicketCategory\create(), DefaultValues\create(), EmailCollector\create(), EmailCollectorAction\create(), EmailCollectorFilter\create(), EmailSenderProfile\create(), Evaluation\create(), EvaluationLine\create(), ExpenseReportIk\create(), ExpenseReportRule\create(), Hook\create(), IntracommReport\create(), Inventory\create(), InventoryLine\create(), Job\create(), KnowledgeRecord\create(), Mo\create(), MoLine\create(), MyObject\create(), Partnership\create(), PartnershipType\create(), Position\create(), ProductFournisseurPrice\create(), RecruitmentCandidature\create(), RecruitmentJobPosition\create(), Skill\create(), Skilldet\create(), SkillRank\create(), SocieteAccount\create(), StockTransfer\create(), StockTransferLine\create(), Target\create(), TimeSpent\create(), UserGroup\create(), WebsitePage\create(), Workstation\create(), and AssetDepreciationOptions\updateDeprecationOptions().

◆ defineBuyPrice()

CommonObject::defineBuyPrice	(	$unitPrice = 0.0,
		$discountPercent = 0.0,
		$fk_product = 0 )

Get buy price to use for margin calculation.

This function is called when buy price is unknown. Set buy price = sell price if ForceBuyingPriceIfNull configured, elseif calculation MARGIN_TYPE = 'costprice' and costprice is defined, use costprice as buyprice elseif calculation MARGIN_TYPE = 'pmp' and pmp is calculated, use pmp as buyprice else set min buy price as buy price

Parameters

float	$unitPrice	Product unit price
float	$discountPercent	Line discount percent
int	$fk_product	Product id

Returns: float|int<-1,-1> Return buy price if OK, integer <0 if KO

Definition at line 9638 of file commonobject.class.php.

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

Referenced by Contrat\addline(), FactureLigne\insert(), OrderLine\insert(), PropaleLigne\insert(), SupplierProposalLine\insert(), ContratLigne\update(), FactureLigne\update(), OrderLine\update(), PropaleLigne\update(), SupplierProposalLine\update(), and Contrat\updateline().

◆ delete_contact()

CommonObject::delete_contact	(		$rowid,
			$notrigger = 0 )

Delete a link to contact line.

Parameters

int	$rowid	Id of contact link line to delete
int	$notrigger	Disable all triggers

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

Definition at line 1399 of file commonobject.class.php.

References call_trigger(), and dol_syslog().

◆ delete_linked_contact()

CommonObject::delete_linked_contact	(		$source = '',
			$code = '' )

Delete all links between an object $this and all its contacts in llx_element_contact.

Parameters

string	$source	'' or 'internal' or 'external'
string	$code	Type of contact (code or id)

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

Definition at line 1449 of file commonobject.class.php.

References dol_syslog(), and liste_type_contact().

Referenced by Commande\delete(), Contrat\delete(), ExpenseReport\delete(), Facture\delete(), Fichinter\delete(), Project\delete(), Propal\delete(), and Task\delete().

◆ delete_resource()

CommonObject::delete_resource	(	$rowid,
		$element,
		$notrigger = 0 )

Delete a link to resource line.

Parameters

int	$rowid	Id of resource line to delete
string	$element	element name (for trigger) TODO: use $this->element into commonobject class
int	$notrigger	Disable all triggers

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

Definition at line 5720 of file commonobject.class.php.

References dol_syslog().

◆ deleteAllItemsLinkedByObjectID()

static CommonObject::deleteAllItemsLinkedByObjectID	(	$fk_object_where,
		$field_where,
		$table_element )

static

Function used to remove all items linked to an object id in association table.

Parameters

int	$fk_object_where	id of object we need to remove linked items
string	$field_where	name of field of object we need to delete linked items
string	$table_element	name of association table

Returns: int Return integer <0 if KO, 0 if nothing done, >0 if OK and something done

Definition at line 4677 of file commonobject.class.php.

◆ deleteByParentField()

CommonObject::deleteByParentField	(	$parentId = 0,
		$parentField = '',
		$filter = '',
		$filtermode = "AND" )

Delete all child object from a parent ID.

Parameters

int	$parentId	Parent Id
string	$parentField	Name of Foreign key parent column
string	$filter	Filter as an Universal Search string. Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND (client:!=:8) AND (nom:like:'a')'
string	$filtermode	No more used

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

Exceptions

Exception

Definition at line 10884 of file commonobject.class.php.

References dol_syslog(), and forgeSQLFromUniversalSearchCriteria().

◆ deleteCommon()

CommonObject::deleteCommon	(	User	$user,
			$notrigger = 0,
			$forcechilddeletion = 0 )

Delete object in database.

Parameters

User	$user	User that deletes
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers
	int<0,1>	$forcechilddeletion 0=no, 1=Force deletion of children

Returns: int<-1,1> Return integer <0 if KO, 0=Nothing done because object has child, >0 if OK

Definition at line 10744 of file commonobject.class.php.

References dol_include_once(), and dol_syslog().

Referenced by ActionCommReminder\delete(), Asset\delete(), AssetModel\delete(), Availabilities\delete(), BOM\delete(), BOMLine\delete(), Calendar\delete(), CashControl\delete(), CompanyPaymentMode\delete(), ConferenceOrBoothAttendee\delete(), CTicketCategory\delete(), DefaultValues\delete(), EmailCollector\delete(), EmailCollectorAction\delete(), EmailCollectorFilter\delete(), EmailSenderProfile\delete(), Evaluation\delete(), EvaluationLine\delete(), ExpenseReportIk\delete(), ExpenseReportRule\delete(), Hook\delete(), IntracommReport\delete(), Inventory\delete(), InventoryLine\delete(), Job\delete(), KnowledgeRecord\delete(), Mo\delete(), MoLine\delete(), MouvementStock\delete(), MyObject\delete(), Partnership\delete(), PartnershipType\delete(), Position\delete(), ProductFournisseurPrice\delete(), RecruitmentCandidature\delete(), RecruitmentJobPosition\delete(), Salary\delete(), Skill\delete(), Skilldet\delete(), SkillRank\delete(), SocieteAccount\delete(), StockTransfer\delete(), StockTransferLine\delete(), Target\delete(), TimeSpent\delete(), UserGroup\delete(), Website\delete(), WebsitePage\delete(), and Workstation\delete().

◆ deleteEcmFiles()

CommonObject::deleteEcmFiles ( $mode = 0 )

Delete related files of object in database.

Parameters

integer $mode 0=Use path to find record, 1=Use src_object_xxx fields (Mode 1 is recommended for new objects)

Returns: bool True if OK, False if KO

Definition at line 11296 of file commonobject.class.php.

References $conf, and ref.

Referenced by Commande\delete(), CommandeFournisseur\delete(), Don\delete(), Expedition\delete(), ExpenseReport\delete(), Facture\delete(), FactureFournisseur\delete(), Fichinter\delete(), Product\delete(), Propal\delete(), and SupplierProposal\delete().

◆ deleteExtraFields()

CommonObject::deleteExtraFields ( )

Delete all extra fields values for the current object.

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

See also: deleteExtraLanguages(), insertExtraField(), updateExtraField(), setValueFrom()

Definition at line 6572 of file commonobject.class.php.

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

Referenced by Account\delete(), ActionComm\delete(), Adherent\delete(), Categorie\delete(), Commande\delete(), CommandeFournisseur\delete(), CommandeFournisseurLigne\delete(), Contact\delete(), Contrat\delete(), Dolresource\delete(), EcmFiles\delete(), Entrepot\delete(), Expedition\delete(), ExpeditionLigne\delete(), ExpenseReport\delete(), Facture\delete(), FactureFournisseur\delete(), FactureFournisseurLigneRec\delete(), FactureFournisseurRec\delete(), FactureLigne\delete(), FactureLigneRec\delete(), FactureRec\delete(), Fichinter\delete(), OrderLine\delete(), Product\delete(), Propal\delete(), PropaleLigne\delete(), ReceptionLineBatch\delete(), Societe\delete(), SupplierInvoiceLine\delete(), SupplierProposal\delete(), SupplierProposalLine\delete(), User\delete(), and FichinterLigne\deleteLine().

◆ deleteLineCommon()

CommonObject::deleteLineCommon	(	User	$user,
			$idline,
			$notrigger = 0 )

Delete a line of object in database.

Parameters

User	$user	User that delete
int	$idline	Id of line to delete
int	$notrigger	0=launch triggers after, 1=disable triggers

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

Definition at line 10949 of file commonobject.class.php.

References dol_syslog().

Referenced by Mo\cancelConsumedAndProducedLines(), Availabilities\deleteLine(), Calendar\deleteLine(), ConferenceOrBoothAttendee\deleteLine(), CTicketCategory\deleteLine(), Evaluation\deleteLine(), EvaluationLine\deleteLine(), Inventory\deleteLine(), Job\deleteLine(), KnowledgeRecord\deleteLine(), Mo\deleteLine(), MyObject\deleteLine(), Partnership\deleteLine(), Position\deleteLine(), RecruitmentCandidature\deleteLine(), RecruitmentJobPosition\deleteLine(), Skill\deleteLine(), Skilldet\deleteLine(), SkillRank\deleteLine(), StockTransfer\deleteLine(), StockTransferLine\deleteLine(), Target\deleteLine(), TimeSpent\deleteLine(), and Workstation\deleteLine().

◆ deleteObjectLinked()

CommonObject::deleteObjectLinked	(	$sourceid = null,
		$sourcetype = '',
		$targetid = null,
		$targettype = '',
		$rowid = 0,
		$f_user = null,
		$notrigger = 0 )

Delete all links between an object $this.

Parameters

?int	$sourceid	Object source id
string	$sourcetype	Object source type
?int	$targetid	Object target id
string	$targettype	Object target type
int	$rowid	Row id of line to delete. If defined, other parameters are not used.
?User	$f_user	User that create
	int<0,1>	$notrigger 1=Does not execute triggers, 0= execute triggers

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

See also: add_object_linked(), updateObjectLinked(), fetchObjectLinked()

Definition at line 4537 of file commonobject.class.php.

References $id, and dol_syslog().

Referenced by Expedition\cancel(), Commande\delete(), CommandeFournisseur\delete(), Contrat\delete(), Delivery\delete(), Expedition\delete(), ExpenseReport\delete(), Facture\delete(), FactureFournisseur\delete(), FactureFournisseurRec\delete(), FactureRec\delete(), Fichinter\delete(), Propal\delete(), Reception\delete(), SupplierInvoiceLine\delete(), SupplierProposal\delete(), and Asset\reopen().

◆ delThumbs()

CommonObject::delThumbs ( $file )

Delete thumbs.

Parameters

string $file Path file in UTF8 to original file to delete thumbs.

Returns: void

Definition at line 6142 of file commonobject.class.php.

References dol_delete_file(), and getImageFileNameForSize().

◆ deprecatedProperties()

CommonObject::deprecatedProperties ( )

protected

Provide list of deprecated properties and replacements.

Returns: array<string,string>

Reimplemented in Societe.

Definition at line 878 of file commonobject.class.php.

◆ emtpyObjectVars()

CommonObject::emtpyObjectVars ( )

Sets all object fields to null.

Useful for example in lists, when printing multiple lines and a different object os fetched for each line.

Returns: void

Definition at line 10247 of file commonobject.class.php.

◆ errorsToString()

CommonObject::errorsToString ( )

◆ fetch_barcode()

CommonObject::fetch_barcode ( )

Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.

Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.

Returns: int<-1,1> Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)

Deprecated: Use fetchBarCode()

Definition at line 1955 of file commonobject.class.php.

References fetchBarCode().

◆ fetch_contact()

CommonObject::fetch_contact ( $contactid = null )

Load object contact with id=$this->contact_id into $this->contact.

Parameters

?int $contactid Id du contact. Use this->contact_id if empty.

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 1851 of file commonobject.class.php.

◆ fetch_optionals()

CommonObject::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.

Parameters

int	$rowid	Id of line. Use the id of object if not defined. Deprecated. Function must be called without parameters.
	array{}\|array{label:array<string,string>,type:array<string,string>,size:array<string,string>,default:array<string,string>,computed:array<string,string>,unique:array<string,int>,required:array<string,int>,param:array<string,mixed>,perms:array<string,mixed[]>,list:array<string,int>\|array<string,string>,pos:array<string,int>,totalizable:array<string,int>,help:array<string,string>,printable:array<string,int>,enabled:array<string,int>,langfile:array<string,string>,css:array<string,string>,csslist:array<string,string>,hidden:array<string,int>,mandatoryfieldsofotherentities?:array<string,string>,loaded?:int,count:int}	$optionsArray Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters.

Returns: int<-1,1> Return integer <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded

See also: fetchValuesForExtraLanguages()

We are in a situation where the current object has no values in its extra fields. We want to initialize all the values to null so that the array_option is accessible in other contexts (especially in document generation).

Definition at line 6433 of file commonobject.class.php.

References $conf, $id, dol_eval(), dol_syslog(), and dolDecrypt().

Referenced by ActionComm\createFromClone(), Facture\createFromCurrent(), Account\fetch(), ActionComm\fetch(), Adherent\fetch(), AdherentType\fetch(), Categorie\fetch(), Commande\fetch(), CommandeFournisseur\fetch(), CommandeFournisseurLigne\fetch(), Contact\fetch(), Contrat\fetch(), ContratLigne\fetch(), Delivery\fetch(), Dolresource\fetch(), Don\fetch(), EcmDirectory\fetch(), EcmFiles\fetch(), Entrepot\fetch(), Expedition\fetch(), Facture\fetch(), FactureFournisseur\fetch(), FactureFournisseurRec\fetch(), FactureLigne\fetch(), FactureRec\fetch(), Fichinter\fetch(), FichinterLigne\fetch(), Holiday\fetch(), MouvementStock\fetch(), OrderLine\fetch(), Partnership\fetch(), Product\fetch(), ProductAttribute\fetch(), ProductAttributeValue\fetch(), Productlot\fetch(), ProductStockEntrepot\fetch(), Project\fetch(), Propal\fetch(), PropaleLigne\fetch(), Reception\fetch(), ReceptionLineBatch\fetch(), Salary\fetch(), Societe\fetch(), SupplierInvoiceLine\fetch(), SupplierProposal\fetch(), Task\fetch(), Ticket\fetch(), and User\fetch().

◆ fetch_origin()

CommonObject::fetch_origin ( )

Read linked origin object.

Set ->origin_object

Returns: void

Definition at line 2107 of file commonobject.class.php.

Referenced by Expedition\cancel(), Expedition\delete(), Reception\delete(), Expedition\generateDocument(), Reception\generateDocument(), Reception\getStatusDispatch(), and Reception\setDraft().

◆ fetch_product()

CommonObject::fetch_product ( )

Load the product with id $this->fk_product into this->product.

Returns: int<-1,1> Return integer <0 if KO, >=0 if OK

Definition at line 2066 of file commonobject.class.php.

Referenced by Productlot\checkSellOrEatByMandatory(), BOM\validate(), and Mo\validate().

◆ fetch_project()

CommonObject::fetch_project ( )

Load the project with id $this->fk_project into this->project.

Returns: int<-1,1> Return integer <0 if KO, >=0 if OK

Deprecated

See also: fetchProject()

Definition at line 2040 of file commonobject.class.php.

References fetchProject().

◆ fetch_projet()

CommonObject::fetch_projet ( )

Load the project with id $this->fk_project into this->project.

Returns: int Return integer <0 if KO, >=0 if OK

Deprecated

See also: fetchProject()

Reimplemented in ConferenceOrBoothAttendee.

Definition at line 2054 of file commonobject.class.php.

References fetchProject().

◆ fetch_thirdparty()

CommonObject::fetch_thirdparty ( $force_thirdparty_id = 0 )

Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty.

Parameters

int<0,1> $force_thirdparty_id Force thirdparty id

Returns: int<-1,1> Return integer <0 if KO, >0 if OK @phan-suppress PhanUndeclaredProperty

Reimplemented in Paiement, and PaiementFourn.

Definition at line 1877 of file commonobject.class.php.

References getDolGlobalString().

Referenced by Propal\create(), SupplierProposal\create(), Expedition\fetch(), Reception\fetch(), Commande\getTooltipContentArray(), CommandeFournisseur\getTooltipContentArray(), Contrat\getTooltipContentArray(), Expedition\getTooltipContentArray(), Propal\getTooltipContentArray(), CommonInvoice\is_erasable(), CommonInvoice\makeStripeSepaRequest(), Contrat\reopen(), ActionComm\sendEmailsReminder(), StockTransfer\update(), SupplierProposal\updateOrCreatePriceFournisseur(), Contrat\validate(), Facture\validate(), and FactureFournisseur\validate().

◆ fetch_user()

CommonObject::fetch_user ( $userid )

Load the user with id $userid into this->user.

Parameters

int $userid Id du contact

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 2091 of file commonobject.class.php.

References user.

◆ fetchBarCode()

CommonObject::fetchBarCode ( )

Load data for barcode into properties ->barcode_type* Properties ->barcode_type that is id of barcode.

Type is used to find other properties, but if it is not defined, ->element must be defined to know default barcode type.

Returns: int<-1,1> Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)

Definition at line 1968 of file commonobject.class.php.

References dol_print_error(), dol_syslog(), and getDolGlobalString().

Referenced by fetch_barcode().

◆ fetchComments()

CommonObject::fetchComments ( )

Load comments linked with current task.

Returns: int<0,max>|-1 Returns the number of comments if OK, -1 if error

Definition at line 11112 of file commonobject.class.php.

◆ fetchCommon()

CommonObject::fetchCommon	(	$id,
		$ref = null,
		$morewhere = '',
		$noextrafields = 0 )

Load object in memory from the database.

This does not load line. This is done by parent fetch() that call fetchCommon

Parameters

int	$id	Id object
?string	$ref	Ref
string	$morewhere	More SQL filters (' AND ...')
	int<0,1>	$noextrafields 0=Default to load extrafields, 1=No extrafields

Returns: int<-4,1> Return integer <0 if KO, 0 if not found, >0 if OK

Definition at line 10504 of file commonobject.class.php.

References $id.

Referenced by ActionCommReminder\fetch(), Asset\fetch(), AssetModel\fetch(), Availabilities\fetch(), BOM\fetch(), BOMLine\fetch(), Calendar\fetch(), CashControl\fetch(), CompanyPaymentMode\fetch(), ConferenceOrBoothAttendee\fetch(), CTicketCategory\fetch(), DefaultValues\fetch(), EmailCollector\fetch(), EmailCollectorAction\fetch(), EmailCollectorFilter\fetch(), EmailSenderProfile\fetch(), Evaluation\fetch(), EvaluationLine\fetch(), ExpenseReportIk\fetch(), ExpenseReportRule\fetch(), Hook\fetch(), IntracommReport\fetch(), Inventory\fetch(), InventoryLine\fetch(), Job\fetch(), KnowledgeRecord\fetch(), Mo\fetch(), MoLine\fetch(), MyObject\fetch(), PartnershipType\fetch(), Position\fetch(), ProductFournisseurPrice\fetch(), RecruitmentCandidature\fetch(), RecruitmentJobPosition\fetch(), Skill\fetch(), Skilldet\fetch(), SkillRank\fetch(), SocieteAccount\fetch(), StockTransfer\fetch(), StockTransferLine\fetch(), Target\fetch(), TimeSpent\fetch(), UserGroup\fetch(), Workstation\fetch(), AssetDepreciationOptions\fetchDeprecationOptions(), and setValueFrom().

◆ fetchLinesCommon()

CommonObject::fetchLinesCommon	(		$morewhere = '',
			$noextrafields = 0 )

Load object in memory from the database.

Parameters

string	$morewhere	More SQL filters (' AND ...'). No user coming from user input are allowed here. Only hard coded values.
	int<0,1>	$noextrafields 0=Default to load extrafields, 1=No extrafields

Returns: int<-1,1> Return integer <0 if KO, 0 if not found, >0 if OK

Definition at line 10568 of file commonobject.class.php.

Referenced by Availabilities\fetchLines(), BOM\fetchLines(), Calendar\fetchLines(), ConferenceOrBoothAttendee\fetchLines(), CTicketCategory\fetchLines(), Evaluation\fetchLines(), EvaluationLine\fetchLines(), Job\fetchLines(), KnowledgeRecord\fetchLines(), Mo\fetchLines(), MyObject\fetchLines(), Partnership\fetchLines(), Position\fetchLines(), RecruitmentCandidature\fetchLines(), RecruitmentJobPosition\fetchLines(), Skilldet\fetchLines(), SkillRank\fetchLines(), StockTransfer\fetchLines(), StockTransferLine\fetchLines(), Target\fetchLines(), and Workstation\fetchLines().

◆ fetchNoCompute()

CommonObject::fetchNoCompute ( $id )

Function to make a fetch but set environment to avoid to load computed values before.

Parameters

int $id ID of object

Returns: int<-1,1> >0 if OK, 0 if not found, <0 if KO

Definition at line 6409 of file commonobject.class.php.

References $conf, and $id.

◆ fetchObjectFrom()

CommonObject::fetchObjectFrom	(	$table,
		$field,
		$key,
		$element = null )

Load object from specific field.

Parameters

string	$table	Table element or element line
string	$field	Field selected
string	$key	Import key
string	$element	Element name

Returns: int<-1,1>|false Return -1 or false if KO, >0 if OK

Definition at line 2138 of file commonobject.class.php.

References $conf, and dol_syslog().

◆ fetchObjectLinked()

CommonObject::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).

Links are loaded into this->linkedObjectsIds array + this->linkedObjects array if $loadalsoobjects = 1 or $loadalsoobjects = type Possible usage for parameters:

all parameters empty -> we look all link to current object (current object can be source or target)
source id+type -> will get list of targets linked to source
target id+type -> will get list of sources linked to target
source id+type + target type -> will get list of targets of the type linked to source
target id+type + source type -> will get list of sources of the type linked to target

Parameters

?int	$sourceid	Object source id (if not defined, $this->id)
string	$sourcetype	Object source type (if not defined, $this->element)
?int	$targetid	Object target id (if not defined, $this->id)
string	$targettype	Object target type (if not defined, $this->element)
string	$clause	'OR' or 'AND' clause used when both source id and target id are provided
	int<0,1>	$alsosametype 0=Return only links to object that differs from source type. 1=Include also link to objects of same type.
string	$orderby	SQL 'ORDER BY' clause
	int<0,1>\|string	$loadalsoobjects Load also the array $this->linkedObjects. Use 0 to not load (increase performances), Use 1 to load all, Use value of type ('facture', 'facturerec', ...) to load only a type of object.

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

See also: add_object_linked(), updateObjectLinked(), deleteObjectLinked()

Definition at line 4293 of file commonobject.class.php.

References $id, $object, dol_include_once(), dol_print_error(), dol_syslog(), and getElementProperties().

Referenced by Expedition\cancel(), Facture\createFromCurrent(), CommandeFournisseur\delete(), Expedition\delete(), Delivery\getRemainingDelivered(), and Propal\InvoiceArrayList().

◆ fetchOneLike()

CommonObject::fetchOneLike ( $ref )

Looks for an object with ref matching the wildcard provided It does only work when $this->table_ref_field is set.

Parameters

string $ref Wildcard

Returns: int<-1,1> >1 = OK, 0 = Not found or table_ref_field not defined, <0 = KO

Definition at line 1918 of file commonobject.class.php.

References dol_syslog().

◆ fetchProject()

CommonObject::fetchProject ( )

Load the project with id $this->fk_project into this->project.

Returns: int<-1,1> Return integer <0 if KO, >=0 if OK

Definition at line 2012 of file commonobject.class.php.

Referenced by fetch_project(), fetch_projet(), Commande\getTooltipContentArray(), Contrat\getTooltipContentArray(), and Propal\getTooltipContentArray().

◆ fetchValuesForExtraLanguages()

CommonObject::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.

Returns: int<-1,1> Return integer <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded

See also: fetch_optionnals()

Definition at line 6257 of file commonobject.class.php.

References dol_print_error().

Referenced by WebPortalMember\getBannerAddressForWebPortal().

◆ formAddObjectLine()

CommonObject::formAddObjectLine	(	$dateSelector,
		$seller,
		$buyer,
		$defaulttpldir = '/core/tpl' )

Show add free and predefined products/services form.

Parameters

int	$dateSelector	1=Show also date range input fields
Societe	$seller	Object thirdparty who sell
?Societe	$buyer	Object thirdparty who buy
string	$defaulttpldir	Directory where to find the template

Returns: void

Reimplemented in ProductAttribute.

Definition at line 5198 of file commonobject.class.php.

References $conf, $object, and dol_buildpath().

◆ getAllItemsLinkedByObjectID()

static CommonObject::getAllItemsLinkedByObjectID	(	$fk_object_where,
		$field_select,
		$field_where,
		$table_element )

static

Function used to get an array with all items linked to an object id in association table.

Parameters

int	$fk_object_where	id of object we need to get linked items
string	$field_select	name of field we need to get a list
string	$field_where	name of field of object we need to get linked items
string	$table_element	name of association table

Returns: array|int Array of record, -1 if empty

Definition at line 4616 of file commonobject.class.php.

References dol_syslog().

◆ getCanvas()

CommonObject::getCanvas	(		$id = 0,
			$ref = '' )

Load type of canvas of an object if it exists.

Parameters

int	$id	Record id
string	$ref	Record ref

Returns: int Return integer <0 if KO, 0 if nothing done, >0 if OK

Definition at line 4836 of file commonobject.class.php.

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

◆ getCategoriesCommon()

CommonObject::getCategoriesCommon ( $type_categ )

Sets object to given categories.

Deletes object from existing categories not supplied. Adds it to non existing supplied categories. Existing categories are left untouch.

Parameters

string $type_categ Category type ('customer', 'supplier', 'website_page', ...)

Returns: int[]|int Array of category IDs or < 0 if KO

Definition at line 11167 of file commonobject.class.php.

◆ getChildrenOfLine()

CommonObject::getChildrenOfLine	(		$id,
			$includealltree = 0 )

Get children of line.

Parameters

int	$id	Id of parent line
	int<0,1001>	$includealltree 0 = 1st level child, 1 = All level child, 2-1001: internal use

Returns: int[] Array with list of children lines id

Definition at line 3416 of file commonobject.class.php.

References dol_syslog(), and getChildrenOfLine().

Referenced by getChildrenOfLine(), and line_order().

◆ getCountOfItemsLinkedByObjectID()

static CommonObject::getCountOfItemsLinkedByObjectID	(	$fk_object_where,
		$field_where,
		$table_element )

static

Count items linked to an object id in association table.

Parameters

int	$fk_object_where	id of object we need to get linked items
string	$field_where	name of field of object we need to get linked items
string	$table_element	name of association table

Returns: array|int Array of record, -1 if empty

Definition at line 4648 of file commonobject.class.php.

◆ getDataToShowPhoto()

CommonObject::getDataToShowPhoto	(		$modulepart,
			$imagesize )

Function used to get the logos or photos of an object.

Parameters

string	$modulepart	Module part
string	$imagesize	Image size ('', 'mini' or 'small')

Returns: array{dir:string,file:string,originalfile:string,altfile:string,email:string,capture:string} Array of data to show photo

Definition at line 9699 of file commonobject.class.php.

◆ getDefaultCreateValueFor()

CommonObject::getDefaultCreateValueFor	(	$fieldname,
		$alternatevalue = null,
		$type = 'alphanohtml' )

Return the default value to use for a field when showing the create form of object.

Return values in this order: 1) If parameter is available into POST, we return it first. 2) If not but an alternate value was provided as parameter of function, we return it. 3) If not but a constant $conf->global->OBJECTELEMENT_FIELDNAME is set, we return it (It is better to use the dedicated table). 4) Return value found into database (TODO No yet implemented)

Parameters

string	$fieldname	Name of field
string	$alternatevalue	Alternate value to use
string	$type	Type of data

Returns: string|string[] Default value (can be an array if the GETPOST return an array)

Definition at line 6168 of file commonobject.class.php.

References dol_syslog(), getDolGlobalString(), and GETPOST().

◆ getElementType()

CommonObject::getElementType ( )

Return an element type string formatted like element_element target_type and source_type.

Returns: string

Definition at line 4261 of file commonobject.class.php.

◆ getExtraField()

CommonObject::getExtraField ( $key )

Convenience method for retrieving the value of an extrafield without actually fetching it from the database.

Parameters

string $key Name of the extrafield

Returns: mixed|null

Definition at line 7387 of file commonobject.class.php.

◆ getFieldError()

CommonObject::getFieldError ( $fieldKey )

get field error message

Parameters

string $fieldKey Key of attribute

Returns: string Error message of validation ('' if no error)

Definition at line 8905 of file commonobject.class.php.

◆ getFieldList()

CommonObject::getFieldList	(		$alias = '',
			$excludefields = array() )

Function to concat keys of fields.

Parameters

string	$alias	String of alias of table for fields. For example 't'. It is recommended to use '' and set alias into fields definition.
string[]	$excludefields	Array of fields to exclude

Returns: string List of alias fields

Definition at line 10261 of file commonobject.class.php.

Referenced by Asset\fetchAll(), AssetModel\fetchAll(), Availabilities\fetchAll(), BOM\fetchAll(), BOMLine\fetchAll(), Calendar\fetchAll(), ConferenceOrBooth\fetchAll(), ConferenceOrBoothAttendee\fetchAll(), CTicketCategory\fetchAll(), DefaultValues\fetchAll(), Evaluation\fetchAll(), EvaluationLine\fetchAll(), Job\fetchAll(), KnowledgeRecord\fetchAll(), Mo\fetchAll(), MoLine\fetchAll(), MyObject\fetchAll(), Opensurveysondage\fetchAll(), Partnership\fetchAll(), PartnershipType\fetchAll(), Position\fetchAll(), ProductFournisseurPrice\fetchAll(), RecruitmentCandidature\fetchAll(), RecruitmentJobPosition\fetchAll(), Skill\fetchAll(), Skilldet\fetchAll(), SkillRank\fetchAll(), StockTransfer\fetchAll(), StockTransferLine\fetchAll(), Target\fetchAll(), TimeSpent\fetchAll(), and Workstation\fetchAll().

◆ getFormatedCustomerRef()

CommonObject::getFormatedCustomerRef ( $objref )

Return customer ref for screen output.

Parameters

string $objref Customer ref

Returns: string Customer ref formatted

Definition at line 1073 of file commonobject.class.php.

◆ getFormatedSupplierRef()

CommonObject::getFormatedSupplierRef ( $objref )

Return supplier ref for screen output.

Parameters

string $objref Supplier ref

Returns: string Supplier ref formatted

Definition at line 1092 of file commonobject.class.php.

◆ getFullAddress()

CommonObject::getFullAddress	(	$withcountry = 0,
		$sep = "\n",
		$withregion = 0,
		$extralangcode = '' )

Return full address of contact.

Parameters

	int<0,1>	$withcountry 1=Add country into address string
string	$sep	Separator to use to build string
	int<0,1>	$withregion 1=Add region into address string
string	$extralangcode	User extralanguages as value

Returns: string Full address string

Definition at line 1114 of file commonobject.class.php.

References dol_format_address(), getCountry(), and getState().

Referenced by Account\getBannerAddress(), and WebPortalMember\getBannerAddressForWebPortal().

◆ getIdContact()

CommonObject::getIdContact	(	$source,
		$code,
		$status = 0 )

Return id of contacts for a source and a contact code.

Example: contact client de facturation ('external', 'BILLING') Example: contact client de livraison ('external', 'SHIPPING') Example: contact interne suivi paiement ('internal', 'SALESREPFOLL')

Parameters

string	$source	'external' or 'internal'
string	$code	'BILLING', 'SHIPPING', 'SALESREPFOLL', ...
int	$status	limited to a certain status

Returns: int[]|null List of id for such contacts, or null if error

Definition at line 1785 of file commonobject.class.php.

References dol_syslog().

Referenced by Contrat\getIdBillingContact(), Facture\getIdBillingContact(), Contrat\getIdServiceContact(), and Facture\getIdShippingContact().

◆ getIdOfLine()

CommonObject::getIdOfLine ( $rang )

Get rowid of the line relative to its position.

Parameters

int $rang Rang value

Returns: int Rowid of the line

Definition at line 3628 of file commonobject.class.php.

◆ getJSListDependancies()

CommonObject::getJSListDependancies ( $type = '_extra' )

Parameters

string $type Type for prefix

Returns: string JavaScript code to manage dependency

Definition at line 9459 of file commonobject.class.php.

◆ getLastMainDocLink()

CommonObject::getLastMainDocLink	(	$modulepart,
		$initsharekey = 0,
		$relativelink = 0 )

Return the link of last main doc file for direct public download.

Parameters

string	$modulepart	Module related to document
int	$initsharekey	Init the share key if it was not yet defined
int	$relativelink	0=Return full external link, 1=Return link relative to root of file

Returns: string|-1 Returns the link, or an empty string if no link was found, or -1 if error.

Definition at line 1144 of file commonobject.class.php.

References getRandomPassword().

◆ getListContactId()

CommonObject::getListContactId ( $source = 'external' )

Return list of id of contacts of object.

Parameters

string $source Source of contact: external (llx_socpeople) or internal (llx_user) or thirdparty (llx_societe)

Returns: int[] Array of id of contacts (if source=external or internal) Array of id of third parties with at least one contact on object (if source=thirdparty)

Reimplemented in Task.

Definition at line 2553 of file commonobject.class.php.

References liste_contact().

◆ getNbComments()

CommonObject::getNbComments ( )

Return nb comments already posted.

Returns: int

Definition at line 11132 of file commonobject.class.php.

◆ getRangOfLine()

CommonObject::getRangOfLine ( $rowid )

Get position of line (rang)

Parameters

int $rowid Id of line

Returns: int Value of rang in table of lines

Definition at line 3602 of file commonobject.class.php.

References dol_syslog().

Referenced by line_down(), line_max(), and line_up().

◆ getRights()

CommonObject::getRights ( )

Returns the rights used for this class.

Returns: null|int|stdClass Object of permission for the module

Reimplemented in CommandeFournisseur, FactureFournisseur, and Product.

Definition at line 9535 of file commonobject.class.php.

◆ getSpecialCode()

CommonObject::getSpecialCode ( $lineid )

Get special code of a line.

Parameters

int $lineid Id of line

Returns: int Special code

Definition at line 4882 of file commonobject.class.php.

◆ getTooltipContent()

CommonObject::getTooltipContent ( $params )

getTooltipContent

Parameters

array<string,mixed> $params params

Since: v18

Returns: string

Definition at line 985 of file commonobject.class.php.

References dol_eval(), getDolGlobalInt(), and getTooltipContentArray().

◆ getTooltipContentArray()

CommonObject::getTooltipContentArray ( $params )

Return array of data to show into a tooltip.

This method must be implemented in each object class.

Since: v18

Parameters

array<string,mixed> $params params to construct tooltip data

Returns: array<string,string> Data to show in tooltip

Reimplemented in Account, ActionComm, Adherent, AdherentType, BOM, Calendar, Categorie, Commande, CommandeFournisseur, Contact, Contrat, ContratLigne, Cronjob, Delivery, Dolresource, EcmFiles, Entrepot, Expedition, ExpenseReport, Facture, FactureFournisseur, Fichinter, Fiscalyear, Holiday, KnowledgeRecord, Mailing, Mo, MyObject, Opensurveysondage, Partnership, PaymentSalary, Product, Productlot, Project, Propal, Salary, Societe, SocieteAccount, SupplierProposal, Task, Ticket, TimeSpent, User, UserGroup, WebPortalInvoice, WebPortalMember, WebPortalOrder, WebPortalPartnership, WebPortalPropal, and Workstation.

Definition at line 973 of file commonobject.class.php.

Referenced by IntracommReport\getNomUrl(), and getTooltipContent().

◆ getTotalDiscount()

CommonObject::getTotalDiscount ( )

Function that returns the total amount HT of discounts applied for all lines.

Returns: float|null Total amount of discount, or null if $table_element_line is empty

Definition at line 5022 of file commonobject.class.php.

References dol_syslog(), and price2num().

◆ getTotalWeightVolume()

CommonObject::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.

Returns: array{weight:int|float,volume:int|float,ordered:int|float,toship:int|float}|array{} array('weight'=>...,'volume'=>...)

Definition at line 5064 of file commonobject.class.php.

◆ getValueFrom()

CommonObject::getValueFrom	(	$table,
		$id,
		$field )

Getter generic.

Load value from a specific field

Parameters

string	$table	Table of element or element line
int	$id	Element id
string	$field	Field selected

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 2180 of file commonobject.class.php.

References dol_syslog().

◆ hasProductsOrServices()

CommonObject::hasProductsOrServices ( $predefined = -1 )

Function to say how many lines object contains.

Parameters

int $predefined -1=All, 0=Count free product/service only, 1=Count predefined product/service only, 2=Count predefined product, 3=Count predefined service

Returns: int Return integer <0 if KO, 0 if no predefined products, nb of lines with predefined products if found

Definition at line 4988 of file commonobject.class.php.

References dol_syslog().

◆ indexFile()

CommonObject::indexFile	(		$destfull,
			$update_main_doc_field )

Index a file into the ECM database.

Parameters

string	$destfull	Full path of file to index
int	$update_main_doc_field	Update field main_doc field into the table of the object. This param is set when called for a document generation if document generator hase ->update_main_doc_field set and returns ->result['fullpath'].

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

Definition at line 5990 of file commonobject.class.php.

References $conf, $id, dol_osencode(), dol_print_error(), getDolGlobalInt(), getRandomPassword(), and setEventMessages().

◆ initAsSpecimenCommon()

CommonObject::initAsSpecimenCommon ( )

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

Returns: int

Definition at line 11062 of file commonobject.class.php.

References dol_now().

Referenced by ActionCommReminder\initAsSpecimen(), Asset\initAsSpecimen(), AssetModel\initAsSpecimen(), Availabilities\initAsSpecimen(), BOM\initAsSpecimen(), BOMLine\initAsSpecimen(), Calendar\initAsSpecimen(), CompanyPaymentMode\initAsSpecimen(), ConferenceOrBooth\initAsSpecimen(), ConferenceOrBoothAttendee\initAsSpecimen(), CTicketCategory\initAsSpecimen(), DefaultValues\initAsSpecimen(), EmailCollector\initAsSpecimen(), EmailCollectorAction\initAsSpecimen(), EmailCollectorFilter\initAsSpecimen(), EmailSenderProfile\initAsSpecimen(), Evaluation\initAsSpecimen(), EvaluationLine\initAsSpecimen(), Hook\initAsSpecimen(), Inventory\initAsSpecimen(), Job\initAsSpecimen(), KnowledgeRecord\initAsSpecimen(), Mo\initAsSpecimen(), MyObject\initAsSpecimen(), Partnership\initAsSpecimen(), PartnershipType\initAsSpecimen(), Position\initAsSpecimen(), ProductFournisseurPrice\initAsSpecimen(), RecruitmentCandidature\initAsSpecimen(), RecruitmentJobPosition\initAsSpecimen(), Skill\initAsSpecimen(), Skilldet\initAsSpecimen(), SkillRank\initAsSpecimen(), SocieteAccount\initAsSpecimen(), StockTransfer\initAsSpecimen(), StockTransferLine\initAsSpecimen(), Target\initAsSpecimen(), TimeSpent\initAsSpecimen(), and Workstation\initAsSpecimen().

◆ insertExtraFields()

CommonObject::insertExtraFields	(		$trigger = '',
			$userused = null )

Add/Update all extra fields values for the current object.

Data to describe values to insert/update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) This function delete record with all extrafields and insert them again from the array $this->array_options.

Parameters

string	$trigger	If defined, call also the trigger (for example COMPANY_MODIFY)
User	$userused	Object user

Returns: int<-1,1> -1=error, O=did nothing, 1=OK

See also: insertExtraLanguages(), updateExtraField(), deleteExtraField(), setValueFrom()

Definition at line 6612 of file commonobject.class.php.

References $conf, $object, dol_eval(), dol_hash(), dol_include_once(), dol_syslog(), dolEncrypt(), getDolGlobalString(), ExtraFields\isEmptyValue(), and price2num().

Referenced by Account\create(), ActionComm\create(), Categorie\create(), Commande\create(), CommandeFournisseur\create(), Contrat\create(), Dolresource\create(), Don\create(), Entrepot\create(), Expedition\create(), ExpenseReport\create(), Facture\create(), FactureFournisseur\create(), FactureFournisseurRec\create(), FactureRec\create(), Fichinter\create(), Holiday\create(), ProductAttribute\create(), ProductAttributeValue\create(), Productlot\create(), Project\create(), Propal\create(), Reception\create(), ReceptionLineBatch\create(), Salary\create(), SupplierProposal\create(), Task\create(), Ticket\create(), ProductAttributeValue\delete(), CommandeFournisseurLigne\insert(), ContratLigne\insert(), ExpeditionLigne\insert(), FactureLigne\insert(), FichinterLigne\insert(), OrderLine\insert(), PropaleLigne\insert(), SupplierInvoiceLine\insert(), SupplierProposalLine\insert(), Account\update(), ActionComm\update(), Adherent\update(), AdherentType\update(), Categorie\update(), Commande\update(), CommandeFournisseur\update(), CommandeFournisseurLigne\update(), Contact\update(), Contrat\update(), ContratLigne\update(), Dolresource\update(), Don\update(), EcmFiles\update(), Entrepot\update(), Expedition\update(), ExpeditionLigne\update(), Facture\update(), FactureFournisseur\update(), FactureFournisseurLigneRec\update(), FactureFournisseurRec\update(), FactureLigne\update(), FactureLigneRec\update(), FactureRec\update(), Fichinter\update(), FichinterLigne\update(), Holiday\update(), OrderLine\update(), Product\update(), ProductAttribute\update(), Productlot\update(), Project\update(), Propal\update(), PropaleLigne\update(), ReceptionLineBatch\update(), Salary\update(), Societe\update(), SupplierInvoiceLine\update(), SupplierProposalLine\update(), Task\update(), and User\update().

◆ insertExtraLanguages()

CommonObject::insertExtraLanguages	(		$trigger = '',
			$userused = null )

Add/Update all extra fields values for the current object.

Data to describe values to insert/update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...) This function delete record with all extrafields and insert them again from the array $this->array_options.

Parameters

string	$trigger	If defined, call also the trigger (for example COMPANY_MODIFY)
User	$userused	Object user

Returns: int<-1,1> -1=error, O=did nothing, 1=OK

See also: insertExtraFields(), updateExtraField(), setValueFrom()

Definition at line 6963 of file commonobject.class.php.

References $conf, dol_syslog(), getDolGlobalString(), and price2num().

Referenced by Societe\update().

◆ isArray()

CommonObject::isArray ( $info )

protected

Function test if type is array.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if array

Definition at line 9958 of file commonobject.class.php.

◆ isDate()

CommonObject::isDate ( $info )

Function test if type is date.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if date

Definition at line 9976 of file commonobject.class.php.

◆ isDuration()

CommonObject::isDuration ( $info )

Function test if type is duration.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if field of type duration

Definition at line 9990 of file commonobject.class.php.

◆ isEmpty()

CommonObject::isEmpty ( )

isEmpty We consider CommonObject isEmpty if this->id is empty

Returns: bool

Definition at line 945 of file commonobject.class.php.

◆ isExistingObject()

static CommonObject::isExistingObject	(	$element,
		$id,
		$ref = '',
		$ref_ext = '' )

static

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.

Parameters

string	$element	String of element ('product', 'facture', ...)
int	$id	Id of object
string	$ref	Ref of object to check
string	$ref_ext	Ref ext of object to check

Returns: int Return integer <0 if KO, 0 if OK but not found, >0 if OK and exists

Definition at line 904 of file commonobject.class.php.

References $conf, and dol_syslog().

Referenced by Commande\create(), Fichinter\create(), Propal\create(), SupplierProposal\create(), FactureLigne\insert(), and SupplierInvoiceLine\insert().

◆ isFloat()

CommonObject::isFloat ( $info )

Function test if type is float.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if float

Definition at line 10028 of file commonobject.class.php.

◆ isForcedToNullIfZero()

CommonObject::isForcedToNullIfZero ( $info )

protected

Function test if field is forced to null if zero or empty.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool true if forced to null

Definition at line 10082 of file commonobject.class.php.

◆ isIndex()

CommonObject::isIndex ( $info )

protected

Function test if is indexed.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info content information of field

Returns: bool

Definition at line 10100 of file commonobject.class.php.

◆ isInt()

CommonObject::isInt ( $info )

Function test if type is integer.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info Properties of field

Returns: bool true if integer

Definition at line 10009 of file commonobject.class.php.

◆ isObjectUsed()

CommonObject::isObjectUsed	(		$id = 0,
			$entity = 0 )

Function to check if an object is used by others (by children).

Check is done into this->childtables. There is no check into llx_element_element.

Parameters

int	$id	Force id of object
int	$entity	Force entity to check

Returns: int Return integer <0 if KO, 0 if not used, >0 if already used

Definition at line 4903 of file commonobject.class.php.

References $id, and dol_print_error().

Referenced by Product\delete(), Societe\delete(), and Task\delete().

◆ isText()

CommonObject::isText ( $info )

Function test if type is text.

Parameters

array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string} $info Properties of field

Returns: bool true if type text

Definition at line 10046 of file commonobject.class.php.

◆ line_ajaxorder()

CommonObject::line_ajaxorder ( $rows )

Update position of line with ajax (rang)

Parameters

int[] $rows Array of rows

Returns: void

Definition at line 3526 of file commonobject.class.php.

References updateRangOfLine().

◆ line_down()

CommonObject::line_down	(		$rowid,
			$fk_parent_line = true )

Update a line to have a higher rank.

Parameters

int	$rowid	Id of line
boolean	$fk_parent_line	Table with fk_parent_line field or not

Returns: void

Definition at line 3474 of file commonobject.class.php.

References getRangOfLine(), line_max(), line_order(), and updateLineDown().

◆ line_max()

CommonObject::line_max ( $fk_parent_line = 0 )

Get max value used for position of line (rang)

Parameters

int $fk_parent_line Parent line id

Returns: int Max value of rang in table of lines

Definition at line 3654 of file commonobject.class.php.

References dol_syslog(), and getRangOfLine().

Referenced by BOM\addLine(), ProductAttribute\addLine(), Commande\addline(), CommandeFournisseur\addline(), Facture\addline(), FactureFournisseur\addline(), FactureRec\addline(), Propal\addline(), SupplierProposal\addline(), ExpeditionLigne\insert(), line_down(), Commande\updateline(), Facture\updateline(), Propal\updateline(), and SupplierProposal\updateline().

◆ line_order()

CommonObject::line_order	(	$renum = false,
		$rowidorder = 'ASC',
		$fk_parent_line = true )

Save a new position (field rang) for details lines.

You can choose to set position for lines with already a position or lines without any position defined.

Parameters

boolean	$renum	True to renum all already ordered lines, false to renum only not already ordered lines.
string	$rowidorder	ASC or DESC
boolean	$fk_parent_line	Table with fk_parent_line field or not

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

Definition at line 3330 of file commonobject.class.php.

References dol_print_error(), dol_syslog(), getChildrenOfLine(), getDolGlobalInt(), and updateRangOfLine().

Referenced by Commande\addline(), CommandeFournisseur\addline(), Facture\addline(), FactureFournisseur\addline(), Propal\addline(), SupplierProposal\addline(), StockTransfer\deleteLine(), line_down(), line_up(), Commande\updateline(), Facture\updateline(), Propal\updateline(), and SupplierProposal\updateline().

◆ line_up()

CommonObject::line_up	(		$rowid,
			$fk_parent_line = true )

Update a line to have a lower rank.

Parameters

int	$rowid	Id of line
boolean	$fk_parent_line	Table with fk_parent_line field or not

Returns: void

Definition at line 3454 of file commonobject.class.php.

References getRangOfLine(), line_order(), and updateLineUp().

◆ liste_contact()

CommonObject::liste_contact	(	$statusoflink = -1,
		$source = 'external',
		$list = 0,
		$code = '',
		$status = -1,
		$arrayoftcids = array() )

Get array of all contacts for an object.

Parameters

int	$statusoflink	Status of links to get (-1=all). Not used.
	'external'\|'thirdparty'\|'internal'	$source Source of contact: 'external' or 'thirdparty' (llx_socpeople) or 'internal' (llx_user)
	int<0,1>	$list 0:Returned array contains all properties, 1:Return array contains just id
string	$code	Filter on this code of contact type ('SHIPPING', 'BILLING', ...)
int	$status	Status of user or company
int[]	$arrayoftcids	Array with ID of type of contacts. If we provide this, we can filter on ec.fk_c_type_contact IN ($arrayoftcids) to avoid a link on c_type_contact table (faster).

Returns: array<int,array{parentId:int,source:string,socid:int,id:int,nom:string,civility:string,lastname:string,firstname:string,email:string,login:string,photo:string,gender:string,statuscontact:int,rowid:int,code:string,libelle:string,status:string,fk_c_type_contact:int}>|int<-1,-1> Array of contacts, -1 if error

Definition at line 1494 of file commonobject.class.php.

References dol_print_error(), and dol_syslog().

Referenced by add_contact(), getListContactId(), Task\getListContactId(), and Project\restrictedProjectArea().

◆ liste_type_contact()

CommonObject::liste_type_contact	(	$source = 'internal',
		$order = 'position',
		$option = 0,
		$activeonly = 0,
		$code = '' )

Return array with list of possible values for type of contacts.

Parameters

	'internal'\|'external'\|'all'	$source 'internal', 'external' or 'all'
string	$order	Sort order by : 'position', 'code', 'rowid'...
	int<0,1>	$option 0=Return array id->label, 1=Return array code->label, 2=Return complete array
	int<0,1>	$activeonly 0=all status of contact, 1=only the active
string	$code	Type of contact (Example: 'CUSTOMER', 'SERVICE')

Returns: array<int,string>|array<string,string>|array<int,array{id:int,code:string,label:string}>|null Array list of type of contacts (id->label if option=0, code->label if option=1), or null if error

Definition at line 1636 of file commonobject.class.php.

Referenced by delete_linked_contact().

◆ listeTypeContacts()

CommonObject::listeTypeContacts	(	$source = 'internal',
		$option = 0,
		$activeonly = 0,
		$code = '',
		$element = '',
		$excludeelement = '' )

Return array with list of possible values for type of contacts.

Parameters

string	$source	'internal', 'external' or 'all'
	int<0,1>	$option 0=Return array id->label, 1=Return array code->label
	int<0,1>	$activeonly 0=all status of contact, 1=only the active
string	$code	Type of contact (Example: 'CUSTOMER', 'SERVICE')
string	$element	Filter on 1 element type
string	$excludeelement	Exclude 1 element type. Example: 'agenda'

Returns: array<int,string>|array<string,string>|null Array list of type of contacts (id->label if option=0, code->label if option=1), or null if error

Definition at line 1703 of file commonobject.class.php.

References dol_syslog().

◆ load_previous_next_ref()

CommonObject::load_previous_next_ref	(	$filter,
		$fieldid,
		$nodbprefix = 0 )

Load properties id_previous and id_next by comparing $fieldid with $this->ref.

Parameters

string	$filter	Optional SQL filter. Use SQL or Universal Search Filter. Example: "(t.field1 = 'aa' OR t.field2 = 'bb')". Do not allow user input data here with this syntax. Example: "((t.field1:=:'aa') OR (t.field2:=:'bb'))".
string	$fieldid	Name of field to use for the select MAX and MIN
	int<0,1>	$nodbprefix Do not include DB prefix to forge table name

Returns: int<-2,1> Return integer <0 if KO, >0 if OK

Definition at line 2345 of file commonobject.class.php.

References $conf, dol_print_error(), forgeSQLFromUniversalSearchCriteria(), getDolGlobalInt(), getEntity(), and ref.

◆ printObjectLine()

CommonObject::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)

Parameters

string	$action	GET/POST action
CommonObjectLine	$line	Selected object line to output
	''	$var Not used
int	$num	Number of line (0)
int	$i	I
int	$dateSelector	1=Show also date range input fields
Societe	$seller	Object of seller third party
Societe	$buyer	Object of buyer third party
int	$selected	ID line selected
?ExtraFields	$extrafields	Object of extrafields
string	$defaulttpldir	Directory where to find the template (deprecated)

Returns: void

Reimplemented in ProductAttribute.

Definition at line 5345 of file commonobject.class.php.

References $conf, $object, dol_buildpath(), dol_htmlentitiesbr(), dol_print_error(), getDolGlobalInt(), getDolGlobalString(), GETPOST(), price2num(), and status.

◆ printObjectLines()

CommonObject::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.

Parameters

string	$action	Action code
Societe	$seller	Object of seller third party
?Societe	$buyer	Object of buyer third party
int	$selected	ID line selected
int	$dateSelector	1=Show also date range input fields
string	$defaulttpldir	Directory where to find the template

Returns: void

Definition at line 5250 of file commonobject.class.php.

References $conf, $object, and dol_buildpath().

◆ printOriginLine()

CommonObject::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).

If lines are into a template, titles 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.

Parameters

CommonObjectLine	$line	Line
string	$var	Not used
string	$restrictlist	''=All lines, 'services'=Restrict to services only (strike line if not)
string	$defaulttpldir	Directory where to find the template
int[]	$selectedLines	Array of lines id for selected lines

Returns: void

Reimplemented in Mo.

Definition at line 5531 of file commonobject.class.php.

References $conf, dol_buildpath(), dol_trunc(), get_date_range(), getDolGlobalInt(), img_object(), img_picto(), price(), Product\TYPE_SERVICE, and vatrate().

◆ printOriginLinesList()

CommonObject::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).

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, so we keep the method available on overloaded objects.

Parameters

	''\|'services'	$restrictlist ''=All lines, 'services'=Restrict to services only
int[]	$selectedLines	Array of lines id for selected lines

Returns: void

Reimplemented in Mo.

Definition at line 5476 of file commonobject.class.php.

References getDolGlobalInt().

◆ quote()

CommonObject::quote	(		$value,
			$fieldsentry )

protected

Add quote to field value if necessary.

Parameters

string \| int	$value	Value to protect
	array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}	$fieldsentry Properties of field

Returns: string|int

Definition at line 10287 of file commonobject.class.php.

References price2num().

◆ setBankAccount()

CommonObject::setBankAccount	(	$fk_account,
		$notrigger = 0,
		$userused = null )

Change the bank account.

Parameters

int	$fk_account	Id of bank account
int	$notrigger	0=launch triggers after, 1=disable triggers
User	$userused	Object user

Returns: int 1 if OK, 0 if KO

Definition at line 3261 of file commonobject.class.php.

References call_trigger(), and dol_syslog().

◆ setCategoriesCommon()

CommonObject::setCategoriesCommon	(	$categories,
		$type_categ = '',
		$remove_existing = true )

Sets object to given categories.

Adds it to non existing supplied categories. Deletes object from existing categories not supplied (if remove_existing==true). Existing categories are left untouch.

Parameters

int[] \| int	$categories	Category ID or array of Categories IDs
string	$type_categ	Category type ('customer', 'supplier', 'website_page', ...) defined into const class Categorie type
boolean	$remove_existing	True: Remove existings categories from Object if not supplies by $categories, False: let them

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

Definition at line 11190 of file commonobject.class.php.

References dol_syslog().

Referenced by WebsitePage\setCategories().

◆ setDeliveryAddress()

CommonObject::setDeliveryAddress ( $id )

Define delivery address.

Deprecated

Parameters

int $id Address id

Returns: int Return integer <0 si ko, >0 si ok

Definition at line 3108 of file commonobject.class.php.

References dol_syslog().

◆ setDocModel()

CommonObject::setDocModel	(		$user,
			$modelpdf )

Set last model used by doc generator.

Parameters

User	$user	User object that make change
string	$modelpdf	Modele name

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

Definition at line 3228 of file commonobject.class.php.

References dol_print_error(), dol_syslog(), and dol_trunc().

◆ setErrorsFromObject()

CommonObject::setErrorsFromObject ( $object )

setErrorsFromObject

Parameters

CommonObject $object commonobject

Returns: void

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

References $object.

◆ setExtraField()

CommonObject::setExtraField	(		$key,
			$value )

Convenience method for setting the value of an extrafield without actually updating it in the database.

Parameters

string	$key	Name of the extrafield
mixed	$value	Value to be assigned to the extrafield

Returns: void

Definition at line 7399 of file commonobject.class.php.

◆ setExtraParameters()

CommonObject::setExtraParameters ( )

Set extra parameters.

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

Definition at line 5160 of file commonobject.class.php.

References dol_syslog().

◆ setFieldError()

CommonObject::setFieldError	(		$fieldKey,
			$msg = '' )

set validation error message a field

Parameters

string	$fieldKey	Key of attribute
string	$msg	the field error message

Returns: void

Definition at line 8889 of file commonobject.class.php.

◆ setMulticurrencyCode()

CommonObject::setMulticurrencyCode ( $code )

Change the multicurrency code.

Parameters

string $code multicurrency code

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

Definition at line 2716 of file commonobject.class.php.

References dol_syslog(), MultiCurrency\getIdAndTxFromCode(), and status.

◆ setPaymentMethods()

CommonObject::setPaymentMethods ( $id )

Change the payments methods.

Parameters

int $id Id of new payment method

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

Definition at line 2649 of file commonobject.class.php.

References call_trigger(), dol_syslog(), and status.

Referenced by CommonInvoice\demande_prelevement(), and Salary\demande_prelevement().

◆ setPaymentTerms()

CommonObject::setPaymentTerms	(		$id,
			$deposit_percent = null )

Change the payments terms.

Parameters

int	$id	Id of new payment terms
float	$deposit_percent	% of deposit if needed by payment terms

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

Definition at line 2980 of file commonobject.class.php.

References dol_syslog(), getDictionaryValue(), and status.

◆ setProject()

CommonObject::setProject	(		$projectid,
			$notrigger = 0 )

Link element with a project.

Parameters

int	$projectid	Project id to link element to
	int<0,1>	$notrigger Disable the trigger

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 2578 of file commonobject.class.php.

References call_trigger(), dol_print_error(), and dol_syslog().

◆ setRetainedWarrantyPaymentTerms()

CommonObject::setRetainedWarrantyPaymentTerms ( $id )

Change the retained warranty payments terms.

Parameters

int $id Id of new payment terms

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

Definition at line 3076 of file commonobject.class.php.

References dol_syslog(), and status.

◆ setSaveQuery()

CommonObject::setSaveQuery ( )

protected

Function to return the array of data key-value from the ->fields and all the ->properties of an object.

Note: $this->${field} are set by the page that make the createCommon() or the updateCommon(). $this->${field} should be a clean and string value (so date are formatted for SQL insert).

Returns: array<string,null|int|float|string> Array with all values of each property to update

Definition at line 10121 of file commonobject.class.php.

References $conf.

◆ setShippingMethod()

CommonObject::setShippingMethod	(	$shipping_method_id,
		$notrigger = 0,
		$userused = null )

Change the shipping method.

Parameters

int	$shipping_method_id	Id of shipping method
int	$notrigger	0=launch triggers after, 1=disable triggers
User	$userused	Object user

Returns: int 1 if OK, 0 if KO

Definition at line 3137 of file commonobject.class.php.

References call_trigger(), and dol_syslog().

◆ setStatusCommon()

CommonObject::setStatusCommon	(	$user,
		$status,
		$notrigger = 0,
		$triggercode = '' )

Set to a status.

Parameters

User	$user	Object user that modify
int	$status	New status to set (often a constant like self\STATUS_XXX)
int	$notrigger	1=Does not execute triggers, 0=Execute triggers
string	$triggercode	Trigger code to use

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

Definition at line 11010 of file commonobject.class.php.

References status.

Referenced by AssetModel\cancel(), Availabilities\cancel(), BOM\cancel(), Calendar\cancel(), ConferenceOrBooth\cancel(), ConferenceOrBoothAttendee\cancel(), Evaluation\cancel(), EvaluationLine\cancel(), Job\cancel(), KnowledgeRecord\cancel(), Mo\cancel(), MyObject\cancel(), Partnership\cancel(), Position\cancel(), ProductFournisseurPrice\cancel(), RecruitmentCandidature\cancel(), RecruitmentJobPosition\cancel(), Skill\cancel(), Skilldet\cancel(), SkillRank\cancel(), StockTransfer\cancel(), StockTransferLine\cancel(), Target\cancel(), TimeSpent\cancel(), Asset\dispose(), Asset\reopen(), AssetModel\reopen(), Availabilities\reopen(), BOM\reopen(), Calendar\reopen(), ConferenceOrBooth\reopen(), ConferenceOrBoothAttendee\reopen(), Don\reopen(), Evaluation\reopen(), EvaluationLine\reopen(), Job\reopen(), KnowledgeRecord\reopen(), Mo\reopen(), MyObject\reopen(), Partnership\reopen(), Position\reopen(), ProductFournisseurPrice\reopen(), RecruitmentCandidature\reopen(), RecruitmentJobPosition\reopen(), Skill\reopen(), Skilldet\reopen(), SkillRank\reopen(), StockTransfer\reopen(), StockTransferLine\reopen(), Target\reopen(), TimeSpent\reopen(), Workstation\setDisabled(), AssetModel\setDraft(), Availabilities\setDraft(), BOM\setDraft(), Calendar\setDraft(), ConferenceOrBooth\setDraft(), ConferenceOrBoothAttendee\setDraft(), Evaluation\setDraft(), EvaluationLine\setDraft(), Expedition\setDraft(), Job\setDraft(), KnowledgeRecord\setDraft(), Mo\setDraft(), MyObject\setDraft(), Partnership\setDraft(), Position\setDraft(), ProductFournisseurPrice\setDraft(), RecruitmentCandidature\setDraft(), RecruitmentJobPosition\setDraft(), Skill\setDraft(), Skilldet\setDraft(), SkillRank\setDraft(), StockTransfer\setDraft(), StockTransferLine\setDraft(), Target\setDraft(), TimeSpent\setDraft(), and Workstation\setEnabled().

◆ setStatut()

CommonObject::setStatut	(	$status,
		$elementId = null,
		$elementType = '',
		$trigkey = '',
		$fieldstatus = 'fk_statut' )

Set status of an object.

Parameters

int	$status	Status to set
?int	$elementId	Id of element to force (use this->id by default if null)
string	$elementType	Type of element to force (use this->table_element by default)
string	$trigkey	Trigger key to use for trigger. Use '' means automatic but it is not recommended and is deprecated.
string	$fieldstatus	Name of status field in this->table_element

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

Definition at line 4705 of file commonobject.class.php.

References $id, dol_now(), dol_syslog(), and status.

Referenced by Delivery\create(), Inventory\setCanceled(), Inventory\setDraft(), Inventory\setRecorded(), Expedition\valid(), Reception\valid(), and Inventory\validate().

◆ setTransportMode()

CommonObject::setTransportMode ( $id )

Change the transport mode methods.

Parameters

int $id Id of transport mode

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

Definition at line 3035 of file commonobject.class.php.

References dol_syslog(), and status.

◆ setValueFrom()

CommonObject::setValueFrom	(	$field,
		$value,
		$table = '',
		$id = null,
		$format = '',
		$id_field = '',
		$fuser = null,
		$trigkey = '',
		$fk_user_field = 'fk_user_modif' )

Setter generic.

Update a specific field into database. Warning: Trigger is run only if param trigkey is provided.

Parameters

string	$field	Field to update
mixed	$value	New value
string	$table	To force other table element or element line (should not be used)
?int	$id	To force other object id (should not be used)
string	$format	Data format ('text', 'int', 'date'). 'text' is used if not defined
string	$id_field	To force rowid field name. 'rowid' is used if not defined
User \| string \| null	$fuser	Update the user of last update field with this user. If not provided, current user is used except if value is 'none'
string	$trigkey	Trigger key to run (in most cases something like 'XXX_MODIFY')
string	$fk_user_field	Name of field to save user id making change

Returns: int<-2,1> Return integer <0 if KO, >0 if OK

See also: updateExtraField()

Definition at line 2213 of file commonobject.class.php.

References call_trigger(), dol_syslog(), and fetchCommon().

Referenced by FactureRec\setNextDate(), and Societe\setThirdpartyType().

◆ setValuesForExtraLanguages()

CommonObject::setValuesForExtraLanguages ( $onlykey = '' )

Fill array_options property of object by extrafields value (using for data sent by forms)

Parameters

string $onlykey Only the following key is filled. When we make update of only one language field ($action = 'update_languages'), calling page must set this to avoid to have other languages being reset.

Returns: int<-1,1> 1 if array_options set, 0 if no value, -1 if error (field required missing for example)

Definition at line 6326 of file commonobject.class.php.

References dol_eval(), dol_mktime(), GETPOST(), GETPOSTINT(), and price2num().

◆ setVarsFromFetchObj()

CommonObject::setVarsFromFetchObj ( & $obj )

Function to load data from a SQL pointer into properties of current object $this.

Parameters

stdClass $obj Contain data of object from database

Returns: void

Definition at line 10189 of file commonobject.class.php.

References ref.

◆ setWarehouse()

CommonObject::setWarehouse ( $warehouse_id )

Change the warehouse.

Parameters

int $warehouse_id Id of warehouse

Returns: int 1 if OK, 0 if KO

Definition at line 3195 of file commonobject.class.php.

References dol_syslog().

◆ show_photos()

CommonObject::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.

Parameters

string	$modulepart	'product', 'ticket', ...
string	$sdir	Directory to scan (full absolute path)
	int<0,1>\|''\|'small'	$size 0 or ''=original size, 1 or 'small'=use thumbnail if possible
int	$nbmax	Nombre maximum de photos (0=pas de max)
int	$nbbyrow	Number of image per line or -1 to use div separator or 0 to use no separator. Used only if size=1 or 'small'.
int	$showfilename	1=Show filename
int	$showaction	1=Show icon with action links (resize, delete)
int	$maxHeight	Max height of original image when size='small' (so we can use original even if small requested). If 0, always use 'small' thumb image.
int	$maxWidth	Max width of original image when size='small'
int	$nolink	Do not add a href link to view enlarged imaged into a new tab
int \| string	$overwritetitle	Do not add title tag on image
int	$usesharelink	Use the public shared link of image (if not available, the 'nophoto' image will be shown instead)
string	$cache	A string if we want to use a cached version of image
string	$addphotorefcss	Add CSS to img of photos

Returns: string Html code to show photo. Number of photos shown is saved in this->nbphoto

Definition at line 9726 of file commonobject.class.php.

References completeFileArrayWithDatabaseInfo(), dol_dir_list(), dol_escape_htmltag(), dol_getImageSize(), dol_is_file(), dol_sort_array(), get_exdir(), getAdvancedPreviewUrl(), getDolGlobalInt(), getImageFileNameForSize(), image_format_supported(), img_delete(), img_picto(), and newToken().

Referenced by Product\getKanbanView(), ProductFournisseur\getNomUrl(), and Product\getTooltipContentArray().

◆ showInputField()

CommonObject::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.

Parameters

	?array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}	$val Array of properties for field to show (used only if ->fields not defined) Array of properties of field to show
string	$key	Key of attribute
string \| string[]	$value	Preselected value to show (for date type it must be in timestamp format, for amount or price it must be a php numeric value, for array type must be array)
string	$moreparam	To add more parameters on html input tag
string	$keysuffix	Suffix string to add into name and id of field (can be used to avoid duplicate names)
string	$keyprefix	Prefix string to add into name and id of field (can be used to avoid duplicate names)
string \| int	$morecss	Value for css to define style/length of field. May also be a numeric.
	int<0,1>	$nonewbutton Force to not show the new button on field that are links to object

Returns: string

Reimplemented in Position.

Definition at line 7447 of file commonobject.class.php.

References $conf, $id, ajax_combobox(), dol_escape_htmltag(), dol_syslog(), dol_trunc(), forgeSQLFromUniversalSearchCriteria(), getDolGlobalInt(), getDolGlobalString(), img_picto(), and price().

◆ showOptionals()

CommonObject::showOptionals	(	$extrafields,
		$mode = 'view',
		$params = null,
		$keysuffix = '',
		$keyprefix = '',
		$onetrtd = '',
		$display_type = 'card' )

Function to show lines of extrafields with output data.

This function is responsible to output the

and

according to correct number of columns received into $params['colspan'] or

according to $display_type

Parameters

ExtraFields	$extrafields	Extrafield Object
string	$mode	Show output ('view') or input ('create' or 'edit') for extrafield
	array<string,mixed>	$params Optional parameters. Example: array('style'=>'class="oddeven"', 'colspan'=>$colspan)
string	$keysuffix	Suffix string to add after name and id of field (can be used to avoid duplicate names)
string	$keyprefix	Prefix string to add before name and id of field (can be used to avoid duplicate names)
string	$onetrtd	All fields in same tr td. Used by objectline_create.tpl.php for example.
string	$display_type	"card" for form display, "line" for document line display (extrafields on propal line, order line, etc...)

Returns: string String with html content to show

Definition at line 9138 of file commonobject.class.php.

References $conf, $id, dol_eval(), dol_mktime(), dol_syslog(), getDolGlobalString(), getPictoForType(), GETPOST(), GETPOSTINT(), and price2num().

◆ swapContactStatus()

CommonObject::swapContactStatus ( $rowid )

Update status of a contact linked to object.

Parameters

int $rowid Id of link between object and contact

Returns: int Return integer <0 if KO, >=0 if OK

Definition at line 1601 of file commonobject.class.php.

References dol_print_error(), dol_syslog(), and update_contact().

◆ trimParameters()

CommonObject::trimParameters ( $parameters )

Trim object parameters.

Parameters

string[] $parameters array of parameters to trim

Returns: void

Definition at line 11143 of file commonobject.class.php.

◆ update_contact()

CommonObject::update_contact	(	$rowid,
		$statut,
		$type_contact_id = 0,
		$fk_socpeople = 0 )

Update a link to contact line.

Parameters

int	$rowid	Id of line contact-element
int	$statut	New status of link
int	$type_contact_id	Id of contact type (not modified if 0)
int	$fk_socpeople	Id of soc_people to update (not modified if 0)

Returns: int Return integer <0 if KO, >= 0 if OK

Definition at line 1368 of file commonobject.class.php.

Referenced by swapContactStatus().

◆ update_note()

CommonObject::update_note	(	$note,
		$suffix = '',
		$notrigger = 0 )

Update note of element.

Parameters

string	$note	New value for note
string	$suffix	'', '_public' or '_private'
int	$notrigger	1=Does not execute triggers, 0=execute triggers

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

Definition at line 3733 of file commonobject.class.php.

References call_trigger(), and dol_syslog().

Referenced by update_note_public().

◆ update_note_public()

CommonObject::update_note_public ( $note )

Update public note (kept for backward compatibility)

Parameters

string $note New value for note

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

Deprecated

See also: update_note()

Definition at line 3821 of file commonobject.class.php.

References update_note().

◆ update_price()

CommonObject::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).

Must be called at end of methods addline or updateline.

Parameters

int	$exclspec	>0 = Exclude special product (product_type=9)
	'none'\|'auto'\|'0'\|'1'	$roundingadjust 'none'=Do nothing, 'auto'=Use default method (MAIN_ROUNDOFTOTAL_NOT_TOTALOFROUND if defined, or '0'), '0'=Force mode Total of rounding, '1'=Force mode Rounding of total
	int<0,1>	$nodatabaseupdate 1=Do not update database total fields of the main object. Update only properties in memory. Can be used to save SQL when this method is called several times, so we can do it only once at end.
?Societe	$seller	If roundingadjust is '0' or '1' or maybe 'auto', it means we recalculate total for lines before calculating total for object and for this, we need seller object (used to analyze lines to check corrupted data).

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 3838 of file commonobject.class.php.

References $conf, and getDolGlobalString().

Referenced by Commande\addline(), CommandeFournisseur\addline(), ExpenseReport\addline(), Facture\addline(), FactureFournisseur\addline(), FactureFournisseurRec\addline(), FactureRec\addline(), Propal\addline(), SupplierProposal\addline(), Commande\create(), ExpenseReport\create(), Facture\create(), FactureFournisseur\create(), Propal\create(), SupplierProposal\create(), Commande\deleteLine(), CommandeFournisseur\deleteLine(), Delivery\deleteLine(), ExpenseReport\deleteLine(), Facture\deleteLine(), FactureFournisseur\deleteLine(), Propal\deleteLine(), SupplierProposal\deleteLine(), Commande\insert_discount(), Facture\insert_discount(), FactureFournisseur\insert_discount(), Propal\insert_discount(), SupplierProposal\insert_discount(), Commande\setDiscount(), Facture\setDiscount(), Facture\update_percent(), CommandeFournisseur\updateFromCommandeClient(), Commande\updateline(), CommandeFournisseur\updateline(), Facture\updateline(), FactureFournisseur\updateline(), FactureFournisseurRec\updateline(), FactureRec\updateline(), Propal\updateline(), SupplierProposal\updateline(), and Facture\validate().

◆ update_ref_ext()

CommonObject::update_ref_ext ( $ref_ext )

Update external ref of element.

Parameters

string $ref_ext Update field ref_ext

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

Definition at line 3701 of file commonobject.class.php.

References dol_syslog().

◆ updateCommon()

CommonObject::updateCommon	(	User	$user,
			$notrigger = 0 )

Update object into database.

Parameters

User	$user	User that modifies
	int<0,1>	$notrigger 0=launch triggers after, 1=disable triggers

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 10627 of file commonobject.class.php.

References $id, dol_now(), dol_string_nospecial(), and dol_syslog().

Referenced by ActionCommReminder\update(), Asset\update(), AssetModel\update(), Availabilities\update(), BOM\update(), BOMLine\update(), BonPrelevement\update(), Calendar\update(), CashControl\update(), CompanyPaymentMode\update(), ConferenceOrBoothAttendee\update(), CTicketCategory\update(), DefaultValues\update(), EmailCollector\update(), EmailCollectorAction\update(), EmailCollectorFilter\update(), EmailSenderProfile\update(), Evaluation\update(), EvaluationLine\update(), ExpenseReportIk\update(), ExpenseReportRule\update(), Hook\update(), Inventory\update(), InventoryLine\update(), Job\update(), KnowledgeRecord\update(), Mo\update(), MoLine\update(), MyObject\update(), Partnership\update(), PartnershipType\update(), Position\update(), ProductFournisseurPrice\update(), RecruitmentCandidature\update(), RecruitmentJobPosition\update(), Skill\update(), Skilldet\update(), SkillRank\update(), SocieteAccount\update(), StockTransfer\update(), StockTransferLine\update(), Target\update(), TimeSpent\update(), UserGroup\update(), WebsitePage\update(), and Workstation\update().

◆ updateExtraField()

CommonObject::updateExtraField	(	$key,
		$trigger = null,
		$userused = null )

Update 1 extra field value for the current object.

Keep other fields unchanged. Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)

Parameters

string	$key	Key of the extrafield to update (without starting 'options_')
string	$trigger	If defined, call also the trigger (for example COMPANY_MODIFY)
User	$userused	Object user

Returns: int<-1,1> -1=error, O=did nothing, 1=OK

See also: updateExtraLanguages(), insertExtraFields(), deleteExtraFields(), setValueFrom()

Definition at line 7081 of file commonobject.class.php.

References $conf, dol_eval(), dol_hash(), dol_syslog(), dolEncrypt(), getDolGlobalString(), price2num(), and setEventMessages().

◆ updateExtraLanguages()

CommonObject::updateExtraLanguages	(	$key,
		$trigger = null,
		$userused = null )

Update an extra language value for the current object.

Data to describe values to update are stored into $this->array_options=array('options_codeforfield1'=>'valueforfield1', 'options_codeforfield2'=>'valueforfield2', ...)

Parameters

string	$key	Key of the extrafield (without starting 'options_')
string	$trigger	If defined, call also the trigger (for example COMPANY_MODIFY)
User	$userused	Object user

Returns: int -1=error, O=did nothing, 1=OK

See also: updateExtraField(), insertExtraLanguages()

Definition at line 7414 of file commonobject.class.php.

References $conf, and getDolGlobalString().

◆ updateLineDown()

CommonObject::updateLineDown	(	$rowid,
		$rang,
		$max )

Update position of line down (rang)

Parameters

int	$rowid	Id of line
int	$rang	Position
int	$max	Max

Returns: void

Definition at line 3573 of file commonobject.class.php.

References dol_print_error().

Referenced by line_down().

◆ updateLineUp()

CommonObject::updateLineUp	(		$rowid,
			$rang )

Update position of line up (rang)

Parameters

int	$rowid	Id of line
int	$rang	Position

Returns: void

Definition at line 3542 of file commonobject.class.php.

References dol_print_error().

Referenced by line_up().

◆ updateObjectLinked()

CommonObject::updateObjectLinked	(	$sourceid = null,
		$sourcetype = '',
		$targetid = null,
		$targettype = '',
		$f_user = null,
		$notrigger = 0 )

Update object linked of a current object.

Parameters

int	$sourceid	Object source id
string	$sourcetype	Object source type
int	$targetid	Object target id
string	$targettype	Object target type
User	$f_user	User that create
int	$notrigger	1=Does not execute triggers, 0= execute triggers

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

See also: add_object_linked(), fetObjectLinked(), deleteObjectLinked()

Definition at line 4467 of file commonobject.class.php.

References dol_syslog().

◆ updateRangOfLine()

CommonObject::updateRangOfLine	(		$rowid,
			$rang )

Update position of line (rang)

Parameters

int	$rowid	Id of line
int	$rang	Position

Returns: int<-1,1> Return integer <0 if KO, >0 if OK

Definition at line 3496 of file commonobject.class.php.

References dol_print_error(), and dol_syslog().

Referenced by Commande\addline(), CommandeFournisseur\addline(), Facture\addline(), FactureFournisseur\addline(), Propal\addline(), SupplierProposal\addline(), Facture\insert_discount(), FactureFournisseur\insert_discount(), line_ajaxorder(), and line_order().

◆ validateField()

CommonObject::validateField	(	$fields,
		$fieldKey,
		$fieldValue )

Return validation test result for a field.

Parameters

	array<string,array{type:string,label:string,enabled:int<0,2>\|string,position:int,notnull?:int,visible:int<-2,5>\|string,noteditable?:int<0,1>,default?:string,index?:int,foreignkey?:string,searchall?:int<0,1>,isameasure?:int<0,1>,css?:string,csslist?:string,help?:string,showoncombobox?:int<0,2>,disabled?:int<0,1>,arrayofkeyval?:array<int\|string,string>,comment?:string,validate?:int<0,1>}>	$fields Array of properties of field to show
string	$fieldKey	Key of attribute
string	$fieldValue	Value of attribute

Returns: bool Return false if fail true on success, see $this->error for error message

Reimplemented in MyObject, and Productlot.

Definition at line 8921 of file commonobject.class.php.

Referenced by AssetDepreciationOptions\setDeprecationOptionsFromPost().

Member Data Documentation

◆ $origin_object

CommonObject::$origin_object

See also: fetch_origin()

Definition at line 287 of file commonobject.class.php.

Referenced by Expedition\cancel(), Expedition\delete(), Reception\delete(), and Reception\getStatusDispatch().

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

dolibarr_dev/htdocs/core/class/commonobject.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ __clone()

◆ add_contact()

◆ add_element_resource()

◆ add_object_linked()

◆ addThumbs()

◆ call_trigger()

◆ canBeNull()

◆ clearFieldError()

◆ clearObjectLinkedCache()

◆ cloneCategories()

◆ commonGenerateDocument()

◆ commonReplaceProduct()

◆ commonReplaceThirdparty()

◆ copy_linked_contact()

◆ createCommon()

◆ defineBuyPrice()

◆ delete_contact()

◆ delete_linked_contact()

◆ delete_resource()

◆ deleteAllItemsLinkedByObjectID()

◆ deleteByParentField()

◆ deleteCommon()

◆ deleteEcmFiles()

◆ deleteExtraFields()

◆ deleteLineCommon()

◆ deleteObjectLinked()

◆ delThumbs()

◆ deprecatedProperties()

◆ emtpyObjectVars()

◆ errorsToString()

◆ fetch_barcode()

◆ fetch_contact()

◆ fetch_optionals()

◆ fetch_origin()

◆ fetch_product()

◆ fetch_project()

◆ fetch_projet()

◆ fetch_thirdparty()

◆ fetch_user()

◆ fetchBarCode()

◆ fetchComments()

◆ fetchCommon()

◆ fetchLinesCommon()

◆ fetchNoCompute()

◆ fetchObjectFrom()

◆ fetchObjectLinked()

◆ fetchOneLike()

◆ fetchProject()

◆ fetchValuesForExtraLanguages()

◆ formAddObjectLine()

◆ getAllItemsLinkedByObjectID()

◆ getCanvas()

◆ getCategoriesCommon()

◆ getChildrenOfLine()

◆ getCountOfItemsLinkedByObjectID()

◆ getDataToShowPhoto()

◆ getDefaultCreateValueFor()

◆ getElementType()

◆ getExtraField()

◆ getFieldError()

◆ getFieldList()

◆ getFormatedCustomerRef()

◆ getFormatedSupplierRef()

◆ getFullAddress()

◆ getIdContact()

◆ getIdOfLine()

◆ getJSListDependancies()

◆ getLastMainDocLink()

◆ getListContactId()

◆ getNbComments()

◆ getRangOfLine()

◆ getRights()

◆ getSpecialCode()

◆ getTooltipContent()