ISimpleFolder
in
Interface ISimpleFolder
Tags
Table of Contents
Methods
- delete() : void
- Remove the folder and all the files in it
- fileExists() : bool
- Check if a file with $name exists
- getDirectoryListing() : array<string|int, ISimpleFile>
- Get all the files in a folder
- getFile() : ISimpleFile
- Get the file named $name from the folder
- getFolder() : ISimpleFolder
- Get the folder named $name from the current folder
- getName() : string
- Get the folder name
- getOrCreateFolder() : ISimpleFolder
- Get or create new folder if the folder does not already exist.
- newFile() : ISimpleFile
- Creates a new file with $name in the folder
- newFolder() : ISimpleFolder
- Creates a new folder with $name in the current folder
Methods
delete()
Remove the folder and all the files in it
public
delete() : void
Tags
fileExists()
Check if a file with $name exists
public
fileExists(string $name) : bool
Parameters
- $name : string
Tags
Return values
boolgetDirectoryListing()
Get all the files in a folder
public
getDirectoryListing() : array<string|int, ISimpleFile>
Tags
Return values
array<string|int, ISimpleFile>getFile()
Get the file named $name from the folder
public
getFile(string $name) : ISimpleFile
Parameters
- $name : string
Tags
Return values
ISimpleFilegetFolder()
Get the folder named $name from the current folder
public
getFolder(string $name) : ISimpleFolder
Parameters
- $name : string
Tags
Return values
ISimpleFoldergetName()
Get the folder name
public
getName() : string
Tags
Return values
stringgetOrCreateFolder()
Get or create new folder if the folder does not already exist.
public
getOrCreateFolder(string $path[, int $maxRetries = 5 ]) : ISimpleFolder
Parameters
- $path : string
-
relative path of the file or folder
- $maxRetries : int = 5
Tags
Return values
ISimpleFoldernewFile()
Creates a new file with $name in the folder
public
newFile(string $name[, string|resource|null $content = null ]) : ISimpleFile
Parameters
- $name : string
- $content : string|resource|null = null
-
@since 19.0.0
Tags
Return values
ISimpleFilenewFolder()
Creates a new folder with $name in the current folder
public
newFolder(string $path) : ISimpleFolder
Parameters
- $path : string