N°6964 - Improve PHPDoc and method name to explicit that paths are relative

This commit is contained in:
Molkobain
2024-04-12 10:50:59 +02:00
parent a6d01739ba
commit dad406d208
3 changed files with 4 additions and 7 deletions

View File

@@ -2292,11 +2292,8 @@ interface iKPILoggerExtension
interface iBackupExtraFilesExtension
{
/**
* Returns an array of files and directories to be included in the backup
*
* @api
*
* @return string[]
* @return string[] Array of relative paths (from app root) for files and directories to be included in the backup
*/
public function GetExtraFiles(): array;
public function GetExtraFilesRelPaths(): array;
}

View File

@@ -276,7 +276,7 @@ class DBBackup
{
/** @var iBackupExtraFilesExtension $oExtensionInstance */
$oExtensionInstance = new $sExtensionClass();
$aExtraFiles = array_merge($aExtraFiles, $oExtensionInstance->GetExtraFiles());
$aExtraFiles = array_merge($aExtraFiles, $oExtensionInstance->GetExtraFilesRelPaths());
}
foreach($aExtraFiles as $sExtraFileOrDir)

View File

@@ -359,7 +359,7 @@ class ExampleFor_iKPILoggerExtension implements \iKPILoggerExtension
<content><![CDATA[
class ExampleFor_iBackupExtraFilesExtension implements \iBackupExtraFilesExtension
{
public function GetExtraFiles(): array
public function GetExtraFilesRelPaths(): array
{
return [
'foo'