PHPXRef 0.7.1 : Unnamed Project : Detail view of FileSystemHelper.php

(no description)

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

Defines 1 class

FileSystemHelper:: (6 methods):
  __construct()
  createFolder()
  createFileWithContents()
  deleteFile()
  deleteFolderRecursively()
  throwIfOperationNotInBaseFolder()

Class: FileSystemHelper - X-Ref

Class FileSystemHelper
This class provides helper functions to help with the file system operations
like files/folders creation & deletion

__construct($baseFolderPath) X-Ref

param: string $baseFolderPath The path of the base folder where all the I/O can occur

createFolder($parentFolderPath, $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($parentFolderPath, $fileName, $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($filePath) X-Ref

Delete the file at the given path

param: string $filePath Path of the file to delete
return: void

deleteFolderRecursively($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
return: void

throwIfOperationNotInBaseFolder($operationFolderPath) X-Ref

All I/O operations must occur inside the base folder, for security reasons.
This function will throw an exception if the folder where the I/O operation
should occur is not inside the base folder.

param: string $operationFolderPath The path of the folder where the I/O operation should occur
return: void

PHP Cross Reference of Unnamed Project

/lib/spout/src/Spout/Common/Helper/ -> FileSystemHelper.php (summary)

Defines 1 class