dolibarr 25.0.0-alpha
repair.lib.php File Reference

Library of repair functions. More...

Go to the source code of this file.

Functions

 checkElementExist ($id, $table)
 Check if an element exist.
 
 checkLinkedElements ($sourcetype, $targettype)
 Check linked elements and delete if invalid.
 
 clean_data_ecm_directories ()
 Clean data into ecm_directories table.
 
 repairEcmFiles ($db, $entity, $documentroot, $confirmed=false, $maxdelete=100)
 Check an entity's ECM index against the filesystem, optionally removing missing-file entries.
 
 repairImagePathIsSafe ($path, $directory, $documentroot)
 Check an image repair path, including a missing destination, against its owner's directory.
 

Detailed Description

Library of repair functions.

Definition in file repair.lib.php.

Function Documentation

◆ checkElementExist()

checkElementExist ( $id,
$table )

Check if an element exist.

Parameters
int$idElement id
string$tableTable of Element
Returns
boolean True if child exists

Definition at line 31 of file repair.lib.php.

References $id.

Referenced by checkLinkedElements().

◆ checkLinkedElements()

checkLinkedElements ( $sourcetype,
$targettype )

Check linked elements and delete if invalid.

Parameters
string$sourcetypeSource element type
string$targettypeTarget element type
Returns
string

Definition at line 57 of file repair.lib.php.

References checkElementExist().

◆ clean_data_ecm_directories()

clean_data_ecm_directories ( )

Clean data into ecm_directories table.

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

Definition at line 130 of file repair.lib.php.

References $id, and dol_sanitizeFileName().

◆ repairEcmFiles()

repairEcmFiles ( $db,
$entity,
$documentroot,
$confirmed = false,
$maxdelete = 100 )

Check an entity's ECM index against the filesystem, optionally removing missing-file entries.

The caller must validate the entity and, for confirmed requests, the installer CSRF token.

Parameters
DoliDB$dbDatabase handler
int$entityEntity to repair (without shared entities)
string$documentrootGlobal documents directory; ECM paths are already relative to it
bool$confirmedRemove missing-file index entries
int$maxdeleteMaximum number of entries to remove
Returns
array{processed:int,missing:int,deleted:int,skipped:int,limitreached:bool,entries:list<array{id:int,path:string}>,error:string}

Definition at line 171 of file repair.lib.php.

References dol_is_dir(), dol_is_file(), dol_is_link(), and dol_osencode().

◆ repairImagePathIsSafe()

repairImagePathIsSafe ( $path,
$directory,
$documentroot )

Check an image repair path, including a missing destination, against its owner's directory.

Parameters
string$pathFile or directory to read or write
string$directoryOwner's module directory
string$documentrootInstallation's documents directory
Returns
bool True when no path component redirects the operation outside its expected location

Definition at line 275 of file repair.lib.php.

References dol_is_dir(), dol_osencode(), and dol_strlen().