dolibarr
20.0.0-beta
|
Library for file managing functions. More...
Go to the source code of this file.
Functions | |
dol_basename ($pathfile) | |
Make a basename working with all page code (default PHP basenamed fails with cyrillic). More... | |
dol_dir_list ($utf8_path, $types="all", $recursive=0, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0, $nohook=0, $relativename="", $donotfollowsymlinks=0, $nbsecondsold=0) | |
Scan a directory and return a list of files/directories. More... | |
dol_dir_list_in_database ($path, $filter="", $excludefilter=null, $sortcriteria="name", $sortorder=SORT_ASC, $mode=0) | |
Scan a directory and return a list of files/directories. More... | |
completeFileArrayWithDatabaseInfo (&$filearray, $relativedir) | |
Complete $filearray with data from database. More... | |
dol_compare_file ($a, $b) | |
Fast compare of 2 files identified by their properties ->name, ->date and ->size. More... | |
dol_is_dir ($folder) | |
Test if filename is a directory. More... | |
dol_is_dir_empty ($dir) | |
Return if path is empty. More... | |
dol_is_file ($pathoffile) | |
Return if path is a file. More... | |
dol_is_link ($pathoffile) | |
Return if path is a symbolic link. More... | |
dol_is_writable ($folderorfile) | |
Test if directory or filename is writable. More... | |
dol_is_url ($uri) | |
Return if path is an URI (the name of the method is misleading). More... | |
dol_dir_is_emtpy ($folder) | |
Test if a folder is empty. More... | |
dol_count_nb_of_line ($file) | |
Count number of lines in a file. More... | |
dol_filesize ($pathoffile) | |
Return size of a file. More... | |
dol_filemtime ($pathoffile) | |
Return time of a file. More... | |
dol_fileperm ($pathoffile) | |
Return permissions of a file. More... | |
dolReplaceInFile ($srcfile, $arrayreplacement, $destfile='', $newmask='0', $indexdatabase=0, $arrayreplacementisregex=0) | |
Make replacement of strings into a file. More... | |
dol_copy ($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=0) | |
Copy a file to another file. More... | |
dolCopyDir ($srcfile, $destfile, $newmask, $overwriteifexists, $arrayreplacement=null, $excludesubdir=0, $excludefileext=null, $excludearchivefiles=0) | |
Copy a dir to another dir. More... | |
dol_move ($srcfile, $destfile, $newmask='0', $overwriteifexists=1, $testvirus=0, $indexdatabase=1, $moreinfo=array()) | |
Move a file into another name. More... | |
dol_move_dir ($srcdir, $destdir, $overwriteifexists=1, $indexdatabase=1, $renamedircontent=1) | |
Move a directory into another name. More... | |
dol_unescapefile ($filename) | |
Unescape a file submitted by upload. More... | |
dolCheckVirus ($src_file, $dest_file='') | |
Check virus into a file. More... | |
dolCheckOnFileName ($src_file, $dest_file='') | |
Check virus into a file. More... | |
dol_move_uploaded_file ($src_file, $dest_file, $allowoverwrite, $disablevirusscan=0, $uploaderrorcode=0, $nohook=0, $varfiles='addedfile', $upload_dir='') | |
Check validity of a file upload from an GUI page, and move it to its final destination. More... | |
dol_delete_file ($file, $disableglob=0, $nophperrors=0, $nohook=0, $object=null, $allowdotdot=false, $indexdatabase=1, $nolog=0) | |
Remove a file or several files with a mask. More... | |
dol_delete_dir ($dir, $nophperrors=0) | |
Remove a directory (not recursive, so content must be empty). More... | |
dol_delete_dir_recursive ($dir, $count=0, $nophperrors=0, $onlysub=0, &$countdeleted=0, $indexdatabase=1, $nolog=0) | |
Remove a directory $dir and its subdirectories (or only files and subdirectories) More... | |
dol_delete_preview ($object) | |
Delete all preview files linked to object instance. More... | |
dol_meta_create ($object) | |
Create a meta file with document file into same directory. More... | |
dol_init_file_process ($pathtoscan='', $trackid='') | |
Scan a directory and init $_SESSION to manage uploaded files with list of all found files. More... | |
dol_add_file_process ($upload_dir, $allowoverwrite=0, $updatesessionordb=0, $varfiles='addedfile', $savingdocmask='', $link=null, $trackid='', $generatethumbs=1, $object=null) | |
Get and save an upload file (for example after submitting a new file a mail form). More... | |
dol_remove_file_process ($filenb, $donotupdatesession=0, $donotdeletefile=1, $trackid='') | |
Remove an uploaded file (for example after submitting a new file a mail form). More... | |
addFileIntoDatabaseIndex ($dir, $file, $fullpathorig='', $mode='uploaded', $setsharekey=0, $object=null) | |
Add a file into database index. More... | |
deleteFilesIntoDatabaseIndex ($dir, $file, $mode='uploaded') | |
Delete files into database index using search criteria. More... | |
dol_convert_file ($fileinput, $ext='png', $fileoutput='', $page='') | |
Convert an image file or a PDF into another image format. More... | |
dol_uncompress ($inputfile, $outputdir) | |
Uncompress a file. More... | |
dol_most_recent_file ($dir, $regexfilter='', $excludefilter=array('(\.meta|_preview.*\.png)$', '^\.'), $nohook=0, $mode=0) | |
Return file(s) into a directory (by default most recent) More... | |
dol_check_secure_access_document ($modulepart, $original_file, $entity, $fuser=null, $refname='', $mode='read') | |
Security check when accessing to a document (used by document.php, viewimage.php and webservices to get documents). More... | |
dol_filecache ($directory, $filename, $object) | |
Store object in file. More... | |
dol_cache_refresh ($directory, $filename, $cachetime) | |
Test if Refresh needed. More... | |
dol_readcachefile ($directory, $filename) | |
Read object from cachefile. More... | |
dirbasename ($pathfile) | |
Return the relative dirname (relative to DOL_DATA_ROOT) of a full path string. More... | |
getFilesUpdated (&$file_list, SimpleXMLElement $dir, $path='', $pathref='', &$checksumconcat=array()) | |
Function to get list of updated or modified files. More... | |
dragAndDropFileUpload ($htmlname) | |
Function to manage the drag and drop of a file. More... | |
archiveOrBackupFile ($filetpl, $max_versions=5, $archivedir='', $suffix="v", $moveorcopy='move') | |
Manage backup versions for a given file, ensuring only a maximum number of versions are kept. More... | |
Library for file managing functions.
Definition in file files.lib.php.
addFileIntoDatabaseIndex | ( | $dir, | |
$file, | |||
$fullpathorig = '' , |
|||
$mode = 'uploaded' , |
|||
$setsharekey = 0 , |
|||
$object = null |
|||
) |
Add a file into database index.
Called by dol_add_file_process when uploading a file and on other cases. See also commonGenerateDocument that also add/update database index when a file is generated.
string | $dir | Directory name (full real path without ending /) |
string | $file | File name (May end with '.noexe') |
string | $fullpathorig | Full path of origin for file (can be '') |
string | $mode | How file was created ('uploaded', 'generated', ...) |
int | $setsharekey | Set also the share key |
Object | $object | Object used to set 'src_object_*' fields |
Definition at line 2101 of file files.lib.php.
archiveOrBackupFile | ( | $filetpl, | |
$max_versions = 5 , |
|||
$archivedir = '' , |
|||
$suffix = "v" , |
|||
$moveorcopy = 'move' |
|||
) |
Manage backup versions for a given file, ensuring only a maximum number of versions are kept.
string | $filetpl | Full path of the source filename for the backups. Example /mydir/mydocuments/mymodule/filename.ext |
int | $max_versions | The maximum number of backup versions to keep. |
string | $archivedir | Target directory of backups (without ending /). Keep empty to save into the same directory than source file. |
string | $suffix | 'v' (versioned files) or 'd' (archived files after deletion) |
string | $moveorcopy | 'move' or 'copy' |
Definition at line 3734 of file files.lib.php.
completeFileArrayWithDatabaseInfo | ( | & | $filearray, |
$relativedir | |||
) |
Complete $filearray with data from database.
This will call doldir_list_indatabase to complete filearray.
array<array{name:string,path:string,level1name:string,relativename:string,fullname:string,date:string,size:int,perm:int,type:string}> | $filearray Array of array('name'=>'xxx','fullname'=>'/abc/xxx','date'=>'yyy','size'=>99,'type'=>'dir|file',...) Array of files obtained using dol_dir_list | |
string | $relativedir | Relative dir from DOL_DATA_ROOT |
Definition at line 341 of file files.lib.php.
deleteFilesIntoDatabaseIndex | ( | $dir, | |
$file, | |||
$mode = 'uploaded' |
|||
) |
Delete files into database index using search criteria.
string | $dir | Directory name (full real path without ending /) |
string | $file | File name |
string | $mode | How file was created ('uploaded', 'generated', ...) |
Definition at line 2207 of file files.lib.php.
dirbasename | ( | $pathfile | ) |
Return the relative dirname (relative to DOL_DATA_ROOT) of a full path string.
string | $pathfile | Full path of a file |
Definition at line 3557 of file files.lib.php.
dol_add_file_process | ( | $upload_dir, | |
$allowoverwrite = 0 , |
|||
$updatesessionordb = 0 , |
|||
$varfiles = 'addedfile' , |
|||
$savingdocmask = '' , |
|||
$link = null , |
|||
$trackid = '' , |
|||
$generatethumbs = 1 , |
|||
$object = null |
|||
) |
Get and save an upload file (for example after submitting a new file a mail form).
Database index of file is also updated if donotupdatesession is set. All information used are in db, conf, langs, user and _FILES. Note: This function can be used only into a HTML page context.
string | $upload_dir | Directory where to store uploaded file (note: used to forge $destpath = $upload_dir + filename) |
int | $allowoverwrite | 1=Allow overwrite existing file |
int | $updatesessionordb | 1=Do no edit _SESSION variable but update database index. 0=Update _SESSION and not database index. -1=Do not update SESSION neither db. |
string | $varfiles | _FILES var name |
string | $savingdocmask | Mask to use to define output filename. For example 'XXXXX-__YYYYMMDD__-__file__' |
string | $link | Link to add (to add a link instead of a file) |
string | $trackid | Track id (used to prefix name of session vars to avoid conflict) |
int | $generatethumbs | 1=Generate also thumbs for uploaded image files |
Object | $object | Object used to set 'src_object_*' fields |
Definition at line 1862 of file files.lib.php.
dol_basename | ( | $pathfile | ) |
Make a basename working with all page code (default PHP basenamed fails with cyrillic).
We suppose dir separator for input is '/'.
string | $pathfile | String to find basename. |
Definition at line 38 of file files.lib.php.
dol_cache_refresh | ( | $directory, | |
$filename, | |||
$cachetime | |||
) |
Test if Refresh needed.
string | $directory | Directory of cache |
string | $filename | Name of filecache |
int | $cachetime | Cachetime delay |
Definition at line 3529 of file files.lib.php.
dol_check_secure_access_document | ( | $modulepart, | |
$original_file, | |||
$entity, | |||
$fuser = null , |
|||
$refname = '' , |
|||
$mode = 'read' |
|||
) |
Security check when accessing to a document (used by document.php, viewimage.php and webservices to get documents).
TODO Replace code that set $accessallowed by a call to restrictedArea()
string | $modulepart | Module of document ('module', 'module_user_temp', 'module_user' or 'module_temp'). Example: 'medias', 'invoice', 'logs', 'tax-vat', ... |
string | $original_file | Relative path with filename, relative to modulepart. |
string | $entity | Restrict onto entity (0=no restriction) |
User | null | $fuser | User object (forced) |
string | $refname | Ref of object to check permission for external users (autodetect if not provided by taking the dirname of $original_file) or for hierarchy |
string | $mode | Check permission for 'read' or 'write' |
Definition at line 2725 of file files.lib.php.
dol_compare_file | ( | $a, | |
$b | |||
) |
Fast compare of 2 files identified by their properties ->name, ->date and ->size.
object | $a | File 1 |
object | $b | File 2 |
Definition at line 446 of file files.lib.php.
dol_convert_file | ( | $fileinput, | |
$ext = 'png' , |
|||
$fileoutput = '' , |
|||
$page = '' |
|||
) |
Convert an image file or a PDF into another image format.
This need Imagick php extension. You can use dol_imageResizeOrCrop() for a function that need GD.
string | $fileinput | Input file name |
string | $ext | Format of target file (It is also extension added to file if fileoutput is not provided). |
string | $fileoutput | Output filename |
string | $page | Page number if we convert a PDF into png |
Definition at line 2266 of file files.lib.php.
dol_copy | ( | $srcfile, | |
$destfile, | |||
$newmask = '0' , |
|||
$overwriteifexists = 1 , |
|||
$testvirus = 0 , |
|||
$indexdatabase = 0 |
|||
) |
Copy a file to another file.
string | $srcfile | Source file (can't be a directory) |
string | $destfile | Destination file (can't be a directory) |
string | $newmask | Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666' |
int | $overwriteifexists | Overwrite file if exists (1 by default) |
int | $testvirus | Do an antivirus test. Move is canceled if a virus is found. |
int | $indexdatabase | Index new file into database. |
Definition at line 767 of file files.lib.php.
dol_count_nb_of_line | ( | $file | ) |
Count number of lines in a file.
string | $file | Filename |
Definition at line 602 of file files.lib.php.
Referenced by ImportCsv\import_get_nb_of_lines().
dol_delete_dir | ( | $dir, | |
$nophperrors = 0 |
|||
) |
Remove a directory (not recursive, so content must be empty).
If directory is not empty, return false
string | $dir | Directory to delete |
int | $nophperrors | Disable all PHP output errors |
Definition at line 1584 of file files.lib.php.
dol_delete_dir_recursive | ( | $dir, | |
$count = 0 , |
|||
$nophperrors = 0 , |
|||
$onlysub = 0 , |
|||
& | $countdeleted = 0 , |
||
$indexdatabase = 1 , |
|||
$nolog = 0 |
|||
) |
Remove a directory $dir and its subdirectories (or only files and subdirectories)
string | $dir | Dir to delete |
int | $count | Counter to count nb of elements found to delete |
int | $nophperrors | Disable all PHP output errors |
int | $onlysub | Delete only files and subdir, not main directory |
int | $countdeleted | Counter to count nb of elements found really deleted |
int | $indexdatabase | Try to remove also index entries. |
int | $nolog | Disable log files (too verbose when making recursive directories) |
Definition at line 1609 of file files.lib.php.
dol_delete_file | ( | $file, | |
$disableglob = 0 , |
|||
$nophperrors = 0 , |
|||
$nohook = 0 , |
|||
$object = null , |
|||
$allowdotdot = false , |
|||
$indexdatabase = 1 , |
|||
$nolog = 0 |
|||
) |
Remove a file or several files with a mask.
This delete file physically but also database indexes.
string | $file | File to delete or mask of files to delete |
int | $disableglob | Disable usage of glob like * so function is an exact delete function that will return error if no file found |
int | $nophperrors | Disable all PHP output errors |
int | $nohook | Disable all hooks |
object | null | $object | Current object in use |
boolean | $allowdotdot | Allow to delete file path with .. inside. Never use this, it is reserved for migration purpose. |
int | $indexdatabase | Try to remove also index entries. |
int | $nolog | Disable log file |
Definition at line 1458 of file files.lib.php.
dol_delete_preview | ( | $object | ) |
Delete all preview files linked to object instance.
Note that preview image of PDF files is generated when required, by dol_banner_tab() for example.
object | $object | Object to clean |
Definition at line 1661 of file files.lib.php.
dol_dir_is_emtpy | ( | $folder | ) |
Test if a folder is empty.
string | $folder | Name of folder |
Definition at line 569 of file files.lib.php.
dol_dir_list | ( | $utf8_path, | |
$types = "all" , |
|||
$recursive = 0 , |
|||
$filter = "" , |
|||
$excludefilter = null , |
|||
$sortcriteria = "name" , |
|||
$sortorder = SORT_ASC , |
|||
$mode = 0 , |
|||
$nohook = 0 , |
|||
$relativename = "" , |
|||
$donotfollowsymlinks = 0 , |
|||
$nbsecondsold = 0 |
|||
) |
Scan a directory and return a list of files/directories.
Content for string is UTF8 and dir separator is "/".
string | $utf8_path | Starting path from which to search. This is a full path. |
string | $types | Can be "directories", "files", or "all" |
int | $recursive | Determines whether subdirectories are searched |
string | $filter | Regex filter to restrict list. This regex value must be escaped for '/' by doing preg_quote($var,'/'), since this char is used for preg_match function, but must not contains the start and end '/'. Filter is checked into basename only. |
string | string[] | $excludefilter | Array of Regex for exclude filter (example: array('(.meta|_preview.*.png)$','^.')). Exclude is checked both into fullpath and into basename (So '^xxx' may exclude 'xxx/dirscanned/...' and dirscanned/xxx'). |
string | $sortcriteria | Sort criteria ('','fullname','relativename','name','date','size') |
int | $sortorder | Sort order (SORT_ASC, SORT_DESC) |
int | $mode | 0=Return array minimum keys loaded (faster), 1=Force all keys like date and size to be loaded (slower), 2=Force load of date only, 3=Force load of size only, 4=Force load of perm |
int | $nohook | Disable all hooks |
string | $relativename | For recursive purpose only. Must be "" at first call. |
int | $donotfollowsymlinks | Do not follow symbolic links |
int | $nbsecondsold | Only files older than $nbsecondsold |
Definition at line 63 of file files.lib.php.
Referenced by Website\compareFichierModifie(), and dolGetListOfObjectClasses().
dol_dir_list_in_database | ( | $path, | |
$filter = "" , |
|||
$excludefilter = null , |
|||
$sortcriteria = "name" , |
|||
$sortorder = SORT_ASC , |
|||
$mode = 0 |
|||
) |
Scan a directory and return a list of files/directories.
Content for string is UTF8 and dir separator is "/".
string | $path | Starting path from which to search. Example: 'produit/MYPROD' |
string | $filter | Regex filter to restrict list. This regex value must be escaped for '/', since this char is used for preg_match function |
string[] | null | $excludefilter | Array of Regex for exclude filter (example: array('(.meta|_preview.*.png)$','^.')) |
string | $sortcriteria | Sort criteria ("","fullname","name","date","size") |
int | $sortorder | Sort order (SORT_ASC, SORT_DESC) |
int | $mode | 0=Return array minimum keys loaded (faster), 1=Force all keys like description |
Definition at line 262 of file files.lib.php.
dol_filecache | ( | $directory, | |
$filename, | |||
$object | |||
) |
Store object in file.
string | $directory | Directory of cache |
string | $filename | Name of filecache |
mixed | $object | Object to store in cachefile |
Definition at line 3506 of file files.lib.php.
dol_filemtime | ( | $pathoffile | ) |
Return time of a file.
string | $pathoffile | Path of file |
Definition at line 647 of file files.lib.php.
References dol_osencode().
dol_fileperm | ( | $pathoffile | ) |
Return permissions of a file.
string | $pathoffile | Path of file |
Definition at line 659 of file files.lib.php.
References dol_osencode().
dol_filesize | ( | $pathoffile | ) |
Return size of a file.
string | $pathoffile | Path of file |
Definition at line 635 of file files.lib.php.
References dol_osencode().
dol_init_file_process | ( | $pathtoscan = '' , |
|
$trackid = '' |
|||
) |
Scan a directory and init $_SESSION to manage uploaded files with list of all found files.
Note: Only email module seems to use this. Other feature initialize the $_SESSION doing $formmail->clear_attached_files(); $formmail->add_attached_files()
string | $pathtoscan | Path to scan |
string | $trackid | Track id (used to prefix name of session vars to avoid conflict) |
Definition at line 1824 of file files.lib.php.
dol_is_dir | ( | $folder | ) |
Test if filename is a directory.
string | $folder | Name of folder |
Definition at line 489 of file files.lib.php.
dol_is_dir_empty | ( | $dir | ) |
Return if path is empty.
string | $dir | Path of Directory |
Definition at line 505 of file files.lib.php.
dol_is_file | ( | $pathoffile | ) |
Return if path is a file.
string | $pathoffile | Path of file |
Definition at line 519 of file files.lib.php.
References dol_osencode().
Referenced by FileUpload\getFileObject().
dol_is_link | ( | $pathoffile | ) |
Return if path is a symbolic link.
string | $pathoffile | Path of file |
Definition at line 531 of file files.lib.php.
References dol_osencode().
dol_is_url | ( | $uri | ) |
Return if path is an URI (the name of the method is misleading).
URLs are addresses for websites, URI refer to online resources.
string | $uri | URI to test |
Definition at line 557 of file files.lib.php.
dol_is_writable | ( | $folderorfile | ) |
Test if directory or filename is writable.
string | $folderorfile | Name of folder or filename |
Definition at line 543 of file files.lib.php.
References dol_osencode().
dol_meta_create | ( | $object | ) |
Create a meta file with document file into same directory.
This make "grep" search possible. This feature to generate the meta file is enabled only if option MAIN_DOC_CREATE_METAFILE is set.
CommonObject | $object | Object |
Definition at line 1739 of file files.lib.php.
dol_most_recent_file | ( | $dir, | |
$regexfilter = '' , |
|||
$excludefilter = array('(\.meta|_preview.*\.png)$', '^\.') , |
|||
$nohook = 0 , |
|||
$mode = 0 |
|||
) |
Return file(s) into a directory (by default most recent)
string | $dir | Directory to scan |
string | $regexfilter | Regex filter to restrict list. This regex value must be escaped for '/', since this char is used for preg_match function |
string[] | $excludefilter | Array of Regex for exclude filter (example: array('(.meta|_preview.*.png)$','^.')). This regex value must be escaped for '/', since this char is used for preg_match function |
int<0,1> | $nohook Disable all hooks | |
int<0,3> | $mode 0=Return array minimum keys loaded (faster), 1=Force all keys like date and size to be loaded (slower), 2=Force load of date only, 3=Force load of size only |
Definition at line 2706 of file files.lib.php.
dol_move | ( | $srcfile, | |
$destfile, | |||
$newmask = '0' , |
|||
$overwriteifexists = 1 , |
|||
$testvirus = 0 , |
|||
$indexdatabase = 1 , |
|||
$moreinfo = array() |
|||
) |
Move a file into another name.
Note:
string | $srcfile | Source file (can't be a directory. use native php @rename() to move a directory) |
string | $destfile | Destination file (can't be a directory. use native php @rename() to move a directory) |
string | $newmask | Mask in octal string for new file ('0' by default means $conf->global->MAIN_UMASK) |
int | $overwriteifexists | Overwrite file if exists (1 by default) |
int | $testvirus | Do an antivirus test. Move is canceled if a virus is found. |
int | $indexdatabase | Index new file into database. |
array | $moreinfo | Array with more information to set in index table |
Definition at line 1011 of file files.lib.php.
dol_move_dir | ( | $srcdir, | |
$destdir, | |||
$overwriteifexists = 1 , |
|||
$indexdatabase = 1 , |
|||
$renamedircontent = 1 |
|||
) |
Move a directory into another name.
string | $srcdir | Source directory |
string | $destdir | Destination directory |
int | $overwriteifexists | Overwrite directory if exists (1 by default) |
int | $indexdatabase | Index new name of files into database. |
int | $renamedircontent | Also rename contents inside srcdir after the move to match new destination name. |
Definition at line 1175 of file files.lib.php.
dol_move_uploaded_file | ( | $src_file, | |
$dest_file, | |||
$allowoverwrite, | |||
$disablevirusscan = 0 , |
|||
$uploaderrorcode = 0 , |
|||
$nohook = 0 , |
|||
$varfiles = 'addedfile' , |
|||
$upload_dir = '' |
|||
) |
Check validity of a file upload from an GUI page, and move it to its final destination.
If there is errors (virus found, antivir in error, bad filename), file is not moved. Note:
string | $src_file | Source full path filename ($_FILES['field']['tmp_name']) |
string | $dest_file | Target full path filename ($_FILES['field']['name']) |
int | $allowoverwrite | 1=Overwrite target file if it already exists |
int | $disablevirusscan | 1=Disable virus scan |
integer | $uploaderrorcode | Value of PHP upload error code ($_FILES['field']['error']) |
int | $nohook | Disable all hooks |
string | $varfiles | _FILES var name |
string | $upload_dir | For information. Already included into $dest_file. |
Definition at line 1320 of file files.lib.php.
dol_readcachefile | ( | $directory, | |
$filename | |||
) |
Read object from cachefile.
string | $directory | Directory of cache |
string | $filename | Name of filecache |
Definition at line 3544 of file files.lib.php.
dol_remove_file_process | ( | $filenb, | |
$donotupdatesession = 0 , |
|||
$donotdeletefile = 1 , |
|||
$trackid = '' |
|||
) |
Remove an uploaded file (for example after submitting a new file a mail form).
All information used are in db, conf, langs, user and _FILES.
int | $filenb | File nb to delete |
int | $donotupdatesession | -1 or 1 = Do not update _SESSION variable |
int | $donotdeletefile | 1=Do not delete physically file |
string | $trackid | Track id (used to prefix name of session vars to avoid conflict) |
Definition at line 2043 of file files.lib.php.
dol_uncompress | ( | $inputfile, | |
$outputdir | |||
) |
Uncompress a file.
string | $inputfile | File to uncompress |
string | $outputdir | Target dir name |
Definition at line 2452 of file files.lib.php.
dol_unescapefile | ( | $filename | ) |
Unescape a file submitted by upload.
PHP escape char " (%22) or char ' (%27) into $FILES.
string | $filename | Filename |
Definition at line 1235 of file files.lib.php.
dolCheckOnFileName | ( | $src_file, | |
$dest_file = '' |
|||
) |
Check virus into a file.
string | $src_file | Source file to check |
string | $dest_file | Destination file name (to know the expected type) |
Definition at line 1281 of file files.lib.php.
References dol_syslog(), and getDolGlobalString().
dolCheckVirus | ( | $src_file, | |
$dest_file = '' |
|||
) |
Check virus into a file.
string | $src_file | Source file to check |
string | $dest_file | Destination file name (to know the expected type) |
Definition at line 1251 of file files.lib.php.
dolCopyDir | ( | $srcfile, | |
$destfile, | |||
$newmask, | |||
$overwriteifexists, | |||
$arrayreplacement = null , |
|||
$excludesubdir = 0 , |
|||
$excludefileext = null , |
|||
$excludearchivefiles = 0 |
|||
) |
Copy a dir to another dir.
This include recursive subdirectories.
string | $srcfile | Source file (a directory) |
string | $destfile | Destination file (a directory) |
string | $newmask | Mask for new file ('0' by default means getDolGlobalString('MAIN_UMASK')). Example: '0666' |
int | $overwriteifexists | Overwrite file if exists (1 by default) |
array<string,string> | $arrayreplacement Array to use to replace filenames with another one during the copy (works only on file names, not on directory names). | |
int | $excludesubdir | 0=Do not exclude subdirectories, 1=Exclude subdirectories, 2=Exclude subdirectories if name is not a 2 chars (used for country codes subdirectories). |
string[] | $excludefileext | Exclude some file extensions |
int | $excludearchivefiles | Exclude archive files that begin with v+timestamp or d+timestamp (0 by default) |
Definition at line 896 of file files.lib.php.
dolReplaceInFile | ( | $srcfile, | |
$arrayreplacement, | |||
$destfile = '' , |
|||
$newmask = '0' , |
|||
$indexdatabase = 0 , |
|||
$arrayreplacementisregex = 0 |
|||
) |
Make replacement of strings into a file.
string | $srcfile | Source file (can't be a directory) |
array<string,string> | $arrayreplacement Array with strings to replace. Example: array('valuebefore'=>'valueafter', ...) | |
string | $destfile | Destination file (can't be a directory). If empty, will be same than source file. |
string | $newmask | Mask for new file (0 by default means $conf->global->MAIN_UMASK). Example: '0666' |
int | $indexdatabase | 1=index new file into database. |
int | $arrayreplacementisregex | 1=Array of replacement is already an array with key that is a regex. Warning: the key must be escaped with preg_quote for '/' |
Definition at line 677 of file files.lib.php.
dragAndDropFileUpload | ( | $htmlname | ) |
Function to manage the drag and drop of a file.
We use global variable $object
string | $htmlname | The id of the component where we need to drag and drop |
Definition at line 3616 of file files.lib.php.
getFilesUpdated | ( | & | $file_list, |
SimpleXMLElement | $dir, | ||
$path = '' , |
|||
$pathref = '' , |
|||
& | $checksumconcat = array() |
||
) |
Function to get list of updated or modified files.
$file_list is used as global variable
array | $file_list | Array for response |
SimpleXMLElement | $dir | SimpleXMLElement of files to test |
string | $path | Path of files relative to $pathref. We start with ''. Used by recursive calls. |
string | $pathref | Path ref (DOL_DOCUMENT_ROOT) |
array | $checksumconcat | Array of checksum |
Definition at line 3574 of file files.lib.php.