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

Inheritance diagram for CommonObject:

Public Member Functions
	errorsToString ()
	Method to output saved errors. More...

	getFormatedCustomerRef ($objref)
	Return customer ref for screen output. More...

	getFormatedSupplierRef ($objref)
	Return supplier ref for screen output. More...

	getFullName ($langs, $option=0, $nameorder=-1, $maxlen=0)
	Return full name (civility+' '+name+' '+lastname) More...

	setUpperOrLowerCase ()
	Set to upper or ucwords/lower if needed. More...

	getKanbanView ($option= '')
	Return clicable link of object (with eventually picto) More...

	getFullAddress ($withcountry=0, $sep="\n", $withregion=0, $extralangcode= '')
	Return full address of contact. More...

	getBannerAddress ($htmlkey, $object)
	Return full address for banner. More...

	getLastMainDocLink ($modulepart, $initsharekey=0, $relativelink=0)
	Return the link of last main doc file for direct public download. More...

	add_contact ($fk_socpeople, $type_contact, $source= 'external', $notrigger=0)
	Add a link between element $this->element and a contact. More...

	copy_linked_contact ($objFrom, $source= 'internal')
	Copy contact from one element to current. More...

	update_contact ($rowid, $statut, $type_contact_id=0, $fk_socpeople=0)
	Update a link to contact line. More...

	delete_contact ($rowid, $notrigger=0)
	Delete a link to contact line. More...

	delete_linked_contact ($source= '', $code= '')
	Delete all links between an object $this and all its contacts. More...

	liste_contact ($status=-1, $source= 'external', $list=0, $code= '')
	Get array of all contacts for an object. More...

	swapContactStatus ($rowid)
	Update status of a contact linked to object. More...

	liste_type_contact ($source= 'internal', $order= 'position', $option=0, $activeonly=0, $code= '')
	Return array with list of possible values for type of contacts. More...

	listeTypeContacts ($source= 'internal', $option=0, $activeonly=0, $code= '', $element= '', $excludeelement= '')
	Return array with list of possible values for type of contacts. More...

	getIdContact ($source, $code, $status=0)
	Return id of contacts for a source and a contact code. More...

	fetch_contact ($contactid=null)
	Load object contact with id=$this->contact_id into $this->contact. More...

	fetch_thirdparty ($force_thirdparty_id=0)
	Load the third party of object, from id $this->socid or $this->fk_soc, into this->thirdparty. More...

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

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

	fetch_projet ()
	Load the project with id $this->fk_project into this->project. More...

	fetch_product ()
	Load the product with id $this->fk_product into this->product. More...

	fetch_user ($userid)
	Load the user with id $userid into this->user. More...

	fetch_origin ()
	Read linked origin object. More...

	fetchObjectFrom ($table, $field, $key, $element=null)
	Load object from specific field. More...

	getValueFrom ($table, $id, $field)
	Getter generic. More...

	setValueFrom ($field, $value, $table= '', $id=null, $format= '', $id_field= '', $fuser=null, $trigkey= '', $fk_user_field= 'fk_user_modif')
	Setter generic. More...

	load_previous_next_ref ($filter, $fieldid, $nodbprefix=0)
	Load properties id_previous and id_next by comparing $fieldid with $this->ref. More...

	getListContactId ($source= 'external')
	Return list of id of contacts of object. More...

	setProject ($projectid)
	Link element with a project. More...

	setPaymentMethods ($id)
	Change the payments methods. More...

	setMulticurrencyCode ($code)
	Change the multicurrency code. More...

	setMulticurrencyRate ($rate, $mode=1)
	Change the multicurrency rate. More...

	setPaymentTerms ($id)
	Change the payments terms. More...

	setTransportMode ($id)
	Change the transport mode methods. More...

	setRetainedWarrantyPaymentTerms ($id)
	Change the retained warranty payments terms. More...

	setDeliveryAddress ($id)
	Define delivery address. More...

	setShippingMethod ($shipping_method_id, $notrigger=false, $userused=null)
	Change the shipping method. More...

	setWarehouse ($warehouse_id)
	Change the warehouse. More...

	setDocModel ($user, $modelpdf)
	Set last model used by doc generator. More...

	setBankAccount ($fk_account, $notrigger=false, $userused=null)
	Change the bank account. More...

	line_order ($renum=false, $rowidorder= 'ASC', $fk_parent_line=true)
	Save a new position (field rang) for details lines. More...

	getChildrenOfLine ($id, $includealltree=0)
	Get children of line. More...

	line_up ($rowid, $fk_parent_line=true)
	Update a line to have a lower rank. More...

	line_down ($rowid, $fk_parent_line=true)
	Update a line to have a higher rank. More...

	updateRangOfLine ($rowid, $rang)
	Update position of line (rang) More...

	line_ajaxorder ($rows)
	Update position of line with ajax (rang) More...

	updateLineUp ($rowid, $rang)
	Update position of line up (rang) More...

	updateLineDown ($rowid, $rang, $max)
	Update position of line down (rang) More...

	getRangOfLine ($rowid)
	Get position of line (rang) More...

	getIdOfLine ($rang)
	Get rowid of the line relative to its position. More...

	line_max ($fk_parent_line=0)
	Get max value used for position of line (rang) More...

	update_ref_ext ($ref_ext)
	Update external ref of element. More...

	update_note ($note, $suffix= '')
	Update note of element. More...

	update_note_public ($note)
	Update public note (kept for backward compatibility) More...

	update_price ($exclspec=0, $roundingadjust= 'none', $nodatabaseupdate=0, $seller=null)
	Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines). More...

	add_object_linked ($origin=null, $origin_id=null)
	Add objects linked in llx_element_element. More...

	fetchObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $clause= 'OR', $alsosametype=1, $orderby= 'sourcetype', $loadalsoobjects=1)
	Fetch array of objects linked to current object (object of enabled modules only). More...

	updateObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '')
	Update object linked of a current object. More...

	deleteObjectLinked ($sourceid=null, $sourcetype= '', $targetid=null, $targettype= '', $rowid= '')
	Delete all links between an object $this. More...

	setStatut ($status, $elementId=null, $elementType= '', $trigkey= '')
	Set status of an object. More...

	getCanvas ($id=0, $ref= '')
	Load type of canvas of an object if it exists. More...

	getSpecialCode ($lineid)
	Get special code of a line. More...

	isObjectUsed ($id=0)
	Function to check if an object is used by others. More...

	hasProductsOrServices ($predefined=-1)
	Function to say how many lines object contains. More...

	getTotalDiscount ()
	Function that returns the total amount HT of discounts applied for all lines. More...

	getTotalWeightVolume ()
	Return into unit=0, the calculated total of weight and volume of all lines * qty Calculate by adding weight and volume of each product line, so properties ->volume/volume_units/weight/weight_units must be loaded on line. More...

	setExtraParameters ()
	Set extra parameters. More...

	formAddObjectLine ($dateSelector, $seller, $buyer, $defaulttpldir= '/core/tpl')
	Show add free and predefined products/services form. More...

	printObjectLines ($action, $seller, $buyer, $selected=0, $dateSelector=0, $defaulttpldir= '/core/tpl')
	Return HTML table for object lines TODO Move this into an output class file (htmlline.class.php) If lines are into a template, title must also be into a template But for the moment we don't know if it's possible as we keep a method available on overloaded objects. More...

	printObjectLine ($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected=0, $extrafields=null, $defaulttpldir= '/core/tpl')
	Return HTML content of a detail line TODO Move this into an output class file (htmlline.class.php) More...

	printOriginLinesList ($restrictlist= '', $selectedLines=array())
	Return HTML table table of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...

	printOriginLine ($line, $var, $restrictlist= '', $defaulttpldir= '/core/tpl', $selectedLines=array())
	Return HTML with a line of table array of source object lines TODO Move this and previous function into output html class file (htmlline.class.php). More...

	add_element_resource ($resource_id, $resource_type, $busy=0, $mandatory=0)
	Add resources to the current object : add entry into llx_element_resources Need $this->element & $this->id. More...

	delete_resource ($rowid, $element, $notrigger=0)
	Delete a link to resource line. More...

	__clone ()
	Overwrite magic function to solve problem of cloning object that are kept as references. More...

	addThumbs ($file)
	Build thumb. More...

	getDefaultCreateValueFor ($fieldname, $alternatevalue=null)
	Return the default value to use for a field when showing the create form of object. More...

	call_trigger ($triggerName, $user)
	Call trigger based on this instance. More...

	fetchValuesForExtraLanguages ()
	Function to get alternative languages of a data into $this->array_languages This method is NOT called by method fetch of objects but must be called separately. More...

	setValuesForExtraLanguages ($onlykey= '')
	Fill array_options property of object by extrafields value (using for data sent by forms) More...

	fetchNoCompute ($id)
	Function to make a fetch but set environment to avoid to load computed values before. More...

	fetch_optionals ($rowid=null, $optionsArray=null)
	Function to get extra fields of an object into $this->array_options This method is in most cases called by method fetch of objects but you can call it separately. More...

	deleteExtraFields ()
	Delete all extra fields values for the current object. More...

	insertExtraFields ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...

	insertExtraLanguages ($trigger= '', $userused=null)
	Add/Update all extra fields values for the current object. More...

	updateExtraField ($key, $trigger=null, $userused=null)
	Update 1 extra field value for the current object. More...

	updateExtraLanguages ($key, $trigger=null, $userused=null)
	Update an extra language value for the current object. More...

	showInputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss=0, $nonewbutton=0)
	Return HTML string to put an input field into a page Code very similar with showInputField of extra fields. More...

	showOutputField ($val, $key, $value, $moreparam= '', $keysuffix= '', $keyprefix= '', $morecss= '')
	Return HTML string to show a field into a page Code very similar with showOutputField of extra fields. More...

	showOptionals ($extrafields, $mode= 'view', $params=null, $keysuffix= '', $keyprefix= '', $onetrtd=0)
	Function to show lines of extrafields with output datas. More...

	getJSListDependancies ($type= '_extra')

	getRights ()
	Returns the rights used for this class. More...

	defineBuyPrice ($unitPrice=0.0, $discountPercent=0.0, $fk_product=0)
	Get buy price to use for margin calculation. More...

	show_photos ($modulepart, $sdir, $size=0, $nbmax=0, $nbbyrow=5, $showfilename=0, $showaction=0, $maxHeight=120, $maxWidth=160, $nolink=0, $notitle=0, $usesharelink=0)
	Show photos of an object (nbmax maximum), into several columns. More...

	isDate ($info)
	Function test if type is date. More...

	isDuration ($info)
	Function test if type is duration. More...

	isInt ($info)
	Function test if type is integer. More...

	isFloat ($info)
	Function test if type is float. More...

	isText ($info)
	Function test if type is text. More...

	setVarsFromFetchObj (&$obj)
	Function to load data from a SQL pointer into properties of current object $this. More...

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

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

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

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

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

	deleteByParentField ($parentId=0, $parentField= '')
	Delete all child object from a parent ID. More...

	deleteLineCommon (User $user, $idline, $notrigger=false)
	Delete a line of object in database. More...

	setStatusCommon ($user, $status, $notrigger=0, $triggercode= '')
	Set to a status. More...

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

	fetchComments ()
	Load comments linked with current task. More...

	getNbComments ()
	Return nb comments already posted. More...

	trimParameters ($parameters)
	Trim object parameters. More...

	getCategoriesCommon ($type_categ)
	Sets object to given categories. More...

	setCategoriesCommon ($categories, $type_categ)
	Sets object to given categories. More...

	cloneCategories ($fromId, $toId, $type= '')
	Copy related categories to another object. More...

	deleteEcmFiles ($mode=0)
	Delete related files of object in database. More...

Static Public Member Functions
static	isExistingObject ($element, $id, $ref= '', $ref_ext= '')
	Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch. More...

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

Public Attributes
	$projet

	$note

Protected Member Functions
	commonGenerateDocument ($modelspath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref, $moreparams=null)
	Common function for all objects extending CommonObject for generating documents. More...

	isArray ($info)
	Function test if type is array. More...

	canBeNull ($info)
	Function test if field can be null. More...

	isForcedToNullIfZero ($info)
	Function test if field is forced to null if zero or empty. More...

	isIndex ($info)
	Function test if is indexed. More...

	setSaveQuery ()
	Function to prepare a part of the query for insert. More...

	getFieldList ()
	Function to concat keys of fields. More...

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

Detailed Description

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

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

Member Function Documentation

CommonObject::__clone ( )

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

Returns: void

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

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 souce = '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 <0 if KO, >0 if OK

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

Referenced by CommandeFournisseur\approve(), Facture\create(), Commande\create(), and Contrat\create().

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 <=0 if KO, >0 if OK

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

CommonObject::add_object_linked	(	$origin = `null`,
		$origin_id = `null`
	)

Add objects linked in llx_element_element.

Parameters

string	$origin	Linked element type
int	$origin_id	Linked element id

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

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

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

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

CommonObject::addThumbs ( $file )

Build thumb.

Parameters

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

Returns: void

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

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

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

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

CommonObject::canBeNull ( $info )

protected

Function test if field can be null.

Parameters

array $info content informations of field

Returns: bool true if it can be null

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

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 < 0 if error, > 0 if ok

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

References db.

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 obj->model_pdf or GETPOST('model_pdf','alpha') for example.
Translate	$outputlangs	Output language to use
int	$hidedetails	1 to hide details. 0 by default
int	$hidedesc	1 to hide product description. 0 by default
int	$hideref	1 to hide product reference. 0 by default
null \| array	$moreparams	Array to provide more information

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

See Also: addFileIntoDatabaseIndex()

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

static CommonObject::commonReplaceThirdparty	(	DoliDB	$db,
			$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 appropiate tables Column name fk_soc MUST be used to identify thirdparties

Parameters

DoliDB	$db	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	$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 7090 of file commonobject.class.php.

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

Copy contact from one element to current.

Parameters

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

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

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

Referenced by RecruitmentCandidature\createFromClone(), RecruitmentJobPosition\createFromClone(), BOM\createFromClone(), MyObject\createFromClone(), Mo\createFromClone(), and Commande\createFromClone().

CommonObject::createCommon	(	User	$user,
			$notrigger = `false`
	)

Create object into database.

Parameters

User	$user	User that creates
bool	$notrigger	false=launch triggers after, true=disable triggers

Returns: int <0 if KO, Id of created object if OK

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

References db, dol_now(), dol_string_nospecial(), and dol_syslog().

Referenced by EmailSenderProfile\create(), EmailCollectorFilter\create(), ActionCommReminder\create(), Asset\create(), SocieteAccount\create(), EmailCollectorAction\create(), RecruitmentCandidature\create(), RecruitmentJobPosition\create(), WebsitePage\create(), Inventory\create(), Mo\create(), CompanyPaymentMode\create(), EmailCollector\create(), BOM\create(), MyObject\create(), Hook\create(), UserGroup\create(), InventoryLine\create(), BOMLine\create(), and MoLine\create().

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, else if calculation MARGIN_TYPE = 'costprice' and costprice is defined, use costprice as buyprice else if 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 <0 if KO, buyprice if OK

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

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

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 1137 of file commonobject.class.php.

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

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

Parameters

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

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

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

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

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

Delete a link to resource line.

Parameters

int	$rowid	Id of resource line to delete
int	$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 4518 of file commonobject.class.php.

CommonObject::deleteByParentField	(	$parentId = `0`,
		$parentField = `''`
	)

Delete all child object from a parent ID.

Parameters

int	$parentId	Parent Id
string	$parentField	Name of Foreign key parent column

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

Exceptions

Exception

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

References $resql, and db.

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

Delete object in database.

Parameters

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

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

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

References $resql, db, dol_include_once(), and dol_syslog().

Referenced by ActionCommReminder\delete(), EmailSenderProfile\delete(), Asset\delete(), EmailCollectorFilter\delete(), EmailCollectorAction\delete(), CashControl\delete(), CompanyPaymentMode\delete(), SocieteAccount\delete(), RecruitmentCandidature\delete(), RecruitmentJobPosition\delete(), Inventory\delete(), EmailCollector\delete(), Hook\delete(), BOM\delete(), MyObject\delete(), WebsitePage\delete(), UserGroup\delete(), Mo\delete(), InventoryLine\delete(), MouvementStock\delete(), BOMLine\delete(), and MoLine\delete().

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 recommanded for new objects)

Returns: bool True if OK, False if KO

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

References $resql, and db.

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

CommonObject::deleteExtraFields ( )

Delete all extra fields values for the current object.

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

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

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

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

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

Delete a line of object in database.

Parameters

User	$user	User that delete
int	$idline	Id of line to delete
bool	$notrigger	false=launch triggers after, true=disable triggers

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

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

References $resql, db, and dol_syslog().

Referenced by RecruitmentCandidature\deleteLine(), RecruitmentJobPosition\deleteLine(), Inventory\deleteLine(), BOM\deleteLine(), MyObject\deleteLine(), and Mo\deleteLine().

CommonObject::deleteObjectLinked	(	$sourceid = `null`,
		$sourcetype = `''`,
		$targetid = `null`,
		$targettype = `''`,
		$rowid = `''`
	)

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.

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

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

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

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

CommonObject::errorsToString ( )

Method to output saved errors.

Returns: string String with errors

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

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 <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded)

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

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 <0 if KO, >0 if OK

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

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	$optionsArray	Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters.

Returns: int <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()

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

Referenced by ActionComm\createFromClone(), Facture\createFromCurrent(), ProductStockEntrepot\fetch(), Dolresource\fetch(), PaymentSalary\fetch(), CommandeFournisseurDispatch\fetch(), Task\fetch(), Productlot\fetch(), CommandeFournisseur\fetch(), Delivery\fetch(), Categorie\fetch(), EcmDirectory\fetch(), Holiday\fetch(), Reception\fetch(), EcmFiles\fetch(), User\fetch(), Fichinter\fetch(), Entrepot\fetch(), FactureRec\fetch(), Project\fetch(), Ticket\fetch(), Expedition\fetch(), FactureFournisseur\fetch(), MouvementStock\fetch(), Don\fetch(), Contrat\fetch(), Contact\fetch(), Account\fetch(), SupplierProposal\fetch(), Adherent\fetch(), Propal\fetch(), Facture\fetch(), Commande\fetch(), Product\fetch(), ContratLigne\fetch(), SupplierInvoiceLine\fetch(), CommandeFournisseurLigne\fetch(), PropaleLigne\fetch(), and doc_generic_project_odt\get_substitutionarray_tasks().

CommonObject::fetch_origin ( )

Read linked origin object.

Returns: void

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

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

CommonObject::fetch_product ( )

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

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

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

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

CommonObject::fetch_projet ( )

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

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

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

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 $force_thirdparty_id Force thirdparty id

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

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

Referenced by SupplierProposal\create(), Propal\create(), Reception\fetch(), Expedition\fetch(), CommonInvoice\is_erasable(), Contrat\reopen(), SupplierProposal\updateOrCreatePriceFournisseur(), Contrat\validate(), FactureFournisseur\validate(), and Facture\validate().

CommonObject::fetch_user ( $userid )

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

Parameters

int $userid Id du contact

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

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

CommonObject::fetchComments ( )

Load comments linked with current task.

Returns: boolean 1 if ok

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

References db.

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

Load object in memory from the database.

Parameters

int	$id	Id object
string	$ref	Ref
string	$morewhere	More SQL filters (' AND ...')

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

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

References db.

Referenced by CoreObject\fetch(), UserGroup\fetch(), ActionCommReminder\fetch(), EmailSenderProfile\fetch(), Asset\fetch(), SocieteAccount\fetch(), EmailCollectorFilter\fetch(), EmailCollectorAction\fetch(), CashControl\fetch(), CompanyPaymentMode\fetch(), RecruitmentCandidature\fetch(), RecruitmentJobPosition\fetch(), EmailCollector\fetch(), Hook\fetch(), BOM\fetch(), MyObject\fetch(), Mo\fetch(), Inventory\fetch(), InventoryLine\fetch(), BOMLine\fetch(), and MoLine\fetch().

CommonObject::fetchLinesCommon ( $morewhere = '' )

Load object in memory from the database.

Parameters

string $morewhere More SQL filters (' AND ...')

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

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

References $resql, and db.

Referenced by RecruitmentCandidature\fetchLines(), RecruitmentJobPosition\fetchLines(), BOM\fetchLines(), MyObject\fetchLines(), and Mo\fetchLines().

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 >0 if OK, 0 if not found, <0 if KO

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

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 <0 if KO, >0 if OK

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

mixed Array of linked objects Loaded by 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 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 target list linked to source
target id+type -> will get source list linked to target
source id+type + target type -> will get target list of the type
target id+type + target source -> will get source list of the type

Parameters

int	$sourceid	Object source id (if not defined, id of object)
string	$sourcetype	Object source type (if not defined, element name of object)
int	$targetid	Object target id (if not defined, id of object)
string	$targettype	Object target type (if not defined, elemennt name of object)
string	$clause	'OR' or 'AND' clause used when both source id and target id are provided
int	$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	$loadalsoobjects	Load also array this->linkedObjects (Use 0 to increase performances)

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

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

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

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

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 = OK, 0 = Not found or table_ref_field not defined, <0 = KO

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

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 <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 4961 of file commonobject.class.php.

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

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

CommonObject::getBannerAddress	(	$htmlkey,
		$object
	)

Return full address for banner.

Parameters

string	$htmlkey	HTML id to make banner content unique
Object	$object	Object (thirdparty, thirdparty of contact for contact, null for a member)

Returns: string Full address string

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

References fields, getFullAddress(), getFullName(), and n.

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 <0 if KO, 0 if nothing done, >0 if OK

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

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 Array of category objects or < 0 if KO

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

References db.

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

Get children of line.

Parameters

int	$id	Id of parent line
int	$includealltree	0 = 1st level child, 1 = All level child

Returns: array Array with list of children lines id

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

CommonObject::getDefaultCreateValueFor	(	$fieldname,
		$alternatevalue = `null`
	)

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

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

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

CommonObject::getFieldList ( )

protected

Function to concat keys of fields.

Returns: string

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

Referenced by RecruitmentCandidature\fetchAll(), RecruitmentJobPosition\fetchAll(), BOM\fetchAll(), MyObject\fetchAll(), Mo\fetchAll(), BOMLine\fetchAll(), and MoLine\fetchAll().

CommonObject::getFormatedCustomerRef ( $objref )

Return customer ref for screen output.

Parameters

string $objref Customer ref

Returns: string Customer ref formated

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

CommonObject::getFormatedSupplierRef ( $objref )

Return supplier ref for screen output.

Parameters

string $objref Supplier ref

Returns: string Supplier ref formated

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

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

Return full address of contact.

Parameters

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

Returns: string Full address string

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

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

Referenced by getBannerAddress().

CommonObject::getFullName	(	$langs,
		$option = `0`,
		$nameorder = `-1`,
		$maxlen = `0`
	)

Return full name (civility+' '+name+' '+lastname)

Parameters

Translate	$langs	Language object for translation of civility (used only if option is 1)
int	$option	0=No option, 1=Add civility
int	$nameorder	-1=Auto, 0=Lastname+Firstname, 1=Firstname+Lastname, 2=Firstname, 3=Firstname if defined else lastname, 4=Lastname, 5=Lastname if defined else firstname
int	$maxlen	Maximum length

Returns: string String with full name

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

References dol_trunc(), dolGetFirstLastname(), name, and nom.

Referenced by Contact\_load_ldap_info(), Adherent\_load_ldap_info(), User\_load_ldap_info(), User\create(), Societe\create_from_member(), getBannerAddress(), RecruitmentCandidature\getNomUrl(), Contact\getNomUrl(), Adherent\getNomUrl(), User\getNomUrl(), Adherent\makeSubstitution(), and Adherent\subscriptionComplementaryActions().

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: array List of id for such contacts

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

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

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 2852 of file commonobject.class.php.

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

Parameters

string $type Type for prefix

Returns: string Javacript code to manage dependency

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

CommonObject::getKanbanView ( $option = '' )

Return clicable link of object (with eventually picto)

Parameters

string $option Where point the link (0=> main card, 1,2 => shipment, 'nolink'=>No link)

Returns: string HTML Code for Kanban thumb.

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

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 Link or empty string if there is no download link

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

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

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

CommonObject::getNbComments ( )

Return nb comments already posted.

Returns: int

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

Referenced by project_prepare_head().

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 2832 of file commonobject.class.php.

CommonObject::getRights ( )

Returns the rights used for this class.

Returns: stdClass

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

CommonObject::getSpecialCode ( $lineid )

Get special code of a line.

Parameters

int $lineid Id of line

Returns: int Special code

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

CommonObject::getTotalDiscount ( )

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

Returns: float

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

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 array('weight'=>...,'volume'=>...)

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

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 <0 if KO, >0 if OK

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

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 <0 if KO, 0 if no predefined products, nb of lines with predefined products if found

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

CommonObject::initAsSpecimenCommon ( )

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

Returns: int

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

References dol_now().

Referenced by ActionCommReminder\initAsSpecimen(), EmailSenderProfile\initAsSpecimen(), Asset\initAsSpecimen(), EmailCollectorFilter\initAsSpecimen(), EmailCollectorAction\initAsSpecimen(), SocieteAccount\initAsSpecimen(), CompanyPaymentMode\initAsSpecimen(), Inventory\initAsSpecimen(), EmailCollector\initAsSpecimen(), Hook\initAsSpecimen(), BOM\initAsSpecimen(), Mo\initAsSpecimen(), and BOMLine\initAsSpecimen().

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=error, O=did nothing, 1=OK

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

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

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

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=error, O=did nothing, 1=OK

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

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

Referenced by Societe\update().

CommonObject::isArray ( $info )

protected

Function test if type is array.

Parameters

array $info content informations of field

Returns: bool true if array

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

Referenced by CoreObject\init().

CommonObject::isDate ( $info )

Function test if type is date.

Parameters

array $info content informations of field

Returns: bool true if date

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

Referenced by CoreObject\init().

CommonObject::isDuration ( $info )

Function test if type is duration.

Parameters

array $info content informations of field

Returns: bool true if field of type duration

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

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

static

Check an object id/ref exists If you don't need/want to instantiate object and just need to know if object exists, use this method instead of fetch.

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 <0 if KO, 0 if OK but not found, >0 if OK and exists

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

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

Referenced by SupplierInvoiceLine\insert(), and FactureLigne\insert().

CommonObject::isFloat ( $info )

Function test if type is float.

Parameters

array $info content informations of field

Returns: bool true if float

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

Referenced by CoreObject\init().

CommonObject::isForcedToNullIfZero ( $info )

protected

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

Parameters

array $info content informations of field

Returns: bool true if forced to null

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

CommonObject::isIndex ( $info )

protected

Function test if is indexed.

Parameters

array $info content informations of field

Returns: bool

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

CommonObject::isInt ( $info )

Function test if type is integer.

Parameters

array $info content informations of field

Returns: bool true if integer

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

Referenced by CoreObject\init().

CommonObject::isObjectUsed ( $id = 0 )

Function to check if an object is used by others.

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

Parameters

int $id Force id of object

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

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

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

CommonObject::isText ( $info )

Function test if type is text.

Parameters

array $info content informations of field

Returns: bool true if type text

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

CommonObject::line_ajaxorder ( $rows )

Update position of line with ajax (rang)

Parameters

array $rows Array of rows

Returns: void

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

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 2709 of file commonobject.class.php.

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 2872 of file commonobject.class.php.

Referenced by SupplierProposal\addline(), Propal\addline(), Commande\addline(), CommandeFournisseur\addline(), FactureFournisseur\addline(), Facture\addline(), ExpeditionLigne\insert(), SupplierProposal\updateline(), Propal\updateline(), Commande\updateline(), and Facture\updateline().

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 <0 if KO, >0 if OK

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

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

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 2689 of file commonobject.class.php.

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

Get array of all contacts for an object.

Parameters

int	$status	Status of links to get (-1=all)
string	$source	Source of contact: 'external' or 'thirdparty' (llx_socpeople) or 'internal' (llx_user)
int	$list	0:Return array contains all properties, 1:Return array contains just id
string	$code	Filter on this code of contact type ('SHIPPING', 'BILLING', ...)

Returns: array|int Array of contacts, -1 if error

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

Referenced by commande_prepare_head(), contract_prepare_head(), project_prepare_head(), Project\restrictedProjectArea(), and societe_prepare_head().

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

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

Returns: array Array list of type of contacts (id->label if option=0, code->label if option=1)

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

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	$option	0=Return array id->label, 1=Return array code->label
int	$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 Array list of type of contacts (id->label if option=0, code->label if option=1)

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

Referenced by FormCompany\showRoles().

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 filter. Example: " AND (t.field1 = 'aa' OR t.field2 = 'bb')"
string	$fieldid	Name of field to use for the select MAX and MIN
int	$nodbprefix	Do not include DB prefix to forge table name

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

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

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
string	$var	Is it a an odd line (true)
int	$num	Number of line (0)
int	$i	I
int	$dateSelector	1=Show also date range input fields
string	$seller	Object of seller third party
string	$buyer	Object of buyer third party
int	$selected	Object line selected
Extrafields	$extrafields	Object of extrafields
string	$defaulttpldir	Directory where to find the template (deprecated)

Returns: void

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

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
string	$seller	Object of seller third party
string	$buyer	Object of buyer third party
int	$selected	Object line selected
int	$dateSelector	1=Show also date range input fields
string	$defaulttpldir	Directory where to find the template

Returns: void

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

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, 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

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

Returns: void

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

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

string	$restrictlist	''=All lines, 'services'=Restrict to services only
array	$selectedLines	Array of lines id for selected lines

Returns: void

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

CommonObject::quote	(	$value,
		$fieldsentry
	)

protected

Add quote to field value if necessary.

Parameters

string \| int	$value	Value to protect
array	$fieldsentry	Properties of field

Returns: string

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

References db.

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

Change the bank account.

Parameters

int	$fk_account	Id of bank account
bool	$notrigger	false=launch triggers after, true=disable triggers
User	$userused	Object user

Returns: int 1 if OK, 0 if KO

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

CommonObject::setCategoriesCommon	(	$categories,
		$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

	int[]\|int	$categories Category ID or array of Categories IDs
string	$type_categ	Category type ('customer', 'supplier', 'website_page', ...)

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

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

References db.

Referenced by WebsitePage\setCategories().

CommonObject::setDeliveryAddress ( $id )

Define delivery address.

Deprecated:

Parameters

int $id Address id

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

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

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 <0 if KO, >0 if OK

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

CommonObject::setExtraParameters ( )

Set extra parameters.

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

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

CommonObject::setMulticurrencyCode ( $code )

Change the multicurrency code.

Parameters

string $code multicurrency code

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

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

CommonObject::setMulticurrencyRate	(	$rate,
		$mode = `1`
	)

Change the multicurrency rate.

Parameters

double	$rate	multicurrency rate
int	$mode	mode 1 : amounts in company currency will be recalculated, mode 2 : amounts in foreign currency will be recalculated

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

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

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 2074 of file commonobject.class.php.

Referenced by CommonInvoice\demande_prelevement().

CommonObject::setPaymentTerms ( $id )

Change the payments terms.

Parameters

int $id Id of new payment terms

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

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

CommonObject::setProject ( $projectid )

Link element with a project.

Parameters

int $projectid Project id to link element to

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

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

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 2331 of file commonobject.class.php.

CommonObject::setSaveQuery ( )

protected

Function to prepare a part of the query for insert.

Note $this->${field} are set by the page that make the createCommon or the updateCommon. $this->${field} should be a clean value. The page can run

Returns: array

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

References db.

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

Change the shipping method.

Parameters

int	$shipping_method_id	Id of shipping method
bool	$notrigger	false=launch triggers after, true=disable triggers
User	$userused	Object user

Returns: int 1 if OK, 0 if KO

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

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 <0 if KO, >0 if OK

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

References db.

Referenced by RecruitmentCandidature\cancel(), RecruitmentJobPosition\cancel(), MyObject\cancel(), BOM\cancel(), Mo\cancel(), RecruitmentCandidature\reopen(), MyObject\reopen(), RecruitmentJobPosition\reopen(), BOM\reopen(), Don\reopen(), Mo\reopen(), RecruitmentCandidature\setDraft(), RecruitmentJobPosition\setDraft(), MyObject\setDraft(), BOM\setDraft(), and Mo\setDraft().

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

Set status of an object.

Parameters

int	$status	Status to set
int	$elementId	Id of element to force (use this->id by default)
string	$elementType	Type of element to force (use this->table_element by default)
string	$trigkey	Trigger key to use for trigger

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

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

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

CommonObject::setTransportMode ( $id )

Change the transport mode methods.

Parameters

int $id Id of new payment method

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

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

CommonObject::setUpperOrLowerCase ( )

Set to upper or ucwords/lower if needed.

Returns: void;

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

References dol_strtolower(), dol_strtoupper(), dol_ucwords(), and name.

Referenced by Contact\create(), Societe\create(), User\create(), Contact\update(), Adherent\update(), Societe\update(), and User\update().

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', 'date'). 'text' is used if not defined
string	$id_field	To force rowid field name. 'rowid' is used if not defined
User \| string	$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 <0 if KO, >0 if OK

See Also: updateExtraField()

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

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 if array_options set, 0 if no value, -1 if error (field required missing for example)

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

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 7606 of file commonobject.class.php.

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 2448 of file commonobject.class.php.

CommonObject::show_photos	(	$modulepart,
		$sdir,
		$size = `0`,
		$nbmax = `0`,
		$nbbyrow = `5`,
		$showfilename = `0`,
		$showaction = `0`,
		$maxHeight = `120`,
		$maxWidth = `160`,
		$nolink = `0`,
		$notitle = `0`,
		$usesharelink = `0`
	)

Show photos of an object (nbmax maximum), into several columns.

Parameters

string	$modulepart	'product', 'ticket', ...
string	$sdir	Directory to scan (full absolute path)
int	$size	0=original size, 1='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. Used only if size=1.
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	$notitle	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)

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

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

References getAdvancedPreviewUrl().

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

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	$val	Array of properties for field to show (used only if ->fields not defined)
string	$key	Key of attribute
string \| array	$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	Prefix string to add into name and id of field (can be used to avoid duplicate names)
string	$keyprefix	Suffix 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	$nonewbutton	Force to not show the new button on field that are links to object

Returns: string

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

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

Function to show lines of extrafields with output datas.

This function is responsible to output the

and

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

Parameters

Extrafields	$extrafields	Extrafield Object
string	$mode	Show output ('view') or input ('create' or 'edit') for extrafield
array	$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.

Returns: string

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

CommonObject::showOutputField	(	$val,
		$key,
		$value,
		$moreparam = `''`,
		$keysuffix = `''`,
		$keyprefix = `''`,
		$morecss = `''`
	)

Return HTML string to show a field into a page Code very similar with showOutputField of extra fields.

Parameters

array	$val	Array of properties of field to show
string	$key	Key of attribute
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)
string	$moreparam	To add more parametes on html input tag
string	$keysuffix	Prefix string to add into name and id of field (can be used to avoid duplicate names)
string	$keyprefix	Suffix string to add into name and id of field (can be used to avoid duplicate names)
mixed	$morecss	Value for css to define size. May also be a numeric.

Returns: string

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

CommonObject::swapContactStatus ( $rowid )

Update status of a contact linked to object.

Parameters

int $rowid Id of link between object and contact

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

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

CommonObject::trimParameters ( $parameters )

Trim object parameters.

Parameters

string[] $parameters array of parameters to trim

Returns: void

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

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 <0 if KO, >= 0 if OK

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

CommonObject::update_note	(	$note,
		$suffix = `''`
	)

Update note of element.

Parameters

string	$note	New value for note
string	$suffix	'', '_public' or '_private'

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

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

CommonObject::update_note_public ( $note )

Update public note (kept for backward compatibility)

Parameters

string $note New value for note

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

Deprecated:

See Also: update_note()

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

CommonObject::update_price	(	$exclspec = `0`,
		$roundingadjust = `'none'`,
		$nodatabaseupdate = `0`,
		$seller = `null`
	)

Update total_ht, total_ttc, total_vat, total_localtax1, total_localtax2 for an object (sum of lines).

Must be called at end of methods addline or updateline.

Parameters

int	$exclspec	>0 = Exclude special product (product_type=9)
string	$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	$nodatabaseupdate	1=Do not update database. Update only properties of object.
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.

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

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

Referenced by SupplierProposal\addline(), Propal\addline(), FactureRec\addline(), Commande\addline(), CommandeFournisseur\addline(), FactureFournisseur\addline(), ExpenseReport\addline(), Facture\addline(), ExpenseReport\create(), FactureFournisseur\create(), Facture\create(), SupplierProposal\create(), Propal\create(), Delivery\deleteline(), SupplierProposal\deleteline(), Propal\deleteline(), CommandeFournisseur\deleteline(), FactureFournisseur\deleteline(), Commande\deleteline(), Facture\deleteline(), SupplierProposal\insert_discount(), Propal\insert_discount(), FactureFournisseur\insert_discount(), Commande\insert_discount(), Facture\insert_discount(), Commande\set_remise(), Facture\set_remise(), SupplierProposal\set_remise_absolue(), Propal\set_remise_absolue(), Commande\set_remise_absolue(), Facture\set_remise_absolue(), SupplierProposal\set_remise_percent(), Propal\set_remise_percent(), Facture\update_percent(), CommandeFournisseur\updateFromCommandeClient(), SupplierProposal\updateline(), Propal\updateline(), FactureRec\updateline(), FactureFournisseur\updateline(), CommandeFournisseur\updateline(), Commande\updateline(), Facture\updateline(), and Facture\validate().

CommonObject::update_ref_ext ( $ref_ext )

Update external ref of element.

Parameters

string $ref_ext Update field ref_ext

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

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

CommonObject::updateCommon	(	User	$user,
			$notrigger = `false`
	)

Update object into database.

Parameters

User	$user	User that modifies
bool	$notrigger	false=launch triggers after, true=disable triggers

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

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

References db, dol_now(), dol_string_nospecial(), and dol_syslog().

Referenced by ActionCommReminder\update(), EmailSenderProfile\update(), Asset\update(), EmailCollectorFilter\update(), EmailCollectorAction\update(), CashControl\update(), CompanyPaymentMode\update(), SocieteAccount\update(), RecruitmentCandidature\update(), RecruitmentJobPosition\update(), Inventory\update(), EmailCollector\update(), BOM\update(), Hook\update(), MyObject\update(), WebsitePage\update(), Mo\update(), UserGroup\update(), InventoryLine\update(), BOMLine\update(), and MoLine\update().

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=error, O=did nothing, 1=OK

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

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

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: updateExtraFields(), insertExtraLanguages()

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

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 2802 of file commonobject.class.php.

CommonObject::updateLineUp	(	$rowid,
		$rang
	)

Update position of line up (rang)

Parameters

int	$rowid	Id of line
int	$rang	Position

Returns: void

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

CommonObject::updateObjectLinked	(	$sourceid = `null`,
		$sourcetype = `''`,
		$targetid = `null`,
		$targettype = `''`
	)

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

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

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

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

CommonObject::updateRangOfLine	(	$rowid,
		$rang
	)

Update position of line (rang)

Parameters

int	$rowid	Id of line
int	$rang	Position

Returns: void

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

Member Data Documentation

CommonObject::$note

Deprecated:

See Also: $note_private

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

Referenced by RecruitmentJobPosition\cloture(), SupplierProposal\cloture(), Propal\cloture(), Paiement\create(), SupplierProposal\reopen(), and Propal\reopen().

CommonObject::$projet

Deprecated:

See Also: project

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

Referenced by Contrat\update().

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

htdocs/core/class/commonobject.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

Member Data Documentation