SimpleFile
in package
implements
File
Represents a file entry
Tags
Table of Contents
Interfaces
Properties
Methods
- __construct() : mixed
- getFileName() : string
- Get the file name
- getFilePath() : string|null
- Get the file path
- getFileType() : string|null
- Get the file type
- getFullPath() : string
- Get the full path to the file on the file system
- getGloss() : string|null
- Get the file gloss
- setFileName() : void
- setFilePath() : void
- setFileType() : void
- setGloss() : void
Properties
$fileName
private
string
$fileName
The file name
$filePath
private
string|null
$filePath
The path to the file
$fileType
private
string|null
$fileType
The file type
$gloss
private
string|null
$gloss
A display friendly name for the file
Methods
__construct()
public
__construct(string $fileName[, string $filePath = null ][, string $fileType = null ][, string $gloss = null ]) : mixed
Parameters
- $fileName : string
-
The file name
- $filePath : string = null
-
The path to the file. Optional
- $fileType : string = null
-
The file type. Optional
- $gloss : string = null
-
A display friendly name for the file. Optional
getFileName()
Get the file name
public
getFileName() : string
Return values
stringgetFilePath()
Get the file path
public
getFilePath() : string|null
Return values
string|nullgetFileType()
Get the file type
public
getFileType() : string|null
Return values
string|nullgetFullPath()
Get the full path to the file on the file system
public
getFullPath() : string
Return values
stringgetGloss()
Get the file gloss
public
getGloss() : string|null
Return values
string|nullsetFileName()
protected
setFileName(string $fileName) : void
Parameters
- $fileName : string
-
Set the file name
setFilePath()
protected
setFilePath(string|null $filePath) : void
Parameters
- $filePath : string|null
-
Set the file path
setFileType()
protected
setFileType(string|null $fileType) : void
Parameters
- $fileType : string|null
-
Set the file type
setGloss()
protected
setGloss(string|null $gloss) : void
Parameters
- $gloss : string|null
-
Set the display friendly gloss for the file