ExtraFields

label of attribute @param string $type Type of attribute ('boolean', 'int', 'varchar', 'text', 'html', 'date', 'datetime', 'duration', 'price', 'pricecy', 'phone', 'email', 'password', 'url', 'select', 'checkbox', 'separate',...) @param int $pos Position of attribute @param string $size Size/length definition of attribute ('5', '24,8', ...). For float, it contains 2 numeric separated with a comma. @param string $elementtype Element type. Same value than object->table_element (Example 'member', 'product', 'thirdparty', ...) @param int<0,1> $unique Is field unique or not @param int<0,1> $required Is field required or not @param string $default_value Defaulted value (In database. use the default_value feature for default value on screen. Example: '', '0', 'null', 'avalue') @param array<string,mixed|mixed[]>|string $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) ) @param int<0,1> $alwayseditable Is attribute always editable regardless of the document status @param string $perms Permission to check @param string $list Visibility ('0'=never visible, '1'=visible on list+forms, '2'=list only, '3'=form only or 'eval string') @param string $help Text with help tooltip @param string $computed Computed value @param string $entity Entity of extrafields (for multicompany modules) @param string $langfile Language file @param string $enabled Condition to have the field enabled or not @param int<0,1> $totalizable Is a measure. Must show a total on lists @param int<0,1> $printable Is extrafield displayed on PDF @param array<string,mixed> $moreparams More parameters. Example: array('css'=>, 'csslist'=>Css on list, 'cssview'=>...) @param string $aiprompt Ai prompt value @param int<0,1> $emptyonclone Is attribute to be emptied after object clone @return int Return integer <=0 if KO, >0 if OK

label of attribute @param string $type Type of attribute ('boolean', 'int', 'varchar', 'text', 'html', 'date', 'datetime', 'duration', 'price', 'pricecy', 'phone', 'email', 'password', 'url', 'select', 'checkbox', 'separate',...) @param int $pos Position of attribute @param string $size Size/length definition of attribute ('5', '24,8', ...). For float, it contains 2 numeric separated with a comma. @param string $elementtype Element type. Same value than object->table_element (Example 'member', 'product', 'thirdparty', ...) @param int<0,1> $unique Is field unique or not @param int<0,1> $required Is field required or not @param string $default_value Defaulted value (In database. use the default_value feature for default value on screen. Example: '', '0', 'null', 'avalue') @param array<string,mixed|mixed[]>|string $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) ) @param int<0,1> $alwayseditable Is attribute always editable regardless of the document status @param string $perms Permission to check @param string $list Visibility ('0'=never visible, '1'=visible on list+forms, '2'=list only, '3'=form only or 'eval string') @param string $help Text with help tooltip @param string $computed Computed value @param string $entity Entity of extrafields (for multicompany modules) @param string $langfile Language file @param string $enabled Condition to have the field enabled or not @param int<0,1> $totalizable Is a measure. Must show a total on lists @param int<0,1> $printable Is extrafield displayed on PDF @param array<string,mixed> $moreparams More parameters. Example: array('css'=>, 'csslist'=>Css on list, 'cssview'=>...)

Is attribute to be emptied after object clone @return int Return integer <=0 if KO, >0 if OK

Code of attribute to delete @param string $elementtype Element type ('member', 'product', 'thirdparty', 'contact', ...) @return int Return integer < 0 if KO, 0 if nothing is done, 1 if OK

Label of attribute @param string $type Type of attribute ('boolean', 'int', 'varchar', 'text', 'html', 'date', 'datetime', 'duration', 'price', 'phone', 'email', 'password', 'url', 'select', 'checkbox', ...) @param string $length Size/length of attribute ('5', '24,8', ...) @param string $elementtype Element type ('member', 'product', 'thirdparty', 'contact', ...) @param int<0,1> $unique Is field unique or not @param int<0,1> $required Is field required or not @param int<0,1> $pos Position of attribute @param array<string,mixed|mixed[]> $param Params for field (ex for select list : array('options' => array(value'=>'label of option')) ) @param int<0,1> $alwayseditable Is attribute always editable regardless of the document status @param string $perms Permission to check @param string $list Visibility @param string $help Help on tooltip @param string $default Default value (in database. use the default_value feature for default value on screen). @param string $computed Computed value @param string $entity Entity of extrafields @param string $langfile Language file @param string $enabled Condition to have the field enabled or not @param int<0,1> $totalizable Is extrafield totalizable on list @param int<0,1> $printable Is extrafield displayed on PDF @param array<string,mixed> $moreparams More parameters. Example: array('css'=>, 'csslist'=>, 'cssview'=>...) @param string $aiprompt Ai prompt value

Is attribute to be emptied after object clone @return int >0 if OK, <=0 if KO @throws Exception

Force load of extra fields whatever is status of cache. @param string $attrname The name of the attribute. @return array<string,string> Array of attributes keys+label for all extra fields. in addition $this->attributes will be completed with array{label:array<string,string>,type:array<string,string>,size:array<string,string>,default:array<string,string>,computed:array<string,string>,unique:array<string,int>,required:array<string,int>,param:array<string,mixed>,perms:array<string,mixed[]>,list:array<string,int>|array<string,string>,pos:array<string,int>,totalizable:array<string,int>,help:array<string,string>,printable:array<string,int>,enabled:array<string,int>,langfile:array<string,string>,css:array<string,string>,csslist:array<string,string>,hidden:array<string,int>,mandatoryfieldsofotherentities?:array<string,string>,loaded?:int,count:int} Note: count set as present to avoid static analysis notices

Key of attribute

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 dates in filter mode, a range array('start'=>, 'end'=>) should be provided

To add more parameters on html input tag

Suffix string to add after name and id of field (can be used to avoid duplicate names)

Prefix string to add before name and id of field (can be used to avoid duplicate names)

More css (to defined size of field. Old behaviour: may also be a numeric)

Current object or object ID. Preferably, pass the object itself.

The key to use to store retrieved data (commonly $object->table_element)

1=Used for search filters

Key of attribute

Value to show

To add more parameters on html input tag (only checkbox use html input for output rendering)

Required (for example $object->table_element).

The parent object of field to show

'' or 'list'

Formatted value

Key of attribute

If defined, use the new method to get extrafields data

Formatted value

Key of attribute

If defined, use the new method to get extrafields data

'csslist' (used on td into table list), 'css' (used on create/update), 'cssview' (used on view)

Formatted value

Key of attribute

Value of colspan to use (it must includes the first column with title)

"card" for form display, "line" for document line display (extrafields on propal line, order line, etc...)

Show output ('view') or input ('create' or 'edit') for extrafield

HTML code with line for separator

Deprecated (old $array of extrafields, now set this to null)

Only some keys are filled: 'string' => When we make update of only one extrafield ($action = 'update_extras'), calling page can set this to avoid to have other extrafields being reset. '@GETPOSTISSET' => When we make update of several extrafields ($action = 'update'), calling page can set this to avoid to have fields not into POST being reset.

1=Set value to the default value in database if value is mandatory and missing

1 if array_options set, 0 if no value, -1 if error (field required missing for example)

array of extrafields (old usage) or value of object->table_element (new usage)

Suffix string to add into name and id of field (can be used to avoid duplicate names)

Prefix string to add into name and id of field (can be used to avoid duplicate names)

array_options set or 0 if no value

Value to test

Type of extrafield 'sellist', 'link', 'select', ...

True is value is an empty value, not allowed for a mandatory field.