ViewManagerFile
extends LocalFile
in package
ViewManagerFile
Tags
Table of Contents
Properties
- $applicationTemplateFile : bool
- Set true when file type is application template (When file has to load from website/codebase component directory)
- $file : string
- The path of the file with a leading directory separator
- $fileSystem : LocalFileSystem
- The file system instance this file belongs to
Methods
- __construct() : mixed
- __toString() : string
- Returns the full file path (path and filename including extension)
- getExtension() : string
- Returns this file's extension
- getFileSystem() : FileSystem
- Returns the FileSystem for this file
- getFullName() : string
- Returns the filename (without path including extension) for this file
- getMimeType() : string
- Returns the MIME type of this file
- getName() : string
- Returns the filename (without path and extension) for this file
- getPath() : string
- Returns the path (without filename) for this file
- isApplicationTemplateFile() : bool
- Check whether the file is application template
- setApplicationTemplateFile() : mixed
- Set true when file type is application template
Properties
$applicationTemplateFile
Set true when file type is application template (When file has to load from website/codebase component directory)
protected
bool
$applicationTemplateFile
= false
$file
The path of the file with a leading directory separator
protected
string
$file
$fileSystem
The file system instance this file belongs to
protected
LocalFileSystem
$fileSystem
Methods
__construct()
public
__construct(mixed $file, mixed $fileSystem) : mixed
Parameters
- $file : mixed
- $fileSystem : mixed
__toString()
Returns the full file path (path and filename including extension)
public
__toString() : string
Return values
stringgetExtension()
Returns this file's extension
public
getExtension() : string
Return values
string —File extension
getFileSystem()
Returns the FileSystem for this file
public
getFileSystem() : FileSystem
Return values
FileSystem —This file's FileSystem
getFullName()
Returns the filename (without path including extension) for this file
public
getFullName() : string
Return values
string —Filename without path including extension
getMimeType()
Returns the MIME type of this file
public
getMimeType() : string
Return values
string —MIME type
getName()
Returns the filename (without path and extension) for this file
public
getName() : string
Return values
string —Filename without path and extension
getPath()
Returns the path (without filename) for this file
public
getPath() : string
Return values
string —Path without filename
isApplicationTemplateFile()
Check whether the file is application template
public
isApplicationTemplateFile() : bool
Return values
boolsetApplicationTemplateFile()
Set true when file type is application template
public
setApplicationTemplateFile(mixed $applicationTemplateFile) : mixed
Parameters
- $applicationTemplateFile : mixed