Start
extends Singleton
in package
Class for handling and loading Magrathea's Bootstrap system
Table of Contents
Properties
- $appPath : mixed
- $instance : array<string|int, mixed>|null
- $structure : mixed
Methods
- __wakeup() : mixed
- CheckSelf() : bool
- Check if the class has everything it needs to survive
- CreateDefaultConfigFile() : bool
- Create default config file
- GetBootstrapURL() : mixed
- GetConfigFilePath() : string
- Get config file path
- GetConfigPath() : string
- Get config file path
- GetStepLink() : string
- Gets link to step
- Instance() : static|Singleton
- Load() : void
- Shows Bootstrap UI
- MockClass() : static|Singleton
- PreLoad() : mixed
- SetInstance() : mixed
- setPath() : Start
- Sets project's path
- ValidateStructure() : void
- Validate project's structure
- ViewConfigFile() : void
- Prints config file
- __clone() : mixed
- __construct() : mixed
- CheckFolder() : bool
- Check folders (printing in the way)
- Structurate() : void
- Create folders path
Properties
$appPath
protected
mixed
$appPath
$instance
protected
static array<string|int, mixed>|null
$instance
= []
$structure
private
mixed
$structure
= []
Methods
__wakeup()
public
final __wakeup() : mixed
CheckSelf()
Check if the class has everything it needs to survive
public
CheckSelf() : bool
Return values
boolCreateDefaultConfigFile()
Create default config file
public
CreateDefaultConfigFile() : bool
Return values
bool —true if file was created, false if don't
GetBootstrapURL()
public
static GetBootstrapURL() : mixed
GetConfigFilePath()
Get config file path
public
GetConfigFilePath() : string
Return values
string —path for config file
GetConfigPath()
Get config file path
public
GetConfigPath() : string
Return values
string —path for config file
GetStepLink()
Gets link to step
public
GetStepLink(int $step) : string
Parameters
- $step : int
-
step to go
Return values
string —step url
Instance()
public
static Instance() : static|Singleton
Return values
static|SingletonLoad()
Shows Bootstrap UI
public
Load() : void
MockClass()
public
static MockClass(mixed $mocker) : static|Singleton
Parameters
- $mocker : mixed
Return values
static|SingletonPreLoad()
public
PreLoad(mixed $appRoot) : mixed
Parameters
- $appRoot : mixed
SetInstance()
public
SetInstance(mixed $inst) : mixed
Parameters
- $inst : mixed
setPath()
Sets project's path
public
setPath(string $path) : Start
Parameters
- $path : string
-
main path of the project
Return values
StartValidateStructure()
Validate project's structure
public
ValidateStructure() : void
ViewConfigFile()
Prints config file
public
ViewConfigFile() : void
__clone()
protected
final __clone() : mixed
__construct()
private
final __construct() : mixed
CheckFolder()
Check folders (printing in the way)
private
CheckFolder(mixed $path[, mixed $retry = false ]) : bool
Parameters
- $path : mixed
- $retry : mixed = false
Return values
bool —Folder OK or not
Structurate()
Create folders path
private
Structurate() : void