Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

(no description)

File Size: 55 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FileSystemHelperInterface:: (4 methods):
  createFolder()
  createFileWithContents()
  deleteFile()
  deleteFolderRecursively()


Interface: FileSystemHelperInterface  - X-Ref


createFolder(string $parentFolderPath, string $folderName)   X-Ref
Creates an empty folder with the given name under the given parent folder.

param: string $parentFolderPath The parent folder path under which the folder is going to be created
param: string $folderName       The name of the folder to create
return: string Path of the created folder

createFileWithContents(string $parentFolderPath, string $fileName, string $fileContents)   X-Ref
Creates a file with the given name and content in the given folder.
The parent folder must exist.

param: string $parentFolderPath The parent folder path where the file is going to be created
param: string $fileName         The name of the file to create
param: string $fileContents     The contents of the file to create
return: string Path of the created file

deleteFile(string $filePath)   X-Ref
Delete the file at the given path.

param: string $filePath Path of the file to delete

deleteFolderRecursively(string $folderPath)   X-Ref
Delete the folder at the given path as well as all its contents.

param: string $folderPath Path of the folder to delete