RemoteServerConfiguration
in package
Server configuration.
Tags
Table of Contents
- $homeDirPrefix : mixed
- $label : mixed
- $scriptPath : mixed
- $server : mixed
- $sshKey : mixed
- $sshKeyPassword : mixed
- $userName : mixed
- __construct() : mixed
- Constructor
- getHomeDirPrefix() : string
- Returns the prefix for user home directories.
- getLabel() : string
- Returns a descriptive label.
- getScriptPath() : string
- Returns the script path.
- getServer() : string
- Returns the server's DNS name.
- getSshKey() : string
- Returns the path to the SSH key.
- getSshKeyPassword() : string
- Returns the SSH key password.
- getUserName() : string
- Returns the user name to connect.
Properties
$homeDirPrefix
private
mixed
$homeDirPrefix
$label
private
mixed
$label
$scriptPath
private
mixed
$scriptPath
$server
private
mixed
$server
$sshKey
private
mixed
$sshKey
$sshKeyPassword
private
mixed
$sshKeyPassword
$userName
private
mixed
$userName
Methods
__construct()
Constructor
public
__construct(string $server, string $label, string $homeDirPrefix, string $scriptPath, string $userName, string $sshKey, string $sshKeyPassword) : mixed
Parameters
- $server : string
-
server DNS name
- $label : string
-
label for GUI
- $homeDirPrefix : string
-
prefix for home directories
- $scriptPath : string
-
script path
- $userName : string
-
user name
- $sshKey : string
-
SSH key path
- $sshKeyPassword : string
-
SSH key password
Return values
mixed —getHomeDirPrefix()
Returns the prefix for user home directories.
public
getHomeDirPrefix() : string
Return values
string —prefix for user home directories
getLabel()
Returns a descriptive label.
public
getLabel() : string
Return values
string —label
getScriptPath()
Returns the script path.
public
getScriptPath() : string
Return values
string —script path
getServer()
Returns the server's DNS name.
public
getServer() : string
Return values
string —server name
getSshKey()
Returns the path to the SSH key.
public
getSshKey() : string
Return values
string —path
getSshKeyPassword()
Returns the SSH key password.
public
getSshKeyPassword() : string
Return values
string —password
getUserName()
Returns the user name to connect.
public
getUserName() : string
Return values
string —user name