Commande

Name of property

Value for replacement property

Name of property

Value of property

Name of property

Name of property

Name of method

Method arguments

Mapping of deprecated properties

Mapping of deprecated methods

Trigger's name to execute

Object user

Result of run_triggers

Id of object @param string $ref Ref of object to check @param string $ref_ext Ref ext of object to check @return int Return integer <0 if KO, 0 if OK but not found, >0 if OK and exists

commonobject or HookManager

String with errors

Customer ref

Customer ref formatted

Supplier ref

Supplier ref formatted

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

Full address string

Module related to document

Init the share key if it was not yet defined

0=Return full external link, 1=Return link relative to root of file

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

Type of contact (code or id). Must be id or code found into table llx_c_type_contact. For example: SALESREPFOLL @param string $source external=Contact extern (llx_socpeople), internal=Contact intern (llx_user) @param int $notrigger Disable all triggers @return int Return integer <0 if KO, 0 if already added or code not valid, >0 if OK

Nature of contact ('internal' or 'external') @return int >0 if OK, <0 if KO

New status of link @param int $type_contact_id Id of contact type (not modified if 0) @param int $fk_socpeople Id of soc_people to update (not modified if 0) @return int Return integer <0 if KO, >= 0 if OK

Disable all triggers @return int >0 if OK, <0 if KO

Type of contact (code or id) @return int Return integer <0 if KO, 0=Nothing done, >0 if OK

Source of contact: 'external' or 'thirdparty' (llx_socpeople) or 'internal' (llx_user) @param int<0,1> $list 0:Returned array contains all properties, 1:Return array contains just id @param string $code Filter on this code of contact type ('SHIPPING', 'BILLING', ...) @param int $status Status of user or company @param int[] $arrayoftcids Array with ID of type of contacts. If we provide this, we can filter on ec.fk_c_type_contact IN ($arrayoftcids) to avoid a link on c_type_contact table (faster). @return array<int,array{parentId:int,source:string,socid:int,id:int,nom:string,civility:string,lastname:string,firstname:string,email:string,login:string,photo:string,gender:string,statuscontact:int,rowid:int,code:string,libelle:string,status:int,fk_c_type_contact:int}>|int<-1,-1> Array of contacts, -1 if error

Return integer <0 if KO, >=0 if OK

Sort order by : 'position', 'code', 'rowid'... @param int<0,1> $option 0=Return array id->label, 1=Return array code->label, 2=Return complete array @param int<0,1> $activeonly 0=all status of contact, 1=only the active @param string $code Type of contact (Example: 'CUSTOMER', 'SERVICE') @return array<int,string>|array<string,string>|array<int,array{id:int,code:string,label:string}>|null Array list of type of contacts (id->label if option=0, code->label if option=1), or null if error

0=Return array id->label, 1=Return array code->label @param int<0,1> $activeonly 0=all status of contact, 1=only the active @param string $code Type of contact (Example: 'CUSTOMER', 'SERVICE') @param string $element Filter on 1 element type @param string $excludeelement Exclude 1 element type. Example: 'agenda' @return array<int,string>|array<string,string>|null Array list of type of contacts (id->label if option=0, code->label if option=1), or null if error

'external' or 'internal' @param string $code 'BILLING', 'SHIPPING', 'SALESREPFOLL', ... @param int $status limited to a certain status @return int[]|null List of id for such contacts, or null if error

Return integer <0 if KO, >0 if OK

Return integer <0 if KO, >0 if OK @phan-suppress PhanUndeclaredProperty

1 = OK, 0 = Not found or table_ref_field not defined, <0 = KO

Return integer <0 if KO, 0 if can't guess type of barcode (ISBN, EAN13...), >0 if OK (all barcode properties loaded) @deprecated Use fetchBarCode()

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

Return integer <0 if KO, >=0 if OK

Id du contact

Return integer <0 if KO, >0 if OK

Field selected @param string $key Import key @param string $element Element name

Return -1 or false if KO, >0 if OK

Table of element or element line

Element id

Field selected

Return integer <0 if KO, >0 if OK

Field to update

New value

To force other table element or element line (should not be used)

To force other object id (should not be used)

Data format ('text', 'int', 'date'). 'text' is used if not defined

To force rowid field name. 'rowid' is used if not defined

Update the user of last update field with this user. If not provided, current user is used except if value is 'none' @param string $trigkey Trigger key to run (in most cases something like 'XXX_MODIFY') @param string $fk_user_field Name of field to save user id making change

Return integer <0 if KO, >0 if OK updateExtraField()

Name of field to use for the select MAX and MIN @param int<0,1> $nodbprefix Do not include DB prefix to forge table name @return int<-2,1> Return integer <0 if KO, >0 if OK

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)

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

Return integer <0 if KO, >0 if OK

0 if OK, <0 if KO

0 if OK, <0 if KO

mode 1 : amounts in company currency will be recalculated, mode 2 : amounts in foreign currency will be recalculated @return int >0 if OK, <0 if KO

% of deposit if needed by payment terms @return int >0 if OK, <0 if KO

0 if OK, <0 if KO

0 if OK, <0 if KO

Address id

Return integer <0 si ko, >0 si ok

0=launch triggers after, 1=disable triggers @param User $userused Object user @return int 1 if OK, 0 if KO

1 if OK, 0 if KO

Modele name @return int Return integer <0 if KO, >0 if OK

0=launch triggers after, 1=disable triggers @param User $userused Object user @return int 1 if OK, 0 if KO

True to renum all already ordered lines, false to renum only not already ordered lines. @param string $rowidorder ASC or DESC @param boolean $fk_parent_line Table with fk_parent_line field or not @return int Return integer <0 if KO, >0 if OK

0 = 1st level child, 1 = All level child, 2-1001: internal use @return int[] Array with list of children lines id

Table with fk_parent_line field or not @return void

Table with fk_parent_line field or not @return void

Position @return int<-1,1> Return integer <0 if KO, >0 if OK

Position @return int<-1,1> Return integer <0 if KO, >0 if OK

Position @param int $max Max @return int<-1,1> Return integer <0 if KO, >0 if OK

Value of rang in table of lines

Rowid of the line

Max value of rang in table of lines

Return integer <0 if KO, >0 if OK

'', '_public' or '_private' @param int $notrigger 1=Does not execute triggers, 0=execute triggers @return int Return integer <0 if KO, >0 if OK

New value for note

Return integer <0 if KO, >0 if OK

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

Return integer <0 if KO, >0 if OK

Object source id (if not defined, $this->id)

Object source type (if not defined, $this->element)

Object target id (if not defined, $this->id)

Object target type (if not defined, $this->element)

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

Return integer <0 if KO, >0 if OK @see add_object_linked(), updateObjectLinked(), deleteObjectLinked()

Return integer <0 if KO, >0 if OK @see fetchObjectLinked()

id of object we need to get linked items

name of field we need to get a list

name of field of object we need to get linked items

name of association table

Array of record, -1 if empty

id of object we need to get linked items

name of field of object we need to get linked items

name of association table

Array of record, -1 if empty

id of object we need to remove linked items

name of field of object we need to delete linked items

name of association table

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

Id of element to force (use this->id by default if null) @param string $elementType Type of element to force (use this->table_element by default) @param string $trigkey Trigger key to use for trigger, or 'none' or use '' means automatic but it is not recommended and is deprecated. @param string $fieldstatus Name of status field to update (commonly field 'status' or 'fk_statut' in this->table_element) @return int Return integer <0 if KO, >0 if OK setStatusCommon()

Record ref @return int Return integer <0 if KO, 0 if nothing done, >0 if OK

Special code

Force id of object @param int $entity Force entity to check @return int Return integer <0 if KO, 0 if not used, >0 if already used

-1=All, 0=Count free product/service only, 1=Count predefined product/service only, 2=Count predefined product, 3=Count predefined service @return int Return integer <0 if KO, 0 if no predefined products, nb of lines with predefined products if found

Total amount of discount, or null if $table_element_line is empty

Return integer <0 if KO, >0 if OK

Object thirdparty who sell @param ?Societe $buyer Object thirdparty who buy @param string $defaulttpldir Directory where to find the template

Action code

Object of seller third party

Object of buyer third party

ID line selected

1=Show also date range input fields @param string $defaulttpldir Directory where to find the template

GET/POST action

Selected object line to output

Not used

Number of line (0)

1=Show also date range input fields

Object of seller third party

Object of buyer third party

ID line selected @param ?ExtraFields $extrafields Object of extrafields @param string $defaulttpldir Directory where to find the template (deprecated)

''=All lines, 'services'=Restrict to services only @param int[] $selectedLines Array of lines id for selected lines @return void

Line @param string $var Not used

''=All lines, 'services'=Restrict to services only (strike line if not) @param string $defaulttpldir Directory where to find the template @param int[] $selectedLines Array of lines id for selected lines @return void

Resource id

Busy or not

Mandatory or not @param int $notrigger Disable all triggers

Return integer <=0 if KO, >0 if OK

element name (for trigger) replaced by $this->TRIGGER_PREFIX @param int $notrigger Disable all triggers @return int >0 if OK, <0 if KO

Relative folder where generators are placed

Generator to use. Caller must set it to from obj->model_pdf or from GETPOST for example.

Output language to use

1 to hide details. 0 by default

1 to hide product description. 0 by default

1 to hide product reference. 0 by default

Array to provide more information

0 if OK, <0 if KO

Full path of file to index

Update field main_doc field into the table of the object. This param is set when called for a document generation if document generator hase ->update_main_doc_field set and returns ->result['fullpath'].

Return integer <0 if KO, >0 if OK

Path file in UTF8 to original file to create thumbs from. @param int $quality Quality after compression (0=worst so better compression, 100=best so low or no compression). For thumbs, we force quality to 50 by default.

Path file in UTF8 to original file to delete thumbs.

Name of field

Alternate value to use

Type of data

Default value (can be an array if the GETPOST return an array)

Return integer <0 if error, 0 if no values of alternative languages to find nor found, 1 if a value was found and loaded fetch_optionnals()

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.

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

ID of object

0 if OK, 0 if not found, <0 if KO

Array resulting of call of extrafields->fetch_name_optionals_label(). Deprecated. Function must be called without parameters. @return int<-1,1> Return integer <0 if error, 0 if no values of extrafield to find nor found, 1 if an attribute is found and value loaded fetchValuesForExtraLanguages()

If defined, call also the trigger (for example COMPANY_MODIFY). Must be used for action 'update_extras'. For other actions, trigger is called explicitly by caller. @param User $userused Object user @return int<-1,1> -1=error, O=did nothing, 1=OK insertExtraLanguages(), updateExtraField(), deleteExtraField(), setValueFrom()

If defined, call also the trigger (for example COMPANY_MODIFY) @param User $userused Object user @return int<-1,1> -1=error, O=did nothing, 1=OK insertExtraFields(), updateExtraField(), setValueFrom()

Key of the extrafield to update (without starting 'options_') @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) @param User $userused Object user @return int<-1,1> -1=error, O=did nothing, 1=OK updateExtraLanguages(), insertExtraFields(), deleteExtraFields(), setValueFrom()

Name of the extrafield

Name of the extrafield

Value to be assigned to the extrafield

Key of the extrafield (without starting 'options_') @param string $trigger If defined, call also the trigger (for example COMPANY_MODIFY) @param User $userused Object user @return int -1=error, O=did nothing, 1=OK updateExtraField(), insertExtraLanguages()

Array of properties for field to show (used only if ->fields not defined, so try to keep this null)

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 array type must be array)

To add more parameters on html input tag

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)

Value for css to define style/length of field. May also be a numeric.

Force to not show the new button on field that are links to object

Array of properties of field to show

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)

To add more parameters on html tag

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

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

Value for CSS to use (Old usage: May also be a numeric to define a size).

Key of attribute to clear

Key of attribute

the field error message

Key of attribute

Error message of validation ('' if no error)

Array of properties of field to show

Key of attribute

Value of attribute

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