Application
in package
Table of Contents
- AmIRunningAsSuperuser() : bool
- Returns TRUE if your application started with Administrator's permissions.
- GetAuthor() : string
- Returns an author of application
- GetDescription() : string
- Returns a description of application
- GetExecutableDirectory() : string
- Returns a full path to work directory
- GetExecutableFileName() : string
- Returns a full path to executable file
- GetFrameworkVersion() : string
- Returns a xRefCore version
- GetHomeDirectory() : string
- Returns a home directory of current user (in Windows is C:\Users\your_username, in *unix systems is /home/your_username or /root)
- GetName() : string
- Returns a name of application
- GetRequiredPhpVersion() : string
- Returns required PHP version
- GetUsername() : string
- Returns a current username
- GetVersion() : string
- Returns a version of application
- GetWindowSize() : array<string|int, mixed>
- Returns a size of window as array with "columns" and "rows" keys
- ParseArguments() : array<string|int, mixed>
- Parses arguments to values with keys, free-key values and uninitialized keys
- SetTitle() : void
- Sets title of process (In Windows - title of window)
- Wait() : void
- Freezes application's execution. It is analog of sleep/usleep/time_nanosleep functions, but also supports asynchronous tasks.
Methods
AmIRunningAsSuperuser()
Returns TRUE if your application started with Administrator's permissions.
public
static AmIRunningAsSuperuser() : bool
Return values
bool —GetAuthor()
Returns an author of application
public
static GetAuthor() : string
Return values
string —Author of application
GetDescription()
Returns a description of application
public
static GetDescription() : string
Return values
string —Description of application
GetExecutableDirectory()
Returns a full path to work directory
public
static GetExecutableDirectory() : string
Return values
string —Full path to work directory
GetExecutableFileName()
Returns a full path to executable file
public
static GetExecutableFileName() : string
Return values
string —Full path to executable file
GetFrameworkVersion()
Returns a xRefCore version
public
static GetFrameworkVersion() : string
Return values
string —Framework version
GetHomeDirectory()
Returns a home directory of current user (in Windows is C:\Users\your_username, in *unix systems is /home/your_username or /root)
public
static GetHomeDirectory() : string
Return values
string —GetName()
Returns a name of application
public
static GetName() : string
Return values
string —Name of application
GetRequiredPhpVersion()
Returns required PHP version
public
static GetRequiredPhpVersion() : string
Return values
string —Required PHP version
GetUsername()
Returns a current username
public
static GetUsername() : string
Return values
string —GetVersion()
Returns a version of application
public
static GetVersion() : string
Return values
string —Version of application
GetWindowSize()
Returns a size of window as array with "columns" and "rows" keys
public
static GetWindowSize() : array<string|int, mixed>
Return values
array<string|int, mixed> —ParseArguments()
Parses arguments to values with keys, free-key values and uninitialized keys
public
static ParseArguments(array<int, string> $args, string $propertyNameDelimiter[, bool $skipFirstElement = true ]) : array<string|int, mixed>
Parameters
- $args : array<int, string>
-
List of arguments
- $propertyNameDelimiter : string
-
Delimiter for key name (for example "-" or "--")
- $skipFirstElement : bool = true
-
If true, skips the first element of $args. Usually the first element is path to your application
Return values
array<string|int, mixed> —= [ 'arguments' => (array<string, string>) Values with keys 'unnamed_values' => (array<int, string>) Values without keys 'uninitialized_keys' => (array<int, string>) Keys which don't have value ]
SetTitle()
Sets title of process (In Windows - title of window)
public
static SetTitle(string $title) : void
Parameters
- $title : string
-
Title of process
Return values
void —Wait()
Freezes application's execution. It is analog of sleep/usleep/time_nanosleep functions, but also supports asynchronous tasks.
public
static Wait(int $milliseconds) : void
Parameters
- $milliseconds : int
-
Time in millisecond. One millisecond is 0.001 second, or one second is 1000 milliseconds