FormFile

HTML name

Module part

Main directory of module

Subdirectory into main directory. Often '', can be 'logos/'.

File name of image to show

HTML code to show and edit image

Title zone (Title or '' or 'none') @param int<0,1> $addcancel 1=Add 'Cancel' button

If upload must be done inside a particular ECM section (is sectionid defined, sectiondir must not be) @param int $perm Value of permission to allow upload @param int $size Length of input file area. Deprecated. @param CommonObject|BlockedLog|null $object Object to use (when attachment is done on an element) @param string $options Add an option column @param int<0,1> $useajax Use fileupload ajax (0=never, 1=if enabled, 2=always whatever is option). Deprecated 2 should never be used and if 1 is used, option should not be enabled. @param string $savingdocmask Mask to use to define output filename. For example 'XXXXX-YYYYMMDD-file' @param int<0,1> $linkfiles 1=Also add form to link files, 0=Do not show form to link files @param string $htmlname Name and id of HTML form ('formuserfile' by default, 'formuserfileecm' when used to upload a file in ECM) @param string $accept Specifies the types of files accepted (This is not a security check but an user interface facility. eg '.pdf,image/' or '.png,.jpg' or 'video/')

If upload must be done inside a particular directory (if sectiondir defined, sectionid must not be) @param int<0,2> $usewithoutform 0=Default, 1=Disable

Sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module. @param string $filedir Directory to scan @param string $urlsource Url of origin page (for return) @param int<0,1> $genallowed Generation is allowed (1/0 or array of formats) @param int<0,1> $delallowed Remove is allowed (1/0) @param string $modelselected Model to preselect by default @param integer $allowgenifempty Show warning if no model activated @param integer $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined) @param int $iconPDF Show only PDF icon with link (1/0) @param int $notused Not used @param integer $noform Do not output html form tags @param string $param More param on http links @param string $title Title to show on top of form @param string $buttonlabel Label on submit button @param string $codelang Default language code to use on lang combo box if multilang is enabled @return int Return integer <0 if KO, number of shown files if OK @deprecated Use print xxx->showdocuments() instead.

Module the files are related to ('propal', 'facture', 'facture_fourn', 'mymodule', 'mymodule:MyObject', 'mymodule_temp', ...) @param string $modulesubdir Existing (so sanitized) sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into a subdir of module. @param string $filedir Directory to scan (must not end with a /). Example: '/mydolibarrdocuments/facture/FAYYMM-1234' @param string $urlsource Url of origin page (for return) @param int<0,1>|string[] $genallowed Generation is allowed (1/0 or array list of templates) @param int<0,1> $delallowed Remove is allowed (1/0) @param string $modelselected Model to preselect by default @param int<0,1> $allowgenifempty Allow generation even if list of template ($genallowed) is empty (show however a warning) @param int<0,1> $forcenomultilang Do not show language option (even if MAIN_MULTILANGS defined) @param int $iconPDF Deprecated, see getDocumentsLink @param int $notused Not used @param int<0,1> $noform Do not output html form tags @param string $param More param on http links @param string $title Title to show on top of form. Example: '' (Default to "Documents") or 'none' @param string $buttonlabel Label on submit button @param string $codelang Default language code to use on lang combo box if multilang is enabled @param string $morepicto Add more HTML content into cell with picto @param Object|null $object Object when method is called from an object card. @param int<0,1> $hideifempty Hide section of generated files if there is no file @param string $removeaction (optional) The action to remove a file @param string $tooltipontemplatecombo Text to show on a tooltip after the combo list of templates @return string|int<-1,-1> Output string with HTML array of documents (might be empty string)

'propal', 'facture', 'facture_fourn', ...

Sub-directory to scan (Example: '0/1/10', 'FA/DD/MM/YY/9999'). Use '' if file is not into subdir of module.

Full path to directory to scan @param string $filter Filter filenames on this regex string (Example: '.pdf$') @param string $morecss Add more css to the download picto @param int<0,1> $allfiles 0=Only generated docs, 1=All files

Output string with HTML link of documents (might be empty string). This also fill the array ->infofiles

Array of files loaded by dol_dir_list('files') function before calling this. @param ?CommonObject $object Object on which document is linked to. @param string $modulepart Value for modulepart used by download or viewimage wrapper. @param string $param Parameters on sort links (param must start with &, example &aaa=bbb&ccc=ddd) @param int<0,1> $forcedownload Force to open dialog box "Save As" when clicking on file. @param string $relativepath Relative path of docs (autodefined if not provided), relative to module dir, not to MAIN_DATA_ROOT. @param int<0,1> $permonobject Permission on object (so permission to delete or crop document) @param int<0,6> $useinecm Change output to add more information: 0, 4, 5, 6: Add a preview column. Show also a rename button. Show also a crop button for some values of $modulepart (must be supported into hard coded list in this function + photos_resize.php + restrictedArea + checkUserAccessToObject) 1: Add link to edit ECM entry 2: Add rename and crop link 5: Add link to edit ECM entry and add a preview column @param string $textifempty Text to show if filearray is empty ('NoFileFound' if not defined) @param int $maxlength Maximum length of file name shown. @param string $title Title before list. Use 'none' to disable title. @param string $url Full url to use for click links ('' = autodetect) @param int<0,1> $showrelpart 0=Show only filename (default), 1=Show first level 1 dir @param int<-1,1> $permtoeditline Permission to edit document line (You must provide a value, -1 is deprecated and must not be used any more) @param string $upload_dir Full path directory so we can know dir relative to MAIN_DATA_ROOT. Fill this to complete file data with database indexes. @param string $sortfield Sort field ('name', 'size', 'position', ...) @param string $sortorder Sort order ('ASC' or 'DESC') @param int<0,1> $disablemove 1=Disable move button, 0=Position move is possible. @param int<0,1> $addfilterfields Add the line with filters @param int<-1,1> $disablecrop Disable crop feature on images (-1 = auto, prefer to set it explicitly to 0 or 1) @param string $moreattrondiv More attributes on the div for responsive. Example 'style="height:280px; overflow: auto;"' @param array<string,mixed> $moreoptions Add more options like array('afteruploadtitle', ...) @return int Return integer <0 if KO, nb of files shown if OK list_of_autoecmfiles()

Array of files loaded by dol_dir_list('files') function before calling this. @param string $modulepart Value for modulepart used by download wrapper. Value can be $object->table_name (that is 'myobject' or 'mymodule_myobject') or $object->element.'-'.$module (for compatibility purpose) @param string $param Parameters on sort links @param int $forcedownload Force to open dialog box "Save As" when clicking on file @param string $relativepath Relative path of docs (autodefined if not provided) @param int $permissiontodelete Permission to delete @param int $useinecm Change output for use in ecm module @param string $textifempty Text to show if filearray is empty @param int $maxlength Maximum length of file name shown @param string $url Full url to use for click links ('' = autodetect) @param int $addfilterfields Add line with filters @return int Return integer <0 if KO, nb of files shown if OK list_of_documents()

Deletion is allowed

More param to add into URL

Html name of component

Add more options like array('afterlinktitle', ...)

Number of links

Array with data of file. Example: array('name'=>...)

propal, facture, facture_fourn, ...

Relative path of docs

Rule for picto: 0=Use the generic preview picto, 1=Use the picto of mime type of file). Use a negative value to show a generic picto even if preview not available.

More param on http links

$out Output string with HTML