FileSystemDetails
in package
Class FileSystemDetails
Table of Contents
- $dangerousTools : array<string|int, mixed>
- $globalUsermodDirectoryExists : bool
- $gxModules : array<string|int, mixed>
- $receiptFiles : array<string|int, mixed>
- $upmDirectoryExists : bool
- $usermods : array<string|int, mixed>
- __construct() : mixed
- FileSystemDetails constructor.
- create() : FileSystemDetails
- Creates and returns a new FileSystemDetails instance.
- dangerousTools() : array<string|int, mixed>
- Returns a list of dangerous tools in the file system.
- globalUsermodDirectoryExists() : bool
- Returns the global user mod directory status.
- gxModules() : array<string|int, mixed>
- Returns a list of GXModules directories in the file system.
- receiptFiles() : array<string|int, mixed>
- Returns a list of receipt files in the file system.
- upmDirectoryExists() : bool
- Returns the upm directory status.
- usermods() : array<string|int, mixed>
- Returns a list of user mods in the file system.
Properties
$dangerousTools
private
array<string|int, mixed>
$dangerousTools
$globalUsermodDirectoryExists
private
bool
$globalUsermodDirectoryExists
$gxModules
private
array<string|int, mixed>
$gxModules
$receiptFiles
private
array<string|int, mixed>
$receiptFiles
$upmDirectoryExists
private
bool
$upmDirectoryExists
$usermods
private
array<string|int, mixed>
$usermods
Methods
__construct()
FileSystemDetails constructor.
public
__construct(array<string|int, mixed> $usermods, array<string|int, mixed> $gxModules, array<string|int, mixed> $dangerousTools, array<string|int, mixed> $receiptFiles, string $globalUsermodDirectoryExists, string $upmDirectoryExists) : mixed
Parameters
- $usermods : array<string|int, mixed>
- $gxModules : array<string|int, mixed>
- $dangerousTools : array<string|int, mixed>
- $receiptFiles : array<string|int, mixed>
- $globalUsermodDirectoryExists : string
- $upmDirectoryExists : string
Return values
mixed —create()
Creates and returns a new FileSystemDetails instance.
public
static create(array<string|int, mixed> $usermods, array<string|int, mixed> $gxModules, array<string|int, mixed> $dangerousTools, array<string|int, mixed> $receiptFiles, string $globalUsermodDirectoryExists, string $upmDirectoryExists) : FileSystemDetails
Parameters
- $usermods : array<string|int, mixed>
- $gxModules : array<string|int, mixed>
- $dangerousTools : array<string|int, mixed>
- $receiptFiles : array<string|int, mixed>
- $globalUsermodDirectoryExists : string
- $upmDirectoryExists : string
Return values
FileSystemDetails —dangerousTools()
Returns a list of dangerous tools in the file system.
public
dangerousTools() : array<string|int, mixed>
Return values
array<string|int, mixed> —globalUsermodDirectoryExists()
Returns the global user mod directory status.
public
globalUsermodDirectoryExists() : bool
Return values
bool —Returns true, if the global user mod directory exists, otherwise false will be returned.
gxModules()
Returns a list of GXModules directories in the file system.
public
gxModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —receiptFiles()
Returns a list of receipt files in the file system.
public
receiptFiles() : array<string|int, mixed>
Return values
array<string|int, mixed> —upmDirectoryExists()
Returns the upm directory status.
public
upmDirectoryExists() : bool
Return values
bool —Returns true, of the upm directory exists, otherwise false will be returned.
usermods()
Returns a list of user mods in the file system.
public
usermods() : array<string|int, mixed>