Collaboration diagram for ilFileUtils:

Static Public Member Functions
static	recursive_dirscan (string $dir, array &$arr)
	Recursively scans a given directory and writes path and filename into referenced array. More...

static	utf8_encode (string $string)

static	getValidFilename (string $a_filename)

static	rename (string $a_source, string $a_target)

static	rCopy (string $a_sdir, string $a_tdir, bool $preserveTimeAttributes=false)
	Copies content of a directory $a_sdir recursively to a directory $a_tdir. More...

static	makeDirParents (string $a_dir)
	Create a new directory and all parent directories. More...

static	getDataDir ()
	get data directory (outside webspace) More...

static	dirsize (string $directory)
	get size of a directory or a file. More...

static	makeDir (string $a_dir)
	creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information. More...

static	moveUploadedFile (string $a_file, string $a_name, string $a_target, bool $a_raise_errors=true, string $a_mode="move_uploaded")
	move uploaded file More...

static	zip (string $a_dir, string $a_file, bool $compress_content=false)

static	delDir (string $a_dir, bool $a_clean_only=false)
	removes a dir and all its content (subdirs and files) recursively More...

static	getSafeFilename (string $a_initial_filename)

static	getDir (string $a_dir, bool $a_rec=false, ?string $a_sub_dir="")
	get directory More...

static	getWebspaceDir (string $mode="filesystem")
	get webspace directory More...

static	createDirectory (string $a_dir, int $a_mod=0755)
	create directory More...

static	getFileSizeInfo ()

static	getASCIIFilename (string $a_filename)

static	ilTempnam (?string $a_temp_path=null)
	Returns a unique and non existing Path for e temporary file or directory. More...

static	unzip (string $a_file, bool $overwrite=false, bool $a_flat=false)
	unzip file More...

static	renameExecutables (string $a_dir)

static	rRenameSuffix (string $a_dir, string $a_old_suffix, string $a_new_suffix)
	Renames all files with certain suffix and gives them a new suffix. More...

static	removeTrailingPathSeparators (string $path)

static	getPhpUploadSizeLimitInBytes ()

static	_sanitizeFilemame (string $a_filename)

Static Protected Member Functions
static	sanitateTargetPath (string $a_target)

Detailed Description

Class ilFileUtils.

Deprecated:: All Methods are widely used and there is currently no other service providing all of them, but please do not implement new methods in this class.

Definition at line 30 of file class.ilFileUtils.php.

Member Function Documentation

◆ _sanitizeFilemame()

static ilFileUtils::_sanitizeFilemame ( string $a_filename )

static

Definition at line 842 of file class.ilFileUtils.php.

References ilUtil\stripSlashes().

Referenced by ilFileDataMail\storeAsAttachment(), ilFileDataForumDraftsLegacyImplementation\storeUploadedFile(), and ilFileDataMail\storeUploadedFile().

                                                                 : string
     {
         return strip_tags(ilUtil::stripSlashes($a_filename));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDirectory()

static ilFileUtils::createDirectory	(	string	$a_dir,
		int	$a_mod = `0755`
	)

static

create directory

Parameters

string	$a_dir
int	$a_mod

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

Definition at line 637 of file class.ilFileUtils.php.

References makeDir().

Referenced by ilObjMediaObject\_createThumbnailDirectory(), ilPropertyFormGUI\appendOnloadCode(), ilExerciseManagementCollectFilesJob\createSubmissionsDirectory(), ilMediaItem\createWorkDirectory(), and ilTempnam().

                                                                             : void
     {
         ilFileUtils::makeDir($a_dir);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delDir()

static ilFileUtils::delDir	(	string	$a_dir,
		bool	$a_clean_only = `false`
	)

static

removes a dir and all its content (subdirs and files) recursively

public

Parameters

string	$a_dir	dir to delete
bool	$a_clean_only

Author: Unknown flexe.nosp@m.r@cu.nosp@m.tephp.nosp@m..com (source: http://www.php.net/rmdir)

Deprecated:: in favour of Filesystem::deleteDir() located at the filesystem service.

See also: ::deleteDir()

Definition at line 475 of file class.ilFileUtils.php.

Referenced by ilObjTest\_createImportDirectory(), assSingleChoice\afterSyncWithOriginal(), assMatchingQuestion\afterSyncWithOriginal(), ilScorm2004DataSet\afterXmlRecordWriting(), ilUserDataSet\afterXmlRecordWriting(), ILIAS\Wiki\Export\WikiHtmlExport\buildExportFile(), ilSurveyExport\buildExportFileXML(), ilObjStyleSheet\cleanExportDirectory(), assOrderingQuestion\cleanImagefiles(), assLongMenu\clearFolder(), ilMobMultiSrtUpload\clearMultiSrtDirectory(), ilObjMediaObject\clearMultiSrtDirectory(), ilCertificateUtilHelper\delDir(), ilObjMediaObject\delete(), ilFileDataForumDraftsLegacyImplementation\delete(), ilObjFileBasedLM\delete(), ilObjSurvey\delete(), ilTestExportGUI\delete(), ilBadgeImageTemplate\delete(), ilExportGUI\delete(), SurveyQuestion\delete(), assQuestion\delete(), ilObjSAHSLearningModule\delete(), ilObjSurveyQuestionPool\deleteAllData(), ilFileDataMail\deleteAttachmentDirectory(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\MailDeletionHandler\deleteDirectory(), ilFileDataCourse\deleteDirectory(), ilObjSurveyQuestionPoolGUI\deleteExportFileObject(), ilFileSystemGUI\deleteFile(), ilExAssignment\deleteGlobalFeedbackFile(), ilObjQuestionPool\deleteQuestionpool(), ilBadge\deleteStaticFiles(), assQuestion\deleteSuggestedSolutions(), ilObjSurvey\deleteSurveyRecord(), ilObjTest\deleteTest(), ilFileDataForumDraftsLegacyImplementation\deliverZipFile(), ilFileDataForumLegacyImplementation\deliverZipFile(), ilObjCmiXapi\doDelete(), ilExSubmission\downloadAllAssignmentFiles(), ilExSubmission\downloadMultipleFiles(), ilExport\exportEntity(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ilExport\exportObject(), ilObjUser\exportPersonalData(), ilObjContentObject\getExportDirectory(), ilExcCriteriaFile\importFromPeerReviewForm(), ilObjSurveyQuestionPool\importObject(), ilObjQuestionPoolGUI\importVerifiedFileObject(), ilObjTestGUI\importVerifiedFileObject(), ILIAS\Glossary\Export\GlossaryHtmlExport\initDirectories(), ILIAS\Notes\Export\NotesHtmlExport\initDirectories(), ILIAS\Portfolio\Export\PortfolioHtmlExport\initDirectories(), ILIAS\Blog\Export\BlogHtmlExport\initDirectories(), ILIAS\LearningModule\Export\LMHtmlExport\initDirectories(), assMultipleChoice\isForcedEmptySolution(), ilExSubmission\processUploadedZipFile(), ilExSubmission\processZipFile(), assKprimChoice\removeAnswerImage(), ilObjTest\removeTestResultsByActiveIds(), rRenameSuffix(), ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob\run(), ilSubmissionsZipJob\run(), ilCalendarZipJob\run(), ilZipJob\run(), assSingleChoice\savePreviewData(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), assMultipleChoice\syncImages(), assSingleChoice\syncImages(), assQuestion\syncSuggestedSolutionFiles(), ilMobMultiSrtUpload\uploadMultipleSubtitleFile(), ilObjMediaObject\uploadMultipleSubtitleFile(), ilObjSAHSLearningModuleGUI\uploadObject(), ilObjQuestionPoolGUI\uploadQplObject(), ilObjTestGUI\uploadTst(), ilUserCertificateZip\zipCertificatesInArchiveDirectory(), ILIAS\Glossary\Export\GlossaryHtmlExport\zipPackage(), ILIAS\Notes\Export\NotesHtmlExport\zipPackage(), ILIAS\Blog\Export\BlogHtmlExport\zipPackage(), ILIAS\Portfolio\Export\PortfolioHtmlExport\zipPackage(), and ILIAS\LearningModule\Export\LMHtmlExport\zipPackage().

                                                                             : void
     {
         if (!is_dir($a_dir) || is_int(strpos($a_dir, ".."))) {
             return;
         }
 
         $current_dir = opendir($a_dir);
 
         $files = [];
 
         // this extra loop has been necessary because of a strange bug
         // at least on MacOS X. A looped readdir() didn't work
         // correctly with larger directories
         // when an unlink happened inside the loop. Getting all files
         // into the memory first solved the problem.
         while ($entryname = readdir($current_dir)) {
             $files[] = $entryname;
         }
 
         foreach ($files as $file) {
             if (is_dir(
                 $a_dir . "/" . $file
             ) and ($file != "." and $file != "..")) {
                 ilFileUtils::delDir($a_dir . "/" . $file);
             } elseif ($file != "." and $file != "..") {
                 unlink($a_dir . "/" . $file);
             }
         }
 
         closedir($current_dir);
         if (!$a_clean_only) {
             @rmdir($a_dir);
         }
     }

Here is the caller graph for this function:

◆ dirsize()

static ilFileUtils::dirsize ( string $directory )

static

get size of a directory or a file.

Parameters

string path to a directory or a file

Returns: integer. Returns -1, if the directory does not exist.

Definition at line 256 of file class.ilFileUtils.php.

Referenced by ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), ilObjFileBasedLMAccess\_lookupDiskUsage(), ilObjMediaCastAccess\_lookupDiskUsage(), ilExSubmission\downloadAllAssignmentFiles(), and ilPortfolioTemplatePage\getPageDiskSize().

                                                      : int
     {
         $size = 0;
         if (!is_dir($directory)) {
             //       dirsize of non-existing directory
             $size = @filesize($directory);
             return ($size === false) ? -1 : $size;
         }
         if ($DIR = opendir($directory)) {
             while (($dirfile = readdir($DIR)) !== false) {
                 if (is_link(
                     $directory . DIRECTORY_SEPARATOR . $dirfile
                 ) || $dirfile == '.' || $dirfile == '..') {
                     continue;
                 }
                 if (is_file($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                     $size += filesize(
                         $directory . DIRECTORY_SEPARATOR . $dirfile
                     );
                 } elseif (is_dir($directory . DIRECTORY_SEPARATOR . $dirfile)) {
                     $dirSize = ilFileUtils::dirsize(
                         $directory . DIRECTORY_SEPARATOR . $dirfile
                     );
                     if ($dirSize >= 0) {
                         $size += $dirSize;
                     } else {
                         return -1;
                     }
                 }
             }
             closedir($DIR);
         }
         return $size;
     }

Here is the caller graph for this function:

◆ getASCIIFilename()

static ilFileUtils::getASCIIFilename ( string $a_filename )

static

Deprecated:

Definition at line 655 of file class.ilFileUtils.php.

References $DIC, and ilFileServicesPolicy\ascii().

Referenced by ilPropertyFormGUI\appendOnloadCode(), ILIAS\Wiki\Export\WikiHtmlExport\buildExportFile(), ilExerciseManagementCollectFilesJob\collectAssignmentData(), ilDownloadFilesBackgroundTask\collectFiles(), ilCSVTestExport\deliver(), ilExcelTestExport\deliver(), ilFileDataMail\deliverAttachmentsAsZip(), ilObjTest\deliverPDFfromFO(), ilExSubmission\downloadAllAssignmentFiles(), ilExSubmission\downloadMultipleFiles(), ilSurveyParticipantsGUI\exportAllCodesObject(), ilTestEvaluationGUI\exportCertificateArchive(), ilSurveyParticipantsGUI\exportCodesObject(), ilSurveyEvaluationGUI\exportCumulatedResults(), ilSurveyEvaluationGUI\exportEvaluationUser(), ilObjExercise\exportGradesExcel(), ilCOPageHTMLExport\exportHTMLFileDirect(), ilObjMediaObject\fixFilename(), ilObjWorkspaceFolderGUI\getBucketTitle(), ilContainerGUI\getBucketTitle(), ilExSubmission\getDirectoryNameFromUserData(), ilAssFileUploadUploadsExporter\getDispoZipFileName(), ilCollectWorkspaceFilesJob\getFileDirs(), ilTestParticipantData\getFileSystemCompliantFullnameByActiveId(), ilVerificationObject\getOfflineFilename(), ilDclPropertyFormGUI\getTempFilename(), ilObjTest\getTitleFilenameCompliant(), assQuestion\getTitleFilenameCompliant(), ilAssFileUploadUploadsExporter\initFilenames(), ilDclMobRecordFieldModel\parseValue(), ilCollectWorkspaceFilesJob\recurseFolder(), ilCollectFilesJob\recurseFolder(), ILIAS\MediaCast\BackgroundTasks\DownloadAllBackgroundTask\run(), ilDownloadSubmissionsBackgroundTask\run(), ilDownloadWorkspaceFolderBackgroundTask\run(), ilDownloadContainerFilesBackgroundTask\run(), ilDownloadFilesBackgroundTask\run(), ilQtiMatImageSecurity\sanitizeLabel(), ilChatroomHistoryGUI\showMessages(), and ilObjMediaCastGUI\updateMediaItem().

                                                                : string
     {
         global $DIC;
         $policy = new ilFileServicesPolicy($DIC->fileServiceSettings());
         return $policy->ascii($a_filename);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDataDir()

static ilFileUtils::getDataDir ( )

static

get data directory (outside webspace)

Deprecated:: in favour of the filesystem service which should be used to operate on the storage directory.

See also: filesystem(); ::storage()

Definition at line 243 of file class.ilFileUtils.php.

References CLIENT_DATA_DIR.

                                        : string
     {
         return CLIENT_DATA_DIR;
     }

Here is the caller graph for this function:

◆ getDir()

static ilFileUtils::getDir	(	string	$a_dir,
		bool	$a_rec = `false`,
		?string	$a_sub_dir = `""`
	)

static

get directory

Parameters

string	$a_dir
bool	$a_rec
string \| null	$a_sub_dir

Returns: array

Deprecated:: in favour of Filesystem::listContents() located at the filesystem service.

See also: ::listContents()

Definition at line 556 of file class.ilFileUtils.php.

Referenced by assOrderingQuestion\cleanImagefiles(), ilFileDataMail\getAttachmentPathAndFilenameByMd5Hash(), ilCertificateUtilHelper\getDir(), ilFileDataForumDraftsLegacyImplementation\getFileDataByMD5Filename(), ilFileDataForumLegacyImplementation\getFileDataByMD5Filename(), ilFileSystemGUI\getFileList(), ilUploadDirFilesTableGUI\getFiles(), ilAdvancedMDRecordExportFiles\getFiles(), ilObjMediaObject\getFilesOfDirectory(), ilMobMultiSrtUpload\getMultiSrtFiles(), ilObjMediaObject\getMultiSrtFiles(), ilObjUser\getPersonalDataExportFile(), ilObjMediaObject\getSrtFiles(), ilFileDataForumDraftsLegacyImplementation\unlinkFilesByMD5Filenames(), ilFileDataForumLegacyImplementation\unlinkFilesByMD5Filenames(), and ilFileSystemGUI\unzipFile().

      : array {
         $current_dir = opendir($a_dir . $a_sub_dir);
 
         $dirs = [];
         $files = [];
         $subitems = [];
         while ($entry = readdir($current_dir)) {
             if (is_dir($a_dir . "/" . $entry)) {
                 $dirs[$entry] = ["type" => "dir",
                                  "entry" => $entry,
                                  "subdir" => $a_sub_dir
                 ];
                 if ($a_rec && $entry != "." && $entry != "..") {
                     $si = ilFileUtils::getDir(
                         $a_dir,
                         true,
                         $a_sub_dir . "/" . $entry
                     );
                     $subitems = array_merge($subitems, $si);
                 }
             } else {
                 if ($entry != "." && $entry != "..") {
                     $size = filesize($a_dir . $a_sub_dir . "/" . $entry);
                     $files[$entry] = ["type" => "file",
                                       "entry" => $entry,
                                       "size" => $size,
                                       "subdir" => $a_sub_dir
                     ];
                 }
             }
         }
         ksort($dirs);
         ksort($files);
 
         return array_merge($dirs, $files, $subitems);
     }

Here is the caller graph for this function:

◆ getFileSizeInfo()

static ilFileUtils::getFileSizeInfo ( )

static

Definition at line 642 of file class.ilFileUtils.php.

References $DIC, and $lng.

Referenced by ilTinyMCE\addCustomRTESupport(), ilTinyMCE\addRTESupport(), ilKprimChoiceWizardInputGUI\checkInput(), ilAssSingleChoiceCorrectionsInputGUI\insert(), ilAssMultipleChoiceCorrectionsInputGUI\insert(), ilMultipleChoiceWizardInputGUI\insert(), ilMatchingWizardInputGUI\insert(), ilSingleChoiceWizardInputGUI\insert(), and ilMultipleImagesInputGUI\render().

                                             : string
     {
         global $DIC;
         $size = new DataSize(self::getPhpUploadSizeLimitInBytes(), DataSize::MB);
         $max_filesize = $size->__toString();
         $lng = $DIC->language();
 
         return $lng->txt("file_notice") . " $max_filesize.";
     }

Here is the caller graph for this function:

◆ getPhpUploadSizeLimitInBytes()

static ilFileUtils::getPhpUploadSizeLimitInBytes ( )

static

Deprecated:: should use DataSize instead

Definition at line 802 of file class.ilFileUtils.php.

Referenced by ilDAVContainer\createFile(), InitUIFramework\init(), ilDAVFile\put(), and ILIAS\FileUpload\FileUploadImpl\uploadSizeLimit().

                                                          : string
     {
         $convertPhpIniSizeValueToBytes = function ($phpIniSizeValue) {
             if (is_numeric($phpIniSizeValue)) {
                 return $phpIniSizeValue;
             }
 
             $suffix = substr($phpIniSizeValue, -1);
             $value = substr($phpIniSizeValue, 0, -1);
 
             switch (strtoupper($suffix)) {
                 case 'P':
                     $value *= 1024;
                     // no break
                 case 'T':
                     $value *= 1024;
                     // no break
                 case 'G':
                     $value *= 1024;
                     // no break
                 case 'M':
                     $value *= 1024;
                     // no break
                 case 'K':
                     $value *= 1024;
                     break;
             }
 
             return $value;
         };
 
 
         $uploadSizeLimitBytes = min(
             $convertPhpIniSizeValueToBytes(ini_get('post_max_size')),
             $convertPhpIniSizeValueToBytes(ini_get('upload_max_filesize'))
         );
 
         return $uploadSizeLimitBytes;
     }

Here is the caller graph for this function:

◆ getSafeFilename()

static ilFileUtils::getSafeFilename ( string $a_initial_filename )

static

Definition at line 510 of file class.ilFileUtils.php.

Referenced by ilExAssignment\instructionFileInsertOrder().

                                                                       : string
     {
         $file_peaces = explode('.', $a_initial_filename);
 
         $file_extension = array_pop($file_peaces);
 
         if (SUFFIX_REPL_ADDITIONAL) {
             $string_extensions = SUFFIX_REPL_DEFAULT . "," . SUFFIX_REPL_ADDITIONAL;
         } else {
             $string_extensions = SUFFIX_REPL_DEFAULT;
         }
 
         $sufixes = explode(",", $string_extensions);
 
         if (in_array($file_extension, $sufixes)) {
             $file_extension = "sec";
         }
 
         $file_peaces[] = $file_extension;
 
         $safe_filename = "";
         foreach ($file_peaces as $piece) {
             $safe_filename .= "$piece";
             if ($piece != end($file_peaces)) {
                 $safe_filename .= ".";
             }
         }
 
         return $safe_filename;
     }

Here is the caller graph for this function:

◆ getValidFilename()

static ilFileUtils::getValidFilename ( string $a_filename )

static

Deprecated:

Definition at line 82 of file class.ilFileUtils.php.

References $DIC, and ILIAS\Filesystem\Security\Sanitizing\FilenameSanitizerImpl\sanitize().

Referenced by ilExSubmission\addFileUpload(), ilFileDataMail\deliverAttachmentsAsZip(), ilPortfolioCertificateFileService\deliverCertificate(), ilWebDAVRepositoryHelper\getFilenameWithSanitizedFileExtension(), ilFSStorageExercise\getStorageFilename(), ilCertificateFileUtilsHelper\getValidFilename(), moveUploadedFile(), ilObjCourseGUI\updateInfoObject(), ilIndividualAssessmentFileStorage\uploadFile(), ilExSubmission\uploadFile(), and ilBadgeImageTemplate\uploadImage().

                                                                : string
     {
         global $DIC;
         $sanitizer = new ilFileServicesFilenameSanitizer(
             $DIC->fileServiceSettings()
         );
 
         return $sanitizer->sanitize($a_filename);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getWebspaceDir()

static ilFileUtils::getWebspaceDir ( string $mode = "filesystem" )

static

get webspace directory

Parameters

string $mode use "filesystem" for filesystem operations and "output" for output operations, e.g. images

Returns: string

Deprecated:: in favour of the filesystem service which should be used for operations on the web dir.

See also: filesystem(); Filesystems::web()

Definition at line 612 of file class.ilFileUtils.php.

References CLIENT_ID, and ILIAS_WEB_DIR.

Referenced by ilObjStyleSheet\_createImagesDirectory(), ilObjMediaObject\_createThumbnailDirectory(), ilObjFileBasedLMAccess\_determineStartUrl(), ilContainer\_getContainerDirectory(), ilObjMediaObject\_getDirectory(), ilObjStyleSheet\_getImagesDirectory(), ilObjMediaObject\_getThumbnailDirectory(), ilObjMediaObject\_getURL(), ilObjSAHSLearningModuleAccess\_lookupDiskUsage(), ilObjFileBasedLMAccess\_lookupDiskUsage(), ilPCTableGUI\_renderTable(), ilObjMediaObjectGUI\assignFullscreenObject(), ilObjMediaObjectGUI\assignStandardObject(), ilCmiXapiLaunchGUI\buildLaunchLink(), ilQuestionPageParser\copyMobFiles(), ilObjUser\copyProfilePicturesToDirectory(), ilContainer\createContainerDirectory(), ilObjSAHSLearningModule\createDataDirectory(), ilObjectCustomIcon\createFromImportDir(), ilObjStyleSheet\delete(), ilPageObjectGUI\displayMedia(), ilObjCmiXapi\doCloneObject(), ilObjCmiXapi\doDelete(), ilObjMediaObject\exportFiles(), ilCOPageHTMLExport\exportHTMLMOB(), ilCOPageHTMLExport\exportQuestionFiles(), ilStudyProgrammeTypeCustomIconsFormGUI\fillForm(), ilLTIConsumeProviderIcon\getAbsoluteFilePath(), ilCmiXapiContentUploadImporter\getAbsoluteObjectDirectory(), ilDidacticTemplateIconHandler\getAbsolutePath(), ilPCInteractiveImage\getBackgroundImage(), ilBadgeHandler\getBasePath(), ilPCTabsGUI\getCaptionForm(), ilObjStyleSheet\getContentStylePath(), ilObjFileBasedLM\getDataDirectory(), ilObjSAHSLearningModule\getDataDirectory(), ilObjMediaObject\getDataDirectory(), ilScormAiccDataSet\getExtendedXmlRepresentation(), ILIAS\Object\Properties\CoreProperties\TileImage\ilObjectTileImage\getFullPath(), ilObjectCustomIcon\getFullPath(), ilOpenIdConnectSettings\getImageFilePath(), ilImageMapEditorGUI\getImageMapOutput(), ilFileDataCourse\getOnlineLink(), ilFSStorageMail\getRelativePathExMailDirectory(), ilLMPresentationGUI\ilMedia(), ilUserCertificateGUI\listCertificates(), ilGlossaryPresentationGUI\media(), ilCmiXapiImporter\prepareLocalSourceStorage(), ilObjUserGUI\removeUserPictureObject(), ilPCTableGUI\renderCell(), ilUserAvatarResolver\resolveLegacyPicturePath(), ilObjMediaObjectGUI\returnToContextObject(), ilCmiXapiContentUploadImporter\sanitizeObjectDirectory(), ilObjMediaPoolGUI\showMedia(), ilPageObjectGUI\showMediaFullscreen(), ilPageObjectGUI\showPage(), ilLMPresentationGUI\showPrintView(), and ilObjStyleSheet\writeCSSFile().

                                                                       : string
     {
         if ($mode === "filesystem") {
             return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
         } else {
             if (defined("ILIAS_MODULE")) {
                 return "../" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
             } else {
                 return "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID;
             }
         }
     }

Here is the caller graph for this function:

◆ ilTempnam()

static ilFileUtils::ilTempnam ( ?string $a_temp_path = null )

static

Returns a unique and non existing Path for e temporary file or directory.

Parameters

string | null $a_temp_path

Returns: string

Definition at line 669 of file class.ilFileUtils.php.

References createDirectory(), and getDataDir().

Referenced by ilImagemapPreview\__construct(), ilObjUserFolder\buildExportFile(), ilTestArchiveService\buildOverviewFilename(), ilDidacticTemplateSettingsGUI\checkInput(), ilVirusScanner\createBufferFile(), ILIAS\MediaCast\BackgroundTasks\DownloadAllCollectFilesJob\createDirectory(), ilRestFileStorage\createFile(), ilAdvancedMDParser\createLocalRecord(), ilTestExportGUI\createTestArchiveExport(), ilCopyWorkspaceFilesToTempDirectoryJob\createUniqueTempDirectory(), ilCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilCalendarCopyFilesToTempDirectoryJob\createUniqueTempDirectory(), ilExerciseManagementCollectFilesJob\createUniqueTempDirectory(), ilFileDataMail\deliverAttachmentsAsZip(), ilObjTest\deliverPDFfromFO(), ilMediaItem\determineDuration(), ilExSubmission\downloadMultipleFiles(), ilPageLayoutAdministrationGUI\exportLayout(), ilObjectCustomIconUploadHandlerGUI\getUploadResult(), ilUserDataSet\getXmlRecord(), ilFileXMLParser\handlerEndTag(), assOrderingQuestionImport\handleUploadedFile(), ilImport\importEntity(), ilAssFileUploadUploadsExporter\initFilenames(), ilTestHTMLGenerator\makeHtmlDocument(), ilExSubmission\processUploadedZipFile(), ilObjectCommonSettingFormAdapter\saveIcon(), ilUserImportParser\saveTempImage(), ilObjTest\sendAdvancedNotification(), ilExcel\sendToClient(), ilRestFileStorage\storeFileForRest(), ilECSConnector\updateResource(), ilCalendarCategoryGUI\uploadAppointments(), ilObjSAHSLearningModuleGUI\uploadObject(), ilObjLanguageExtGUI\uploadObject(), and ilExcel\writeToTmpFile().

                                                                  : string
     {
         if ($a_temp_path === null) {
             $temp_path = ilFileUtils::getDataDir() . "/temp";
         } else {
             $temp_path = $a_temp_path;
         }
 
         if (!is_dir($temp_path)) {
             ilFileUtils::createDirectory($temp_path);
         }
         $temp_name = $temp_path . "/" . uniqid("tmp");
 
         return $temp_name;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ makeDir()

static ilFileUtils::makeDir ( string $a_dir )

static

creates a new directory and inherits all filesystem permissions of the parent directory You may pass only the name of your new directory or with the entire path or relative path information.

examples: a_dir = /tmp/test/your_dir a_dir = ../test/your_dir a_dir = your_dir (–> creates your_dir in current directory)

public

Parameters

string [path] + directory name

Returns: boolean

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

Definition at line 309 of file class.ilFileUtils.php.

References $path.

                                                  : bool
     {
         $a_dir = trim($a_dir);
 
         // remove trailing slash (bugfix for php 4.2.x)
         if (substr($a_dir, -1) == "/") {
             $a_dir = substr($a_dir, 0, -1);
         }
 
         // check if a_dir comes with a path
         if (!($path = substr(
             $a_dir,
             0,
             strrpos($a_dir, "/") - strlen($a_dir)
         ))) {
             $path = ".";
         }
 
         // create directory with file permissions of parent directory
         if (is_dir($a_dir)) {
             return true;
         }
         $old_mask = umask(0000);
         $result = @mkdir($a_dir, fileperms($path));
         umask($old_mask);
         
         return $result;
     }

Here is the caller graph for this function:

◆ makeDirParents()

static ilFileUtils::makeDirParents ( string $a_dir )

static

Create a new directory and all parent directories.

Creates a new directory and inherits all filesystem permissions of the parent directory If the parent directories doesn't exist, they will be created recursively. The directory name NEEDS TO BE an absolute path, because it seems that relative paths are not working with PHP's file_exists function.

Parameters

string $a_dir The directory name to be created public

Returns: bool

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.tzi.d.nosp@m.e

Deprecated:: in favour of Filesystem::createDir() located at the filesystem service.

See also: ::createDir()

Definition at line 183 of file class.ilFileUtils.php.

References ILIAS\LTI\ToolProvider\$key.

                                                         : bool
     {
         $dirs = [$a_dir];
         $a_dir = dirname($a_dir);
         $last_dirname = '';
         while ($last_dirname != $a_dir) {
             array_unshift($dirs, $a_dir);
             $last_dirname = $a_dir;
             $a_dir = dirname($a_dir);
         }
 
         // find the first existing dir
         $reverse_paths = array_reverse($dirs, true);
         $found_index = -1;
         foreach ($reverse_paths as $key => $value) {
             if ($found_index == -1) {
                 if (is_dir($value)) {
                     $found_index = $key;
                 }
             }
         }
 
         $old_mask = umask(0000);
         foreach ($dirs as $dirindex => $dir) {
             // starting with the longest existing path
             if ($dirindex >= $found_index) {
                 if (!file_exists($dir)) {
                     if (strcmp(substr($dir, strlen($dir) - 1, 1), "/") == 0) {
                         // on some systems there is an error when there is a slash
                         // at the end of a directory in mkdir, see Mantis #2554
                         $dir = substr($dir, 0, strlen($dir) - 1);
                     }
                     if (!mkdir($dir)) {
                         error_log("Can't make directory: $dir");
                         return false;
                     }
                 } elseif (!is_dir($dir)) {
                     error_log("$dir is not a directory");
                     return false;
                 } else {
                     // get umask of the last existing parent directory
                     $umask = fileperms($dir);
                 }
             }
         }
         umask($old_mask);
 
         return true;
     }

Here is the caller graph for this function:

◆ moveUploadedFile()

static ilFileUtils::moveUploadedFile	(	string	$a_file,
		string	$a_name,
		string	$a_target,
		bool	$a_raise_errors = `true`,
		string	$a_mode = `"move_uploaded"`
	)

static

move uploaded file

Parameters

string	$a_file
string	$a_name
string	$a_target
bool	$a_raise_errors
string	$a_mode

Returns: bool

Exceptions

ilException Thrown if no uploaded files are found and raise error is set to true.

Deprecated:: in favour of the FileUpload service.

See also: upload()

Definition at line 389 of file class.ilFileUtils.php.

References $DIC, Vendor\Package\$e, and getValidFilename().

Referenced by ilObjMediaObject\_saveTempFileAsMediaObject(), ilObjUserFolder\_updateAccountMailAttachment(), ilPropertyFormGUI\appendOnloadCode(), ilDidacticTemplateSettingsGUI\checkInput(), ilCourseFile\create(), ilPCInteractiveImageGUI\create(), assKprimChoice\handleFileUpload(), ilObjStyleSheet\import(), ilImport\importEntity(), ilObjSurveyQuestionPoolGUI\importFileObject(), ilExcCriteriaFile\importFromPeerReviewForm(), ilObjSurvey\importObject(), ilPropertyFormGUI\moveFileUpload(), ilAdvancedMDRecordImportFiles\moveUploadedFile(), ilCertificateUtilHelper\moveUploadedFile(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilExSubmission\processZipFile(), assFileUpload\savePreviewData(), ilObjMediaObjectGUI\savePropertiesObject(), assMultipleChoice\setImageFile(), assSingleChoice\setImageFile(), assMatchingQuestion\setImageFile(), assImagemapQuestion\setImageFilename(), SurveyQuestion\setMaterialsfile(), ilObjMediaObjectGUI\setObjectPerCreationForm(), assOrderingQuestion\storeImageFile(), ilFileDataForumDraftsLegacyImplementation\storeUploadedFile(), ilFileDataMail\storeUploadedFile(), assQuestionGUI\suggestedsolution(), ilPCInteractiveImageGUI\update(), ilObjMediaCastGUI\updateMediaItem(), ilObjMediaObject\uploadAdditionalFile(), ilCalendarCategoryGUI\uploadAppointments(), ilFSStorageExercise\uploadAssignmentFiles(), ilObjCertificateSettings\uploadBackgroundImage(), ilCertificateBackgroundImageUpload\uploadBackgroundImage(), ilIndividualAssessmentFileStorage\uploadFile(), ilBookingObject\uploadFile(), ilFSStorageExercise\uploadFile(), ilBadgeImageTemplate\uploadImage(), ilObjPortfolioBase\uploadImage(), ilBadge\uploadImage(), ilObjBlog\uploadImage(), ilObjPoll\uploadImage(), ilMobMultiSrtUpload\uploadMultipleSubtitleFile(), ilObjMediaObject\uploadMultipleSubtitleFile(), ilObjSAHSLearningModuleGUI\uploadObject(), ilBookingObject\uploadPostFile(), ilObjQuestionPoolGUI\uploadQplObject(), ilObjSurveyQuestionPoolGUI\uploadQuestionsObject(), and ilObjTestGUI\uploadTst().

      : bool {
         global $DIC;
         $main_tpl = $DIC->ui()->mainTemplate();
         $target_filename = basename($a_target);
 
         $target_filename = ilFileUtils::getValidFilename($target_filename);
 
         // Make sure the target is in a valid subfolder. (e.g. no uploads to ilias/setup/....)
         [$target_filesystem, $target_dir] = self::sanitateTargetPath($a_target);
 
         $upload = $DIC->upload();
 
         // If the upload has not yet been processed make sure he gets processed now.
         if (!$upload->hasBeenProcessed()) {
             $upload->process();
         }
 
         try {
             if (!$upload->hasUploads()) {
                 throw new ilException(
                     $DIC->language()->txt("upload_error_file_not_found")
                 );
             }
             $upload_result = $upload->getResults()[$a_file] ?? null;
             if ($upload_result instanceof UploadResult) {
                 if (!$upload_result->isOK()) {
                     throw new ilException($upload_result->getStatus()->getMessage());
                 }
             } else {
                 return false;
             }
         } catch (ilException $e) {
             if (!$a_raise_errors) {
                 $main_tpl->setOnScreenMessage('failure', $e->getMessage(), true);
             } else {
                 throw $e;
             }
 
             return false;
         }
 
         $upload->moveOneFileTo(
             $upload_result,
             $target_dir,
             $target_filesystem,
             $target_filename,
             true
         );
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rCopy()

static ilFileUtils::rCopy	(	string	$a_sdir,
		string	$a_tdir,
		bool	$preserveTimeAttributes = `false`
	)

static

Copies content of a directory $a_sdir recursively to a directory $a_tdir.

Parameters

string	$a_sdir	source directory
string	$a_tdir	target directory
boolean	$preserveTimeAttributes	if true, ctime will be kept.

Returns: boolean TRUE for sucess, FALSE otherwise

Exceptions

Definition at line 127 of file class.ilFileUtils.php.

References Vendor\Package\$e.

Referenced by ilDataSet\addRecordsXml(), assSingleChoice\afterSyncWithOriginal(), assMatchingQuestion\afterSyncWithOriginal(), ILIAS\Exercise\SampleSolution\SampleSolutionManager\cloneTo(), ilObjStyleSheet\copyImagesToDir(), ilQuestionPageParser\copyMobFiles(), ilPlayerUtil\copyPlayerFilesToTargetDirectory(), ilObjStyleSheet\create(), ilObjectCustomIcon\createFromImportDir(), ilFileDataCourse\createOnlineVersion(), ilBookingObject\doClone(), ilObjCmiXapi\doCloneObject(), ilObjMediaObject\duplicate(), ilObjStyleSheet\export(), ilObjMediaObject\exportFiles(), ilObjFileBasedLMGUI\exportHTML(), ilCOPageHTMLExport\exportHTMLMOB(), ilCOPageHTMLExport\exportQuestionFiles(), ilCOPageHTMLExport\exportStyles(), ilHTMLLearningModuleDataSet\getXmlRecord(), ilPollDataSet\getXmlRecord(), ilObjStyleSheet\import(), ilPortfolioDataSet\importRecord(), ilMediaObjectDataSet\importRecord(), ilBlogDataSet\importRecord(), ilStyleDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), and ilFileDataCourse\rCopy().

      : bool {
         $sourceFS = LegacyPathHelper::deriveFilesystemFrom($a_sdir);
         $targetFS = LegacyPathHelper::deriveFilesystemFrom($a_tdir);
 
         $sourceDir = LegacyPathHelper::createRelativePath($a_sdir);
         $targetDir = LegacyPathHelper::createRelativePath($a_tdir);
 
         // check if arguments are directories
         if (!$sourceFS->hasDir($sourceDir)) {
             return false;
         }
 
         $sourceList = $sourceFS->listContents($sourceDir, true);
 
         foreach ($sourceList as $item) {
             if ($item->isDir()) {
                 continue;
             }
             try {
                 $itemPath = $targetDir . '/' . substr(
                     $item->getPath(),
                     strlen($sourceDir)
                 );
                 $stream = $sourceFS->readStream($item->getPath());
                 $targetFS->writeStream($itemPath, $stream);
             } catch (\ILIAS\Filesystem\Exception\FileAlreadyExistsException $e) {
                 // Do nothing with that type of exception
             }
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ recursive_dirscan()

static ilFileUtils::recursive_dirscan	(	string	$dir,
		array &	$arr
	)

static

Recursively scans a given directory and writes path and filename into referenced array.

Parameters

string	$dir	Directory to start from
array	&$arr	Referenced array which is filled with Filename and path

Exceptions

ilFileUtilsException

Deprecated:: Will be removed completely with ILIAS 9

Definition at line 41 of file class.ilFileUtils.php.

References ilFileUtilsException\$BROKEN_FILE, $DIC, and $lng.

Referenced by ilObjFileBasedLMGUI\afterSave(), ilExSubmission\processUploadedZipFile(), ilExSubmission\processZipFile(), and ilFileSystemGUI\unzipFile().

                                                                       : void
     {
         global $DIC;
 
         $lng = $DIC->language();
 
         $dirlist = opendir($dir);
         while (false !== ($file = readdir($dirlist))) {
             if (!is_file($dir . "/" . $file) && !is_dir($dir . "/" . $file)) {
                 throw new ilFileUtilsException(
                     $lng->txt("filenames_not_supported"),
                     ilFileUtilsException::$BROKEN_FILE
                 );
             }
 
             if ($file != '.' && $file != '..') {
                 $newpath = $dir . '/' . $file;
                 $level = explode('/', $newpath);
                 if (is_dir($newpath)) {
                     ilFileUtils::recursive_dirscan($newpath, $arr);
                 } else {
                     $arr["path"][] = $dir . "/";
                     $arr["file"][] = end($level);
                 }
             }
         }
         closedir($dirlist);
     }

Here is the caller graph for this function:

◆ removeTrailingPathSeparators()

static ilFileUtils::removeTrailingPathSeparators ( string $path )

static

Definition at line 793 of file class.ilFileUtils.php.

References $path.

Referenced by SurveyQuestion\_getInternalLinkHref(), ilInitialisation\buildHTTPPath(), ilSoapFunctions\buildHTTPPath(), assQuestion\fixUnavailableSkinImageSources(), ilObjCertificateSettings\getBackgroundImageThumbPathWeb(), ilObjCertificateSettings\getDefaultBackgroundImagePathWeb(), assFileUpload\getFileUploadPathWeb(), SurveyQuestion\getImagePathWeb(), assQuestion\getImagePathWeb(), ilObjTest\getImagePathWeb(), SurveyQuestion\getMaterialsPathWeb(), assFileUpload\getPreviewFileUploadPathWeb(), ilFSStorageMail\getRelativePathExMailDirectory(), assQuestion\getSuggestedSolutionPathWeb(), and ilObjCmiXapiAdministrationGUI\saveLrsTypeFormCmd().

                                                                      : string
     {
         $path = preg_replace("/[\/\\\]+$/", "", $path);
         return (string) $path;
     }

Here is the caller graph for this function:

◆ rename()

static ilFileUtils::rename	(	string	$a_source,
		string	$a_target
	)

static

Deprecated:

Definition at line 95 of file class.ilFileUtils.php.

References $DIC.

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilFileDataForumLegacyImplementation\getForumPath(), ilScormAiccImporter\importXmlRepresentation(), ilPropertyFormGUI\moveFileUpload(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilDclMobRecordFieldModel\parseValue(), ilObjSurveyQuestionPool\pasteFromClipboard(), ilFileSystemGUI\renameFile(), ilFileDataForumDraftsLegacyImplementation\rotateFiles(), ilFileDataMail\rotateFiles(), rRenameSuffix(), assOrderingQuestion\updateImageFile(), ilObjMediaObject\uploadAdditionalFile(), ilFSStorageExercise\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

                                                                      : bool
     {
         $pi = pathinfo($a_target);
         global $DIC;
         $sanitizer = new ilFileServicesFilenameSanitizer(
             $DIC->fileServiceSettings()
         );
 
         if (!$sanitizer->isClean($a_target)) {
             throw new ilFileUtilsException("Invalid target file");
         }
 
         return rename($a_source, $a_target);
     }

Here is the caller graph for this function:

◆ renameExecutables()

static ilFileUtils::renameExecutables ( string $a_dir )

static

Deprecated:

Definition at line 712 of file class.ilFileUtils.php.

Referenced by ilPCInteractiveImageGUI\create(), ilObjMediaPoolGUI\createMediaFromUploadDir(), ilScormAiccImporter\importXmlRepresentation(), ilObjSCORMLearningModuleGUI\newModuleVersionUpload(), ilDclMobRecordFieldModel\parseValue(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjMediaObject\renameExecutables(), ilFileSystemGUI\renameFile(), ilCmiXapiContentUploadImporter\sanitizeObjectDirectory(), assQuestionGUI\suggestedsolution(), ilFileSystemGUI\unzipFile(), ilObjMediaCastGUI\updateMediaItem(), ilFileSystemGUI\uploadFile(), and ilObjSAHSLearningModuleGUI\uploadObject().

                                                            : void
     {
         $def_arr = explode(",", SUFFIX_REPL_DEFAULT);
         foreach ($def_arr as $def) {
             self::rRenameSuffix($a_dir, trim($def), "sec");
         }
 
         $def_arr = explode(",", SUFFIX_REPL_ADDITIONAL);
         foreach ($def_arr as $def) {
             self::rRenameSuffix($a_dir, trim($def), "sec");
         }
     }

Here is the caller graph for this function:

◆ rRenameSuffix()

static ilFileUtils::rRenameSuffix	(	string	$a_dir,
		string	$a_old_suffix,
		string	$a_new_suffix
	)

static

Renames all files with certain suffix and gives them a new suffix.

This words recursively through a directory.

Deprecated:

Definition at line 731 of file class.ilFileUtils.php.

References delDir(), and rename().

Referenced by ilObjMediaObject\renameExecutables().

                                                                                                    : bool
     {
         if ($a_dir == "/" || $a_dir == "" || is_int(strpos($a_dir, ".."))
             || trim($a_old_suffix) == "") {
             return false;
         }
 
         // check if argument is directory
         if (!@is_dir($a_dir)) {
             return false;
         }
 
         // read a_dir
         $dir = opendir($a_dir);
 
         while ($file = readdir($dir)) {
             if ($file !== "." && $file !== "..") {
                 // triple dot is not allowed in filenames
                 if ($file === '...') {
                     unlink($a_dir . "/" . $file);
                     continue;
                 }
                 // directories
                 if (@is_dir($a_dir . "/" . $file)) {
                     ilFileUtils::rRenameSuffix($a_dir . "/" . $file, $a_old_suffix, $a_new_suffix);
                 }
 
                 // files
                 if (@is_file($a_dir . "/" . $file)) {
                     // first check for files with trailing dot
                     if (strrpos($file, '.') == (strlen($file) - 1)) {
                         try {
                             rename($a_dir . '/' . $file, substr($a_dir . '/' . $file, 0, -1));
                         } catch (Throwable $t) {
                             // to avoid exploits we do delete this file and continue renaming
                             unlink($a_dir . '/' . $file);
                             continue;
                         }
                         $file = substr($file, 0, -1);
                     }
 
                     $path_info = pathinfo($a_dir . "/" . $file);
 
                     if (strtolower($path_info["extension"] ?? '') === strtolower($a_old_suffix)) {
                         $pos = strrpos($a_dir . "/" . $file, ".");
                         $new_name = substr($a_dir . "/" . $file, 0, $pos) . "." . $a_new_suffix;
                         // check if file exists
                         if (file_exists($new_name)) {
                             if (is_dir($new_name)) {
                                 ilFileUtils::delDir($new_name);
                             } else {
                                 unlink($new_name);
                             }
                         }
                         rename($a_dir . "/" . $file, $new_name);
                     }
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sanitateTargetPath()

static ilFileUtils::sanitateTargetPath ( string $a_target )

staticprotected

Definition at line 338 of file class.ilFileUtils.php.

References CLIENT_DATA_DIR, CLIENT_ID, CLIENT_WEB_DIR, ILIAS\FileUpload\Location\CUSTOMIZING, ILIAS_WEB_DIR, ILIAS\FileUpload\Location\STORAGE, ILIAS\FileUpload\Location\TEMPORARY, and ILIAS\FileUpload\Location\WEB.

                                                                   : array
     {
         switch (true) {
             case strpos($a_target, ILIAS_WEB_DIR . '/' . CLIENT_ID) === 0:
             case strpos(
                 $a_target,
                 './' . ILIAS_WEB_DIR . '/' . CLIENT_ID
             ) === 0:
             case strpos($a_target, CLIENT_WEB_DIR) === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::WEB;
                 break;
             case strpos($a_target, CLIENT_DATA_DIR . "/temp") === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::TEMPORARY;
                 break;
             case strpos($a_target, CLIENT_DATA_DIR) === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::STORAGE;
                 break;
             case strpos($a_target, ILIAS_ABSOLUTE_PATH . '/Customizing') === 0:
                 $targetFilesystem = \ILIAS\FileUpload\Location::CUSTOMIZING;
                 break;
             default:
                 throw new InvalidArgumentException(
                     "Can not move files to \"$a_target\" because path can not be mapped to web, storage or customizing location."
                 );
         }
 
         $absTargetDir = dirname($a_target);
         $targetDir = LegacyPathHelper::createRelativePath($absTargetDir);
 
         return [$targetFilesystem, $targetDir];
     }

◆ unzip()

static ilFileUtils::unzip	(	string	$a_file,
		bool	$overwrite = `false`,
		bool	$a_flat = `false`
	)

static

unzip file

Parameters

string	$a_file	full path/filename
boolean	$overwrite	pass true to overwrite existing files

Definition at line 693 of file class.ilFileUtils.php.

References $DIC.

                                                                                                : bool
     {
         if(defined('DEVMODE') && DEVMODE) {
             trigger_error('Deprecated method called: ' . __METHOD__, E_USER_DEPRECATED);
         }
 
         global $DIC;
         return $DIC->legacyArchives()->unzip(
             $a_file,
             null,
             $overwrite,
             $a_flat,
             false
         );
     }

◆ utf8_encode()

static ilFileUtils::utf8_encode ( string $string )

static

Deprecated:: in ILIAS 9 for ILIAS 10: Use Refinery instead

Definition at line 73 of file class.ilFileUtils.php.

References $DIC.

Referenced by ilExSubmission\processUploadedZipFile(), and ilExSubmission\processZipFile().

                                                       : string
     {
         global $DIC;
         return $DIC->refinery()->string()->encoding()->latin1ToUtf8()->transform($string);
     }

Here is the caller graph for this function:

◆ zip()

static ilFileUtils::zip	(	string	$a_dir,
		string	$a_file,
		bool	$compress_content = `false`
	)

static

Deprecated:: Please refactor your code using $DIC->archives()->zip() (recommended) or $DIC->legacyArchives()->zip() instead.

Definition at line 450 of file class.ilFileUtils.php.

References $DIC.

Referenced by ILIAS\Wiki\Export\WikiHtmlExport\buildExportFile(), ilSurveyExport\buildExportFileXML(), ilSurveyQuestionpoolExport\buildExportFileXML(), ilGlossaryExport\buildExportFileXML(), ilContObjectExport\buildExportFileXML(), ilQuestionpoolExport\buildExportFileXML(), ilTestExport\buildExportFileXML(), ilTestArchiver\compressTestArchive(), ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilSkinStyleContainer\createTempZip(), ilFileDataForumDraftsLegacyImplementation\createZipFile(), ilFileDataForumLegacyImplementation\createZipFile(), ilFileDataMail\deliverAttachmentsAsZip(), ilObjStyleSheet\export(), ilExport\exportEntity(), ilObjFileBasedLMGUI\exportHTML(), ilExportContainer\exportObject(), ilExport\exportObject(), ilScormAiccDataSet\getExtendedXmlRepresentation(), ILIAS\MediaCast\BackgroundTasks\DownloadAllZipJob\run(), ilSubmissionsZipJob\run(), ilCalendarZipJob\run(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilUserCertificateZip\zipCertificatesInArchiveDirectory(), ilFileDataCourse\zipFile(), ILIAS\Glossary\Export\GlossaryHtmlExport\zipPackage(), ILIAS\Notes\Export\NotesHtmlExport\zipPackage(), ILIAS\Blog\Export\BlogHtmlExport\zipPackage(), and ILIAS\LearningModule\Export\LMHtmlExport\zipPackage().

      : bool {
         global $DIC;
         // ensure top directory should be the same behaviour as before, if you need it to be different, you should legacyArchives directly
         return $DIC->legacyArchives()->zip($a_dir, $a_file, true);
     }

Here is the caller graph for this function:

The documentation for this class was generated from the following file:

Services/FileServices/classes/class.ilFileUtils.php

Static Public Member Functions

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ _sanitizeFilemame()

◆ createDirectory()

◆ delDir()

◆ dirsize()

◆ getASCIIFilename()

◆ getDataDir()

◆ getDir()

◆ getFileSizeInfo()

◆ getPhpUploadSizeLimitInBytes()

◆ getSafeFilename()

◆ getValidFilename()

◆ getWebspaceDir()

◆ ilTempnam()

◆ makeDir()

◆ makeDirParents()

◆ moveUploadedFile()

◆ rCopy()

◆ recursive_dirscan()

◆ removeTrailingPathSeparators()

◆ rename()

◆ renameExecutables()

◆ rRenameSuffix()

◆ sanitateTargetPath()

◆ unzip()

◆ utf8_encode()

◆ zip()