Inheritance diagram for Memo:

Collaboration diagram for Memo:

Public Member Functions
	__construct (DoliDB $db)
	Constructor.

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

	createFromClone (User $user, $fromid)
	Clone an object into another one.

	fetch ($id, $ref=null, $noextrafields=0, $nolines=0)
	Load object in memory from the database.

	fetchLines ($noextrafields=0)
	Load object lines in memory from the database.

	fetchAll ($sortorder='', $sortfield='', $limit=1000, $offset=0, string $filter='', $filtermode='AND')
	Load list of objects in memory from the database.

	update (User $user, $notrigger=0)
	Update object into database.

	updatePosition (User $user, int $x, int $y, int $w, int $h, int $z)
	Update position of a memo for a specific user.

	delete (User $user, $notrigger=0)
	Delete object in database.

	deleteLine (User $user, $idline, $notrigger=0)
	Delete a line of object in database.

	validate ($user, $notrigger=0)
	Validate object.

	setDraft ($user, $notrigger=0)
	Set draft status.

	setArchived ($user, $notrigger=0)
	Set archived status.

	setUnArchived ($user, $notrigger=0)
	Set unarchived status.

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

	reopen ($user, $notrigger=0)
	Set back to validated status.

	getTooltipContentArray ($params)
	getTooltipContentArray

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

	getKanbanView ($option='', $arraydata=null)
	Return a thumb for kanban views.

	getLabelStatus ($mode=0)
	Return the label of the status.

	getLibStatut ($mode=0)
	Return the label of the status.

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

	info ($id)
	Load the info information in the object.

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

	getNextNumRef ()
	Returns the reference to the following non used object depending on the active numbering module.

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

	countArchivedMemoQuery ($element_type, $element_id, $context, $id=0)
	Count archived memo query.

	getMemosQuery ($element_type, $element_id, $context, $id=0)
	Get memos query.

	getTemplateMemosQuery ($element_type, $context_tab='', $id=0)
	Get template memos query.

	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.

	getJsMemo (User $currentUser)
	Get JS memo.

Public Member Functions inherited from CommonObject
	isEmpty ()
	isEmpty We consider CommonObject isEmpty if this->id is empty

	setErrorsFromObject ($object)
	setErrorsFromObject

	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.

	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='')
	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, $notrigger=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, $quality=50)
	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.

	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) Used for example when PDF_USE_ALSO_LANGUAGE_CODE is set to a language for the name of a thirdparty.

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

	checkActiveProductInLines ($status='onsale')
	Check if all products have the right status (on sale, on buy) called during validation of propal, order, supplier proposal, supplier order.

	setErrorWithoutLog ($message)
	Set the error message for the object without logging it.

	setErrorWithLog ($message, $loglevel=LOG_ERR)
	Set the error message for the object and logs it, including the file name and line number.

Static Public Member Functions
static	checkColor ($color)
	Vérifie si une couleur est un code hex valide.

static	getColorPreset ()
	Get color preset.

static	getMemoContext ($context, $object=null)
	Get memo context.

static	completeMemoContextMapping (array &$contextTabMapping, string $tabContext, string $dolibarrContext='')

static	getAvailableMemoContextMapping ($object=null, $onlyActiveModules=true)
	Get available memo context.

static	getAvailableMemoContext ()
	Get available memo context.

static	loadQuickMemoJsInterface ($jsConfVars)
	Load the Javascript interface for QuickMemo.

static	getJsMemoDefault ()
	Get JS memo default.

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

static	getAllItemsLinkedByObjectID ($fk_object_where, $field_select, $field_where, $table_element)
	Function used to get an array with all items linked to an object id in association table.

static	getCountOfItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Count items linked to an object id in association table.

static	deleteAllItemsLinkedByObjectID ($fk_object_where, $field_where, $table_element)
	Function used to remove all items linked to an object id in association table.

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

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

Public Attributes
	$fields
	'type' field format: 'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]', 'select' (list of values are in 'options'.

Public Attributes inherited from CommonObject
	$origin_object

Additional Inherited Members
Protected Member Functions inherited from CommonObject
	deprecatedProperties ()
	Provide list of deprecated properties and replacements.

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

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

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

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

	isIndex ($info)
	Function test if is indexed.

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

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

Detailed Description

Class for Memo.

Definition at line 35 of file memo.class.php.

Constructor & Destructor Documentation

◆ __construct()

Memo::__construct ( DoliDB $db )

Constructor.

Parameters

DoliDB $db Database handler

Definition at line 235 of file memo.class.php.

References $db, getDolGlobalInt(), and isModEnabled().

Member Function Documentation

◆ cancel()

Memo::cancel	(		$user,
			$notrigger = 0 )

Set cancel status.

Parameters

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

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

Definition at line 804 of file memo.class.php.

◆ checkColor()

static Memo::checkColor ( $color )

static

Vérifie si une couleur est un code hex valide.

Parameters

mixed $color the color to check

Returns: bool

Definition at line 1237 of file memo.class.php.

◆ completeMemoContextMapping()

static Memo::completeMemoContextMapping	(	array &	$contextTabMapping,
		string	$tabContext,
		string	$dolibarrContext = '' )

static

Parameters

	array<string,array<string>>	$contextTabMapping memo context list and Dolibarr context associated
string	$tabContext	memo context
string	$dolibarrContext	Dolibarr context

Returns: void

Definition at line 1329 of file memo.class.php.

◆ countArchivedMemoQuery()

Memo::countArchivedMemoQuery	(	$element_type,
		$element_id,
		$context,
		$id = 0 )

Count archived memo query.

Parameters

string	$element_type	Type of element
int	$element_id	Id of element
string	$context	Context
int	$id	Id

Returns: int|false

Definition at line 1490 of file memo.class.php.

References $id.

◆ create()

Memo::create	(	User	$user,
			$notrigger = 0 )

Create object into 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 274 of file memo.class.php.

References CommonObject\createCommon().

◆ createFromClone()

Memo::createFromClone	(	User	$user,
			$fromid )

Clone an object into another one.

Parameters

User	$user	User that creates
int	$fromid	Id of object to clone

Returns: self|int<-1,-1> New object created, <0 if KO

Definition at line 288 of file memo.class.php.

References $object, dol_now(), dol_syslog(), and CommonObject\setErrorsFromObject().

◆ delete()

Memo::delete	(	User	$user,
			$notrigger = 0 )

Delete object in database.

Parameters

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

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

Definition at line 580 of file memo.class.php.

◆ deleteLine()

Memo::deleteLine	(	User	$user,
			$idline,
			$notrigger = 0 )

Delete a line of object in database.

Parameters

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

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

Definition at line 594 of file memo.class.php.

◆ fetch()

Memo::fetch	(	$id,
		$ref = null,
		$noextrafields = 0,
		$nolines = 0 )

Load object in memory from the database.

Parameters

int	$id	Id object
string	$ref	Ref
	int<0,1>	$noextrafields 0=Default to load extrafields, 1=No extrafields
	int<0,1>	$nolines 0=Default to load lines, 1=No lines

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

Definition at line 360 of file memo.class.php.

References CommonObject\fetchCommon(), and fetchLines().

◆ fetchAll()

Memo::fetchAll	(		$sortorder = '',
			$sortfield = '',
			$limit = 1000,
			$offset = 0,
		string	$filter = '',
			$filtermode = 'AND' )

Load list of objects in memory from the database.

Using a fetchAll() with limit = 0 is a very bad practice. Instead try to forge yourself an optimized SQL request with your own loop with start and stop pagination.

Parameters

string	$sortorder	Sort Order
string	$sortfield	Sort field
	int<0,max>	$limit Limit the number of lines returned
	int<0,max>	$offset Offset
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 longer used

Returns: array<int,self>|int<-1,-1> <0 if KO, array of pages if OK

Definition at line 398 of file memo.class.php.

References dol_syslog(), and CommonObject\getFieldList().

◆ fetchLines()

Memo::fetchLines ( $noextrafields = 0 )

Load object lines in memory from the database.

Parameters

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 375 of file memo.class.php.

References CommonObject\fetchLinesCommon().

Referenced by fetch().

◆ generateDocument()

Memo::generateDocument	(	$modele,
		$outputlangs,
		$hidedetails = 0,
		$hidedesc = 0,
		$hideref = 0,
		$moreparams = null )

Create a document onto disk according to template module.

Parameters

string	$modele	Force template to use ('' to not force)
Translate	$outputlangs	object lang a utiliser pour traduction
	int<0,1>	$hidedetails Hide details of lines
	int<0,1>	$hidedesc Hide description
	int<0,1>	$hideref Hide ref
	?array<string,string>	$moreparams Array to provide more information

Returns: int 0 if KO, 1 if OK

Definition at line 1226 of file memo.class.php.

◆ getAvailableMemoContext()

static Memo::getAvailableMemoContext ( )

static

Get available memo context.

Returns: string[]

Definition at line 1443 of file memo.class.php.

◆ getAvailableMemoContextMapping()

static Memo::getAvailableMemoContextMapping	(		$object = null,
			$onlyActiveModules = true )

static

Get available memo context.

Parameters

null	$object	the common Dolibarr object
bool	$onlyActiveModules	on true return only

Returns: array<string, array<string>>

Definition at line 1351 of file memo.class.php.

Referenced by modQuickMemo\__construct().

◆ getColorPreset()

static Memo::getColorPreset ( )

static

Get color preset.

Returns: string[]

Definition at line 1255 of file memo.class.php.

◆ getJsMemo()

Memo::getJsMemo ( User $currentUser )

Get JS memo.

Parameters

User $currentUser Current user

Returns: stdClass

Definition at line 1702 of file memo.class.php.

References dol_print_date(), and getJsMemoDefault().

◆ getJsMemoDefault()

static Memo::getJsMemoDefault ( )

static

Get JS memo default.

Returns: stdClass

Definition at line 1754 of file memo.class.php.

Referenced by getJsMemo().

◆ getKanbanView()

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

Return a thumb for kanban views.

Parameters

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

Returns: string HTML Code for Kanban thumb.

Definition at line 999 of file memo.class.php.

◆ getLabelStatus()

Memo::getLabelStatus ( $mode = 0 )

Return the label of the status.

Parameters

int<0,6> $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns: string Label of status

Definition at line 1071 of file memo.class.php.

◆ getLibStatut()

Memo::getLibStatut ( $mode = 0 )

Return the label of the status.

Parameters

int<0,6> $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns: string Label of status

Definition at line 1082 of file memo.class.php.

◆ getMemoContext()

static Memo::getMemoContext	(		$context,
			$object = null )

static

Get memo context.

Parameters

	string\|array<string>	$context Context
CommonObject \| null	$object	the common Dolibarr object

Returns: mixed|string

Definition at line 1283 of file memo.class.php.

Referenced by ActionsQuickMemo\addMoreActionsButtons(), and ActionsQuickMemo\llxFooter().

◆ getMemosQuery()

Memo::getMemosQuery	(	$element_type,
		$element_id,
		$context,
		$id = 0 )

Get memos query.

Parameters

string	$element_type	Type of element
int	$element_id	Id of element
string	$context	Context
int	$id	Id

Returns: string

Definition at line 1525 of file memo.class.php.

◆ getNextNumRef()

Memo::getNextNumRef ( )

Returns the reference to the following non used object depending on the active numbering module.

Returns: string Object free reference

Definition at line 1210 of file memo.class.php.

◆ getNomUrl()

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

Return a link to the object card (with optionally the picto)

Parameters

int	$withpicto	Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
string	$option	On what the link point to ('nolink', ...)
int	$notooltip	1=Disable tooltip
string	$morecss	Add more css on link
int	$save_lastsearch_value	-1=Auto, 0=No save of lastsearch_values when clicking, 1=Save lastsearch_values whenclicking

Returns: string String with URL

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

◆ getTemplateMemosQuery()

Memo::getTemplateMemosQuery	(	$element_type,
		$context_tab = '',
		$id = 0 )

Get template memos query.

Parameters

string	$element_type	Type of element
string	$context_tab	Context tab
int	$id	Id

Returns: string

Definition at line 1560 of file memo.class.php.

◆ getTooltipContentArray()

Memo::getTooltipContentArray ( $params )

getTooltipContentArray

Parameters

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

Since: v18

Returns: array{optimize?:string,picto?:string,ref?:string}

Reimplemented from CommonObject.

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

◆ info()

Memo::info ( $id )

Load the info information in the object.

Parameters

int $id Id of object

Returns: void

Definition at line 1134 of file memo.class.php.

◆ initAsSpecimen()

Memo::initAsSpecimen ( )

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

Returns: int

Definition at line 1195 of file memo.class.php.

◆ LibStatut()

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

Return the label of a given status.

Parameters

int	$status	Id status
	int<0,6>	$mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short label + Picto, 6=Long label + Picto

Returns: string Label of status

Definition at line 1095 of file memo.class.php.

◆ loadQuickMemoJsInterface()

static Memo::loadQuickMemoJsInterface ( $jsConfVars )

static

Load the Javascript interface for QuickMemo.

Parameters

array<string|mixed> $jsConfVars Configuration variables

Returns: bool

Definition at line 1624 of file memo.class.php.

Referenced by ActionsQuickMemo\addMoreActionsButtons(), and ActionsQuickMemo\llxFooter().

◆ reopen()

Memo::reopen	(		$user,
			$notrigger = 0 )

Set back to validated status.

Parameters

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

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

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

◆ setArchived()

Memo::setArchived	(		$user,
			$notrigger = 0 )

Set archived status.

Parameters

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

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

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

◆ setDraft()

Memo::setDraft	(		$user,
			$notrigger = 0 )

Set draft status.

Parameters

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

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

Definition at line 748 of file memo.class.php.

◆ setUnArchived()

Memo::setUnArchived	(		$user,
			$notrigger = 0 )

Set unarchived status.

Parameters

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

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

Definition at line 789 of file memo.class.php.

◆ showOutputField()

Memo::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{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 of field to show
string	$key	Key of attribute
string \| int \| null	$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 parameters on html 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 use (Old usage: May also be a numeric to define a size).

Returns: string

Definition at line 1602 of file memo.class.php.

◆ update()

Memo::update	(	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 472 of file memo.class.php.

References CommonObject\updateCommon().

Referenced by updatePosition().

◆ updatePosition()

Memo::updatePosition	(	User	$user,
		int	$x,
		int	$y,
		int	$w,
		int	$h,
		int	$z )

Update position of a memo for a specific user.

Parameters

User	$user	Dolibarr user
int	$x	Position X
int	$y	Position Y
int	$w	Width
int	$h	Height
int	$z	Z-index (rank)

Returns: bool True if success, false if error

Definition at line 489 of file memo.class.php.

References dol_now(), and update().

◆ validate()

Memo::validate	(		$user,
			$notrigger = 0 )

Validate object.

Parameters

User	$user	User making status change
	int<0,1>	$notrigger 1=Does not execute triggers, 0= execute triggers

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

Definition at line 612 of file memo.class.php.

Member Data Documentation

◆ $fields

Memo::$fields

Initial value:

= array(
    "rowid" => array("type" => "integer", "label" => "TechnicalID", 'enabled' => 1, 'position' => 1, 'notnull' => 1, "visible" => 0, 'noteditable' => 1, 'index' => 1, "css" => "left", "comment" => "Id"),
    "quick_note" => array("type" => "text", "label" => "Note", 'enabled' => 1, 'position' => 61, 'notnull' => 0, "visible" => -1, "cssview" => "wordbreak", "validate" => 1,),
    "date_creation" => array("type" => "datetime", "label" => "DateCreation", 'enabled' => 1, 'position' => 500, 'notnull' => 1, "visible" => -2,),
    "tms" => array("type" => "timestamp", "label" => "DateModification", 'enabled' => 1, 'position' => 501, 'notnull' => 0, "visible" => -2,),
    "date_archived" => array("type" => "timestamp", "label" => "DateArchived", 'enabled' => 1, 'position' => 502, 'notnull' => 0, "visible" => -2,),
    "fk_user_creat" => array("type" => "integer:User:user/class/user.class.php", "label" => "UserAuthor", "picto" => "user", 'enabled' => 1, 'position' => 510, 'notnull' => 1, "visible" => -2, "csslist" => "tdoverflowmax150",),
    "fk_user_modif" => array("type" => "integer:User:user/class/user.class.php", "label" => "UserModif", "picto" => "user", 'enabled' => 1, 'position' => 511, 'notnull' => -1, "visible" => -2, "csslist" => "tdoverflowmax150",),
    "fk_user_archived" => array("type" => "integer:User:user/class/user.class.php", "label" => "ArchivedBy", "picto" => "user", 'enabled' => 1, 'position' => 511, 'notnull' => -1, "visible" => -2, "csslist" => "tdoverflowmax150",),
    "fk_element" => array('type' => 'integer','label' => 'MemoLinkedTo','help' => 'MemoLinkedToHelp','enabled' => 1,'visible' => 5,'notnull' => 0,'default' => 0,'index' => 1,'position' => 0),
    "element_type" => array('type' => 'varchar(64)','label' => 'QuickMemoElementType','enabled' => 1,'visible' => 5,'position' => 10,'required' => 0),
    "pos_z" => array("type" => "integer", "label" => "PosZ", 'enabled' => 1, 'position' => 1000, 'notnull' => 1, "visible" => 0, "default" => 0, "validate" => 1),
    "pos_y" => array("type" => "integer", "label" => "PosY", 'enabled' => 1, 'position' => 1000, 'notnull' => 1, "visible" => 0, "default" => 0, "validate" => 1),
    "pos_x" => array("type" => "integer", "label" => "PosX", 'enabled' => 1, 'position' => 1000, 'notnull' => 1, "visible" => 0, "default" => 0, "validate" => 1),
    "pos_w" => array("type" => "integer", "label" => "PosW", 'enabled' => 1, 'position' => 1000, 'notnull' => 1, "visible" => 0, "default" => 0, "validate" => 1),
    "pos_h" => array("type" => "integer", "label" => "PosH", 'enabled' => 1, 'position' => 1000, 'notnull' => 1, "visible" => 0, "default" => 0, "validate" => 1),
    "color" => array('type' => 'varchar(10)', 'label' => 'Color','enabled' => 1,'visible' => 1,'position' => 10,'required' => 0),
    "context_tab" => array('type' => 'varchar(64)', 'label' => 'ContextTab','enabled' => 1,'visible' => 1,'position' => 10,'required' => 0),
    "private" => array("type" => "integer", "label" => "Private", 'enabled' => 1, 'position' => 1990, 'notnull' => 1, "visible" => 1, 'index' => 1, "arrayofkeyval" => array(0 => "No", 1 => "Yes"),'default' => 1, "validate" => 1,),
    "private_tpl" => array("type" => "integer", "label" => "PrivateTemplate", 'enabled' => 1, 'position' => 1990, 'notnull' => 0, "visible" => 1, 'index' => 1, "arrayofkeyval" => array(0 => "No", 1 => "Yes"),'default' => 0, "validate" => 1,),
    "rank_tpl" => array("type" => "integer", "label" => "TemplateRank", 'enabled' => 1, 'position' => 1990, 'notnull' => 0, "visible" => 0, 'index' => 1,'default' => 0, "validate" => 1,),
    "name_tpl" => array('type' => 'varchar(256)','label' => 'QuickMemoTemplateName','enabled' => 1,'visible' => -1,'position' => 1,'required' => 0),
    "shared_on_element" => array("type" => "integer", "label" => "SharedBetweenElement", 'enabled' => 1, 'position' => 1991, 'notnull' => 1, "visible" => 1, 'index' => 1, "arrayofkeyval" => array(0 => "No", 1 => "Yes"), "validate" => 1,),
    "import_key" => array("type" => "varchar(14)", "label" => "ImportId", 'enabled' => 1, 'position' => 1000, 'notnull' => -1, "visible" => -2,),
    "status" => array("type" => "integer", "label" => "Status", 'enabled' => 1, 'position' => 2000, 'notnull' => 1, "visible" => 1, 'index' => 1, "arrayofkeyval" => array(1 => "Active",2 => "Template",  9 => "Archived"), "validate" => 1,),
  )

'type' field format: 'integer', 'integer:ObjectClass:PathToClass[:AddCreateButtonOrNot[:Filter[:Sortfield]]]', 'select' (list of values are in 'options'.

for integer list of values are in 'arrayofkeyval'), 'sellist:TableName:LabelFieldName[:KeyFieldName[:KeyFieldParent[:Filter[:CategoryIdType[:CategoryIdList[:SortField]]]]]]', 'chkbxlst:...', 'varchar(x)', 'text', 'text:none', 'html', 'double(24,8)', 'real', 'price', 'stock', 'date', 'datetime', 'timestamp', 'duration', 'boolean', 'checkbox', 'radio', 'array', 'email', 'phone', 'url', 'password', 'ip' Note: Filter must be a Dolibarr Universal Filter syntax string. Example: "(t.ref:like:'SO-%') or (t.date_creation:>:'20160101') or (t.status:!=:0) or (t.nature:is:NULL)" 'length' the length of field. Example: 255, '24,8' 'label' the translation key. 'langfile' the key of the language file for translation. 'alias' the alias used into some old hard coded SQL requests 'picto' is code of a picto to show before value in forms 'enabled' is a condition when the field must be managed (Example: 1 or 'getDolGlobalInt("MY_SETUP_PARAM")' or 'isModEnabled("multicurrency")' ...) 'position' is the sort order of field. 'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0). 'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view forms, 2=Visible on list only, 3=Visible on create/update/view form only (not list), 4=Visible on list and update/view form (not create). 5=Visible on list and view form (not create/not update). 6=visible on list and update/view form (not update). Using a negative value means field is not shown by default on list but can be selected for viewing) 'noteditable' says if field is not editable (1 or 0) 'alwayseditable' says if field can be modified also when status is not draft ('1' or '0') 'default' is a default value for creation (can still be overwritten by the Setup of Default Values if the field is editable in creation form). Note: If default is set to '(PROV)' and field is 'ref', the default value will be set to '(PROVid)' where id is rowid when a new record is created. 'index' if we want an index in database. 'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...). 'searchall' is 1 if we want to search in this field when making a search from the quick search button. 'isameasure' must be set to 1 or 2 if field can be used for measure. Field type must be summable like integer or double(24,8). Use 1 in most cases, or 2 if you don't want to see the column total into list (for example for percentage) 'css' and 'cssview' and 'csslist' is the CSS style to use on field. 'css' is used in creation and update. 'cssview' is used in view mode. 'csslist' is used for columns in lists. For example: 'css'=>'minwidth300 maxwidth500 widthcentpercentminusx', 'cssview'=>'wordbreak', 'csslist'=>'tdoverflowmax200' 'placeholder' to set the placeholder of a varchar field. 'help' and 'helplist' is a 'TranslationString' to use to show a tooltip on field. You can also use 'TranslationString:keyfortooltiponlick' for a tooltip on click. 'showoncombobox' if value of the field must be visible into the label of the combobox that list record 'disabled' is 1 if we want to have the field locked by a 'disabled' attribute. In most cases, this is never set into the definition of $fields into class, but is set dynamically by some part of code like the constructor of the class. 'arrayofkeyval' to set a list of values if type is a list of predefined values. For example: array("0"=>"Draft","1"=>"Active","-1"=>"Cancel"). Note that type can be 'integer' or 'varchar' 'autofocusoncreate' to have field having the focus on a create form. Only 1 field should have this property set to 1. 'comment' is not used. You can store here any text of your choice. It is not used by application. 'validate' is 1 if you need to validate the field with $this->validateField(). Need MAIN_ACTIVATE_VALIDATION_RESULT. 'copytoclipboard' is 1 or 2 to allow to add a picto to copy value into clipboard (1=picto after label, 2=picto after value)

Note: To have value dynamic, you can set value to 0 in definition and edit the value on the fly into the constructor. Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.

Definition at line 133 of file memo.class.php.

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

dolibarr_dev/htdocs/quickmemo/class/memo.class.php

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancel()

◆ checkColor()

◆ completeMemoContextMapping()

◆ countArchivedMemoQuery()

◆ create()

◆ createFromClone()

◆ delete()

◆ deleteLine()

◆ fetch()

◆ fetchAll()

◆ fetchLines()

◆ generateDocument()

◆ getAvailableMemoContext()

◆ getAvailableMemoContextMapping()

◆ getColorPreset()

◆ getJsMemo()

◆ getJsMemoDefault()

◆ getKanbanView()

◆ getLabelStatus()

◆ getLibStatut()

◆ getMemoContext()

◆ getMemosQuery()

◆ getNextNumRef()

◆ getNomUrl()

◆ getTemplateMemosQuery()

◆ getTooltipContentArray()

◆ info()

◆ initAsSpecimen()

◆ LibStatut()

◆ loadQuickMemoJsInterface()

◆ reopen()

◆ setArchived()

◆ setDraft()

◆ setUnArchived()

◆ showOutputField()

◆ update()

◆ updatePosition()

◆ validate()

Member Data Documentation

◆ $fields