Toolkit
in package
Provides default Toolkit class.
Table of Contents
- VERSION = '9.3.0'
- Constant holding the current version.
- ensureArray() : mixed
- If given content is a string, it will be exploded by given separator.
- filterFolders() : mixed
- Remove un-existing folders from given array.
- getAsdaPass() : string
- Returns the ASDA password.
- getAsdaUser() : string
- Returns the ASDA user.
- getNextcloudPass() : string
- Returns the NEXTCLOUD password.
- getNextcloudUser() : string
- Returns the NEXTCLOUD user.
- getProjectRoot() : string
- Returns the Project root.
- getRoboVersion() : string
- Return the current Robo version.
- getToolkitRoot() : string
- Returns the Toolkit root.
- isCiCd() : bool
- Returns whether is running in CI/CD environment.
Constants
VERSION
Constant holding the current version.
public
mixed
VERSION
= '9.3.0'
Methods
ensureArray()
If given content is a string, it will be exploded by given separator.
public
static ensureArray(mixed &$data[, string $sep = ',' ]) : mixed
Parameters
- $data : mixed
-
If the data is a string it will be exploded by comma.
- $sep : string = ','
-
The separator to explode the string.
Return values
mixed —filterFolders()
Remove un-existing folders from given array.
public
static filterFolders(array<string|int, mixed> &$files) : mixed
Parameters
- $files : array<string|int, mixed>
-
The folders to check.
Return values
mixed —getAsdaPass()
Returns the ASDA password.
public
static getAsdaPass() : string
Return values
string —The ASDA password.
getAsdaUser()
Returns the ASDA user.
public
static getAsdaUser() : string
Return values
string —The ASDA user.
getNextcloudPass()
Returns the NEXTCLOUD password.
public
static getNextcloudPass() : string
Return values
string —The NEXTCLOUD password.
getNextcloudUser()
Returns the NEXTCLOUD user.
public
static getNextcloudUser() : string
Return values
string —The NEXTCLOUD user.
getProjectRoot()
Returns the Project root.
public
static getProjectRoot() : string
Return values
string —The Project root.
getRoboVersion()
Return the current Robo version.
public
static getRoboVersion() : string
Return values
string —A string with the Robo version, empty string if could not find the version,
getToolkitRoot()
Returns the Toolkit root.
public
static getToolkitRoot() : string
Return values
string —The Toolkit root.
isCiCd()
Returns whether is running in CI/CD environment.
public
static isCiCd() : bool
Return values
bool —True if running in CI/CD, false otherwise.